来自<模块>; import ... in __init__.py 使模块名称可见?

发布于 2024-11-07 22:17:35 字数 672 浏览 2 评论 0原文

采取以下代码示例:

文件 package1/__init__.py

from moduleB import foo
print moduleB.__name__

文件 package1/moduleB.py

def foo(): pass

然后从当前目录:

>>> import package1
package1.moduleB

此代码在 CPython 中运行。令我惊讶的是,__init__.py 语句中的 from ... import 使 moduleB 名称可见。根据 Python 文档,情况不应该是这样:

from表单不绑定模块名称

有人可以解释一下为什么 CPython 会这样工作吗?有没有详细描述这一点的文档?

Take the following code example:

File package1/__init__.py:

from moduleB import foo
print moduleB.__name__

File package1/moduleB.py:

def foo(): pass

Then from the current directory:

>>> import package1
package1.moduleB

This code works in CPython. What surprises me about it is that the from ... import in __init__.py statement makes the moduleB name visible. According to Python documentation, this should not be the case:

The from form does not bind the module name

Could someone please explain why CPython works that way? Is there any documentation describing this in detail?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

三生殊途 2024-11-14 22:17:37

该文档误导了您,因为它是为了描述从包含该模块的父包外部导入模块的更常见情况而编写的。

例如,在我自己的代码中使用“from example import submodule”,其中“example”是一些与我自己的代码完全无关的第三方库,不会绑定名称“example”。它仍然导入 example/__init__.py 和 example/submodule.py 模块,创建两个模块对象,并将 example.submodule 分配给第二个模块对象。

但是,子模块中名称的“from..import”必须在父包对象上设置子模块属性。考虑一下是否没有:

  1. package/__init__.py 在导入包时执行。

  2. __init__ 执行“从子模块导入名称”。

  3. 在稍后的某个时刻,其他完全不同的代码执行“import package.submodule”。

在步骤 3 中,要么 sys.modules["package.submodule"] 不存在,在这种情况下再次加载它会为您提供两个不同作用域中的不同模块对象;或 sys.modules["package.submodule"] 将存在,但 "submodule" 不会是父包对象 (sys.modules["package"]) 的属性,并且 "import package.submodule" 将不执行任何操作。但是,如果它什么都不做,那么使用 import 的代码就无法将子模块作为包的属性来访问!


从理论上讲,如果导入机制的其余部分进行了更改以匹配,则可以更改导入子模块的工作方式。

如果您只需要知道从包 P 导入子模块 S 会做什么,那么简而言之:

  1. 确保导入 P,否则导入它。 (此步骤递归处理“import ABCD”。)
  2. 执行 S.py 以获取模块对象。 (跳过 .pyc 文件的详细信息等)
  3. 将模块对象存储在 sys.modules["PS"] 中。
  4. setattr(sys.modules["P"], "S", sys.modules["PS"])
  5. 如果导入的形式为“import PS”,则在本地范围内绑定“P” 。

The documentation misled you as it is written to describe the more common case of importing a module from outside of the parent package containing it.

For example, using "from example import submodule" in my own code, where "example" is some third party library completely unconnected to my own code, does not bind the name "example". It does still import both the example/__init__.py and example/submodule.py modules, create two module objects, and assign example.submodule to the second module object.

But, "from..import" of names from a submodule must set the submodule attribute on the parent package object. Consider if it didn't:

  1. package/__init__.py executes when package is imported.

  2. That __init__ does "from submodule import name".

  3. At some point later, other completely different code does "import package.submodule".

At step 3, either sys.modules["package.submodule"] doesn't exist, in which case loading it again will give you two different module objects in different scopes; or sys.modules["package.submodule"] will exist but "submodule" won't be an attribute of the parent package object (sys.modules["package"]), and "import package.submodule" will do nothing. However, if it does nothing, the code using the import cannot access submodule as an attribute of package!


Theoretically, how importing a submodule works could be changed if the rest of the import machinery was changed to match.

If you just need to know what importing a submodule S from package P will do, then in a nutshell:

  1. Ensure P is imported, or import it otherwise. (This step recurses to handle "import A.B.C.D".)
  2. Execute S.py to get a module object. (Skipping details of .pyc files, etc.)
  3. Store module object in sys.modules["P.S"].
  4. setattr(sys.modules["P"], "S", sys.modules["P.S"])
  5. If that import was of the form "import P.S", bind "P" in local scope.
不弃不离 2024-11-14 22:17:37

这是因为 __init__.py 在运行时将自身表示为 package1 模块对象,因此每个 .py 文件都将被定义为子模块。并重写 __all__ 没有任何意义。您可以创建另一个文件,例如 example.py 并在 __init__.py 中填充相同的代码,它将引发 NameError

我认为 CPython 运行时在 __init__.py 寻找与其他 python 文件不同的变量时采用特殊算法,可能是这样的:

looking for variable named "moduleB"
if not found:
   if __file__ == '__init__.py': #dont raise NameError, looking for file named moduleB.py
         if current dir contains file named "moduleB.py":
                      import moduleB
         else:
                    raise namerror

this is because __init__.py represent itself as package1 module object at runtime, so every .py file will be defined as an submodule. and rewrite __all__ will not make any sense. you can make another file e.g example.py and fill it with the same code in __init__.py and it will raise NameError.

i think CPython runtime takes special algorithm when __init__.py looking for variables differ from other python files, may be like this:

looking for variable named "moduleB"
if not found:
   if __file__ == '__init__.py': #dont raise NameError, looking for file named moduleB.py
         if current dir contains file named "moduleB.py":
                      import moduleB
         else:
                    raise namerror
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文