From 58ad5c0051ea7e8dbfa0384bc3e649b2df8f997b Mon Sep 17 00:00:00 2001 From: Sergey B Kirpichev Date: Sat, 3 Aug 2024 14:20:10 +0300 Subject: [PATCH] [3.12] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-GH-122280) (cherry picked from commit d91ac525ef166edc0083acf5a96f81b87324fe7f) Co-authored-by: Sergey B Kirpichev --- Doc/c-api/long.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst index 76ac80322f8f40..af86810c6b166b 100644 --- a/Doc/c-api/long.rst +++ b/Doc/c-api/long.rst @@ -324,6 +324,17 @@ distinguished from a number. Use :c:func:`PyErr_Occurred` to disambiguate. Returns ``NULL`` on error. Use :c:func:`PyErr_Occurred` to disambiguate. +.. c:function:: PyObject* PyLong_GetInfo(void) + + On success, return a read only :term:`named tuple`, that holds + information about Python's internal representation of integers. + See :data:`sys.int_info` for description of individual fields. + + On failure, return ``NULL`` with an exception set. + + .. versionadded:: 3.1 + + .. c:function:: int PyUnstable_Long_IsCompact(const PyLongObject* op) Return 1 if *op* is compact, 0 otherwise.