traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

document that encoding error handlers may return bytes (#16585)

This commit is contained in:
Benjamin Peterson 2012-12-02 11:26:10 -05:00
parent 47a00f3d1a
commit 196035595f
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Doc/library/codecs.rst
View File

@ -155,13 +155,16 @@ functions which use :func:`lookup` for the codec lookup:
when *name* is specified as the errors parameter. when *name* is specified as the errors parameter.
For encoding *error_handler* will be called with a :exc:`UnicodeEncodeError` For encoding *error_handler* will be called with a :exc:`UnicodeEncodeError`
instance, which contains information about the location of the error. The error instance, which contains information about the location of the error. The
handler must either raise this or a different exception or return a tuple with a error handler must either raise this or a different exception or return a
replacement for the unencodable part of the input and a position where encoding tuple with a replacement for the unencodable part of the input and a position
should continue. The encoder will encode the replacement and continue encoding where encoding should continue. The replacement may be either :class:`str` or
the original input at the specified position. Negative position values will be :class:`bytes`. If the replacement is bytes, the encoder will simply copy
treated as being relative to the end of the input string. If the resulting them into the output buffer. If the replacement is a string, the encoder will
position is out of bound an :exc:`IndexError` will be raised. encode the replacement. Encoding continues on original input at the
specified position. Negative position values will be treated as being
relative to the end of the input string. If the resulting position is out of
bound an :exc:`IndexError` will be raised.
Decoding and translating works similar, except :exc:`UnicodeDecodeError` or Decoding and translating works similar, except :exc:`UnicodeDecodeError` or
:exc:`UnicodeTranslateError` will be passed to the handler and that the :exc:`UnicodeTranslateError` will be passed to the handler and that the