Python动态加载模块时类型导入的命名空间不一致问题解决

问题 #

我希望从包内动态加载一个模块，并将包中的对象导入该模块，但遇到了类型相关的命名空间不一致问题。

包文件位于pkg目录：

pkg:
__init__.py, main.py, commands.py, queries.py

待加载的模块run.py位于其他路径my_directory中。

各文件代码 #

• main.py（主模块，负责动态加载run.py）：

import importlib.util
import sys

script_file = 'my_directory/run.py'
spec = importlib.util.spec_from_file_location('my_script', script_file)
mod = importlib.util.module_from_spec(spec)
sys.modules[script_file] = mod
spec.loader.exec_module(mod)

• commands.py：

from queries import report, Format

def list_data(fmt: Format = Format.ASCII):
    report(fmt)

• queries.py：

from enum import auto, Enum

class Format(Enum):
    ASCII = auto()
    PYTHON = auto()

def report(fmt):
    if fmt == Format.PYTHON:
        print('Format is Python')
    else:
        print('Same values:', fmt == Format.PYTHON)
        print('Same types:', type(fmt) == type(Format.PYTHON))
        print(f'Formats: {fmt}, {Format.PYTHON}')
        print('Module of Format:', Format.__module__)
        print('Module of fmt:', fmt.__module__)

• init.py：

from .queries import Format
from .commands import list_data

• run.py：

from pkg import list_data, Format

list_data(Format.PYTHON)

问题现象 #

预期打印Format is Python，但实际执行else分支，输出：

Same values: False
Same types: False
Formats: Format.PYTHON, Format.PYTHON
Module of Format: queries
Module of fmt: pkg.queries

可见Format.PYTHON的类型处于不同命名空间，无法匹配。

解决方案 #

问题根源是commands.py中直接从queries（而非pkg.queries）导入Format，导致模块内的Format和run.py中从pkg导入的Format是两个不同的类对象（命名空间不一致）。需要统一所有导入的命名空间：

1. 修改commands.py的导入路径 #

将commands.py中的导入改为包内相对路径，确保使用pkg.queries下的Format：

from .queries import report, Format  # 用相对路径，对应pkg.queries

def list_data(fmt: Format = Format.ASCII):
    report(fmt)

2. 修正动态加载的模块注册名称 #

修改main.py中注册模块的名称，不要用文件路径，而是与spec定义的名称保持一致，避免干扰包的命名空间：

import importlib.util
import sys

script_file = 'my_directory/run.py'
spec = importlib.util.spec_from_file_location('my_script', script_file)
mod = importlib.util.module_from_spec(spec)
sys.modules['my_script'] = mod  # 与spec的name参数一致，替换原文件路径
spec.loader.exec_module(mod)

3. 验证效果 #

执行main.py后，run.py中从pkg导入的Format和commands.py中使用的Format会指向同一个类对象，此时list_data(Format.PYTHON)会正确进入if分支，打印Format is Python。

内容的提问来源于stack exchange，提问作者Dmitry K.