Mercurial > cpython-lru_cache-weakref
diff Doc/api/api.tex @ 15300:0da4ccc7e8cf legacy-trunk
Added exception to the rule that the buffer returned by PyString_AsString()
and PyString_AsStringAndSize() for strings that were just created using
PyString_FromStringAndSize(NULL, n).
This closes bug #117377.
Added warning about passing NULL to the concrete object functions; many of
them use the appropriate Py<Type>_Check() test, but do not check for NULL.
"de-allocated" --> "deallocated"
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Mon, 23 Oct 2000 16:00:54 +0000 |
| parents | f1ade8ab1869 |
| children | 7e514f1fe31f |
line wrap: on
line diff
--- a/Doc/api/api.tex Mon Oct 23 15:41:13 2000 +0000 +++ b/Doc/api/api.tex Mon Oct 23 16:00:54 2000 +0000 @@ -2001,6 +2001,13 @@ \cfunction{PyDict_Check()}. The chapter is structured like the ``family tree'' of Python object types. +\strong{Warning:} +While the functions described in this chapter carefully check the type +of the objects which are passed in, many of them do not check for +\NULL{} being passed instead of a valid object. Allowing \NULL{} to +be passed in can cause memory access violations and immediate +termination of the interpreter. + \section{Fundamental Objects \label{fundamental}} @@ -2057,6 +2064,9 @@ \subsection{String Objects \label{stringObjects}} +These functions raise \exception{TypeError} when expecting a string +parameter and are called with a non-string parameter. + \obindex{string} \begin{ctypedesc}{PyStringObject} This subtype of \ctype{PyObject} represents a Python string object. @@ -2096,8 +2106,10 @@ \begin{cfuncdesc}{char*}{PyString_AsString}{PyObject *string} Returns a null-terminated representation of the contents of \var{string}. The pointer refers to the internal buffer of -\var{string}, not a copy. The data must not be modified in any way. -It must not be de-allocated. +\var{string}, not a copy. The data must not be modified in any way, +unless the string was just created using +\code{PyString_FromStringAndSize(NULL, \var{size})}. +It must not be deallocated. \end{cfuncdesc} \begin{cfuncdesc}{char*}{PyString_AS_STRING}{PyObject *string} @@ -2118,8 +2130,9 @@ TypeError is raised. The buffer refers to an internal string buffer of \var{obj}, not a -copy. The data must not be modified in any way. It must not be -de-allocated. +copy. The data must not be modified in any way, unless the string was +just created using \code{PyString_FromStringAndSize(NULL, +\var{size})}. It must not be deallocated. \end{cfuncdesc} \begin{cfuncdesc}{void}{PyString_Concat}{PyObject **string,
