Python 3 包和脚本中的导入最佳实践

Question

考虑这个简单的文件夹结构：

root
  Package1
    x.py
    y.py
  Package2
    z.py
  Examples
    main.py

现在我们的要求是：

• x.py需要导入y.py
• z.py需要导入y.py
• main.py需要导入y.py和z.py

以下是有效的：

x.py

import y

def x():
  y()

y.py

def y():
  pass

z.py

import package1.y as y

def z():
  y.y()

ma​​in.py

import sys
from os import path
sys.path.append(  path.dirname(  path.dirname( path.abspath(__file__) ) ) )

import package1.y as y
import package2.z as z

y.y()
z.z()

问题：

1. 这是在 Python 3 中设置导入的最佳和推荐方法吗？
2. 我真的不喜欢在main 中更改sys.path，因为它强烈绑定了关于代码文件内部 包位置的假设。有什么办法解决吗？
3. 我也真的不喜欢as y 中多余的import package1.y as y 部分。有什么办法解决吗？

Answer 1

与往常一样，有两个单独的步骤：

1. 您针对包的abstract 命名空间编写代码，其中包含package1 和package2（以及sys、os、等） ，但不是“示例”，它不是一个包（因为main.py 不是一个模块）。
2. 您在任何代码运行之前适当地设置sys.path。如果是您自己的（卸载的）代码，则有 places you can put it，或者您可以编写一个简单的 shell 脚本包装器来为您的 python 进程设置 PYTHONPATH。

所以你的问题的答案是

1. 在x.py 你写from . import y。 （Python 2 支持这一点，而 3 需要它。）
2. 如何设置sys.path 取决于您的打包/环境系统。传统方法是为python 进程设置PYTHONPATH 环境变量，但还有其他方法涉及site 模块等。
3. from package1 import y 是只命名一次的常用方式。