[3.12] gh-117518: Clarify PyTuple_GetItem() borrowed reference in the… · python/cpython@15be34a · GitHub

python / cpython Public

• Notifications You must be signed in to change notification settings
• Fork 35.3k
• Star 75k

• Code
• Issues 5k+
• Pull requests 2.6k
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 15be34a

Browse filesBrowse the repository at this point in the historyBrowse files

miss-islington

and

vstinner

authored

[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 4605a19) Co-authored-by: Victor Stinner <vstinner@python.org>

1 parent a0f82dd commit 15be34a
Copy full SHA for 15be34a

1 file changed

+6Lines changed: 6 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• Doc/c-api
  • tuple.rst

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎Doc/c-api/tuple.rst‎

Copy file name to clipboardExpand all lines: Doc/c-api/tuple.rst

+6Lines changed: 6 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -59,6 +59,12 @@ Tuple Objects
59	59	Return the object at position *pos* in the tuple pointed to by *p*. If *pos* is
60	60	negative or out of bounds, return ``NULL`` and set an :exc:`IndexError` exception.
61	61
	62	+ The returned reference is borrowed from the tuple *p*
	63	+ (that is: it is only valid as long as you hold a reference to *p*).
	64	+ To get a :term:`strong reference`, use
	65	+ :c:func:`Py_NewRef(PyTuple_GetItem(...)) <Py_NewRef>`
	66	+ or :c:func:`PySequence_GetItem`.
	67	+
62	68
63	69	.. c:function:: PyObject* PyTuple_GET_ITEM(PyObject *p, Py_ssize_t pos)
64	70

0 commit comments

Comments

0 (0)