Python 导入失败。相对导入、包识别、__init__.py、__package__、__all__

Python Imports failing. Relative imports, package recognition, __init__.py , __package__, __all__

我已经阅读了很多线程,与此问题相关的 PEP 文章,其中大约有 4 篇,但是其中 none 在某些点上给出了清晰的思路,我仍然不能'不做相对进口。

其实我的主包里面的东西根本就没有列出来

再版。 post全部修改了,太复杂了,问题也多

C:/test/ 我有这个包:

Package/ (FOLDER 2)
    __init__.py
    moduleA.py
    moduleB.py

我的过程:

  1. 我把C:/test/加到sys.path
  2. import Package(作品)
  3. dir(Package) 未列出包内的任何模块。
  4. 包裹是:<module ‘Package’ from C:/test/Package/_init_.py>
  5. __file__是Package
  6. 下的init文件
  7. __name__Package
  8. __package__ 为空串
  9. __path__C:/test/Package

测试 1 - 版本 1: 在 moduleA 我有 from Package import moduleB

我明白了:

>>> import Package.moduleA
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "C:/test\Package\moduleA.py", line
    from Package import moduleB
  File "C:/test\Package\moduleB.py", line
    from Package import moduleA
ImportError: cannot import name moduleA

它不起作用,因为 moduleA 不是 Package 的一部分。所以Package没有被识别为包?


测试 1 - 版本 2: 在 moduleA 我有 from . import moduleB

不起作用,同样的错误


测试 1 - 版本 3: 在 moduleA 我有 import Package.moduleB

有效。

之后,运行:

>>> dir(Package.moduleB)
['Package', '__builtins__', '__doc__', '__file__', '__name__', '__package__']
>>> Package.moduleB.Package
<module 'Package' from 'C:/prueba\Package\__init__.py'>
>>> dir(Package)
['__builtins__', '__doc__', '__file__', '__name__', '__package__', '__path__', 'moduleA', 'moduleB']

所以现在,Package.moduleBPackage 作为变量 令人惊讶的是,Package 看起来像是一个合适的包,并且包含两个模块。

事实上,现在可以在版本 1 和版本 2 中进行任何导入,因为现在 moduleAmoduleBPackage 的一部分。


问题:

1) 为什么 Package 没有被识别为包?是吗?它不应该包含所有子模块吗?

2) 为什么 运行 import Package.moduleAmoduleA 里面生成 Package?

3) 为什么 运行 import Package.moduleAmoduleA 添加到 Package 而它之前不存在?

4) 空的 __init__.py 文件和非空的 __init__.py 文件是否对此有影响?

5) 定义一个包含 ['moduleA', 'moduleB']__all__ 变量在这里有什么作用吗?

6) 如何让初始化文件加载两个子模块?我应该在里面做 import Package.moduleAPackage.moduleB 吗?...我不能像 import .moduleA as moduleA 或类似的那样做吗? (如果 Package 的名字改变了怎么办?)

7) 包变量上的空字符串有影响吗?如果我们想让它识别自己,我们应该改变它的内容……__package__ 应该与 __name__ 相同,或者这就是 PEP 所说的。但是这样做没有用:

if __name__ == "__main__" and __package__ is None:
    __package__ = "Package"

这是一个循环依赖问题。它与此 question 非常相似,但不同之处在于您尝试从包中导入模块,而不是从模块中导入 class。在这种情况下,最好的解决方案是重新考虑您的代码,这样就不需要循环依赖了。将任何常用功能或 classes 移至包中的第三个模块。

担心 __package__ 是转移注意力。当您的包成为正确的包时,python 导入系统将适当地设置它。

问题是 moduleAmoduleB 只有在成功导入后才放在 package 中。但是,由于 moduleAmoduleB 都在导入过程中,因此它们在 package 中看不到对方。当您绕过相对导入机制时,绝对导入部分解决了问题。但是,如果您的模块在初始化期间需要彼此的一部分,那么程序将失败。

如果删除 var = ... 行,则以下代码将起作用。

package.moduleA

import package.moduleB
def func():
    return 1

package.moduleB

import package.moduleA
var = package.moduleA.func() # error, can't find moduleA

破损包裹的例子

package.moduleA

from . import moduleB
def depends_on_y():
    return moduleB.y()
def x():
    return "x"

package.moduleB

from . import moduleA
def depends_on_x():
    return moduleA.x()
def y():
    return "y"

将公共部分提取到包中的单独模块的示例

package.common

def x():
    return "x"
def y():
    return "y"

package.moduleA

from .common import y
def depends_on_y():
    return y()

package.moduleB

from .common import x
def depends_on_x():
    return x()

这是一个 Python 错误,存在于 3.5 之前的 Python 版本中。请参阅 issue 992389 where it was discussed (for many years) and issue 17636 问题的常见情况已修复。

在 Python 3.5 中修复后,包 Package 中模块内的 from . import moduleA 之类的显式相对导入将为 [=13] 签入 sys.modules =] 如果 moduleA 尚未出现在 Package 中,则在放弃之前。由于模块对象在开始加载之前添加到 sys.modules,但直到加载完成后才添加到 Package.__dict__,这通常可以解决问题。

使用 from package import * 的循环导入仍然存在问题,但在 issue 23447(我为此贡献了一个补丁)中,决定修复更模糊的极端情况不是值得额外的代码复杂性。

循环导入通常是糟糕设计的标志。您可能应该将相互依赖的代码位重构为一个实用程序模块,其他模块都导入该模块,或者您应该将两个单独的模块合并为一个模块。