https://github.com/python/cpython/commit/d91ac525ef166edc0083acf5a96f81b87324fe7f
commit: d91ac525ef166edc0083acf5a96f81b87324fe7f
branch: main
author: Sergey B Kirpichev <[email protected]>
committer: encukou <[email protected]>
date: 2024-08-03T13:20:10+02:00
summary:
gh-122613: Document PyLong_GetInfo() (part of Limited API) (GH-#122280)
files:
M Doc/c-api/long.rst
diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst
index 42162914c0aec8..9f2c48d98b8344 100644
--- a/Doc/c-api/long.rst
+++ b/Doc/c-api/long.rst
@@ -514,6 +514,17 @@ distinguished from a number. Use :c:func:`PyErr_Occurred`
to disambiguate.
.. versionadded:: 3.14
+.. 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.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
