summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/sys.rst
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-12-09 19:22:30 (GMT)
committerGitHub <noreply@github.com>2019-12-09 19:22:30 (GMT)
commitc93d68bbb986ee0879f5627223e0bd2bb91f63dd (patch)
tree1d9ab21f6c4deb3dcd3bfad62da952f766652710 /Doc/c-api/sys.rst
parent3c5feaffde1944052830c896ae39c54e76a2e063 (diff)
downloadcpython-c93d68bbb986ee0879f5627223e0bd2bb91f63dd.zip
cpython-c93d68bbb986ee0879f5627223e0bd2bb91f63dd.tar.gz
cpython-c93d68bbb986ee0879f5627223e0bd2bb91f63dd.tar.bz2
bpo-39008: Require Py_ssize_t for PySys_Audit formats rather than raise a deprecation warning (GH-17540)
(cherry picked from commit b8cbe74c3498c617f0e73fd0cdc5c07f2c532092) Co-authored-by: Steve Dower <steve.dower@python.org>
Diffstat (limited to 'Doc/c-api/sys.rst')
-rw-r--r--Doc/c-api/sys.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/c-api/sys.rst b/Doc/c-api/sys.rst
index eccb8a6..c851ff6 100644
--- a/Doc/c-api/sys.rst
+++ b/Doc/c-api/sys.rst
@@ -320,10 +320,18 @@ accessible to C code. They all work with the current interpreter thread's
arguments to this function will be consumed, using it may cause reference
leaks.)
+ Note that ``#`` format characters should always be treated as
+ ``Py_ssize_t``, regardless of whether ``PY_SSIZE_T_CLEAN`` was defined.
+
:func:`sys.audit` performs the same function from Python code.
.. versionadded:: 3.8
+ .. versionchanged:: 3.8.2
+
+ Require ``Py_ssize_t`` for ``#`` format characters. Previously, an
+ unavoidable deprecation warning was raised.
+
.. c:function:: int PySys_AddAuditHook(Py_AuditHookFunction hook, void *userData)