From fe65a8b0d7a826158c6589ceb8cb83e91ed18977 Mon Sep 17 00:00:00 2001 From: Sergey B Kirpichev Date: Mon, 5 Aug 2024 21:11:34 +0300 Subject: [PATCH] [3.13] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-122280) (#122645) [3.13] gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-GH-122280) (cherry picked from commit d91ac525ef166edc0083acf5a96f81b87324fe7f) --- 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 c502a8251828..842bf1720431 100644 --- a/Doc/c-api/long.rst +++ b/Doc/c-api/long.rst @@ -501,6 +501,17 @@ distinguished from a number. Use :c:func:`PyErr_Occurred` to disambiguate. .. versionadded:: 3.13 +.. 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. -- 2.47.3