codecs doc: what is StreamCodec?

[vstinner]

BPO	12160
Nosy	@malemburg, @vstinner, @sandrotosi, @berkerpeksag, @vadmium
Files	codecs_incremental.patch codecs_docs.patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2015-07-30.15:28:46.414>
created_at = <Date 2011-05-23.15:55:37.199>
labels = ['type-bug', 'docs']
title = 'codecs doc: what is StreamCodec?'
updated_at = <Date 2015-07-30.20:27:23.426>
user = 'https://github.com/vstinner'

bugs.python.org fields:

activity = <Date 2015-07-30.20:27:23.426>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2015-07-30.15:28:46.414>
closer = 'berker.peksag'
components = ['Documentation']
creation = <Date 2011-05-23.15:55:37.199>
creator = 'vstinner'
dependencies = []
files = ['22084', '29446']
hgrepos = []
issue_num = 12160
keywords = ['patch']
message_count = 8.0
messages = ['136665', '136675', '139150', '184476', '233980', '247684', '247685', '247693']
nosy_count = 8.0
nosy_names = ['lemburg', 'vstinner', 'sandro.tosi', 'docs@python', 'python-dev', 'berker.peksag', 'martin.panter', 'ncweinhold']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue12160'
versions = ['Python 2.7', 'Python 3.4', 'Python 3.5', 'Python 3.6']

[vstinner]

Codec.encode() and Codec.decode() refer to StreamCode, but I cannot find this class in the doc nor in the code.

I suppose that it should be replaced by IncrementalEncoder and IncrementalDecoder. If I'm correct, see attached patch.

[malemburg]

STINNER Victor wrote:

New submission from STINNER Victor <victor.stinner@haypocalc.com>:

Codec.encode() and Codec.decode() refer to StreamCode, but I cannot find this class in the doc nor in the code.

I suppose that it should be replaced by IncrementalEncoder and IncrementalDecoder. If I'm correct, see attached patch.

Thanks for spotting this.

It should read StreamReader/StreamWriter, since these were designed
to keep state.

[sandrotosi]

Hi Victor, would you update the patch?

[ncweinhold]

I've noticed that this issue hasn't been looked at in a while, and from looking through the current docucmentation, it looks like this issue still exists.

I've uploaded a patch with the changes that Marc-Andre mentioned.

[vadmium]

This patch looks simple and uncontroversial. I think it could be merged.

[python-dev]

New changeset f9694502f07c by Berker Peksag in branch '3.4':
Issue bpo-12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/f9694502f07c

New changeset 98631f35426f by Berker Peksag in branch '3.5':
Issue bpo-12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/98631f35426f

New changeset d3b20bff9c5d by Berker Peksag in branch 'default':
Issue bpo-12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/d3b20bff9c5d

[berkerpeksag]

Thanks for the patch, Nick!

[python-dev]

New changeset 296a09614f31 by Berker Peksag in branch '2.7':
Issue bpo-12160: Fix incorrect StreamCodec references in Codec.encode() and Codec.decode() docs.
https://hg.python.org/cpython/rev/296a09614f31