From 4f5f98d7d122d5d5fe17d97ac61b288abb45a5fc Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Mon, 4 May 2009 21:01:20 +0000 Subject: Add missing documentation for bytes.decode(). --- Doc/howto/unicode.rst | 2 +- Doc/library/stdtypes.rst | 28 ++++++++++++++++++++-------- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/Doc/howto/unicode.rst b/Doc/howto/unicode.rst index 60f7d7d..c9b6720 100644 --- a/Doc/howto/unicode.rst +++ b/Doc/howto/unicode.rst @@ -234,7 +234,7 @@ The String Type Since Python 3.0, the language features a ``str`` type that contain Unicode characters, meaning any string created using ``"unicode rocks!"``, ``'unicode -rocks!``, or the triple-quoted string syntax is stored as Unicode. +rocks!'``, or the triple-quoted string syntax is stored as Unicode. To insert a Unicode character that is not part ASCII, e.g., any letters with accents, one can use escape sequences in their string literals as such:: diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index c8c2c80..fc77adc 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -800,14 +800,14 @@ functions based on regular expressions. .. method:: str.encode([encoding[, errors]]) - Return an encoded version of the string. Default encoding is the current - default string encoding. *errors* may be given to set a different error - handling scheme. The default for *errors* is ``'strict'``, meaning that - encoding errors raise a :exc:`UnicodeError`. Other possible values are - ``'ignore'``, ``'replace'``, ``'xmlcharrefreplace'``, ``'backslashreplace'`` and - any other name registered via :func:`codecs.register_error`, see section - :ref:`codec-base-classes`. For a list of possible encodings, see section - :ref:`standard-encodings`. + 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 + different error handling scheme. The default for *errors* is ``'strict'``, + meaning that encoding errors raise a :exc:`UnicodeError`. Other possible + values are ``'ignore'``, ``'replace'``, ``'xmlcharrefreplace'``, + ``'backslashreplace'`` and any other name registered via + :func:`codecs.register_error`, see section :ref:`codec-base-classes`. For a + list of possible encodings, see section :ref:`standard-encodings`. .. method:: str.endswith(suffix[, start[, end]]) @@ -1512,6 +1512,18 @@ Wherever one of these methods needs to interpret the bytes as characters b = a.replace(b"a", b"f") +.. method:: bytes.decode([encoding[, errors]]) + bytearray.decode([encoding[, errors]]) + + Return a string decoded from the given bytes. Default encoding is the + current default string encoding. *errors* may be given to set a different + error handling scheme. The default for *errors* is ``'strict'``, meaning + that encoding errors raise a :exc:`UnicodeError`. Other possible values are + ``'ignore'``, ``'replace'`` and any other name registered via + :func:`codecs.register_error`, see section :ref:`codec-base-classes`. For a + list of possible encodings, see section :ref:`standard-encodings`. + + The bytes and bytearray types have an additional class method: .. classmethod:: bytes.fromhex(string) -- cgit v0.12