bpo-41805: Documentation for PEP 585 by Fidget-Spinner · Pull Request #22615 · python/cpython

Fidget-Spinner · 2020-10-09T17:52:19Z

This PR (if accepted) probably needs a backport to 3.9. It also partly addresses https://bugs.python.org/issue40814.

Also, I'll need to update the links in stdtypes Union Type to point to GenericAlias now. However, I'm not sure if doing that in this PR would make backporting harder/go against the 1 issue per PR recommendation.

Lastly, I have a feeling that we should create a section in stdtypes called "Types for Type Annotations" and place GenericAlias and Union under that since it's becoming a moderate chunk of the documentation for that page. I'll open a bpo if that makes sense.

https://bugs.python.org/issue41805

Fidget-Spinner · 2020-10-10T16:35:35Z

It should be ready for review now @gvanrossum :). Please take a look whenever it's convenient for you. Thanks!

gvanrossum · 2020-10-20T23:44:04Z

I'm pretty overwhelmed by sprint activity. I promise I will review this at some point -- if I haven't done so in 1 week can you ping me? Either here or on the issue will notify me via email.

Fidget-Spinner · 2020-10-21T01:14:59Z

Alright, no worries. Thanks for the promise, I'll ping again in a week :)

gvanrossum · 2020-10-25T22:15:50Z

+These standard library collections support parameterized generics. Most of
+their type parameters can be found in the :mod:`typing` module:


What do you mean by the second sentence? That you need to read the docs for typing to find out how many parameters each of these has and whether they are invariant or covariant?

Your interpretation is correct. Should I place a table for such information instead?

gvanrossum

Getting close!

Co-Authored-By: Guido van Rossum <gvanrossum@users.noreply.github.com>

gvanrossum

Two more suggestions that I will apply myself, then it's good. Thank you very much!

gvanrossum

Ready to go!

miss-islington · 2020-10-27T21:37:21Z

Thanks @Fidget-Spinner for the PR, and @gvanrossum for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9.
🐍🍒⛏🤖

miss-islington · 2020-10-27T21:37:35Z

Sorry, @Fidget-Spinner and @gvanrossum, I could not cleanly backport this to 3.9 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 4173320920706b49a004bdddd8d7108e8984e3fc 3.9

gvanrossum · 2020-10-27T21:37:57Z

@Fidget-Spinner Can you work on the manual backport?

Fidget-Spinner · 2020-10-27T23:32:47Z

@gvanrossum sure, give me a day or two to figure out cherry_picker.

Also, thanks for the many rounds of reviews. This was a fairly challenging peice of documentation, but I'm glad to have had feedback throughout the process to help me along the way :).

gvanrossum · 2020-10-28T00:02:38Z

You're welcome -- and take your time (though cherry_picker really isn't much more than a little bit of workflow around the git cherry-pick command -- the hard part presumably is resolving the merge conflict :-).

bedevere-bot · 2020-10-28T15:01:38Z

GH-23016 is a backport of this pull request to the 3.9 branch.

Backport of #22615 to 3.9 since that couldn't be auto-merged due to conflicts.

…lots1 * origin/master: (365 commits) bpo-42029: Remove IRIX code (pythonGH-23023) bpo-42143: Ensure PyFunction_NewWithQualName() can't fail after creating the func object (pythonGH-22953) bpo-34204: Use pickle.DEFAULT_PROTOCOL in shelve (pythonGH-19639) bpo-41805: Documentation for PEP 585 (pythonGH-22615) bpo-42161: Micro-optimize _collections._count_elements() (pythonGH-23008) bpo-42161: Remove private _PyLong_Zero and _PyLong_One (pythonGH-23003) bpo-42099: Fix reference to ob_type in unionobject.c and ceval (pythonGH-22829) bpo-41659: Disallow curly brace directly after primary (pythonGH-22996) bpo-6761: Enhance __call__ documentation (pythonGH-7987) bpo-42161: Modules/ uses _PyLong_GetZero() and _PyLong_GetOne() (pythonGH-22998) bpo-41474, Makefile: Add dependency on cpython/frameobject.h (pythonGH-22999) bpo-42157: Rename unicodedata.ucnhash_CAPI (pythonGH-22994) bpo-42161: Use _PyLong_GetZero() and _PyLong_GetOne() (pythonGH-22995) bpo-30681: Support invalid date format or value in email Date header (pythonGH-22090) bpo-42161: Add _PyLong_GetZero() and _PyLong_GetOne() (pythonGH-22993) bpo-42123: Run the parser two times and only enable invalid rules on the second run (pythonGH-22111) bpo-42157: Convert unicodedata.UCD to heap type (pythonGH-22991) bpo-42157: unicodedata avoids references to UCD_Type (pythonGH-22990) bpo-39101: Fixes BaseException hang in IsolatedAsyncioTestCase. (pythonGH-22654) bpo-1635741: _PyUnicode_Name_CAPI moves to internal C API (pythonGH-22713) ...

Documentation for GenericAlias
e22fb28

the-knights-who-say-ni added the CLA signed label Oct 9, 2020

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Oct 9, 2020

add versionadded for types
072dd24

Fidget-Spinner marked this pull request as draft October 10, 2020 06:47

docs for special attributes and more explanations
96a42f5

Fidget-Spinner marked this pull request as ready for review October 10, 2020 16:25

Fidget-Spinner changed the title ~~bpo-41805: Documentation for PEP585~~bpo-41805: Documentation for PEP 585Oct 10, 2020

Fidget-Spinner added 2 commits October 18, 2020 01:07

fix typos and minor tweaks
3bd13c2

add intro and a implementation
ee3a16d

gvanrossum added the needs backport to 3.9 label Oct 20, 2020

gvanrossum reviewed Oct 25, 2020
View reviewed changes

Implement suggestions
3258cfc

gvanrossum reviewed Oct 27, 2020
View reviewed changes

Fidget-Spinnerand others added 2 commits October 27, 2020 23:52

Implement second round of suggestions
dffc294
Co-Authored-By: Guido van Rossum <gvanrossum@users.noreply.github.com>

minor formatting nits
8793653

gvanrossum reviewed Oct 27, 2020
View reviewed changes

Comment threadDoc/library/stdtypes.rst Outdated
Comment threadDoc/library/stdtypes.rst Outdated
Comment threadDoc/library/stdtypes.rst Outdated

Apply final suggestions from code review
e91c4ad

gvanrossum approved these changes Oct 27, 2020
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Oct 27, 2020

gvanrossum merged commit 4173320 into python:masterOct 27, 2020

bedevere-bot removed the awaiting merge label Oct 27, 2020

miss-islington assigned gvanrossum Oct 27, 2020

Fidget-Spinner mentioned this pull request Oct 28, 2020
[3.9] bpo-41805: Documentation for PEP 585 (GH-22615) #23016
Merged

bedevere-bot removed the needs backport to 3.9 label Oct 28, 2020

miss-islington pushed a commit that referenced this pull request Oct 28, 2020
[3.9]bpo-41805: Documentation for PEP 585 (GH-22615) (GH-23016)
577d7c4
Backport of #22615 to 3.9 since that couldn't be auto-merged due to conflicts.

Fidget-Spinner deleted the add-docs-pep585 branch October 28, 2020 15:57

adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 13, 2021
bpo-41805: Documentation for PEP 585 (pythonGH-22615)
4071ef7

		These standard library collections support parameterized generics. Most of
		their type parameters can be found in the :mod:`typing` module:

Uh oh!

Uh oh!

Conversation

Fidget-Spinner commented Oct 9, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Fidget-Spinner commented Oct 10, 2020

Uh oh!

gvanrossum commented Oct 20, 2020

Uh oh!

Fidget-Spinner commented Oct 21, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gvanrossumOct 25, 2020

Choose a reason for hiding this comment

Uh oh!

Fidget-SpinnerOct 26, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gvanrossum left a comment

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Oct 27, 2020

Uh oh!

miss-islington commented Oct 27, 2020

Uh oh!

gvanrossum commented Oct 27, 2020

Uh oh!

Fidget-Spinner commented Oct 27, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gvanrossum commented Oct 28, 2020 via email

Uh oh!

bedevere-bot commented Oct 28, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Fidget-Spinner commented Oct 9, 2020•
edited
Loading

Fidget-Spinner commented Oct 27, 2020•
edited
Loading