From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 6 Nov 2025 14:07:56 +0000 (-0800)
Subject: [3.14] gh-141004: Document `PyLong_FromPid` and `PyLong_AsPid` (GH-141028) (GH-141142)
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5d10409e332233e5a58c9f52ee89fec19fa8c894;p=thirdparty%2FPython%2Fcpython.git

[3.14] gh-141004: Document `PyLong_FromPid` and `PyLong_AsPid` (GH-141028) (GH-141142)

gh-141004: Document `PyLong_FromPid` and `PyLong_AsPid` (GH-141028)
(cherry picked from commit bcc524f82d8548707046ce90f5bc56f60018767a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
---

diff --git a/Doc/c-api/long.rst b/Doc/c-api/long.rst
index 8370dcecad33..a905d4b23b76 100644
--- a/Doc/c-api/long.rst
+++ b/Doc/c-api/long.rst
@@ -161,6 +161,17 @@ distinguished from a number.  Use :c:func:`PyErr_Occurred` to disambiguate.
    .. versionadded:: 3.13
 
 
+.. c:macro:: PyLong_FromPid(pid)
+
+   Macro for creating a Python integer from a process identifier.
+
+   This can be defined as an alias to :c:func:`PyLong_FromLong` or
+   :c:func:`PyLong_FromLongLong`, depending on the size of the system's
+   PID type.
+
+   .. versionadded:: 3.2
+
+
 .. c:function:: long PyLong_AsLong(PyObject *obj)
 
    .. index::
@@ -575,6 +586,17 @@ distinguished from a number.  Use :c:func:`PyErr_Occurred` to disambiguate.
    .. versionadded:: 3.13
 
 
+.. c:macro:: PyLong_AsPid(pid)
+
+   Macro for converting a Python integer into a process identifier.
+
+   This can be defined as an alias to :c:func:`PyLong_AsLong`,
+   :c:func:`PyLong_FromLongLong`, or :c:func:`PyLong_AsInt`, depending on the
+   size of the system's PID type.
+
+   .. versionadded:: 3.2
+
+
 .. c:function:: int PyLong_GetSign(PyObject *obj, int *sign)
 
    Get the sign of the integer object *obj*.