diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-05-18 09:00:22 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-18 09:00:22 (GMT) |
commit | fad72d0e36caa823f128d441656cc907bb663b5b (patch) | |
tree | df0429612fa03603b9449a1f68b5070282b6d6fc /Doc/c-api | |
parent | 9a61afec20554c7bfe8043709e35ebc7b1e3fa2d (diff) | |
download | cpython-fad72d0e36caa823f128d441656cc907bb663b5b.zip cpython-fad72d0e36caa823f128d441656cc907bb663b5b.tar.gz cpython-fad72d0e36caa823f128d441656cc907bb663b5b.tar.bz2 |
gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28039863b014f57a1ac93b51e20920ebe7b)
Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/refcounting.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/Doc/c-api/refcounting.rst b/Doc/c-api/refcounting.rst index 391907c..738bd77 100644 --- a/Doc/c-api/refcounting.rst +++ b/Doc/c-api/refcounting.rst @@ -109,11 +109,17 @@ objects. It is a good idea to use this macro whenever decrementing the reference count of an object that might be traversed during garbage collection. +.. c:function:: void Py_IncRef(PyObject *o) + + Increment the reference count for object *o*. A function version of :c:func:`Py_XINCREF`. + It can be used for runtime dynamic embedding of Python. + + +.. c:function:: void Py_DecRef(PyObject *o) + + Decrement the reference count for object *o*. A function version of :c:func:`Py_XDECREF`. + It can be used for runtime dynamic embedding of Python. -The following functions are for runtime dynamic embedding of Python: -``Py_IncRef(PyObject *o)``, ``Py_DecRef(PyObject *o)``. They are -simply exported function versions of :c:func:`Py_XINCREF` and -:c:func:`Py_XDECREF`, respectively. The following functions or macros are only for use within the interpreter core: :c:func:`_Py_Dealloc`, :c:func:`_Py_ForgetReference`, :c:func:`_Py_NewReference`, |