traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document PY_SSIZE_T_CLEAN use and behavior for PyArg_ParseTuple and 

mention that it will become the default in a future python version.
This commit is contained in:
Gregory P. Smith 2008-11-23 23:49:16 +00:00
parent e8068edf1e
commit 02c3b5cc30
2 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/c-api/arg.rst
View File

@ -42,12 +42,18 @@ variable(s) whose address should be passed.
responsible** for calling ``PyBuffer_Release`` with the structure after it responsible** for calling ``PyBuffer_Release`` with the structure after it
has processed the data. has processed the data.
``s#`` (string, Unicode or any read buffer compatible object) [const char \*, int] ``s#`` (string, Unicode or any read buffer compatible object) [const char \*, int or :ctype:`Py_ssize_t`]
This variant on ``s*`` stores into two C variables, the first one a pointer This variant on ``s*`` stores into two C variables, the first one a pointer
to a character string, the second one its length. All other read-buffer to a character string, the second one its length. All other read-buffer
compatible objects pass back a reference to the raw internal data compatible objects pass back a reference to the raw internal data
representation. Since this format doesn't allow writable buffer compatible representation. Since this format doesn't allow writable buffer compatible
objects like byte arrays, ``s*`` is to be preferred. objects like byte arrays, ``s*`` is to be preferred. The type of
the length argument (int or :ctype:`Py_ssize_t`) is controlled by
defining the macro :cmacro:`PY_SSIZE_T_CLEAN` before including
:file:`Python.h`. If the macro was defined, length is a :ctype:`Py_ssize_t`
rather than an int. This behavior will change in a future Python
version to only support :ctype:`Py_ssize_t` and drop int support.
It is best to always define :cmacro:`PY_SSIZE_T_CLEAN`.
``y`` (bytes object) [const char \*] ``y`` (bytes object) [const char \*]
This variant on ``s`` converts a Python bytes or bytearray object to a C This variant on ``s`` converts a Python bytes or bytearray object to a C

7
Doc/extending/extending.rst
View File

@ -587,11 +587,16 @@ Note that any Python object references which are provided to the caller are
Some example calls:: Some example calls::
#define PY_SSIZE_T_CLEAN /* Make "s#" use Py_ssize_t rather than int. */
#include <Python.h>
::
int ok; int ok;
int i, j; int i, j;
long k, l; long k, l;
const char *s; const char *s;
int size; Py_ssize_t size;
ok = PyArg_ParseTuple(args, ""); /* No arguments */ ok = PyArg_ParseTuple(args, ""); /* No arguments */
/* Python call: f() */ /* Python call: f() */