mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 00:48:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

bpo-44263: Better explain the GC contract for PyType_FromSpecWithBases (GH-26442)

Browse source
This commit is contained in:
Pablo Galindo 2021-05-29 03:57:39 +01:00 • committed by GitHub
parent de14d709e3
commit 8b55bc3f93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -33,6 +33,17 @@ Constructors for container types must conform to two rules:
#. Once all the fields which may contain references to other containers are
initialized, it must call :c:func:`PyObject_GC_Track`.
.. warning::
If a type adds the Py_TPFLAGS_HAVE_GC, then it *must* implement at least
a :c:member:`~PyTypeObject.tp_traverse` handler or explicitly use one
from its subclass or subclasses.
Some APIs like :c:func:`PyType_FromSpecWithBases` or
:c:func:`PyType_FromSpec` will automatically populate the
:c:member:`~PyTypeObject.tp_flags`, :c:member:`~PyTypeObject.tp_traverse`
and :c:member:`~PyTypeObject.tp_clear` fields if the type inherits from a
class that implements the garbage collector protocol and the child class
does *not* include the :const:`Py_TPFLAGS_HAVE_GC` flag.
.. c:function:: TYPE* PyObject_GC_New(TYPE, PyTypeObject *type)