8000 Best Practices: Split an example by srittau · Pull Request #2114 · python/typing · GitHub
[go: up one dir, main page]
Skip to content

Best Practices: Split an example #2114

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
srittau merged 1 commit into from
Nov 19, 2025
Merged

Best Practices: Split an example #2114

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files. 8000
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/reference/best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,18 @@ with the current type system or using the correct type is unergonomic.

If a function accepts every possible object as an argument, for example
because it's only passed to ``str()``, use ``object`` instead of ``Any`` as
type annotation. Similarly, if the return value of a callback is ignored,
annotate it with ``object``::
type annotation::

def call_cb_if_int(cb: Callable[[int], object], o: object) -> None:
def print_formatted(o: object) -> None:
if isinstance(o, int):
cb(o)
o = f"{o:02}"
print(o)

Similarly, if the return value of a callback is ignored,
annotate it with ``object``, not ``Any`` or ``None``::

def call_cb(cb: Callable[[int], object]) -> None:
cb(42)

.. _argument-return-practices:

Expand Down
0