从上一级目录（包）导入模块

Question

在 Python 中从上一级目录导入模块的正确方法是什么？该目录是一个包含所有这些模块的 Python 包，我有一个包含需要这些模块的代码的子目录。

以下工作正常，但这只是一个 hack。我想要一个推荐的/pythonic的方式。

import sys
sys.path.append("../")
from fruit import Fruit
print("OK")

目录结构：

pkg1
   __init__.py  
   fruit.py  
   +sub_pkg
      __init__.py
      recipe.py

fruit.py 的内容

class Fruit:
   def get_name(self):
       print("Fruit name")

sub_pkg/recipe.py 的内容.. 只是一个导入行：

from fruit import Fruit

当我跑步时：

python recipe.py

它给出了以下错误。

Traceback (most recent call last):
  File "recipe.py", line 2, in <module>
    from fruit import Fruit
ImportError: No module named fruit

我也试过了：from pkg1.fruit import Fruit，不行。还看了其他类似的问题.. python -m recipe.py 或 python -m sub_pkg/recipe.py 不起作用。

Answer 1

如果您遇到问题，也可以使用以下方法。

从当前目录导入

from . import something

从上面的一个目录导入

from .. import fruit

相对路径文档：https://docs.python.org/2/tutorial/modules.html#intra-package-references

RELATIVE PACKAGE ISSUE ValueError: Attempted relative import in non-package

适用于对相关软件包有疑问的人。这是您的解决方案。

if __name__ == "__main__" and __package__ is None:
    __package__ = "expected.package.name"

还有解释，抄自另一个python docs

当主模块由其文件名指定时，package 属性将设置为 None 。为了在直接执行模块时允许相对导入，在第一个相对导入语句之前需要类似于以下的样板：

if __name__ == "__main__" and __package__ is None:
    __package__ = "expected.package.name

请注意，仅当顶层包已经可以通过 sys.path 访问时，此样板文件才足够。需要额外的代码来操作 sys.path 以便直接执行工作，而无需导入顶级包。

创建包的文档 我不打算粘贴内容，因为它很长，但这里是关于创建包的 python 文档部分。 https://docs.python.org/2/tutorial/modules.html#packages

PYTHONPATH 上的另一个文档 https://docs.python.org/2/using/cmdline.html#envvar-PYTHONPATH

Answer 2

你可以使用relative imports:

from ..fruit import Fruit

Answer 3

不要使用上层导入，而是有一个入口点，您可以从最上层调用该入口点，并在 recipe.py 文件中设置相对于该入口点的导入。

例如：

pkg1/
   __init__.py  
   main.py
   fruit.py  
   +sub_pkg
      __init__.py
      recipe.py

其中main.py 包含：

#!/usr/bin/env python3

import subpkg.recipe as recipe
import fruit

if __package__ is None and __name__ == "__main__":
    __package__ = "main"
    print()
    # Call recipe.py or fruit.py methods from here

在recipe.py:

import fruit
# do stuff with fruit module, which is properly imported now

要运行，请致电python3 main.py

Answer 4

在你的主文件recipe.py 中添加pkg1 路径到PYTHONPATH

sys.path.append('/path/to/pkg1')

或者使用相对路径

sys.path.append('../..')

这应该允许从程序中的任何位置导入pkg1。

始终可以选择使用此处建议的相对导入，我发现使用绝对导入更具可读性并且不太可能导致错误。此外，在使用相对导入的大型项目中，您会不断计算路径层次结构，而在使用绝对导入时，很容易知道您总是引用一个根目录。

关于 Python 2.5 中从 PEP328 的相对导入：

阅读依赖于相对导入的代码也不太清楚，因为读者可能会对打算使用哪个模块感到困惑。 Python 用户很快就学会了不要在他们的包的子模块的名称中重复标准库模块的名称，但是您无法防止您的子模块的名称被用于在 Python 的未来版本中添加的新模块。

Guido 建议在相对导入中使用前导点以避免如上所述的模棱两可的导入，再次来自 PEP328：

Guido 已宣布相对导入将使用前导点。单个前导点表示相对导入，从当前包开始。两个或多个前导点表示对当前包的父级的相对导入，在第一个点之后每个点一个级别。