summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorSteve Dower <steve.dower@python.org>2019-12-09 19:05:39 (GMT)
committerGitHub <noreply@github.com>2019-12-09 19:05:39 (GMT)
commitb8cbe74c3498c617f0e73fd0cdc5c07f2c532092 (patch)
treeab78352644177312c0902ea36122c324b510919b /Doc/c-api
parentac229116a34a679511c20bfeca167cc6a9df9807 (diff)
downloadcpython-b8cbe74c3498c617f0e73fd0cdc5c07f2c532092.zip
cpython-b8cbe74c3498c617f0e73fd0cdc5c07f2c532092.tar.gz
cpython-b8cbe74c3498c617f0e73fd0cdc5c07f2c532092.tar.bz2
bpo-39008: Require Py_ssize_t for PySys_Audit formats rather than raise a deprecation warning (GH-17540)
Diffstat (limited to 'Doc/c-api')
-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)