Skip to content

Commit 2ff4158

Browse files
authored
[3.12] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-122280) (#122644)
[3.12] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-GH-122280) (cherry picked from commit d91ac52)
1 parent 8f19be4 commit 2ff4158

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Doc/c-api/long.rst

+11
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,17 @@ distinguished from a number. Use :c:func:`PyErr_Occurred` to disambiguate.
324324
Returns ``NULL`` on error. Use :c:func:`PyErr_Occurred` to disambiguate.
325325
326326
327+
.. c:function:: PyObject* PyLong_GetInfo(void)
328+
329+
On success, return a read only :term:`named tuple`, that holds
330+
information about Python's internal representation of integers.
331+
See :data:`sys.int_info` for description of individual fields.
332+
333+
On failure, return ``NULL`` with an exception set.
334+
335+
.. versionadded:: 3.1
336+
337+
327338
.. c:function:: int PyUnstable_Long_IsCompact(const PyLongObject* op)
328339
329340
Return 1 if *op* is compact, 0 otherwise.

0 commit comments

Comments
 (0)