Skip to content

gh-98500: Fix typing docs for *View classes #98511

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-98500: Fix typing docs for *View classes #98511

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b51d618
gh-98500: Fix typing docs for `*View` classes
sobolevn Oct 21, 2022
29d3686
Address review
sobolevn Oct 24, 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
8 changes: 4 additions & 4 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2096,15 +2096,15 @@ Corresponding to collections in :mod:`collections.abc`
:class:`collections.abc.Container` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.

.. class:: ItemsView(MappingView, Generic[KT_co, VT_co])
.. class:: ItemsView(MappingView, AbstractSet[tuple[KT_co, VT_co]], Generic[KT_co, VT_co])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generic is redundant as a base class, because there is a generic base. Other classes nearby don't list Generic as an explicit base, so these ones shouldn't either.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I feel like the fact that so many typeshed classes do this in the stubs is something of a legacy thing (though some may prefer it for added explicitness).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!


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:: KeysView(MappingView[KT_co], AbstractSet[KT_co])
.. class:: KeysView(MappingView, AbstractSet[KT_co], Generic[KT_co])

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

Expand All @@ -2124,7 +2124,7 @@ Corresponding to collections in :mod:`collections.abc`
:class:`collections.abc.Mapping` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.

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

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

Expand Down Expand Up @@ -2164,7 +2164,7 @@ Corresponding to collections in :mod:`collections.abc`
:class:`collections.abc.Sequence` now supports ``[]``. See :pep:`585`
and :ref:`types-genericalias`.

.. class:: ValuesView(MappingView[VT_co])
.. class:: ValuesView(MappingView, Collection[_VT_co], Generic[_VT_co])

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

Expand Down