Kaydet (Commit) cd881b85 authored tarafından Serhiy Storchaka's avatar Serhiy Storchaka

Fixed documentation of functions with const char* arguments.

...@@ -119,13 +119,13 @@ The following functions provide locale-independent string to number conversions. ...@@ -119,13 +119,13 @@ The following functions provide locale-independent string to number conversions.
.. versionadded:: 3.1 .. versionadded:: 3.1
.. c:function:: int PyOS_stricmp(char *s1, char *s2) .. c:function:: int PyOS_stricmp(const char *s1, const char *s2)
Case insensitive comparison of strings. The function works almost Case insensitive comparison of strings. The function works almost
identically to :c:func:`strcmp` except that it ignores the case. identically to :c:func:`strcmp` except that it ignores the case.
.. c:function:: int PyOS_strnicmp(char *s1, char *s2, Py_ssize_t size) .. c:function:: int PyOS_strnicmp(const char *s1, const char *s2, Py_ssize_t size)
Case insensitive comparison of strings. The function works almost Case insensitive comparison of strings. The function works almost
identically to :c:func:`strncmp` except that it ignores the case. identically to :c:func:`strncmp` except that it ignores the case.
...@@ -244,7 +244,7 @@ NULL pointer for use in a ``return`` statement. ...@@ -244,7 +244,7 @@ NULL pointer for use in a ``return`` statement.
.. versionadded:: 3.4 .. versionadded:: 3.4
.. c:function:: void PyErr_SyntaxLocationEx(char *filename, int lineno, int col_offset) .. c:function:: void PyErr_SyntaxLocationEx(const char *filename, int lineno, int col_offset)
Like :c:func:`PyErr_SyntaxLocationObject`, but *filename* is a byte string Like :c:func:`PyErr_SyntaxLocationObject`, but *filename* is a byte string
decoded from the filesystem encoding (:func:`os.fsdecode`). decoded from the filesystem encoding (:func:`os.fsdecode`).
...@@ -252,7 +252,7 @@ NULL pointer for use in a ``return`` statement. ...@@ -252,7 +252,7 @@ NULL pointer for use in a ``return`` statement.
.. versionadded:: 3.2 .. versionadded:: 3.2
.. c:function:: void PyErr_SyntaxLocation(char *filename, int lineno) .. c:function:: void PyErr_SyntaxLocation(const char *filename, int lineno)
Like :c:func:`PyErr_SyntaxLocationEx`, but the col_offset parameter is Like :c:func:`PyErr_SyntaxLocationEx`, but the col_offset parameter is
omitted. omitted.
...@@ -516,7 +516,7 @@ Signal Handling ...@@ -516,7 +516,7 @@ Signal Handling
Exception Classes Exception Classes
================= =================
.. c:function:: PyObject* PyErr_NewException(char *name, PyObject *base, PyObject *dict) .. c:function:: PyObject* PyErr_NewException(const char *name, PyObject *base, PyObject *dict)
This utility function creates and returns a new exception class. The *name* This utility function creates and returns a new exception class. The *name*
argument must be the name of the new exception, a C string of the form argument must be the name of the new exception, a C string of the form
...@@ -531,7 +531,7 @@ Exception Classes ...@@ -531,7 +531,7 @@ Exception Classes
argument can be used to specify a dictionary of class variables and methods. argument can be used to specify a dictionary of class variables and methods.
.. c:function:: PyObject* PyErr_NewExceptionWithDoc(char *name, char *doc, PyObject *base, PyObject *dict) .. c:function:: PyObject* PyErr_NewExceptionWithDoc(const char *name, const char *doc, PyObject *base, PyObject *dict)
Same as :c:func:`PyErr_NewException`, except that the new exception class can Same as :c:func:`PyErr_NewException`, except that the new exception class can
easily be given a docstring: If *doc* is non-*NULL*, it will be used as the easily be given a docstring: If *doc* is non-*NULL*, it will be used as the
......
...@@ -39,7 +39,7 @@ Importing Modules ...@@ -39,7 +39,7 @@ Importing Modules
behaviour isn't needed anymore. behaviour isn't needed anymore.
.. c:function:: PyObject* PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals, PyObject *fromlist) .. c:function:: PyObject* PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)
.. index:: builtin: __import__ .. index:: builtin: __import__
...@@ -70,7 +70,7 @@ Importing Modules ...@@ -70,7 +70,7 @@ Importing Modules
.. versionadded:: 3.3 .. versionadded:: 3.3
.. c:function:: PyObject* PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level) .. c:function:: PyObject* PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)
Similar to :c:func:`PyImport_ImportModuleLevelObject`, but the name is an Similar to :c:func:`PyImport_ImportModuleLevelObject`, but the name is an
UTF-8 encoded string instead of a Unicode object. UTF-8 encoded string instead of a Unicode object.
......
...@@ -86,7 +86,7 @@ Process-wide parameters ...@@ -86,7 +86,7 @@ Process-wide parameters
======================= =======================
.. c:function:: int Py_SetStandardStreamEncoding(char *encoding, char *errors) .. c:function:: int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)
.. index:: .. index::
single: Py_Initialize() single: Py_Initialize()
......
...@@ -34,7 +34,7 @@ Mapping Protocol ...@@ -34,7 +34,7 @@ Mapping Protocol
failure. This is equivalent to the Python statement ``del o[key]``. failure. This is equivalent to the Python statement ``del o[key]``.
.. c:function:: int PyMapping_HasKeyString(PyObject *o, char *key) .. c:function:: int PyMapping_HasKeyString(PyObject *o, const char *key)
On success, return ``1`` if the mapping object has the key *key* and ``0`` On success, return ``1`` if the mapping object has the key *key* and ``0``
otherwise. This is equivalent to the Python expression ``key in o``. otherwise. This is equivalent to the Python expression ``key in o``.
......
...@@ -88,7 +88,7 @@ written using these routines? ...@@ -88,7 +88,7 @@ written using these routines?
:exc:`TypeError`) and returns *NULL*. :exc:`TypeError`) and returns *NULL*.
.. c:function:: PyObject* PyMarshal_ReadObjectFromString(char *string, Py_ssize_t len) .. c:function:: PyObject* PyMarshal_ReadObjectFromString(const char *string, Py_ssize_t len)
Return a Python object from the data stream in a character buffer Return a Python object from the data stream in a character buffer
containing *len* bytes pointed to by *string*. containing *len* bytes pointed to by *string*.
......
...@@ -110,12 +110,12 @@ These are utility functions that make functionality from the :mod:`sys` module ...@@ -110,12 +110,12 @@ These are utility functions that make functionality from the :mod:`sys` module
accessible to C code. They all work with the current interpreter thread's accessible to C code. They all work with the current interpreter thread's
:mod:`sys` module's dict, which is contained in the internal thread state structure. :mod:`sys` module's dict, which is contained in the internal thread state structure.
.. c:function:: PyObject *PySys_GetObject(char *name) .. c:function:: PyObject *PySys_GetObject(const char *name)
Return the object *name* from the :mod:`sys` module or *NULL* if it does Return the object *name* from the :mod:`sys` module or *NULL* if it does
not exist, without setting an exception. not exist, without setting an exception.
.. c:function:: int PySys_SetObject(char *name, PyObject *v) .. c:function:: int PySys_SetObject(const char *name, PyObject *v)
Set *name* in the :mod:`sys` module to *v* unless *v* is *NULL*, in which Set *name* in the :mod:`sys` module to *v* unless *v* is *NULL*, in which
case *name* is deleted from the sys module. Returns ``0`` on success, ``-1`` case *name* is deleted from the sys module. Returns ``0`` on success, ``-1``
......
...@@ -1635,7 +1635,7 @@ They all return *NULL* or ``-1`` if an exception occurs. ...@@ -1635,7 +1635,7 @@ They all return *NULL* or ``-1`` if an exception occurs.
respectively. respectively.
.. c:function:: int PyUnicode_CompareWithASCIIString(PyObject *uni, char *string) .. c:function:: int PyUnicode_CompareWithASCIIString(PyObject *uni, const char *string)
Compare a unicode object, *uni*, with *string* and return -1, 0, 1 for less Compare a unicode object, *uni*, with *string* and return -1, 0, 1 for less
than, equal, and greater than, respectively. It is best to pass only than, equal, and greater than, respectively. It is best to pass only
......
...@@ -600,7 +600,7 @@ Extracting Parameters in Extension Functions ...@@ -600,7 +600,7 @@ Extracting Parameters in Extension Functions
The :c:func:`PyArg_ParseTuple` function is declared as follows:: The :c:func:`PyArg_ParseTuple` function is declared as follows::
int PyArg_ParseTuple(PyObject *arg, char *format, ...); int PyArg_ParseTuple(PyObject *arg, const char *format, ...);
The *arg* argument must be a tuple object containing an argument list passed The *arg* argument must be a tuple object containing an argument list passed
from Python to a C function. The *format* argument must be a format string, from Python to a C function. The *format* argument must be a format string,
...@@ -693,7 +693,7 @@ Keyword Parameters for Extension Functions ...@@ -693,7 +693,7 @@ Keyword Parameters for Extension Functions
The :c:func:`PyArg_ParseTupleAndKeywords` function is declared as follows:: The :c:func:`PyArg_ParseTupleAndKeywords` function is declared as follows::
int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict, int PyArg_ParseTupleAndKeywords(PyObject *arg, PyObject *kwdict,
char *format, char *kwlist[], ...); const char *format, char *kwlist[], ...);
The *arg* and *format* parameters are identical to those of the The *arg* and *format* parameters are identical to those of the
:c:func:`PyArg_ParseTuple` function. The *kwdict* parameter is the dictionary of :c:func:`PyArg_ParseTuple` function. The *kwdict* parameter is the dictionary of
...@@ -770,7 +770,7 @@ Building Arbitrary Values ...@@ -770,7 +770,7 @@ Building Arbitrary Values
This function is the counterpart to :c:func:`PyArg_ParseTuple`. It is declared This function is the counterpart to :c:func:`PyArg_ParseTuple`. It is declared
as follows:: as follows::
PyObject *Py_BuildValue(char *format, ...); PyObject *Py_BuildValue(const char *format, ...);
It recognizes a set of format units similar to the ones recognized by It recognizes a set of format units similar to the ones recognized by
:c:func:`PyArg_ParseTuple`, but the arguments (which are input to the function, :c:func:`PyArg_ParseTuple`, but the arguments (which are input to the function,
......
...@@ -115,8 +115,8 @@ call, a format string like that used with :c:func:`Py_BuildValue`, and the ...@@ -115,8 +115,8 @@ call, a format string like that used with :c:func:`Py_BuildValue`, and the
argument values:: argument values::
PyObject * PyObject *
PyObject_CallMethod(PyObject *object, char *method_name, PyObject_CallMethod(PyObject *object, const char *method_name,
char *arg_format, ...); const char *arg_format, ...);
This works for any object that has methods -- whether built-in or user-defined. This works for any object that has methods -- whether built-in or user-defined.
You are responsible for eventually :c:func:`Py_DECREF`\ 'ing the return value. You are responsible for eventually :c:func:`Py_DECREF`\ 'ing the return value.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment