Skip to content

gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs #123544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexWaygood merged 18 commits into from
Sep 6, 2024
Merged

gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs #123544

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
412c358
Move typing docs for deprecated aliases to collections.abc
sterliakov Aug 31, 2024
3a71312
Do the same with `contextlib` references
sterliakov Aug 31, 2024
c146cbd
Add a generators&coroutines section
sterliakov Sep 1, 2024
8b6f65c
Replace PEP695 parameters with Generic inheritance
sterliakov Sep 1, 2024
5aa430c
Remove type arguments for now
sterliakov Sep 1, 2024
fb13736
Revert "Do the same with `contextlib` references"
sterliakov Sep 1, 2024
e7bd7b7
Use double backticks
sterliakov Sep 1, 2024
5c513aa
Address review comments
sterliakov Sep 1, 2024
c827599
s/details of/details on/g
sterliakov Sep 1, 2024
8bac826
Address other review comments
sterliakov Sep 1, 2024
a65f256
Remove "This type may be used as follows" notes from List, Dict and M…
sterliakov Sep 1, 2024
dfa8564
Remove deprecated alias to `typing.Callable` from `collections.abc` r…
sterliakov Sep 1, 2024
7de2e02
Add deprecation notice to `typing.Callable` and `typing.Type` recomme…
sterliakov Sep 1, 2024
587d240
Use simple link
sterliakov Sep 1, 2024
e35d682
Reference modern `collections.abc` aliases
sterliakov Sep 1, 2024
fc16d76
Use fully qualified name for `collections.abc.Set` to avoid confusion…
sterliakov Sep 1, 2024
24ff30e
s/Refer to/See
sterliakov Sep 3, 2024
e63c976
Disambiguate `typing.Set` and `collections.abc.Set`
sterliakov Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace PEP695 parameters with Generic inheritance
  • Loading branch information
@sterliakov
sterliakov committed Sep 1, 2024
commit 8b6f65c06a4ca7cebd55c9fff71d7fde11e6643d
28 changes: 14 additions & 14 deletions Doc/library/collections.abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Collections Abstract Base Classes -- Detailed Descriptions
----------------------------------------------------------


.. class:: Container[T_co]
.. class:: Container(Generic[T_co])

ABC for classes that provide the :meth:`~object.__contains__` method.

Expand All @@ -216,7 +216,7 @@ Collections Abstract Base Classes -- Detailed Descriptions
See :ref:`annotating-callables` for details on how to use
Comment thread
AlexWaygood marked this conversation as resolved.
:class:`Callable` and :class:`~typing.Callable` in type annotations.
Comment thread
AlexWaygood marked this conversation as resolved.
Outdated

.. class:: Iterable[T_co]
.. class:: Iterable(Generic[T_co])

ABC for classes that provide the :meth:`~container.__iter__` method.

Expand All @@ -227,26 +227,26 @@ Collections Abstract Base Classes -- Detailed Descriptions
The only reliable way to determine whether an object is :term:`iterable`
is to call ``iter(obj)``.

.. class:: Collection[T_co](Sized, Iterable[T_co], Container[T_co])
.. class:: Collection(Sized, Iterable[T_co], Container[T_co])

ABC for sized iterable container classes.

.. versionadded:: 3.6

.. class:: Iterator[T_co](Iterable[T_co])
.. class:: Iterator(Iterable[T_co])

ABC for classes that provide the :meth:`~iterator.__iter__` and
:meth:`~iterator.__next__` methods. See also the definition of
:term:`iterator`.

.. class:: Reversible[T_co](Iterable[T_co])
.. class:: Reversible(Iterable[T_co])

ABC for iterable classes that also provide the :meth:`~object.__reversed__`
method.

.. versionadded:: 3.6

.. class:: Generator[YieldType_co, SendType_contra, ReturnType_co](Iterator[YieldType_co])
.. class:: Generator(Iterator[YieldType_co], Generic[YieldType_co, SendType_contra, ReturnType_co])

ABC for :term:`generator` classes that implement the protocol defined in
:pep:`342` that extends :term:`iterators <iterator>` with the
Expand All @@ -259,7 +259,7 @@ Collections Abstract Base Classes -- Detailed Descriptions

.. versionadded:: 3.5

.. class:: Sequence[T_co](Reversible[T_co], Collection[T_co])
.. class:: Sequence(Reversible[T_co], Collection[T_co])
MutableSequence[T](Sequence[T])

ABCs for read-only and mutable :term:`sequences <sequence>`.
Expand All @@ -277,12 +277,12 @@ Collections Abstract Base Classes -- Detailed Descriptions
The index() method added support for *stop* and *start*
arguments.

.. class:: Set[T_co](Collection[T_co])
.. class:: Set(Collection[T_co])
MutableSet[T](Set[T])

ABCs for read-only and mutable :ref:`sets <types-set>`.

.. class:: Mapping[KT, VT_co](Collection[KT], Generic[KT, VT_co])
.. class:: Mapping(Collection[KT], Generic[KT, VT_co])
MutableMapping[KT, VT](Mapping[KT, VT])

ABCs for read-only and mutable :term:`mappings <mapping>`.
Expand All @@ -299,7 +299,7 @@ Collections Abstract Base Classes -- Detailed Descriptions

ABCs for mapping, items, keys, and values :term:`views <dictionary view>`.

.. class:: Awaitable[T_co]
.. class:: Awaitable(Generic[T_co])

ABC for :term:`awaitable` objects, which can be used in :keyword:`await`
expressions. Custom implementations must provide the
Expand All @@ -317,7 +317,7 @@ Collections Abstract Base Classes -- Detailed Descriptions

.. versionadded:: 3.5

.. class:: Coroutine[YieldType_co, SendType_contra, ReturnType_co](Awaitable[ReturnType_co])
.. class:: Coroutine(Awaitable[ReturnType_co], Generic(YieldType_co, SendType_contra, ReturnType_co))

ABC for :term:`coroutine` compatible classes. These implement the
following methods, defined in :ref:`coroutine-objects`:
Expand All @@ -340,21 +340,21 @@ Collections Abstract Base Classes -- Detailed Descriptions

.. versionadded:: 3.5

.. class:: AsyncIterable[T_co]
.. class:: AsyncIterable(Generic[T_co])

ABC for classes that provide an ``__aiter__`` method. See also the
definition of :term:`asynchronous iterable`.

.. versionadded:: 3.5

.. class:: AsyncIterator[T_co](AsyncIterable[T_co])
.. class:: AsyncIterator(AsyncIterable[T_co])

ABC for classes that provide ``__aiter__`` and ``__anext__``
methods. See also the definition of :term:`asynchronous iterator`.

.. versionadded:: 3.5

.. class:: AsyncGenerator[YieldType_co, SendType_contra](AsyncIterator[YieldType_co])
.. class:: AsyncGenerator(AsyncIterator[YieldType_co], Generic[YieldType_co, SendType_contra])

ABC for :term:`asynchronous generator` classes that implement the protocol
defined in :pep:`525` and :pep:`492`.
Expand Down