mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-13 15:40:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-44263: Mention PyType_Ready in the gc protocol warning (GH-26445)

Browse source
This commit is contained in:
Pablo Galindo 2021-05-29 04:32:42 +01:00 • committed by GitHub
parent 8b55bc3f93
commit 43cf7c864a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Doc/c-api/gcsupport.rst
View file

@ -38,8 +38,9 @@ Constructors for container types must conform to two rules:
a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one
from its subclass or subclasses. from its subclass or subclasses.
Some APIs like :c:func:`PyType_FromSpecWithBases` or When calling :c:func:`PyType_Ready` or some of the APIs that indirectly
:c:func:`PyType_FromSpec` will automatically populate the call it like :c:func:`PyType_FromSpecWithBases` or
:c:func:`PyType_FromSpec` the interpreter will automatically populate the
:c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse` :c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse`
and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a
class that implements the garbage collector protocol and the child class class that implements the garbage collector protocol and the child class

16
Doc/c-api/type.rst
View file

@ -97,6 +97,15 @@ Type Objects
from a type's base class. Return ``0`` on success, or return ``-1`` and sets an from a type's base class. Return ``0`` on success, or return ``-1`` and sets an
exception on error. exception on error.
.. note::
If some of the base classes implements the GC protocol and the provided
type does not include the :const:`Py_TPFLAGS_HAVE_GC` in its flags, then
the GC protocol will be automatically implemented from its parents. On
the contrary, if the type being created does include
:const:`Py_TPFLAGS_HAVE_GC` in its flags then it **must** implement the
GC protocol itself by at least implementing the
:c:member:`~PyTypeObject.tp_traverse` handle.
.. c:function:: void* PyType_GetSlot(PyTypeObject *type, int slot) .. c:function:: void* PyType_GetSlot(PyTypeObject *type, int slot)
Return the function pointer stored in the given slot. If the Return the function pointer stored in the given slot. If the
@ -169,13 +178,6 @@ The following functions and structs are used to create
The associated module is not inherited by subclasses; it must be specified The associated module is not inherited by subclasses; it must be specified
for each class individually. for each class individually.
If some of the bases in *bases* implements the GC protocol and the type being
created does not include the :const:`Py_TPFLAGS_HAVE_GC` in the flags included in
*spec*, then the GC protocol will be automatically implemented from its parents. On
the contrary, if the type being created does include :const:`Py_TPFLAGS_HAVE_GC` in
its flags then it *must* implement the GC protocol itself by at least including a slot
for :c:member:`~PyTypeObject.tp_traverse` in *spec*.
This function calls :c:func:`PyType_Ready` on the new type. This function calls :c:func:`PyType_Ready` on the new type.
.. versionadded:: 3.9 .. versionadded:: 3.9