Skip to content

Document special meaning of ... in overloads #10772

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.

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 4 commits into from
Jul 7, 2021
Merged
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions docs/source/more_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,25 @@ return type by using overloads like so:
subtypes, you can use a :ref:`value restriction
<type-variable-value-restriction>`.

The default values of a function's arguments don't affect its signature, only
the absence or presence of a default value does. So in order to reduce
redundancy it's possible to replace default values in overload definitions with
`...` as a placeholder.

.. code-block:: python

from typing import overload

class M: ...

@overload
def get_model(model_or_pk: M, flag: bool = ...) -> M: ...
@overload
def get_model(model_or_pk: int, flag: bool = ...) -> M | None: ...

def get_model(model_or_pk: int | M, flag: bool = True) -> M | None:
...


Runtime behavior
----------------
Expand Down