diff options
author | QuakeIV <me@matthewadler.net> | 2022-10-15 14:56:14 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-15 14:56:14 (GMT) |
commit | 4e2bd58af46fef2c913273acbf78a3b1ed934d1d (patch) | |
tree | 70db9ee3c938eeb0f83879f436269c99a7f43efb /Doc/c-api/structures.rst | |
parent | bf786e6901934a7c25cb0aa6b7d42a1677f02300 (diff) | |
download | cpython-4e2bd58af46fef2c913273acbf78a3b1ed934d1d.zip cpython-4e2bd58af46fef2c913273acbf78a3b1ed934d1d.tar.gz cpython-4e2bd58af46fef2c913273acbf78a3b1ed934d1d.tar.bz2 |
gh-96258: move Py_REFCNT and Py_SET_REFCNT to reference counting page (#96259)
Diffstat (limited to 'Doc/c-api/structures.rst')
-rw-r--r-- | Doc/c-api/structures.rst | 23 |
1 files changed, 2 insertions, 21 deletions
diff --git a/Doc/c-api/structures.rst b/Doc/c-api/structures.rst index 76803a0..ee757e3 100644 --- a/Doc/c-api/structures.rst +++ b/Doc/c-api/structures.rst @@ -17,7 +17,8 @@ All Python objects ultimately share a small number of fields at the beginning of the object's representation in memory. These are represented by the :c:type:`PyObject` and :c:type:`PyVarObject` types, which are defined, in turn, by the expansions of some macros also used, whether directly or indirectly, in -the definition of all other Python objects. +the definition of all other Python objects. Additional macros can be found +under :ref:`reference counting <countingrefs>`. .. c:type:: PyObject @@ -121,26 +122,6 @@ the definition of all other Python objects. .. versionadded:: 3.9 -.. c:function:: Py_ssize_t Py_REFCNT(PyObject *o) - - Get the reference count of the Python object *o*. - - Use the :c:func:`Py_SET_REFCNT()` function to set an object reference count. - - .. versionchanged:: 3.11 - The parameter type is no longer :c:expr:`const PyObject*`. - - .. versionchanged:: 3.10 - :c:func:`Py_REFCNT()` is changed to the inline static function. - - -.. c:function:: void Py_SET_REFCNT(PyObject *o, Py_ssize_t refcnt) - - Set the object *o* reference counter to *refcnt*. - - .. versionadded:: 3.9 - - .. c:function:: Py_ssize_t Py_SIZE(PyVarObject *o) Get the size of the Python object *o*. |