Document typing.Text and typing.AnyStr

[Michael0x2a]

BPO	27723
Nosy	@gvanrossum, @Michael0x2a, @ilevkivskyi
Files	document-text-and-anystr.patch document-text-and-anystr-2.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 2016-08-15.22:10:02.408>
created_at = <Date 2016-08-10.01:40:43.646>
labels = ['docs']
title = 'Document typing.Text and typing.AnyStr'
updated_at = <Date 2016-08-15.22:10:02.407>
user = 'https://github.com/michael0x2a'

bugs.python.org fields:

activity = <Date 2016-08-15.22:10:02.407>
actor = 'gvanrossum'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-08-15.22:10:02.408>
closer = 'gvanrossum'
components = ['Documentation']
creation = <Date 2016-08-10.01:40:43.646>
creator = 'michael0x2a'
dependencies = []
files = ['44062', '44121']
hgrepos = []
issue_num = 27723
keywords = ['patch']
message_count = 6.0
messages = ['272286', '272695', '272702', '272781', '272783', '272803']
nosy_count = 4.0
nosy_names = ['gvanrossum', 'docs@python', 'michael0x2a', 'levkivskyi']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue27723'
versions = ['Python 3.5', 'Python 3.6']

[Michael0x2a]

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.

[ilevkivskyi]

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.

[gvanrossum]

Also see my comments in rietveld.

--Guido (mobile)

[Michael0x2a]

Second revision attached below.

[ilevkivskyi]

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\>

---

[gvanrossum]

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)