导入路径 - 正确的方式？

Question

我知道有很多类似或相同的问题，但我仍然无法理解/找到适合我使用模块的方法。 Python 是我最喜欢的语言，我喜欢其中的所有内容，除了使用导入：递归导入（当您尝试引用尚不存在的名称时）、导入路径等。

所以，我有这样一个项目结构：

my_project/
    package1/
        __init__.py
        module1
        module2
    package2/
        __init__.py
        module1
        module2

Package1 可以作为独立单元使用，但也可以通过package2 导入。 我现在在做什么，例如，在package1.module1 我写from package1 import module2，即使用导入模块的完整路径。我这样做是因为如果我使用import module2 - 当模块将从另一个包 (package2) 导入时，这将不起作用。我也不能使用from . import module2——这在直接运行module1 时不起作用。

好的，所以为了让package1.module1 中的from package1 import module2 在这两种情况下都能正常工作（直接运行package1.module1 和从package2 导入它时）我在package1.module1 的开头添加这些行：

import os, sys
currDir = os.path.dirname(os.path.realpath(__file__))
rootDir = os.path.abspath(os.path.join(currDir, '..'))
if rootDir not in sys.path: # add parent dir to paths
    sys.path.append(rootDir)

对我来说这是可行的，但我觉得这不是 pythonic。我是不是做错了什么？

我是否应该始终从项目根目录运行package1.module1？如果是这样，从 IDE 运行它会很不方便——我需要以某种方式在其中设置路径。

更新：我尝试将文件 root.pth 添加到 package1 目录，内容为 ..。但它不起作用——我猜它是为了别的目的。

结论：

1. 始终使用绝对导入：import package1.module1

2. 将引导程序添加到根文件夹以将某些模块作为独立脚本启动。这解决了从 IDE 运行脚本的问题，并且是一种 Python 方法。

2007 年 4 月 22 日，Brett Cannon 写道：

此 PEP 是将 if __name__ == "__main__": ... 成语更改为 if __name__ == sys.main: ...让你至少有机会 在使用相对导入的包中执行模块。

通过 python-ideas 运行这个 PEP。也停止了讨论 提出了许多新的想法。 =) 我已经把它们都列在了 被拒绝的想法部分，虽然如果压倒性地支持一个 挺身而出，PEP 可以转移到其中之一。

我在这个和__main__ 的任何其他提议的小玩意上都是-1 机械。唯一的用例似乎是运行发生的脚本 生活在一个模块的目录中，我一直将其视为一个 反模式。要让我改变主意，你必须说服我 不是。

--Guido van Rossum

Answer 1

您的程序的入口点是什么？通常，程序的入口点将位于项目的根目录。由于它位于根目录，因此根目录中的所有模块都是可导入的，前提是其中有一个__init__.py 文件。

所以，用你的例子：

my_project/
    main.py
    package1/
        __init__.py
        module1
        module2
    package2/
        __init__.py
        module1
        module2

main.py 将是您的程序的入口点。因为作为 main 执行的文件会自动放在 PYTHONPATH 上，所以 package1 和 package2 都可以从顶级导入中获得。

# in main.py
from package1.module1 import *
from package1.module2 import *

# in package1.module1
import module2
from package2.module1 import *

# in package2.module1 import *
import module2
from package1.module1 import *

请注意，在上面，package1 和 package2 是相互依赖的。绝不应该是这样。但这只是能够从任何地方导入的示例。

main.py 也不必太花哨。可以很简单：

# main.py

if __name__ == '__main__':
    from package1.module1 import SomeClass
    SomeClass().start()

我想说的是，如果一个模块需要被其他模块访问，那么该模块应该可以作为顶级导入使用。模块不应尝试将自己作为顶级导入（直接在 PYTHONPATH 上）。

如果模块直接包含在项目中，则项目应负责确保满足所有导入。有两种方法可以做到这一点。第一种是在项目文件夹中创建一个引导程序文件，例如main.py。另一种方法是创建一个文件，将所有相关路径添加到 PYTHONPATH，该文件由可能存在的任何入口点加载。

例如：

# setup.py
import sys

def load():
    paths = ['/path1/','/path2/','/path3/']
    for p in path:
        sys.path.insert(0, p)

# entrypoint.py
from setup import load
load()
# continue with program

要带走的主要内容是，模块不应该将自己置于路径上。路径应该由程序的入口点自动确定，或者由知道所有相关模块在哪里的安装脚本明确定义。

Answer 2

我通常将每个包创建为一个可安装包（即，创建一个 setup.py 文件），然后使用 pip 将它们安装到仅用于该项目的 virtualenv 中。

如果仍在开发中，您甚至可以使用 pip -e 安装。

Answer 3

我在这里晚了 5 年.. 但只需执行 export PYTHONPATH=/path1:/path2:（注意尾随“:”） - 这样您的工作目录（从中运行 python）将在路径中。