Skip to content

Commit

Permalink
gh-90190: Add doc for using singledispatch with precise collection …
Browse files Browse the repository at this point in the history
…type hints (#116544)
  • Loading branch information
Delengowski authored Sep 27, 2024
1 parent 6266689 commit 2357d5b
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Doc/library/functools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,25 @@ The :mod:`functools` module defines the following functions:
... print(arg.real, arg.imag)
...

For code that dispatches on a collections type (e.g., ``list``), but wants
to typehint the items of the collection (e.g., ``list[int]``), the
dispatch type should be passed explicitly to the decorator itself with the
typehint going into the function definition::

>>> @fun.register(list)
... def _(arg: list[int], verbose=False):
... if verbose:
... print("Enumerate this:")
... for i, elem in enumerate(arg):
... print(i, elem)

.. note::

At runtime the function will dispatch on an instance of a list regardless
of the type contained within the list i.e. ``[1,2,3]`` will be
dispatched the same as ``["foo", "bar", "baz"]``. The annotation
provided in this example is for static type checkers only and has no
runtime impact.

To enable registering :term:`lambdas<lambda>` and pre-existing functions,
the :func:`register` attribute can also be used in a functional form::
Expand Down

0 comments on commit 2357d5b

Please sign in to comment.