Message 354836 - Python tracker

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author	doerwalter
Recipients	doerwalter, jamercee, serhiy.storchaka
Date	2019-10-17.08:59:43
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<1571302784.26.0.117885582017.issue38482@roundup.psfhosted.org>
In-reply-to

Content
codecs.iterencode()/iterdecode() are just shallow 10-line wrappers around incremental codecs (which are used as the basis of io streams). Note that the doc string for iterencode() contains: Encodes the input strings from the iterator using an IncrementalEncoder. i.e. "strings" (plural) should give a hint that iterator is an iterator over strings. But maybe this could be made clearer. And https://docs.python.org/3/library/codecs.html#codecs.iterencode and https://docs.python.org/3/library/codecs.html#codecs.iterdecode could indead be clearer about what iterator should be. An example might also help.

codecs.iterencode()/iterdecode() are just shallow 10-line wrappers around incremental codecs (which are used as the basis of io streams).

Note that the doc string for iterencode() contains:

   Encodes the input strings from the iterator using an IncrementalEncoder.

i.e. "strings" (plural) should give a hint that iterator is an iterator over strings.

But maybe this could be made clearer.

And https://docs.python.org/3/library/codecs.html#codecs.iterencode and https://docs.python.org/3/library/codecs.html#codecs.iterdecode could indead be clearer about what iterator should be. An example might also help.

History
Date	User	Action	Args
2019-10-17 08:59:44	doerwalter	set	recipients: + doerwalter, serhiy.storchaka, jamercee
2019-10-17 08:59:44	doerwalter	set	messageid: <1571302784.26.0.117885582017.issue38482@roundup.psfhosted.org>
2019-10-17 08:59:44	doerwalter	link	issue38482 messages
2019-10-17 08:59:43	doerwalter	create