Commit 82596a49 authored by Victor Stinner's avatar Victor Stinner

Fix encode/decode method doc of str, bytes, bytearray types

 * Specify the default encoding: write 'utf-8' instead of
   sys.getdefaultencoding(), because the default encoding is now constant
 * Specify the default errors value
parent eb6a1ea1
...@@ -992,12 +992,12 @@ functions based on regular expressions. ...@@ -992,12 +992,12 @@ functions based on regular expressions.
interpreted as in slice notation. interpreted as in slice notation.
.. method:: str.encode(encoding=sys.getdefaultencoding(), errors="strict") .. method:: str.encode(encoding="utf-8", errors="strict")
Return an encoded version of the string as a bytes object. Default encoding Return an encoded version of the string as a bytes object. Default encoding
is the current default string encoding. *errors* may be given to set a is ``'utf-8'``. *errors* may be given to set a different error handling scheme.
different error handling scheme. The default for *errors* is ``'strict'``, The default for *errors* is ``'strict'``, meaning that encoding errors raise
meaning that encoding errors raise a :exc:`UnicodeError`. Other possible a :exc:`UnicodeError`. Other possible
values are ``'ignore'``, ``'replace'``, ``'xmlcharrefreplace'``, values are ``'ignore'``, ``'replace'``, ``'xmlcharrefreplace'``,
``'backslashreplace'`` and any other name registered via ``'backslashreplace'`` and any other name registered via
:func:`codecs.register_error`, see section :ref:`codec-base-classes`. For a :func:`codecs.register_error`, see section :ref:`codec-base-classes`. For a
...@@ -1765,11 +1765,11 @@ Wherever one of these methods needs to interpret the bytes as characters ...@@ -1765,11 +1765,11 @@ Wherever one of these methods needs to interpret the bytes as characters
b = a.replace(b"a", b"f") b = a.replace(b"a", b"f")
.. method:: bytes.decode(encoding=sys.getdefaultencoding(), errors="strict") .. method:: bytes.decode(encoding="utf-8", errors="strict")
bytearray.decode(encoding=sys.getdefaultencoding(), errors="strict") bytearray.decode(encoding="utf-8", errors="strict")
Return a string decoded from the given bytes. Default encoding is the Return a string decoded from the given bytes. Default encoding is
current default string encoding. *errors* may be given to set a different ``'utf-8'``. *errors* may be given to set a different
error handling scheme. The default for *errors* is ``'strict'``, meaning error handling scheme. The default for *errors* is ``'strict'``, meaning
that encoding errors raise a :exc:`UnicodeError`. Other possible values are that encoding errors raise a :exc:`UnicodeError`. Other possible values are
``'ignore'``, ``'replace'`` and any other name registered via ``'ignore'``, ``'replace'`` and any other name registered via
......
...@@ -2465,10 +2465,10 @@ bytearray_rstrip(PyByteArrayObject *self, PyObject *args) ...@@ -2465,10 +2465,10 @@ bytearray_rstrip(PyByteArrayObject *self, PyObject *args)
} }
PyDoc_STRVAR(decode_doc, PyDoc_STRVAR(decode_doc,
"B.decode([encoding[, errors]]) -> str\n\ "B.decode([encoding='utf-8'[, errors='strict']]) -> str\n\
\n\ \n\
Decode B using the codec registered for encoding. encoding defaults\n\ Decode B using the codec registered for encoding. Default encoding\n\
to the default encoding. errors may be given to set a different error\n\ is 'utf-8'. errors may be given to set a different error\n\
handling scheme. Default is 'strict' meaning that encoding errors raise\n\ handling scheme. Default is 'strict' meaning that encoding errors raise\n\
a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n\ a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n\
as well as any other name registered with codecs.register_error that is\n\ as well as any other name registered with codecs.register_error that is\n\
......
...@@ -2289,10 +2289,10 @@ bytes_endswith(PyBytesObject *self, PyObject *args) ...@@ -2289,10 +2289,10 @@ bytes_endswith(PyBytesObject *self, PyObject *args)
PyDoc_STRVAR(decode__doc__, PyDoc_STRVAR(decode__doc__,
"B.decode([encoding[, errors]]) -> str\n\ "B.decode([encoding='utf-8'[, errors='strict']]) -> str\n\
\n\ \n\
Decode B using the codec registered for encoding. encoding defaults\n\ Decode B using the codec registered for encoding. Default encoding\n\
to the default encoding. errors may be given to set a different error\n\ is 'utf-8'. errors may be given to set a different error\n\
handling scheme. Default is 'strict' meaning that encoding errors raise\n\ handling scheme. Default is 'strict' meaning that encoding errors raise\n\
a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n\ a UnicodeDecodeError. Other possible values are 'ignore' and 'replace'\n\
as well as any other name registerd with codecs.register_error that is\n\ as well as any other name registerd with codecs.register_error that is\n\
......
...@@ -7393,10 +7393,10 @@ unicode_count(PyUnicodeObject *self, PyObject *args) ...@@ -7393,10 +7393,10 @@ unicode_count(PyUnicodeObject *self, PyObject *args)
} }
PyDoc_STRVAR(encode__doc__, PyDoc_STRVAR(encode__doc__,
"S.encode([encoding[, errors]]) -> bytes\n\ "S.encode([encoding='utf-8'[, errors='strict']]) -> bytes\n\
\n\ \n\
Encode S using the codec registered for encoding. encoding defaults\n\ Encode S using the codec registered for encoding. Default encoding\n\
to the default encoding. errors may be given to set a different error\n\ is 'utf-8'. errors may be given to set a different error\n\
handling scheme. Default is 'strict' meaning that encoding errors raise\n\ handling scheme. Default is 'strict' meaning that encoding errors raise\n\
a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and\n\ a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and\n\
'xmlcharrefreplace' as well as any other name registered with\n\ 'xmlcharrefreplace' as well as any other name registered with\n\
......
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