https://github.com/python/cpython/commit/425587a110eb214a097c634d4b6d944ac478923e
commit: 425587a110eb214a097c634d4b6d944ac478923e
branch: main
author: Petr Viktorin <[email protected]>
committer: encukou <[email protected]>
date: 2024-09-27T23:40:50Z
summary:
gh-124385: Document and soft-deprecate PyLong_AS_LONG (GH-124386)
files:
M Doc/c-api/long.rst
diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst
index 188eec4592a270..e0ae0f77a01db9 100644
--- a/Doc/c-api/long.rst
+++ b/Doc/c-api/long.rst
@@ -159,7 +159,6 @@ distinguished from a number. Use :c:func:`PyErr_Occurred`
to disambiguate.
.. versionadded:: 3.13
-.. XXX alias PyLong_AS_LONG (for now)
.. c:function:: long PyLong_AsLong(PyObject *obj)
.. index::
@@ -181,6 +180,16 @@ distinguished from a number. Use :c:func:`PyErr_Occurred`
to disambiguate.
.. versionchanged:: 3.10
This function will no longer use :meth:`~object.__int__`.
+ .. c:namespace:: NULL
+
+ .. c:function:: long PyLong_AS_LONG(PyObject *obj)
+
+ A :term:`soft deprecated` alias.
+ Exactly equivalent to the preferred ``PyLong_AsLong``. In particular,
+ it can fail with :exc:`OverflowError` or another exception.
+
+ .. deprecated:: 3.14
+ The function is soft deprecated.
.. c:function:: int PyLong_AsInt(PyObject *obj)
_______________________________________________
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]
