Skip to content

Commit

Permalink
Add missing documentation for bytes.decode().
Browse files Browse the repository at this point in the history
  • Loading branch information
birkenfeld committed May 4, 2009
1 parent 5f25972 commit 4f5f98d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Doc/howto/unicode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
28 changes: 20 additions & 8 deletions Doc/library/stdtypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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]])
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 4f5f98d

Please sign in to comment.