Python之模块详细梳理(四)，关于相对导入报错最优雅解决方法。

相对导入

相对导入是指在同一个项目下不同模块之间相互导入，称为相对导入。

相对导入的案例

项目结构图如下：

项目名称project，该目录下有xx子项目和test.py模块。其中xx子目录下有y和z两个子目录，y子目录下有abc.py模块和yy.py模块，z子目录下有zz.py模块。yy.py是xx子项目的入口。test.py是整个项目的入口。

test.py模块的内容

"""
此模块是整个project项目的入口
"""

from xx.y import yy

yy.f2()
print(yy.num1, yy.num2, yy.num3)

out:
123
10
hello
10 123 888

yy.py模块的内容

"""
此模块是xx子项目对外引用的入口
"""

from .abc import *
from ..z.zz import *

num3 = 888


def f2():
    print(num2)
    print(num1)

zz.py模块的内容

"""
子项目，被导入的子模块
"""

num1 = 10


def f():
    print('hello')

abc.py模块的内容

"""
子项目，被导入的子模块
"""

num2 = 123

以上就是模拟大型项目的框架结构，测试运行test.py模块可以看到输出正常，完全没有问题。

请仔细看yy.py模块的内容：

from .abc import *语句：. 表示当前目录，abc表示abc.py模块。

from ..z.zz import *语句，.. 表示父目录，z表示z文件夹，zz表示zz.py模块。

另外... 表示祖父目录，请熟悉from 路径标识结构。

相对导入：以from . 开头的语句，例如from .abc import *。

绝对导入：以文件夹或包或模块名开头的语句，例如from xx.y import yy。

以上暂未遇到报错，可如果你尝试调试yy.py模块，直接运行yy.py模块时会报错。

相对导入报错情况分析

是不是非常奇怪！为什么运行test.py模块调用yy.py模块时不报错，而直接脚本方式运行yy.py模块时会报错。我在网上找了很多资料没理出个头绪。后来找到有建议在yy.py模块中对sys.path添加路径，方法虽然可行但不优雅，也没有解释为什么yy.py模块被调用时不会报错，而直接运行yy.py会报错。

我针对被调用时不报错主动执行时报错的情况特地查了很多资料，做了仔细分析，关于上述这个特点我首先想到的是__name__，这个变量在被调用时和主动执行时内容是不一样的。后来针对模块调用查资料找到了__package__，这个变量在被调用时和主动执行时内容也是不一样的。

下面我们尝试打印__name__和__package__这两个变量，看看在被调用和主动执行时分别有什么不同。

修改yy.py模块文件内容

"""
此模块是xx子项目对外引用的入口
"""

from .abc import *
from ..z.zz import *

print(__name__)
print(__package__)
num3 = 888


def f2():
    print(num2)
    print(num1)

执行test.py模块的结果：

xx.y.yy
xx.y
123
10
hello
10 123 888

直接执行yy.py的结果(暂时注释那2行相对导入的代码，要不然报错会导致看不到print打印内容)：

相对导入报错的pythonic解决方法

认真观察yy.py模块被导入时打印的内容和主动执行时打印的内容不同之处。我想到了最pythonic的解决方案。

"""
此模块是xx子项目对外引用的入口
"""
__package__ = 'xx.y'

from .abc import *
from ..z.zz import *


num3 = 888


def f2():
    print(num2)
    print(num1)

直接修改__package__变量的值为被调用时的值，这样主动运行yy.py模块时不再报错，被调用时也不报错。

以上是相对导入的知识点梳理，我在yy.py模块直接调试运行会报错这一问题上花费很多时间和精力，最终想到了最优雅的解决方式，希望对各位深入学python的朋友有所帮助，如果要转载请注明出处和作者是“皛心”。