10000 gh-106461: typing: Consolidate docs on `Callable` by AlexWaygood · Pull Request #106462 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-106461: typing: Consolidate docs on Callable #106462

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
Jul 9, 2023
Merged

gh-106461: typing: Consolidate docs on Callable #106462

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
854b2c5
gh-106461: Consolidate docs on `Callable`
AlexWaygood Jul 5, 2023
a72d1a9
Address Shantanu's review
AlexWaygood Jul 9, 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
Address Shantanu's review
  • Loading branch information
@AlexWaygood
AlexWaygood committed Jul 9, 2023
commit a72d1a95078112f930aabdc671757725a4fcb6aa
20 changes: 10 additions & 10 deletions Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,12 +258,12 @@ See :pep:`484` for more details.
The performance of calling ``NewType`` has been restored to its level in
Python 3.9.

.. _annotating-callbacks:
.. _annotating-callables:

Annotating callbacks
====================
Annotating callable objects
===========================

Functions -- or other callable objects -- can be annotated using
Functions -- or other :term:`callable` objects -- can be annotated using
:class:`collections.abc.Callable` or :data:`typing.Callable`.
``Callable[[int], str]`` signifies a function that takes a single parameter
of type :class:`int` and returns a :class:`str`.
Expand Down Expand Up @@ -1044,12 +1044,12 @@ These can be used as types in annotations. They all support subscription using

Special form for annotating higher-order functions.

``Concatenate`` can be used in conjunction with :ref:`Callable <annotating-callbacks>` and
``Concatenate`` can be used in conjunction with :ref:`Callable <annotating-callables>` and
:class:`ParamSpec` to annotate a higher-order callable which adds, removes,
or transforms parameters of another
callable. Usage is in the form
``Concatenate[Arg1Type, Arg2Type, ..., ParamSpecVariable]``. ``Concatenate``
is currently only valid when used as the first argument to a :ref:`Callable <annotating-callbacks>`.
is currently only valid when used as the first argument to a :ref:`Callable <annotating-callables>`.
The last parameter to ``Concatenate`` must be a :class:`ParamSpec` or
ellipsis (``...``).

Expand Down Expand Up @@ -1095,7 +1095,7 @@ These can be used as types in annotations. They all support subscription using
* :pep:`612` -- Parameter Specification Variables (the PEP which introduced
``ParamSpec`` and ``Concatenate``)
* :class:`ParamSpec`
* :ref:`annotating-callbacks`
* :ref:`annotating-callables`


.. class:: Type(Generic[CT_co])
Expand Down Expand Up @@ -1902,7 +1902,7 @@ without the dedicated syntax, as documented below.
* :pep:`612` -- Parameter Specification Variables (the PEP which introduced
``ParamSpec`` and ``Concatenate``)
* :data:`Concatenate`
* :ref:`annotating-callbacks`
* :ref:`annotating-callables`

.. data:: ParamSpecArgs
.. data:: ParamSpecKwargs
Expand Down Expand Up @@ -2187,7 +2187,7 @@ types.
methods or attributes, not their type signatures or types.
For example, :class:`ssl.SSLObject`
is a class, therefore it passes an :func:`issubclass`
check against :ref:`Callable <annotating-callbacks>`. However, the
check against :ref:`Callable <annotating-callables>`. However, the
``ssl.SSLObject.__init__`` method exists only to raise a
:exc:`TypeError` with a more informative message, therefore making
it impossible to call (instantiate) :class:`ssl.SSLObject`.
Expand Down Expand Up @@ -3532,7 +3532,7 @@ Aliases to other ABCs in :mod:`collections.abc`

Deprecated alias to :class:`collections.abc.Callable`.

See :ref:`annotating-callbacks` for details on how to use
See :ref:`annotating-callables` for details on how to use
:class:`collections.abc.Callable` and ``typing.Callable`` in type annotations.

.. deprecated:: 3.9
Expand Down
0