如何在 Jupyter 笔记本中使用来自外部 Python 文件的代码？

Question

我有一个作为 Jupyter 笔记本开始的宠物项目。至此，我把所有的 Python 代码都放在了 notebook 里。

一开始一切都很好。但随着时间的推移，我在笔记本上写的代码变得越来越复杂。现在它几乎无法管理：当我发现错误时，我需要

1. 导航到有错误的代码部分（通常在笔记本的开头），
2. 修复那里的错误，
3. （通常）转到笔记本底部以触发执行我更改的代码。

我想把代码分成两部分：

1. 将存储为 Python 文件，我将使用编辑器（和/或 IDE）对其进行编辑。
2. Jupyter 笔记本中调用代码部分 1 并显示其输出的代码（即，使用 Jupyter 笔记本作为第 1 步中 Python 代码的用户界面）。

假设笔记本在我的本地机器上运行（Windows 7；Jupyter 在 Anaconda 中运行）并且 Python 文件也存储在本地。

有哪些好方法可以使用 IPython 文件中的代码，以便我可以频繁且快速地修改此代码？

我所说的“频繁且快速”是指“将更改从 Python 文件传播到笔记本所需的步骤尽可能少”。理想的解决方案是我更改其中一个 Python 文件，运行一个命令，然后在 Jupyter 笔记本中提供更改。或者，用一个更老的比喻，我希望它像 PHP 一样——您经常更改代码并立即看到更改的结果。

更新 1：我尝试在单元格中使用带有%load TestClass.py 的解决方案。

问题在于，如果文件更改，单元格内容不会更新。

例子：

假设我放了文字

class TestClass:
    def __init__(self):
        print("TestClass constructor")

进入TestClass.py。然后我在 Jupyter notebook 中使用%load TestClass.py 创建一个单元格。当我执行该单元格时，来自TestClass.py 的代码被导入，%load TestClass.py 行被注释掉。

现在我把TestClass.py改成

class TestClass:
    def __init__(self):
        print("TestClass constructor")
        print("change")

当我执行单元格时，它的内容并没有改变。

Answer 1

我通常卸载要刷新的模块然后重新导入。绑定到旧代码的对象不会被刷新，我时不时地必须重新启动内核，但这比每次重新启动内核要快得多。我只建议那些已经了解或愿意了解从 sys.modules 中删除模块的影响的人。但它为我节省了很多时间。

请参阅 UnloadModules here。

我在 Jupyter 中的典型用法：

from coppertop import Unload
Unload("fred.joe")
from fred.joe.sally import arthur
arthur.doSomethingInteresting()

Answer 2

你在写：

并且 %load TestClass.py 行被注释掉了。

我明白，您将其注释掉。为什么？重新运行导入并更新类。

BTW !run TestClass.py 应该做同样的事情 - 至少在 Jupyter NB 中。

Answer 3

听起来像 IPython 的 autoload extension 正是您所需要的。只需插入

%load_ext autoreload
%autoreload 2

在 Jupyter notebook 的第一个单元格中，导入的 python 模块会在更改时自动重新加载。你也可以对已安装的 python 包进行更改，前提是你已经安装了它们editable。

Answer 4

我一直在研究类似的问题。如果您使用 Jupyterlab 而不是较旧的 Jupyter Notebooks，您可以同时打开多个 nb，编辑保存您的函数的一个，然后在导入时重新启动另一个内核以更新。不幸的是，您丢失了所有变量，需要再次运行整个笔记本，但它允许第一个 nb 中的更改传播到第二个。

这不是一个完美的答案，但让我可以继续从事我的项目。