diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-04-19 08:57:51 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-19 08:57:51 (GMT) |
| commit | 15be34ade88cd06ef637f5726d85f1e7d0ef4c18 (patch) | |
| tree | 65639fbc2369dddeea375f863f220eb1a4afc181 /Doc/c-api | |
| parent | a0f82dd6ccddc5fd3266df8ba55496ab573aacf2 (diff) | |
| download | cpython-15be34ade88cd06ef637f5726d85f1e7d0ef4c18.zip cpython-15be34ade88cd06ef637f5726d85f1e7d0ef4c18.tar.gz cpython-15be34ade88cd06ef637f5726d85f1e7d0ef4c18.tar.bz2 | |
[3.12] gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920) (#118087)
gh-117518: Clarify PyTuple_GetItem() borrowed reference in the doc (GH-117920)
(cherry picked from commit 4605a197bd84da1a232bd835d8e8e654f2fef220)
Co-authored-by: Victor Stinner <vstinner@python.org>
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/tuple.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/c-api/tuple.rst b/Doc/c-api/tuple.rst index 9bc3dab..e0186c1f 100644 --- a/Doc/c-api/tuple.rst +++ b/Doc/c-api/tuple.rst @@ -59,6 +59,12 @@ Tuple Objects Return the object at position *pos* in the tuple pointed to by *p*. If *pos* is negative or out of bounds, return ``NULL`` and set an :exc:`IndexError` exception. + The returned reference is borrowed from the tuple *p* + (that is: it is only valid as long as you hold a reference to *p*). + To get a :term:`strong reference`, use + :c:func:`Py_NewRef(PyTuple_GetItem(...)) <Py_NewRef>` + or :c:func:`PySequence_GetItem`. + .. c:function:: PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos) |