Codecs docs should explain that the bytes-bytes shorthand aliases are missing

[ncoghlan]

BPO	15331
Nosy	@ncoghlan, @ezio-melotti, @bitdancer

^{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 2014-03-29.20:41:02.673>
created_at = <Date 2012-07-12.11:04:34.031>
labels = ['easy', 'docs']
title = 'Codecs docs should explain that the bytes-bytes shorthand aliases are missing'
updated_at = <Date 2014-03-29.20:41:02.672>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2014-03-29.20:41:02.672>
actor = 'ncoghlan'
assignee = 'docs@python'
closed = True
closed_date = <Date 2014-03-29.20:41:02.673>
closer = 'ncoghlan'
components = ['Documentation']
creation = <Date 2012-07-12.11:04:34.031>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 15331
keywords = ['easy']
message_count = 5.0
messages = ['165295', '165302', '165434', '185978', '215143']
nosy_count = 4.0
nosy_names = ['ncoghlan', 'ezio.melotti', 'r.david.murray', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue15331'
versions = ['Python 3.3', 'Python 3.4']

[ncoghlan]

In writing a post looking at a potentially different way of handling codec pipelines that is source compatible across both Python 2 and 3, I noticed that the bytes-bytes codec aliases are all missing but are still listed in the documentation as being supported:

base64_codec base64, base-64
bz2_codec bz2
hex_codec hex

quopri_codec quopri, quoted-printable, quotedprintable
uu_codec uu
zlib_codec zip, zlib

The canonical names (i.e. *_codec) all work as expected, though.

[bitdancer]

Don't you have to resolve bpo-7475 before you can add them, though?

[ncoghlan]

While you're right about that, the docs shouldn't be claiming they're available as long as that is the case.

Updated the issue to make it clear this is a problem with the current docs and the change in the nature of the encode() and decode() methods for Python 3.

[ezio-melotti]

Should they just be removed from the table then?

[ncoghlan]

The aliases are back in 3.4+