email docstrings and comments use python 2 language (Unicode strings)

[serhiy-storchaka]

BPO	18778
Nosy	@warsaw, @bitdancer, @serhiy-storchaka

^{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 = None
created_at = <Date 2013-08-19.07:20:20.303>
labels = ['type-bug', 'expert-email', '3.10', '3.11', '3.9', 'docs']
title = 'email docstrings and comments use python 2 language (Unicode strings)'
updated_at = <Date 2021-12-12.13:06:47.268>
user = 'https://github.com/serhiy-storchaka'

bugs.python.org fields:

activity = <Date 2021-12-12.13:06:47.268>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation', 'email']
creation = <Date 2013-08-19.07:20:20.303>
creator = 'serhiy.storchaka'
dependencies = []
files = []
hgrepos = []
issue_num = 18778
keywords = []
message_count = 5.0
messages = ['195605', '195625', '195626', '195651', '195658']
nosy_count = 4.0
nosy_names = ['barry', 'r.david.murray', 'docs@python', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue18778'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

Linked PRs

• gh-62978: Use Python 3 terms in the email package docs #155190

[serhiy-storchaka]

email docstrings and comments uses the "Unicode string" term and refer to the unicode() built-in. In 3.x this should be corrected to "string" and "str()". Perhaps some code (for example coercing a charset name to Unicode) is not needed more.

[bitdancer]

If you mean the code in Charset's __init__, if you change that you'll have backward compatibility issues. As the code currently stands it is legal to pass in a charset name that is bytes. And the string path of that if checks that it contains only ASCII characters, a check that is also still required.

[bitdancer]

The comment, however, is clearly no longer appropriate :)

[serhiy-storchaka]

It is just unusual to accept a bytes object as a charset name. Of course if it is needed for Charset's __init__ the code should not be removed.

[bitdancer]

Yeah, if I could have a do-over of the 3.0 port, I'd probably drop the acceptance of byte strings. Maybe we can deprecate it.