如何在Python中重写包的__init__.py且不破坏子模块导入

问题根源 #

当你用自定义钩子替换zope.intid.__init__.py的模块对象时，新生成的模块缺少包必需的__path__属性。Python只有在模块包含__path__时才会将其识别为包，没有这个属性的话，后续导入子模块（如zope.intid.interfaces）时就会抛出ModuleNotFoundError，提示“不是包”。

解决方案 #

1. 为替换后的包模块添加__path__属性 #

在加载自定义的__init__.py后，手动为模块添加__path__，值可以复用原包的子模块搜索路径，也可以追加自定义目录的路径（优先加载自定义子模块）。

以下是调整后的自定义导入钩子示例：

import importlib.util
import sys
import os

class ZopeIntidImportHook:
    def find_spec(self, fullname, path, target=None):
        # 仅处理zope.intid相关模块
        if not fullname.startswith("zope.intid"):
            return None

        # 拼接自定义文件路径
        module_parts = fullname.split('.')
        custom_file = os.path.join("./lib_changes", *module_parts) + ".py"
        
        # 处理包的__init__.py（如果上面的文件不存在，尝试找__init__.py）
        if not os.path.exists(custom_file):
            custom_file = os.path.join("./lib_changes", *module_parts, "__init__.py")

        if os.path.exists(custom_file):
            # 创建模块spec
            spec = importlib.util.spec_from_file_location(fullname, custom_file)
            if not spec:
                return None

            # 包装exec_module，加载后为包添加__path__
            original_exec = spec.loader.exec_module
            def wrapped_exec(module):
                # 先执行原加载逻辑
                original_exec(module)
                # 为zope.intid主包添加__path__
                if fullname == "zope.intid":
                    # 获取原包的搜索路径（保留原site-packages的子模块查找能力）
                    original_spec = importlib.util.find_spec(fullname)
                    if original_spec and original_spec.submodule_search_locations:
                        module.__path__ = original_spec.submodule_search_locations
                    # 可选：将自定义目录加入__path__，优先加载自定义子模块
                    # custom_package_path = os.path.join("./lib_changes", *module_parts)
                    # module.__path__.append(custom_package_path)
            spec.loader.exec_module = wrapped_exec
            return spec
        
        # 没有自定义文件时，交给默认导入机制处理
        return None

# 注册钩子（放到sys.meta_path最前面，优先触发）
sys.meta_path.insert(0, ZopeIntidImportHook())

2. 子模块导入的处理逻辑 #

上述钩子会自动处理子模块：

• 如果自定义目录./lib_changes/zope/intid/下有interfaces.py，则加载这个自定义版本；
• 如果没有自定义文件，钩子返回None，Python会自动去原site-packages路径查找子模块。

3. 验证修复效果 #

导入模块后，检查包属性是否正确：

import zope.intid
# 应该返回True，说明被识别为包
print(hasattr(zope.intid, '__path__'))
# 尝试导入子模块
from zope.intid import interfaces

关键注意点 #

• 不要直接替换sys.modules['zope.intid']而不设置__path__，这会破坏包的识别逻辑；
• 测试前清空模块缓存：如果之前导入过相关模块，先执行del sys.modules['zope.intid']和del sys.modules['zope.intid.interfaces']，避免缓存导致的问题；
• 如果需要自定义子模块，确保自定义目录的结构和原包一致（比如./lib_changes/zope/intid/interfaces.py对应zope.intid.interfaces）。

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