Jupyter Notebook中autoreload重载本地模块运行异常问题咨询

错误回溯中展示的代码片段是Python报错时实时读取磁盘上的源码文件生成的，和内存中正在运行的已编译字节码没有关联，所以才会出现显示的代码已经修正为yyy = xxx * 2，但运行时仍报旧变量xx未定义的情况，本质是内存中运行的还是修改前的旧版本代码。

• 直接导入函数到当前命名空间导致引用未更新：你使用from local.script import calculate_task的方式导入时，会直接把函数对象的引用拷贝到当前命名空间，autoreload只会重载模块本身的内容，不会主动更新当前命名空间已经存在的旧函数引用，导致实际调用的还是旧版本函数。
• 模块导入链缓存：如果local模块、local.script模块或其他依赖模块已经被提前导入到Python的sys.modules缓存中，autoreload可能没有递归触发全链路重载，导致旧代码残留。
• autoreload自身限制：如果calculate_task函数被装饰器包裹、或是属于类的成员方法，autoreload大概率无法正确重载更新后的代码；此外如果导入的模块路径和你修改的文件路径不一致，也会出现修改不生效的问题。

方案1：手动清除缓存后重新导入 #

优先尝试清理现有引用和模块缓存，再重新导入函数：

# 删除当前命名空间的旧函数引用
del calculate_task
# 清理模块缓存
import sys
sys.modules.pop('local.script', None)
sys.modules.pop('local', None)
# 重新导入
from local.script import calculate_task

方案2：调整导入方式适配autoreload #

autoreload对模块级别的导入支持更好，建议后续导入时直接导入模块，调用时带上模块前缀：

%load_ext autoreload
%autoreload 2
# 导入模块而非直接导入函数
import local.script
# 调用时使用模块前缀，autoreload会自动重载模块内容
local.script.calculate_task()

方案3：排查路径及特殊场景 #

• 先确认修改的文件和实际导入的模块是同一个，执行以下代码打印模块路径核对：

import local.script
print(local.script.__file__)

如果路径不匹配，说明Python导入的是其他位置的同名模块，调整Python导入路径或修改对应位置的代码即可。

• 如果函数被装饰器修饰、或上述方案都不生效，直接重启IPython/Jupyter内核即可，所有缓存会被清空，重新导入的就是最新代码。

内容的提问来源于stack exchange，提问作者ian_chan