[Python-checkins] cpython (3.5): Issue #23231: Document codecs.iterencode(), iterdecode() shortcomings

Fri Oct 14 21:05:08 EDT 2016

https://hg.python.org/cpython/rev/402eba63650c
changeset: 104497:402eba63650c
branch: 3.5
parent: 104487:7fb90c4ae643
user: Martin Panter <vadmium+py at gmail.com>
date: Sat Oct 15 00:56:47 2016 +0000
summary:
 Issue #23231: Document codecs.iterencode(), iterdecode() shortcomings
files:
 Doc/library/codecs.rst | 9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -224,6 +224,10 @@
 The *errors* argument (as well as any
 other keyword argument) is passed through to the incremental encoder.
 
+ This function requires that the codec accept text :class:`str` objects
+ to encode. Therefore it does not support bytes-to-bytes encoders such as
+ ``base64_codec``.
+
 
 .. function:: iterdecode(iterator, encoding, errors='strict', **kwargs)
 
@@ -232,6 +236,11 @@
 The *errors* argument (as well as any
 other keyword argument) is passed through to the incremental decoder.
 
+ This function requires that the codec accept :class:`bytes` objects
+ to decode. Therefore it does not support text-to-text encoders such as
+ ``rot_13``, although ``rot_13`` may be used equivalently with
+ :func:`iterencode`.
+
 
 The module also provides the following constants which are useful for reading
 and writing to platform dependent files:
-- 
Repository URL: https://hg.python.org/cpython
