一文了解Python跨包引用其他模块

在Python中，跨包引用其他模块主要涉及到Python的模块导入机制以及包（package）的概念。包是Python中用来组织模块的方式，它是一个包含多个模块的文件夹，该文件夹下必须有一个__init__.py文件（在Python 3.3之后这个文件可以为空，但必须存在，以标识该目录是一个Python包）。跨包引用即在一个包的模块中引用另一个包或同一包内其他模块的功能。

基本步骤

1. 确保每个包（目录）下有__init__.py文件，即使它是空的。
2. 使用.来表示当前包及其子包，进行相对导入或绝对导入。

示例说明

假设我们有以下目录结构：

my_project/
│
├── main.py
│
├── package1/
│   ├── __init__.py
│   ├── module1.py
│   
└── package2/
    ├── __init__.py
    ├── module2.py

一、在module2.py中引用package1.module1中的函数

1.1 如果要在package2.module2中使用package1.module1中的一个函数function_a，可以这样做：

package1/module1.py:

def function_a():
    return "This is function a in module1."

package2/module2.py:

from package1.module1 import function_a

def function_b():
    result = function_a()
    print(result)

这里使用了绝对导入，明确指出了要导入的模块的完整路径。

不过很多人在这里会遇到报错：

Traceback (most recent call last):
  File "d:/soft/src/python-src/my_project/package2/module2.py", line 1, in <module>
    from package1.module1 import function_a
ModuleNotFoundError: No module named 'package1'

可以继续往下看

1.2 package2/module2.py:相对导入引用

from ..package1.module1 import function_a

def function_b():
    result = function_a()
    print(result)

这里使用了相对导入，明确指出了要导入的模块的相对路径。

不过也网上也有很多人会报错：

Traceback (most recent call last):
  File "d:/soft/src/python-src/my_project/package2/module2.py", line 1, in <module>
    from ..package1.module1 import function_a
ImportError: attempted relative import with no known parent package

如果上述没有解决跨包引用的问题，那么只能用最后的方法了。

1.3 package2/module2.py:系统路径引入法

import sys
sys.path.append('D:/python-src/my_project/package1')
import module1 import function_a

def function_b():
    result = function_a()
    print(result)

这里使用了系统路径引入法，明确将模块的导入系统中。

二、在main.py中引用上述模块

如果在项目的顶层main.py中想要使用这两个模块的功能，同样可以通过绝对导入实现：

main.py:

from package1.module1 import function_a
from package2.module2 import function_b

print(function_a())
function_b()

三、同包相对导入

在某些情况下，特别是在包内部的模块之间互相引用时，可以使用相对导入。例如，在package2.module2中，如果要导入同包内的module2.py，可以这样写：

假设现在在package2.module_x.py中，要引用module2.py：

from .module2 import function_b

这里的.表示当前包，.module2就是指同一包内的module2.py模块。

请注意，相对导入在顶层脚本或非包的模块中是不允许的，它们只能在包内部使用。

通过遵循这些原则和方法，你可以有效地在Python项目中进行跨包引用。