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.

classification
Title: Document typing.Text and typing.AnyStr
Type: Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum, levkivskyi, michael0x2a
Priority: normal Keywords: patch

Created on 2016-08-10 01:40 by michael0x2a, last changed 2022-04-11 14:58 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
document-text-and-anystr.patch michael0x2a, 2016-08-10 01:40 review
document-text-and-anystr-2.patch michael0x2a, 2016-08-15 16:57 review
Messages (6)
msg272286 - (view) Author: Michael Lee (michael0x2a) * Date: 2016-08-10 01:40
This patch documents typing.Text and typing.AnyStr.

I decided against creating a new top-level section to document Text/AnyStr mainly because it seems like how exactly str/bytes/unicode is handled by mypy and described in PEP 484 might be changing sometime in the future and didn't want to add text that would need to be changed later on -- I'm not sure if that was the right call or not.
msg272695 - (view) Author: Ivan Levkivskyi (levkivskyi) * (Python committer) Date: 2016-08-14 21:12
Thank you for the patch, Michael!
I could add a comment that probably it is better to mention the definition of AnyStr = TypeVar('AnyStr', str, bytes) at beginning and only then go with examples.
msg272702 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2016-08-15 01:03
Also see my comments in rietveld.

--Guido (mobile)
msg272781 - (view) Author: Michael Lee (michael0x2a) * Date: 2016-08-15 16:57
Second revision attached below.
msg272783 - (view) Author: Ivan Levkivskyi (levkivskyi) * (Python committer) Date: 2016-08-15 17:15
Looks good to me.
15 Сер 2016 18:57 "Michael Lee" <report@bugs.python.org> пише:

>
> Michael Lee added the comment:
>
> Second revision attached below.
>
> ----------
> Added file: http://bugs.python.org/file44121/document-text-and-
> anystr-2.patch
>
> _______________________________________
> Python tracker <report@bugs.python.org>
> <http://bugs.python.org/issue27723>
> _______________________________________
>
msg272803 - (view) Author: Guido van Rossum (gvanrossum) * (Python committer) Date: 2016-08-15 22:10
Committed and merged to 3.6.

changeset:   102670:d5872d0863c8
branch:      3.5
parent:      102663:27a99a722828
user:        Guido van Rossum <guido@python.org>
date:        Mon Aug 15 15:06:38 2016 -0700
summary:     Add docs for typing.AnyStr and typing.Text. By Michael Lee.

changeset:   102672:705416c5909e
tag:         tip
parent:      102671:247ecbae325c
parent:      102670:d5872d0863c8
user:        Guido van Rossum <guido@dropbox.com>
date:        Mon Aug 15 15:08:11 2016 -0700
summary:     Add docs for typing.AnyStr and typing.Text. By Michael Lee. (Merge 3.5->3.6)
History
Date User Action Args
2022-04-11 14:58:34adminsetgithub: 71910
2016-08-15 22:10:02gvanrossumsetstatus: open -> closed
resolution: fixed
messages: + msg272803

stage: resolved
2016-08-15 17:15:34levkivskyisetmessages: + msg272783
2016-08-15 16:57:41michael0x2asetfiles: + document-text-and-anystr-2.patch

messages: + msg272781
2016-08-15 01:03:55gvanrossumsetmessages: + msg272702
2016-08-14 21:12:05levkivskyisetnosy: + levkivskyi
messages: + msg272695
2016-08-10 01:40:43michael0x2acreate