Skip to content

Commit

Permalink
Clarify usage of callables regarding type object in docs (#15079)
Browse files Browse the repository at this point in the history
Related: #15024.
  • Loading branch information
Viicos authored May 1, 2023
1 parent 3097169 commit dbb72bb
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions docs/source/kinds_of_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,28 @@ using bidirectional type inference:
If you want to give the argument or return value types explicitly, use
an ordinary, perhaps nested function definition.

Callables can also be used against type objects, matching their
``__init__`` or ``__new__`` signature:

.. code-block:: python
from typing import Callable
class C:
def __init__(self, app: str) -> None:
pass
CallableType = Callable[[str], C]
def class_or_callable(arg: CallableType) -> None:
inst = arg("my_app")
reveal_type(inst) # Revealed type is "C"
This is useful if you want ``arg`` to be either a ``Callable`` returning an
instance of ``C`` or the type of ``C`` itself. This also works with
:ref:`callback protocols <callback_protocols>`.


.. _union-types:

Union types
Expand Down
2 changes: 1 addition & 1 deletion docs/source/protocols.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ member:
batch_proc([], bad_cb) # Error! Argument 2 has incompatible type because of
# different name and kind in the callback
Callback protocols and :py:data:`~typing.Callable` types can be used interchangeably.
Callback protocols and :py:data:`~typing.Callable` types can be used mostly interchangeably.
Argument names in :py:meth:`__call__ <object.__call__>` methods must be identical, unless
a double underscore prefix is used. For example:

Expand Down

0 comments on commit dbb72bb

Please sign in to comment.