Python模块相互引用报错与解决方案详解

摘要：本文详细解析了Python中相对路径与绝对路径在模块引用中的具体应用与差异。

在实际运行过程中，可能会遇到以下两类典型报错：

报错1：ModuleNotFoundError: No module named '__main__.src_test1'; '__main__' is not a package 报错2：ImportError: attempted relative import with no known parent package

针对上述两个报错，本文对Python 3环境下的模块相互引用机制进行了深入探究，并逐一进行解析，建议仔细阅读。

首先，我们构建第一个错误的测试场景，代码目录结构如下：

|--- test_main.py
|--- src
 |--- __init__.py                               
  |--- src_test1.py
  |--- src_test2.py

src_test2.py 代码内容

class Test2(object):
  def foo(self):
    print('I am foo')

src_test1.py 代码，其中引用了Test2模块

from .src_test2 import Test2
 
def fun1():
  t2 = Test2()
  t2.foo()
if __name__ == "__main__":
  fun1()

此时直接运行 src_test1.py 会报错“No module named '__main__.src_test1'; '__main__' is not a package”

问题原因分析：

核心问题在于引用 src_test2 模块时使用了相对路径“.”，在 import 语法中这被翻译为“./”，即当前目录。从逻辑上看似乎无误，但为何会报错？

查阅 PEP 328 文档，其中关于相对引用（relative imports）有明确介绍。

通俗解释如下：当程序直接运行某个模块时，该模块被视为主模块，其 __name__ 属性为 '__main__'。此时，模块 import 语句中的点（.）会被替换为 '__main__'，导致 .src_test2 变为 __main__.src_test2。由于系统中不存在名为 __main__ 的包，因此无法找到该模块。

解决方法：

建议的做法是在 src 同级目录下创建一个入口模块 test_main.py（暂不解释为何不在 src 目录下创建，后续报错部分会说明），并在其中引用 src_test1 模块，代码如下：

from src.src_test1 import fun1
 
if __name__ == "__main__":
  fun1()

为何这样执行即可成功？其原理如下（欢迎指正）：当执行 test_main 时，它被视为根目录。因此，它引用的 src.src_test1 是绝对路径，无论在哪里执行都不会出错。此时 test_main 的 __name__ 为 '__main__'。当执行 src_test1 时，注意其 __name__ 变为 src.src_test1。在 src_test1 中使用相对路径查找时，逻辑是先找到父节点（src 目录），再在父节点下查找 src_test2，因此可以成功找到模块。

辅助验证：

构造一个例子来理解“执行目录即根目录”的说法。修改 test1，使其引用 test_main：

from .. import test_main
 
报错：ValueError: attempted relative import beyond top-level package

OK，接下来构造第二个报错场景：

上文提到，解决 __main__ 问题的方法是创建一个模块来调用使用相对路径的模块。那么，为什么不能在相同目录下直接创建该文件来调用呢？让我们通过代码测试一下：

创建 test_src.py 文件，代码结构变更如下：

|--- test_main.py
|--- src
 |--- __init__.py                               
  |--- src_test1.py
  |--- src_test2.pys
  |--- test_src.py

test_src 代码内容

from src_test1 import fun1
 
if __name__ == "__main__":
  fun1()

执行报错：ImportError: attempted relative import with no known parent package

问题原因：

当执行 test_src 时，按前述理解，执行文件所在目录被视为根目录。此时引用 test1，需注意 test1 的 __name__ 属性不再是 src.src_test1，因为程序无法感知 src 目录的存在，其绝对路径变为 src_test1。当再次引用相对路径查找 test2 时，步骤相同：先找父节点。但由于此时它自己就是根节点，没有父节点，因此报错“no known parent package”。

解决方法：

为避免父节点查找出现矛盾，可将 test1 中的相对引用改为绝对引用。

from .src_test2 import Test2  -->  from src_test2 import Test2

继续深入探讨：

使用相对路径和绝对路径时，编译器是如何定位模块的？

执行 import 时存在特定的查找顺序：优先查找执行目录下是否有该文件；如果没有，再查找 lib 库；如果仍没有，再查找 sys.path 中的路径；若依然找不到，则报错。

因此，无论是当前目录还是 sys.path 中的目录，只要能查到 src_test2 模块，编译即可成功。

补充说明：

解决上述问题后，无论采用哪种方式，调试代码时通常都是单个文件调试。但此时根目录设置不正确，import 方式又需改动，执行起来较为麻烦。因此推荐另一种方式（若有更好方式欢迎留言），即使用 sys.path.append() 方法。

import sys,os
sys.path.append(os.getcwd())
from src.src_test2 import Test2

使用 append 方式将程序文件根目录加入 sys.path 中，然后引用绝对路径。这种方式不管使用上文中的第一种或第二种执行方式均可调用，也可以单独编译 test1 文件而无需修改 import 路径，相对安全。但缺点是，如果修改了某个包名，需要修改所有引用处，工作量较大，需因地制宜。

综上所述，本文详细讲解了相对路径和绝对路径的引用方法，现在你应该对 import 导入问题有了清晰的理解。

备注：本文基于 Python 3.7 版本进行测试。

到此这篇关于 Python 模块相互引用问题的文章介绍完毕，更多相关 Python 模块引用内容请搜索本站以前的文章或继续浏览下面的相关文章，希望大家以后多多支持本站！