summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrett Cannon <brett@python.org>2021-03-23 08:25:39 -0700
committerBrett Cannon <brett@python.org>2021-03-23 08:40:44 -0700
commitd93255666e705729ce69e1ec3fc6e15fa4c59899 (patch)
tree2a02a081ac98fae1eaeac0e4e2461dab57e68b5b
parent994a519915bff4901abaa7476e2b91682dea619a (diff)
downloadcpython-git-backport-76b5d71-3.9.tar.gz
[3.9] Clarify attribute docs on types.ModuleType (GH-24974)backport-76b5d71-3.9
(cherry picked from commit 76b5d714e4e2b9f3b63847325cba51d4c4dc36bc) Co-authored-by: Brett Cannon <brett@python.org>
-rw-r--r--Doc/library/types.rst32
1 files changed, 30 insertions, 2 deletions
diff --git a/Doc/library/types.rst b/Doc/library/types.rst
index d83d9667ba..d1099cf2af 100644
--- a/Doc/library/types.rst
+++ b/Doc/library/types.rst
@@ -209,7 +209,7 @@ Standard names are defined for the following types:
.. 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`.
.. note::
@@ -224,12 +224,23 @@ Standard names are defined for the following types:
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
Defaults to ``None``. Previously the attribute was optional.
.. attribute:: __name__
- The name of the module.
+ The name of the module. Expected to match
+ :attr:`importlib.machinery.ModuleSpec.name`.
.. 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
: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
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)