8000 gh-98507: [typing docs] Rephrase "now supports `[]`" to "now supports subscripting" by sobolevn · Pull Request #98508 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-98507: [typing docs] Rephrase "now supports []" to "now supports subscripting" #98508

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
merged 2 commits into from
Oct 24, 2022
Merged

gh-98507: [typing docs] Rephrase "now supports []" to "now supports subscripting" #98508

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1abbe4e
[typing docs] Rephrase "now supports `[]`" to "now supports `__class_…
sobolevn Oct 21, 2022
5f7ed15
Implement @Fidget-Spinner suggestion
sobolevn Oct 21, 2022
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
150 changes: 78 additions & 72 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,8 +760,8 @@ These can be used as types in annotations using ``[]``, each having a unique syn
is equivalent to ``Tuple[Any, ...]``, and in turn to :class:`tuple`.

.. deprecated:: 3.9
:class:`builtins.tuple <tuple>` now supports ``[]``. See :pep:`585` and
:ref:`t 10000 ypes-genericalias`.
:class:`builtins.tuple <tuple>` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. data:: Union

Expand Down Expand Up @@ -849,8 +849,8 @@ These can be used as types in annotations using ``[]``, each having a unique syn
respectively.

.. deprecated:: 3.9
:class:`collections.abc.Callable` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.abc.Callable` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. versionchanged:: 3.10
``Callable`` now supports :class:`ParamSpec` and :data:`Concatenate`.
Expand Down Expand Up @@ -957,8 +957,8 @@ These can be used as types in annotations using ``[]``, each having a unique syn
.. versionadded:: 3.5.2

.. deprecated:: 3.9
:class:`builtins.type <type>` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`builtins.type <type>` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. data:: Literal

Expand Down Expand Up @@ -1896,8 +1896,8 @@ Corresponding to built-in types
...

.. deprecated:: 3.9
:class:`builtins.dict <dict>` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`builtins.dict <dict>` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: List(list, MutableSequence[T])

Expand All @@ -1917,8 +1917,8 @@ Corresponding to built-in types
return [item for item in vector if item > 0]

.. deprecated:: 3.9
:class:`builtins.list <list>` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`builtins.list <list>` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: Set(set, MutableSet[T])

Expand All @@ -1927,16 +1927,17 @@ Corresponding to built-in types
to use an abstract collection type such as :class:`AbstractSet`.

.. deprecated:: 3.9
:class:`builtins.set <set>` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`builtins.set <set>` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: FrozenSet(frozenset, AbstractSet[T_co])

A generic version of :class:`builtins.frozenset <frozenset>`.

.. deprecated:: 3.9
:class:`builtins.frozenset <frozenset>` now supports ``[]``. See
:pep:`585` and :ref:`types-genericalias`.
:class:`builtins.frozenset <frozenset>`
now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. note:: :data:`Tuple` is a special form.

Expand All @@ -1950,8 +1951,8 @@ Corresponding to types in :mod:`collections`
.. versionadded:: 3.5.2

.. deprecated:: 3.9
:class:`collections.defaultdict` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.defaultdict` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: OrderedDict(collections.OrderedDict, MutableMapping[KT, VT])

Expand All @@ -1960,8 +1961,8 @@ Corresponding to types in :mod:`collections`
.. versionadded:: 3.7.2

.. deprecated:: 3.9
:class:`collections.OrderedDict` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.OrderedDict` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: ChainMap(collections.ChainMap, MutableMapping[KT, VT])

Expand All @@ -1971,8 +1972,8 @@ Corresponding to types in :mod:`collections`
.. versionadded:: 3.6.1

.. deprecated:: 3.9
:class:`collections.ChainMap` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.ChainMap` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: Counter(collections.Counter, Dict[T, int])

Expand All @@ -1982,8 +1983,8 @@ Corresponding to types in :mod:`collections`
.. versionadded:: 3.6.1

.. deprecated:: 3.9
:class:`collections.Counter` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.Counter` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: Deque(deque, MutableSequence[T])

Expand All @@ -1993,8 +1994,8 @@ Corresponding to types in :mod:`collections`
.. versionadded:: 3.6.1

.. deprecated:: 3.9
:class:`collections.deque` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.deque` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

Other concrete types
""""""""""""""""""""
Expand Down Expand Up @@ -2061,8 +2062,8 @@ Corresponding to collections in :mod:`collections.abc`
A generic version of :class:`collections.abc.Set`.

.. deprecated:: 3.9
:class:`collections.abc.Set` now supports ``[]``. See :pep:`585` and
:ref:`types-genericalias`.
:class:`collections.abc.Set` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: ByteString(Sequence[int])

Expand All @@ -2075,8 +2076,8 @@ Corresponding to collections in :mod:`collections.abc`
annotate arguments of any of the types mentioned above.

.. deprecated:: 3.9
:class:`collections.abc.ByteString` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.ByteString` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

Expand All @@ -2085,32 +2086,32 @@ Corresponding to collections in :mod:`collections.abc`
.. versionadded:: 3.6.0

.. deprecated:: 3.9
:class:`collections.abc.Collection` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Collection` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

A generic version of :class:`collections.abc.Container`.

.. deprecated:: 3.9
:class:`collections.abc.Container` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Container` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: ItemsView(MappingView, Generic[KT_co, VT_co])

A generic version of :class:`collections.abc.ItemsView`.

.. deprecated:: 3.9
:class:`collections.abc.ItemsView` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.ItemsView` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: KeysView(MappingView[KT_co], AbstractSet[KT_co])

A generic version of :class:`collections.abc.KeysView`.

.. deprecated:: 3.9
:class:`collections.abc.KeysView` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.KeysView` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

Expand All @@ -2121,56 +2122,58 @@ Corresponding to collections in :mod:`collections.abc`
return word_list[word]

.. deprecated:: 3.9
:class:`collections.abc.Mapping` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Mapping` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: MappingView(Sized, Iterable[T_co])

A generic version of :class:`collections.abc.MappingView`.

.. deprecated:: 3.9
:class:`collections.abc.MappingView` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.MappingView` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

A generic version of :class:`collections.abc.MutableMapping`.

.. deprecated:: 3.9
:class:`collections.abc.MutableMapping` now supports ``[]``. See
:pep:`585` and :ref:`types-genericalias`.
:class:`collections.abc.MutableMapping`
now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: MutableSequence(Sequence[T])

A generic version of :class:`collections.abc.MutableSequence`.

.. deprecated:: 3.9
:class:`collections.abc.MutableSequence` now supports ``[]``. See
:pep:`585` and :ref:`types-genericalias`.
:class:`collections.abc.MutableSequence`
now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: MutableSet(AbstractSet[T])

A generic version of :class:`collections.abc.MutableSet`.

.. deprecated:: 3.9
:class:`collections.abc.MutableSet` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.MutableSet` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

A generic version of :class:`collections.abc.Sequence`.

.. deprecated:: 3.9
:class:`collections.abc.Sequence` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Sequence` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: ValuesView(MappingView[VT_co])

A generic version of :class:`collections.abc.ValuesView`.

.. deprecated:: 3.9
:class:`collections.abc.ValuesView` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.ValuesView` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

Corresponding to other types in :mod:`collections.abc`
""""""""""""""""""""""""""""""""""""""""""""""""""""""
Expand All @@ -2180,16 +2183,16 @@ Corresponding to other types in :mod:`collections.abc`
A generic version of :class:`collections.abc.Iterable`.

.. deprecated:: 3.9
:class:`collections.abc.Iterable` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Iterable` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

A generic version of :class:`collections.abc.Iterator`.

.. deprecated:: 3.9
:class:`collections.abc.Iterator` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Iterator` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: Generator(Iterator[T_co], Generic[T_co, T_contra, V_co])

Expand Down Expand Up @@ -2223,8 +2226,8 @@ Corresponding to other types in :mod:`collections.abc`
start += 1

.. deprecated:: 3.9
:class:`collections.abc.Generator` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Generator` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: Hashable

Expand All @@ -2238,8 +2241,8 @@ Corresponding to other types in :mod:`collections.abc`
A generic version of :class:`collections.abc.Reversible`.

.. deprecated:: 3.9
:class:`collections.abc.Reversible` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Reversible` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: Sized

Expand All @@ -2266,8 +2269,8 @@ Asynchronous programming
.. versionadded:: 3.5.3

.. deprecated:: 3.9
:class:`collections.abc.Coroutine` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Coroutine` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

.. class:: AsyncGenerator(AsyncIterator[T_co], Generic[T_co, T_contra])

Expand Down Expand Up @@ -2303,8 +2306,9 @@ Asynchronous programming
.. versionadded:: 3.6.1

.. deprecated:: 3.9
:class:`collections.abc.AsyncGenerator` now supports ``[]``. See
:pep:`585` and :ref:`types-genericalias`.
:class:`collections.abc.AsyncGenerator`
now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

Expand All @@ -2313,8 +2317,8 @@ Asynchronous programming
.. versionadded:: 3.5.2

.. deprecated:: 3.9
:class:`collections.abc.AsyncIterable` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.AsyncIterable` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

Expand All @@ -2323,8 +2327,8 @@ Asynchronous programming
.. versionadded:: 3.5.2

.. deprecated:: 3.9
:class:`collections.abc.AsyncIterator` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.AsyncIterator` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

Expand All @@ -2333,8 +2337,8 @@ Asynchronous programming
.. versionadded:: 3.5.2

.. deprecated:: 3.9
:class:`collections.abc.Awaitable` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.
:class:`collections.abc.Awaitable` now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.


Context manager types
Expand All @@ -2348,8 +2352,9 @@ Context manager types
.. versionadded:: 3.6.0

.. deprecated:: 3.9
:class:`contextlib.AbstractContextManager` now supports ``[]``. See
:pep:`585` and :ref:`types-genericalias`.
:class:`contextlib.AbstractContextManager`
now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

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

Expand All @@ -2359,8 +2364,9 @@ Context manager types
.. versionadded:: 3.6.2

.. deprecated:: 3.9
:class:`contextlib.AbstractAsyncContextManager` now supports ``[]``. See
:pep:`585` and :ref:`types-genericalias`.
:class:`contextlib.AbstractAsyncContextManager`
now supports subscripting (``[]``).
See :pep:`585` and :ref:`types-genericalias`.

Protocols
---------
Expand Down
0