From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 7 Oct 2022 20:36:21 +0000 (-0700)
Subject: Add a warning message about PyOS_snprintf (GH-95993)
X-Git-Tag: v3.10.8~25
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=90f2c7992f3d3285bafa1eef6d0f8255ce8921c2;p=thirdparty%2FPython%2Fcpython.git

Add a warning message about PyOS_snprintf (GH-95993)

(cherry picked from commit c7b220499662f0c7a4cae51e33372f92ca7b1ee9)

Co-authored-by: Eric Wieser <wieser.eric@gmail.com>
---

diff --git a/Doc/c-api/conversion.rst b/Doc/c-api/conversion.rst
index 9b9c4ffa4d03..fdb321fe7ab3 100644
--- a/Doc/c-api/conversion.rst
+++ b/Doc/c-api/conversion.rst
@@ -28,7 +28,8 @@ not.
 The wrappers ensure that ``str[size-1]`` is always ``'\0'`` upon return. They
 never write more than *size* bytes (including the trailing ``'\0'``) into str.
 Both functions require that ``str != NULL``, ``size > 0``, ``format != NULL``
-and ``size < INT_MAX``.
+and ``size < INT_MAX``. Note that this means there is no equivalent to the C99
+``n = snprintf(NULL, 0, ...)`` which would determine the necessary buffer size.
 
 The return value (*rv*) for these functions should be interpreted as follows:
 
diff --git a/Python/mysnprintf.c b/Python/mysnprintf.c
index cd69198011e3..2a505d14f82c 100644
--- a/Python/mysnprintf.c
+++ b/Python/mysnprintf.c
@@ -9,6 +9,7 @@
    would have been written had the buffer not been too small, and to set
    the last byte of the buffer to \0.  At least MS _vsnprintf returns a
    negative value instead, and fills the entire buffer with non-\0 data.
+   Unlike C99, our wrappers do not support passing a null buffer.
 
    The wrappers ensure that str[size-1] is always \0 upon return.