即使使用 __init__.py，如何修复“尝试在非包中进行相对导入”

Posted 2023-02-23

【中文标题】即使使用 __init__.py，如何修复“尝试在非包中进行相对导入”

【英文标题】：How to fix "Attempted relative import in non-package" even with __init__.py

【发布时间】：2012-07-17 05:11:44

【问题描述】：

我正在尝试关注PEP 328，其目录结构如下：

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

在core_test.py我有以下导入语句

from ..components.core import GameLoopEvents

但是，当我运行时，我收到以下错误：

tests$ python core_test.py 
Traceback (most recent call last):
  File "core_test.py", line 3, in <module>
    from ..components.core import GameLoopEvents
ValueError: Attempted relative import in non-package

四处搜索我找到了“relative path not working even with __init__.py”和“Import a module from a relative path”，但它们没有帮助。

这里有什么我遗漏的吗？

【问题讨论】：

我也对构建unittest 项目的各种方式感到非常困惑，所以我写了这个fairly exhaustive sample project，它涵盖了模块的深度嵌套、相对和绝对导入（工作和不工作的地方） )，以及来自包内的相对和绝对引用，以及类的单、双和包级导入。为我立即帮我清理了事情！

我无法让您的测试正常工作。当我运行它们时，不断收到no module named myimports.foo。

我同意吉恩的观点。我希望有一种调试导入过程的机制更有帮助。就我而言，我在同一个目录中有两个文件。我正在尝试将一个文件导入另一个文件。如果我在那个目录中有一个 init.py 文件，我会收到一个 ValueError: Attempted relative import in non-package 错误。如果我删除 init.py 文件，则会收到错误 no module named 'NAME' 错误。

就我而言，我在同一个目录中有两个文件。我正在尝试将一个文件导入另一个文件。如果我在那个目录中有一个 init.py 文件，我会收到一个 ValueError: Attempted relative import in non-package 错误。如果我删除 init.py 文件，则会收到错误 no module named 'NAME' 错误。真正令人沮丧的是，我有这个工作，然后我通过删除 .bashrc 文件，将 PYTHONPATH 设置为某个东西，然后我把自己开枪打死了。

【参考方案1】：

python <main module>.py 不适用于相对导入

问题是当您从命令行运行__main__ 模块时relative import 不起作用

python <main_module>.py

PEP 338中明确说明。

2.5b1 的发布显示了此 PEP 和 PEP 328 之间令人惊讶的（尽管回想起来很明显）交互 - 显式相对导入在主模块中不起作用。这是因为相对导入依赖于__name__ 来确定当前模块在包层次结构中的位置。在主模块中，__name__ 的值始终为 '__main__'，因此显式相对导入总是会失败（因为它们仅适用于包内的模块）。

原因

Python Bug Tracker Issue1510172: Absolute/relative import not working?

这个问题实际上并不是 -m 开关所独有的。问题是相对导入基于__name__，而在主模块中，__name__ 始终具有值__main__。因此，相对导入目前无法从应用程序的主模块正常工作，因为主模块不知道它真正适合 Python 模块命名空间的位置（对于通过 -m 开关执行的主要模块，这至少在理论上是可以解决的，但直接执行的文件和交互式解释器完全不走运）。

要进一步了解，请参阅Relative imports in Python 3 了解详细说明以及如何解决。

【参考方案2】：

对我来说只有这样有效：我必须将 package 的值显式设置为父目录，并将父目录添加到 sys.path

from os import path
import sys
if __package__ is None:
    sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
    __package__= "myparent"

from .subdir import something # the . can now be resolved

我现在可以使用python myscript.py 直接运行我的脚本。

【参考方案3】：

由于您已经将所有内容标记为模块，因此如果您作为 python 模块启动，则无需使用相对引用。

代替

from ..components.core import GameLoopEvents

简单

from pkg.components.core import GameLoopEvents

当您从 pkg 的父级运行时，请使用以下内容

python -m pkg.tests.core_test

【参考方案4】：

这很令人困惑，如果您使用的是 pycharm 之类的 IDE，那就更令人困惑了。 什么对我有用： 1. 进行 pycharm 项目设置（如果您从 VE 或 python 目录运行 python） 2. 你定义的方式没有错。有时它适用于 from folder1.file1 导入类

如果它不起作用，请使用 导入文件夹1.file1 3. 您的环境变量应在系统中正确提及或在命令行参数中提供。

【参考方案5】：

这是一种会惹恼所有人但效果很好的方法。在测试运行中：

ln -s ../components components

然后像往常一样导入组件。

【讨论】：

这是一颗被严重低估的宝石！我不明白为什么没有足够的赞成票使这个答案接近顶部！

【参考方案6】：

问题在于您的测试方法，

你试过python core_test.py

然后你会得到这个错误 ValueError：尝试在非包中进行相对导入

原因：您正在从非包源测试您的包。

所以从包源测试你的模块。

如果这是您的项目结构，

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

cd 包

python -m tests.core_test # dont use .py

或来自外部 pkg/

python -m pkg.tests.core_test

如果要从同一目录中的文件夹导入，则单个 . 。 每后退一步，再加一个。

hi/
  hello.py
how.py

在how.py

from .hi import hello

如果你想从 hello.py 导入方法

from .. import how

【讨论】：

在示例from .. import how 中，如何从“how”文件中导入特定的类/方法。当我执行相当于from ..how import foo 的操作时，我会得到“尝试相对导入超出***包”

@JamesHulse from .. import how 有效，但第二个语句无效？如果包含 hi 文件夹的文件夹不包含 _ _ init _ _.py 文件，我会假设这两个语句都不起作用。换句话说，如果 hi 文件夹中只有一个 init 文件，那么 hi 文件夹是最顶层的包，你不能超出它。

【参考方案7】：

由于您的代码中包含if __name__ == "__main__"，并没有作为包导入，您最好使用sys.path.append()来解决问题。

【讨论】：

我认为在您的文件中包含 if __name__ == "__main__" 不会对与导入相关的任何内容产生影响。

【参考方案8】：

这种方法对我有用，并且比某些解决方案更简洁：

try:
  from ..components.core import GameLoopEvents
except ValueError:
  from components.core import GameLoopEvents

父目录在我的PYTHONPATH中，父目录和这个目录下都有__init__.py文件。

上述方法在 python 2 中总是有效的，但 python 3 有时会遇到 ImportError 或 ModuleNotFoundError（后者是 python 3.6 中的新内容，是 ImportError 的子类），因此以下调整在 python 2 和 3 中都适用于我：

try:
  from ..components.core import GameLoopEvents
except ( ValueError, ImportError):
  from components.core import GameLoopEvents

【参考方案9】：

正如Paolo所说，我们有2个调用方法：

1) python -m tests.core_test
2) python tests/core_test.py

它们之间的一个区别是 sys.path[0] 字符串。由于the interpret will search sys.path when doing import，我们可以使用tests/core_test.py：

if __name__ == '__main__':
    import sys
    from pathlib import Path
    sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
    from components import core
    <other stuff>

在此之后，我们可以使用其他方法运行 core_test.py：

cd tests
python core_test.py
python -m core_test
...

注意，py36 仅测试过。

【参考方案10】：

你可以使用from pkg.components.core import GameLoopEvents，比如我用的是pycharm，下面是我的项目结构图，我只是从根包导入，就可以了：

【讨论】：

这对我不起作用。您是否必须在配置中设置路径？

@MohammadMahjoub 您需要他还必须完成这项工作的所有初始化文件...不要忘记 cnn_scratch 中的那个

【参考方案11】：

试试这个

import components
from components import *

【参考方案12】：

详细说明Ignacio Vazquez-Abrams's答案：

Python 导入机制相对于当前文件的__name__ 起作用。当您直接执行文件时，它没有通常的名称，而是使用"__main__" 作为其名称。所以相对导入不起作用。

您可以按照 Igancio 的建议，使用 -m 选项执行它。如果您的包的一部分打算作为脚本运行，您还可以使用__package__ 属性来告诉该文件它应该在包层次结构中具有什么名称。

详情请见http://www.python.org/dev/peps/pep-0366/。

【讨论】：

我花了一段时间才意识到你不能在tests 子目录中运行python -m core_test - 它必须来自父目录，或者你必须将父目录添加到路径中。

@DannyStaple：不完全是。您可以使用__package__ 来确保可执行脚本文件可以相对地从同一个包中导入其他模块。没有办法从“整个系统”相对导入。我什至不确定你为什么要这样做。

我的意思是如果__package__ 符号设置为“parent.child”，那么您就可以导入“parent.other_child”。可能是我措辞不够好。

@DannyStaple：嗯，它的工作原理在链接文档中有描述。如果你在包pack.subpack 中有一个脚本script.py，那么将它的__package__ 设置为pack.subpack 将允许你使用from ..module import something 从pack.module 导入一些东西。请注意，正如文档所述，您仍然必须在系统路径上拥有***包。这已经是导入模块的工作方式。 __package__ 所做的唯一一件事就是让您也可以将该行为用于直接执行的脚本。

我在直接执行的脚本中使用__package__，但不幸的是，我收到以下错误：“未加载父模块'xxx'，无法执行相对导入”

【参考方案13】：

旧线程。我发现将__all__= ['submodule', ...] 添加到 __init__.py 文件，然后在目标中使用 from <CURRENT_MODULE> import * 可以正常工作。

【参考方案14】：

如果有人正在寻找解决方法，我偶然发现了一个。这里有一点上下文。我想测试我在文件中的一种方法。当我从内部运行它时

if __name__ == "__main__":

它总是抱怨相对进口。我尝试应用上述解决方案，但未能奏效，因为嵌套文件很多，每个文件都有多个导入。

这就是我所做的。我刚刚创建了一个启动器，一个可以导入必要的方法并调用它们的外部程序。虽然这不是一个很好的解决方案，但它确实有效。

【参考方案15】：

在 core_test.py 中，执行以下操作：

import sys
sys.path.append('../components')
from core import GameLoopEvents

【参考方案16】：

我的快速修复是将目录添加到路径：

import sys
sys.path.insert(0, '../components/')

【讨论】：

您的方法在所有情况下都不起作用，因为“../”部分是从您运行脚本的目录中解析的 (core_test.py)。使用您的方法，您必须在运行 core_test.py 脚本之前 cd 到“测试”。

【参考方案17】：

如果将当前目录追加到sys.path，则可以直接使用import components.core：

if __name__ == '__main__' and __package__ is None:
    from os import sys, path
    sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))

【讨论】：

sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) 这也可以

from os import sys 看起来像作弊:)

@Piotr：它可能被认为更好，因为它稍微更清楚地显示了正在附加到 sys.path 的内容——当前文件所在目录的父目录。

@flyingsheep：同意，我会使用普通的import sys, os.path as path。

仅供参考，要在 ipython 笔记本中使用它，我将这个答案改编为：import os; os.sys.path.append(os.path.dirname(os.path.abspath('.')))。然后直接import components.core 为我工作，根据需要从笔记本的父目录导入。

【参考方案18】：

如果您的用例是用于运行测试，并且确实如此，那么您可以执行以下操作。不要以python core_test.py 运行您的测试脚本，而是使用pytest 之类的测试框架。然后在命令行输入就可以了

$$ py.test

这将在您的目录中运行测试。这解决了@BrenBarn 指出的__name__ 是__main__ 的问题。接下来，将一个空的__init__.py 文件放入您的测试目录，这将使测试目录成为您包的一部分。那你就可以了

from ..components.core import GameLoopEvents

但是，如果您将测试脚本作为主程序运行，那么事情将再次失败。所以只需使用测试运行器。也许这也适用于其他测试运行程序，例如nosetests，但我还没有检查过。希望这可以帮助。

【参考方案19】：

这取决于您要如何启动脚本。

如果你想用经典的方式launch your UnitTest from the command line，那就是：

python tests/core_test.py

然后，由于在这种情况下 'components' 和 'tests' 是同级文件夹，您可以使用 insert 或 sys.path 模块的 append 方法。 比如：

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

否则，你可以launch your script with the '-m' argument（注意，在这种情况下，我们说的是一个包，因此你不能给'.py'扩展名），即： p>

python -m pkg.tests.core_test

在这种情况下，您可以像以前一样简单地使用相对导入：

from ..components.core import GameLoopEvents

您最终可以混合使用这两种方法，以便您的脚本无论以何种方式调用都能正常工作。 例如：

if __name__ == '__main__':
    if __package__ is None:
        import sys
        from os import path
        sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
        from components.core import GameLoopEvents
    else:
        from ..components.core import GameLoopEvents

【讨论】：

如果我尝试使用 pdb 进行调试，我该怎么办？因为您使用python -m pdb myscript.py 启动调试会话。

@dannynjust -- 这是一个很好的问题，因为您不能拥有 2 个主要模块。通常在调试时，我更喜欢在要开始调试的第一个点手动进入调试器。您可以通过将import pdb; pdb.set_trace() 插入代码（内联）来做到这一点。

使用insert而不是append会更好吗？即sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))

使用 insert 更适合相对导入语义，其中本地包名称优先于已安装的包。特别是对于测试，您通常希望测试本地版本，而不是已安装的版本（除非您的测试基础架构安装了被测代码，在这种情况下不需要相对导入，您不会遇到这个问题）。

您还应该提到，当您作为模块运行时，您不能在包含 core_test 的目录中（这太容易了）

【参考方案20】：

是的。你没有把它当作一个包来使用。

python -m pkg.tests.core_test

【讨论】：

一个陷阱：注意最后没有'.py'！

我不是投票者中的任何一个，但考虑到这个问题和答案的受欢迎程度，我觉得这可以使用相当多的更多细节。注意诸如从哪个目录执行上述 shell 命令之类的东西，您需要一直使用 __init__.pys 以及 __package__-modifying 技巧（下面由 BrenBarn 描述）需要允许这些可执行脚本的导入（例如，当使用 shebang 并在 Unix shell 上执行 ./my_script.py 时）都会很有用。整个问题对我来说是非常棘手的，要弄清楚或找到简明易懂的文档。

注意：从 CLI 调用此行时，您需要位于目录 pkg 之外。然后，它应该按预期工作。如果您在pkg 内并调用python -m tests.core_test，它将无法正常工作。至少它不适合我。

说真的，你能解释一下你的答案是怎么回事吗？

@MarkAmery 几乎失去了想了解这一切是如何工作的想法，在项目中的相对导入具有 py 文件的子目录，其中 py 文件具有 __init__.py 文件，但您不断收到 ValueError: Attempted relative import in non-package 错误。我会花很多钱让某个地方的某个人最终用简单的英语解释这一切是如何运作的。