Skip to content

Commit

Permalink
Clarify that Type[SomeTypeVar] is legal (#9585)
Browse files Browse the repository at this point in the history
Currently, the docs state that when doing `Type[X]`, X is only allowed to
be a class, a union of classes, and Any. This pull request amends
that sentence to clarify X may also be a typevar (or a union involving
classes, Any, and TypeVars).
  • Loading branch information
Michael0x2a authored and ilevkivskyi committed Sep 26, 2018
1 parent bb81651 commit 130717f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Doc/library/typing.rst
Expand Up @@ -169,6 +169,8 @@ It is possible to declare the return type of a callable without specifying
the call signature by substituting a literal ellipsis
for the list of arguments in the type hint: ``Callable[..., ReturnType]``.

.. _generics:

Generics
--------

Expand All @@ -183,7 +185,7 @@ subscription to denote expected types for container elements.
def notify_by_email(employees: Sequence[Employee],
overrides: Mapping[str, str]) -> None: ...

Generics can be parametrized by using a new factory available in typing
Generics can be parameterized by using a new factory available in typing
called :class:`TypeVar`.

::
Expand Down Expand Up @@ -488,8 +490,9 @@ The module defines the following classes, functions and decorators:
required to handle this particular case may change in future revisions of
:pep:`484`.

The only legal parameters for :class:`Type` are classes, unions of classes, and
:data:`Any`. For example::
The only legal parameters for :class:`Type` are classes, :data:`Any`,
:ref:`type variables <generics>`, and unions of any of these types.
For example::

def new_non_team_user(user_class: Type[Union[BaseUser, ProUser]]): ...

Expand Down

0 comments on commit 130717f

Please sign in to comment.