mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-29 19:56:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Clarify attribute docs on types.ModuleType (GH-24974)

Browse source 
(cherry picked from commit 76b5d714e4)

Co-authored-by: Brett Cannon <brett@python.org>
This commit is contained in:
Miss Islington (bot) 2021-03-23 09:01:10 -07:00 • committed by GitHub
parent 994a519915
commit 10e17bc693
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

32
Doc/library/types.rst
View file

@ -209,7 +209,7 @@ Standard names are defined for the following types:
.. class:: ModuleType(name, doc=None) .. class:: ModuleType(name, doc=None)
The type of :term:`modules <module>`. Constructor takes the name of the The type of :term:`modules <module>`. The constructor takes the name of the
module to be created and optionally its :term:`docstring`. module to be created and optionally its :term:`docstring`.
.. note:: .. note::
@ -224,12 +224,23 @@ Standard names are defined for the following types:
The :term:`loader` which loaded the module. Defaults to ``None``. The :term:`loader` which loaded the module. Defaults to ``None``.
This attribute is to match :attr:`importlib.machinery.ModuleSpec.loader`
as stored in the attr:`__spec__` object.
.. note::
A future version of Python may stop setting this attribute by default.
To guard against this potential change, preferrably read from the
:attr:`__spec__` attribute instead or use
``getattr(module, "__loader__", None)`` if you explicitly need to use
this attribute.
.. versionchanged:: 3.4 .. versionchanged:: 3.4
Defaults to ``None``. Previously the attribute was optional. Defaults to ``None``. Previously the attribute was optional.
.. attribute:: __name__ .. attribute:: __name__
The name of the module. The name of the module. Expected to match
:attr:`importlib.machinery.ModuleSpec.name`.
.. attribute:: __package__ .. attribute:: __package__
@ -238,9 +249,26 @@ Standard names are defined for the following types:
to ``''``, else it should be set to the name of the package (which can be to ``''``, else it should be set to the name of the package (which can be
:attr:`__name__` if the module is a package itself). Defaults to ``None``. :attr:`__name__` if the module is a package itself). Defaults to ``None``.
This attribute is to match :attr:`importlib.machinery.ModuleSpec.parent`
as stored in the attr:`__spec__` object.
.. note::
A future version of Python may stop setting this attribute by default.
To guard against this potential change, preferrably read from the
:attr:`__spec__` attribute instead or use
``getattr(module, "__package__", None)`` if you explicitly need to use
this attribute.
.. versionchanged:: 3.4 .. versionchanged:: 3.4
Defaults to ``None``. Previously the attribute was optional. Defaults to ``None``. Previously the attribute was optional.
.. attribute:: __spec__
A record of the the module's import-system-related state. Expected to be
an instance of :class:`importlib.machinery.ModuleSpec`.
.. versionadded:: 3.4
.. class:: GenericAlias(t_origin, t_args) .. class:: GenericAlias(t_origin, t_args)