如何在 Python 模块中正确使用相对或绝对导入？

Question

在 Python 中使用相对导入有一个缺点：您将无法再作为独立运行模块，因为您将收到异常：

ValueError：尝试在非包中进行相对导入

代码

# /test.py: just a sample file importing foo module
import foo
...

# /foo/foo.py:
from . import bar
...
if __name__ == "__main__":
   pass

# /foo/bar.py: a submodule of foo, used by foo.py
from . import foo
...
if __name__ == "__main__":
   pass

中进行相对导入我应该如何修改示例代码以便能够执行以下所有操作？ test.py、foo.py 和 bar.py。

我正在寻找适用于 Python 2.6+（包括 3.x）的解决方案。

Answer 1

您可以以一种不同的方式开始“以独立方式运行模块”：

而不是：

python foo/bar.py

使用：

python -mfoo.bar

当然，foo/__init__.py 文件必须存在。

另请注意，foo.py 和 bar.py 之间存在循环依赖关系 - 这是行不通的。我想这只是你的例子中的一个错误。

看来将其用作 foo/bar.py 的第一行也非常有效：

#!/usr/bin/python -mfoo.bar

然后您可以直接在 POSIX 系统。

Answer 2

首先，我假设您意识到您所写的内容会导致循环导入问题，因为 foo 导入 bar ，反之亦然；尝试添加

from foo import bar

到 test.py，你会发现它失败了。该示例必须更改才能工作。

因此，您所要求的实际上是在相对导入失败时回退到绝对导入；事实上，如果您将 foo.py 或 bar.py 作为主模块执行，其他模块将位于根级别，并且它们是否与系统上的另一个模块共享名称，将选择哪个模块取决于sys.path 中的顺序。由于当前目录通常是第一个，因此如果可用，将选择本地模块 - 即，如果当前工作目录中有一个“os.py”文件，则将选择该文件而不是内置模块。

一个可能的建议是：

foo.py

try:
    from . import bar
except ValueError:
    import bar

if __name__ == "__main__":
    pass

bar.py：

if __name__ == "__main__":
    pass

顺便说一句，从正确的位置调用脚本通常会更好。

python -m foo.bar

可能是最好的方法。此将模块作为脚本运行。

Answer 3

放弃相对导入：无论如何，你应该将你的包命名空间视为全局命名空间。

使这个变得可口的技巧是适当地编辑sys.path。这里有一些值得思考的地方：

# one directory up
_root_dir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
sys.path.insert(0, _root_dir)for now

Answer 4

每个文件夹中都需要 __init__.py。

相对导入仅在您执行以下操作时才有效：

python test.py

test.py导入foo.py并且foo.py可以相对导入文件夹中的任何内容>test.py 及以上。

你做不到：

cd foo
python foo.py
python bar.py

它永远不会起作用。

您可以尝试 sys.path.append 或 sys.path.insert 解决方案，但您会搞砸路径，并且 f= 会出现问题打开（文件名）。

Answer 5

只需将“main”放在不同的 .py 文件中即可。

Answer 6

到目前为止，我发现的唯一解决方案是根本不使用相对导入。

由于当前的限制，我想知道什么时候应该有人在 Python 中使用相对导入。

在我使用的所有配置中， sys.path 包含当前目录作为第一个参数，因此只需使用 import foo 而不是 from 。 import foo，因为它会做同样的事情。