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

Show file tree
Hide file tree
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
Revert "Do the same with contextlib references" 
Similarly to `collections.abc` changes, this is not acceptable for now.
  • Loading branch information
@sterliakov
sterliakov committed Sep 1, 2024
commit fb137364e9dc255547b63a4782b06089ee11b555
14 changes: 2 additions & 12 deletions Doc/library/contextlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,18 @@ Utilities

Functions and classes provided:

.. class:: AbstractContextManager[T_co, ExitT_co]
.. class:: AbstractContextManager

An :term:`abstract base class` for classes that implement
:meth:`object.__enter__` and :meth:`object.__exit__`. A default
implementation for :meth:`object.__enter__` is provided which returns
``self`` while :meth:`object.__exit__` is an abstract method which by default
returns ``None``. See also the definition of :ref:`typecontextmanager`.

The first type parameter, ``T_co``, represents the type returned by
the :meth:`~object.__enter__` method. The optional second type parameter, ``ExitT_co``,
which defaults to ``bool | None``, represents the type returned by the
:meth:`~object.__exit__` method.

.. versionadded:: 3.6


.. class:: AbstractAsyncContextManager[T_co, AExitT_co]
.. class:: AbstractAsyncContextManager

An :term:`abstract base class` for classes that implement
:meth:`object.__aenter__` and :meth:`object.__aexit__`. A default
Expand All @@ -43,11 +38,6 @@ Functions and classes provided:
returns ``None``. See also the definition of
:ref:`async-context-managers`.

The first type parameter, ``T_co``, represents the type returned by
the :meth:`~object.__aenter__` method. The optional second type parameter, ``AExitT_co``,
which defaults to ``bool | None``, represents the type returned by the
:meth:`~object.__aexit__` method.

.. versionadded:: 3.7


Expand Down
10 changes: 10 additions & 0 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3812,6 +3812,11 @@ Aliases to :mod:`contextlib` ABCs

Deprecated alias to :class:`contextlib.AbstractContextManager`.

The first type parameter, ``T_co``, represents the type returned by
the :meth:`~object.__enter__` method. The optional second type parameter, ``ExitT_co``,
which defaults to ``bool | None``, represents the type returned by the
:meth:`~object.__exit__` method.

.. versionadded:: 3.5.4

.. deprecated:: 3.9
Expand All @@ -3826,6 +3831,11 @@ Aliases to :mod:`contextlib` ABCs

Deprecated alias to :class:`contextlib.AbstractAsyncContextManager`.

The first type parameter, ``T_co``, represents the type returned by
the :meth:`~object.__aenter__` method. The optional second type parameter, ``AExitT_co``,
which defaults to ``bool | None``, represents the type returned by the
:meth:`~object.__aexit__` method.

.. versionadded:: 3.6.2

.. deprecated:: 3.9
Expand Down