Skip to content

[3.11] gh-103921: Improve typing documentation (GH-104642) #105007

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
JelleZijlstra merged 3 commits into from
May 27, 2023
Merged

[3.11] gh-103921: Improve typing documentation (GH-104642) #105007

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0428d38
[3.11] gh-103921: Document PEP 695 (GH-104642)
JelleZijlstra May 26, 2023
c7e9ef8
Apply suggestions from code review
JelleZijlstra May 27, 2023
df9d949
de-695
JelleZijlstra May 27, 2023
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
Apply suggestions from code review 
Thanks Alex!

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
@JelleZijlstra @AlexWaygood
JelleZijlstra and AlexWaygood authored May 27, 2023
commit c7e9ef87021afaab95ae230f194a60a014f51458
10 changes: 5 additions & 5 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,7 @@ to this is that a list of types can be used to substitute a :class:`ParamSpec`::
>>> Z[int, [dict, float]]
__main__.Z[int, (<class 'dict'>, <class 'float'>)]

Another difference between :class:`TypeVar` and :class:`ParamSpec` is that a
generic with only one parameter specification variable will accept
Furthermore, a generic with only one parameter specification variable will accept
parameter lists in the forms ``X[[Type1, Type2, ...]]`` and also
``X[Type1, Type2, ...]`` for aesthetic reasons. Internally, the latter is converted
to the former, so the following are equivalent::
Expand Down Expand Up @@ -1364,11 +1363,11 @@ for creating generic types.

.. attribute:: __covariant__

Whether the type var has been explicitly marked as covariant.
Whether the type var has been marked as covariant.

.. attribute:: __contravariant__

Whether the type var has been explicitly marked as contravariant.
Whether the type var has been marked as contravariant.

.. attribute:: __bound__

Expand Down Expand Up @@ -1431,6 +1430,7 @@ for creating generic types.
Type variable tuples can be used in the same contexts as normal type
variables. For example, in class definitions, arguments, and return types::

Shape = TypeVarTuple("Shape")
class Array(Generic[*Shape]):
Comment thread
JelleZijlstra marked this conversation as resolved.
def __getitem__(self, key: tuple[*Shape]) -> float: ...
def __abs__(self) -> "Array[*Shape]": ...
Expand All @@ -1452,7 +1452,7 @@ for creating generic types.
However, note that at most one type variable tuple may appear in a single
list of type arguments or type parameters::

x: tuple[*Ts, *Ts] # Not valid
x: tuple[*Ts, *Ts] # Not valid
class Array(Generic[*Shape, *Shape]): # Not valid
pass

Expand Down