mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-26 10:19:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

#7035: improve docs of the various <method>_errors() functions, and give them docstrings.

Browse source
This commit is contained in:
Georg Brandl 2009-10-22 15:42:32 +00:00
parent 030d65811f
commit f4ffae2b2a
2 changed files with 42 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

36
Doc/library/codecs.rst
View file

@ -69,14 +69,18 @@ It defines the following functions:
the base classes :class:`StreamWriter` and :class:`StreamReader`, respectively.
Stream codecs can maintain state.
Possible values for errors are ``'strict'`` (raise an exception in case of an
encoding error), ``'replace'`` (replace malformed data with a suitable
replacement marker, such as ``'?'``), ``'ignore'`` (ignore malformed data and
continue without further notice), ``'xmlcharrefreplace'`` (replace with the
appropriate XML character reference (for encoding only)) and
``'backslashreplace'`` (replace with backslashed escape sequences (for encoding
only)) as well as any other error handling name defined via
:func:`register_error`.
Possible values for errors are
* ``'strict'``: raise an exception in case of an encoding error
* ``'replace'``: replace malformed data with a suitable replacement marker,
such as ``'?'`` or ``'\ufffd'``
* ``'ignore'``: ignore malformed data and continue without further notice
* ``'xmlcharrefreplace'``: replace with the appropriate XML character
reference (for encoding only)
* ``'backslashreplace'``: replace with backslashed escape sequences (for
encoding only
as well as any other error handling name defined via :func:`register_error`.
In case a search function cannot find a given encoding, it should return
``None``.
@ -177,27 +181,33 @@ functions which use :func:`lookup` for the codec lookup:
.. function:: strict_errors(exception)
Implements the ``strict`` error handling.
Implements the ``strict`` error handling: each encoding or decoding error
raises a :exc:`UnicodeError`.
.. function:: replace_errors(exception)
Implements the ``replace`` error handling.
Implements the ``replace`` error handling: malformed data is replaced with a
suitable replacement character such as ``'?'`` in bytestrings and
``'\ufffd'`` in Unicode strings.
.. function:: ignore_errors(exception)
Implements the ``ignore`` error handling.
Implements the ``ignore`` error handling: malformed data is ignored and
encoding or decoding is continued without further notice.
.. function:: xmlcharrefreplace_errors(exception)
Implements the ``xmlcharrefreplace`` error handling.
Implements the ``xmlcharrefreplace`` error handling (for encoding only): the
unencodable character is replaced by an appropriate XML character reference.
.. function:: backslashreplace_errors(exception)
Implements the ``backslashreplace`` error handling.
Implements the ``backslashreplace`` error handling (for encoding only): the
unencodable character is replaced by a backslashed escape sequence.
To simplify working with encoded files or stream, the module also defines these
utility functions:

22
Python/codecs.c
View file

@ -774,7 +774,9 @@ static int _PyCodecRegistry_Init(void)
{
"strict_errors",
strict_errors,
METH_O
METH_O,
PyDoc_STR("Implements the 'strict' error handling, which "
"raises a UnicodeError on coding errors.")
}
},
#ifdef Py_USING_UNICODE
@ -783,7 +785,9 @@ static int _PyCodecRegistry_Init(void)
{
"ignore_errors",
ignore_errors,
METH_O
METH_O,
PyDoc_STR("Implements the 'ignore' error handling, which "
"ignores malformed data and continues.")
}
},
{
@ -791,7 +795,9 @@ static int _PyCodecRegistry_Init(void)
{
"replace_errors",
replace_errors,
METH_O
METH_O,
PyDoc_STR("Implements the 'replace' error handling, which "
"replaces malformed data with a replacement marker.")
}
},
{
@ -799,7 +805,10 @@ static int _PyCodecRegistry_Init(void)
{
"xmlcharrefreplace_errors",
xmlcharrefreplace_errors,
METH_O
METH_O,
PyDoc_STR("Implements the 'xmlcharrefreplace' error handling, "
"which replaces an unencodable character with the "
"appropriate XML character reference.")
}
},
{
@ -807,7 +816,10 @@ static int _PyCodecRegistry_Init(void)
{
"backslashreplace_errors",
backslashreplace_errors,
METH_O
METH_O,
PyDoc_STR("Implements the 'backslashreplace' error handling, "
"which replaces an unencodable character with a "
"backslashed escape sequence.")
}
}
#endif