https://github.com/python/cpython/commit/bc055444e4ade9e210139d07200f602a4a9feb67
commit: bc055444e4ade9e210139d07200f602a4a9feb67
branch: main
author: Bernát Gábor <[email protected]>
committer: serhiy-storchaka <[email protected]>
date: 2026-06-02T11:03:36+03:00
summary:
gh-89554: Document standard type objects in types as classes (GH-150676)
Use the directive and the role "class" instead of "data" for classes
exposed in the types module.
files:
M Doc/howto/a-conceptual-overview-of-asyncio.rst
M Doc/library/types.rst
M Doc/whatsnew/3.10.rst
M Doc/whatsnew/3.15.rst
diff --git a/Doc/howto/a-conceptual-overview-of-asyncio.rst
b/Doc/howto/a-conceptual-overview-of-asyncio.rst
index 3adfedbf410ecc..7a7a87cb958400 100644
--- a/Doc/howto/a-conceptual-overview-of-asyncio.rst
+++ b/Doc/howto/a-conceptual-overview-of-asyncio.rst
@@ -115,7 +115,7 @@ The terms "coroutine function" and "coroutine object" are
often conflated
as coroutine.
That can be confusing!
In this article, coroutine specifically refers to a coroutine object, or more
-precisely, an instance of :data:`types.CoroutineType` (native coroutine).
+precisely, an instance of :class:`types.CoroutineType` (native coroutine).
Note that coroutines can also exist as instances of
:class:`collections.abc.Coroutine` -- a distinction that matters for type
checking.
diff --git a/Doc/library/types.rst b/Doc/library/types.rst
index b4793be9bdfd70..9f7b7579519052 100644
--- a/Doc/library/types.rst
+++ b/Doc/library/types.rst
@@ -150,8 +150,8 @@ Standard names are defined for the following types:
.. versionadded:: 3.10
-.. data:: FunctionType
- LambdaType
+.. class:: FunctionType
+ LambdaType
The type of user-defined functions and functions created by
:keyword:`lambda` expressions.
@@ -162,13 +162,13 @@ Standard names are defined for the following types:
and is not raised for normal compilation.
-.. data:: GeneratorType
+.. class:: GeneratorType
The type of :term:`generator`-iterator objects, created by
generator functions.
-.. data:: CoroutineType
+.. class:: CoroutineType
The type of :term:`coroutine` objects, created by
:keyword:`async def` functions.
@@ -176,7 +176,7 @@ Standard names are defined for the following types:
.. versionadded:: 3.5
-.. data:: AsyncGeneratorType
+.. class:: AsyncGeneratorType
The type of :term:`asynchronous generator`-iterator objects, created by
asynchronous generator functions.
@@ -196,7 +196,7 @@ Standard names are defined for the following types:
required by the initializer. The audit event only occurs for direct
instantiation of code objects, and is not raised for normal compilation.
-.. data:: CellType
+.. class:: CellType
The type for cell objects: such objects are used as containers for
a function's :term:`closure variables <closure variable>`.
@@ -204,20 +204,20 @@ Standard names are defined for the following types:
.. versionadded:: 3.8
-.. data:: MethodType
+.. class:: MethodType
The type of methods of user-defined class instances.
-.. data:: BuiltinFunctionType
- BuiltinMethodType
+.. class:: BuiltinFunctionType
+ BuiltinMethodType
The type of built-in functions like :func:`len` or :func:`sys.exit`, and
methods of built-in classes. (Here, the term "built-in" means "written in
C".)
-.. data:: WrapperDescriptorType
+.. class:: WrapperDescriptorType
The type of methods of some built-in data types and base classes such as
:meth:`object.__init__` or :meth:`object.__lt__`.
@@ -225,7 +225,7 @@ Standard names are defined for the following types:
.. versionadded:: 3.7
-.. data:: MethodWrapperType
+.. class:: MethodWrapperType
The type of *bound* methods of some built-in data types and base classes.
For example it is the type of :code:`object().__str__`.
@@ -240,14 +240,14 @@ Standard names are defined for the following types:
.. versionadded:: 3.10
-.. data:: MethodDescriptorType
+.. class:: MethodDescriptorType
The type of methods of some built-in data types such as :meth:`str.join`.
.. versionadded:: 3.7
-.. data:: ClassMethodDescriptorType
+.. class:: ClassMethodDescriptorType
The type of *unbound* class methods of some built-in data types such as
``dict.__dict__['fromkeys']``.
@@ -327,13 +327,13 @@ Standard names are defined for the following types:
dynamically.
-.. data:: FrameType
+.. class:: FrameType
The type of :ref:`frame objects <frame-objects>` such as found in
:attr:`tb.tb_frame <traceback.tb_frame>` if ``tb`` is a traceback object.
-.. data:: FrameLocalsProxyType
+.. class:: FrameLocalsProxyType
The type of frame locals proxy objects, as found on the
:attr:`frame.f_locals` attribute.
@@ -343,7 +343,7 @@ Standard names are defined for the following types:
.. seealso:: :pep:`667`
-.. data:: LazyImportType
+.. class:: LazyImportType
The type of lazy import proxy objects. These objects are created when a
module is lazily imported and serve as placeholders until the module is
@@ -355,7 +355,7 @@ Standard names are defined for the following types:
.. seealso:: :pep:`810`
-.. data:: GetSetDescriptorType
+.. class:: GetSetDescriptorType
The type of objects defined in extension modules with ``PyGetSetDef``, such
as :attr:`FrameType.f_locals <frame.f_locals>` or ``array.array.typecode``.
@@ -364,7 +364,7 @@ Standard names are defined for the following types:
:class:`property` type, but for classes defined in extension modules.
-.. data:: MemberDescriptorType
+.. class:: MemberDescriptorType
The type of objects defined in extension modules with ``PyMemberDef``, such
as ``datetime.timedelta.days``. This type is used as descriptor for simple
C
diff --git a/Doc/whatsnew/3.10.rst b/Doc/whatsnew/3.10.rst
index 0a01462aa430e7..f687b6c85591fc 100644
--- a/Doc/whatsnew/3.10.rst
+++ b/Doc/whatsnew/3.10.rst
@@ -1928,7 +1928,7 @@ Changes in the Python API
(Contributed by Yurii Karabas, Andrew Svetlov, Yury Selivanov and Kyle
Stanley
in :issue:`42392`.)
-* The :data:`types.FunctionType` constructor now inherits the current builtins
+* The :class:`types.FunctionType` constructor now inherits the current builtins
if the *globals* dictionary has no ``"__builtins__"`` key, rather than using
``{"None": None}`` as builtins: same behavior as :func:`eval` and
:func:`exec` functions. Defining a function with ``def function(...): ...``
diff --git a/Doc/whatsnew/3.15.rst b/Doc/whatsnew/3.15.rst
index 3330129ca10f68..0f76c66144d689 100644
--- a/Doc/whatsnew/3.15.rst
+++ b/Doc/whatsnew/3.15.rst
@@ -183,7 +183,7 @@ eager:
import myapp.slow_module # lazy (matches filter)
import json # eager (does not match filter)
-The proxy type itself is available as :data:`types.LazyImportType` for code
+The proxy type itself is available as :class:`types.LazyImportType` for code
that needs to detect lazy imports programmatically.
There are some restrictions on where the ``lazy`` keyword can be used. Lazy
@@ -1661,7 +1661,7 @@ types
-----
* Expose the write-through :func:`locals` proxy type
- as :data:`types.FrameLocalsProxyType`.
+ as :class:`types.FrameLocalsProxyType`.
This represents the type of the :attr:`frame.f_locals` attribute,
as described in :pep:`667`.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
