Docs for StringIO should link to io.BytesIO

[guettli]

BPO	26817
Nosy	@ZackerySpytz

^{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 2020-05-10.00:42:35.088>
created_at = <Date 2016-04-21.13:31:25.821>
labels = ['docs']
title = 'Docs for StringIO should link to io.BytesIO'
updated_at = <Date 2020-05-10.00:42:35.087>
user = 'https://bugs.python.org/guettli'

bugs.python.org fields:

activity = <Date 2020-05-10.00:42:35.087>
actor = 'zach.ware'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-05-10.00:42:35.088>
closer = 'zach.ware'
components = ['Documentation']
creation = <Date 2016-04-21.13:31:25.821>
creator = 'guettli'
dependencies = []
files = []
hgrepos = []
issue_num = 26817
keywords = []
message_count = 2.0
messages = ['263917', '368550']
nosy_count = 3.0
nosy_names = ['guettli', 'docs@python', 'ZackerySpytz']
pr_nums = []
priority = 'normal'
resolution = 'out of date'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue26817'
versions = ['Python 2.7']

[guettli]

I think a warning at the top of StringIO docs is needed.

And it should link to io.BytesIO.

Maybe even deprecate StringIO and cStringIO in Python2?

StringIO docs: https://docs.python.org/2/library/stringio.html

io.BytesIO docs: https://docs.python.org/2/library/io.html#io.BytesIO

I would like to see this at the top of StringIO:

{{{
Please use io.BytesIO and io.StringIO since this module is not supported in Python3
}}

[ZackerySpytz]

Python 2 is EOL.