Issue #24029: Document the name binding behavior for submodule imports.
This commit is contained in:
parent
34e006031a
commit
2097f53ec3
|
@ -461,6 +461,41 @@ import machinery will create the new module itself.
|
|||
into :data:`sys.modules`, but it must remove **only** the failing
|
||||
module, and only if the loader itself has loaded it explicitly.
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
When a submodule is loaded using any mechanism (e.g. ``importlib`` APIs, the
|
||||
``import`` or ``import-from`` statements, or built-in ``__import__()``) a
|
||||
binding is placed in the parent module's namespace to the submodule object.
|
||||
For example, if package ``spam`` has a submodule ``foo``, after importing
|
||||
``spam.foo``, ``spam`` will have an attribute ``foo`` which is bound to the
|
||||
submodule. Let's say you have the following directory structure::
|
||||
|
||||
spam/
|
||||
__init__.py
|
||||
foo.py
|
||||
bar.py
|
||||
|
||||
and ``spam/__init__.py`` has the following lines in it::
|
||||
|
||||
from .foo import Foo
|
||||
from .bar import Bar
|
||||
|
||||
then executing the following puts a name binding to ``foo`` and ``bar`` in the
|
||||
``spam`` module::
|
||||
|
||||
>>> import spam
|
||||
>>> spam.foo
|
||||
<module 'spam.foo' from '/tmp/imports/spam/foo.py'>
|
||||
>>> spam.bar
|
||||
<module 'spam.bar' from '/tmp/imports/spam/bar.py'>
|
||||
|
||||
Given Python's familiar name binding rules this might seem surprising, but
|
||||
it's actually a fundamental feature of the import system. The invariant
|
||||
holding is that if you have ``sys.modules['spam']`` and
|
||||
``sys.modules['spam.foo']`` (as you would after the above import), the latter
|
||||
must appear as the ``foo`` attribute of the former.
|
||||
|
||||
Module spec
|
||||
-----------
|
||||
|
||||
|
|
Loading…
Reference in New Issue