Repository navigation
Move typing-related usage of PEP585 generics from typing docs to collections.abc #123523
Description
Activity
@JelleZijlstra, as a typing expert, does this approach seem good to you?
As a user of collections generics, this would be quite useful, and seems appropriate now that Python 3.8 is nearing end-of-life. Happy to defer to others' views, though.
A
Reacted by Kirill Podoprigora, Bénédikt Tran, sobolevn, Peter Bierma and Thomas GraingerI think +3 on the last comment is a good enough indicator - I'll grab this and open a PR soon.
- added a commit that references this issue
on Sep 6, 2024 - added a commit that references this issue
on Sep 6, 2024
Documentation
As pointed out in #123521, currently we have typing-related usage of PEP585 generics (
Generator,Callable,Coroutine, etc.) explained ontypingpage. However, those aliases are deprecated, and there's no backlink from theircollections.abccounterparts.So, currently all users of the recommended modern option (
collections.abcgenerics) have no documentation regarding their use in typing context at hand. Worse, classes there don't even have their generic arguments listed - only the name:This clearly should be fixed. At minimum the following needs to hold:
collections.abcaliases have their generic arguments listed in the docstypingdocs entries should be reachable fromcollections.abcdocs.Upon some thinking I agree with @ZeroIntensity that moving all information to
collections.abcand only retaining deprecation warning with a link intypingdocs could be the most ergonomic option.Linked PRs
collections.abcdocs #123544collections.abcdocs (GH-123544) #123790collections.abcdocs (#123544) #123792