Skip to content

fix(typing): User may not have provided a return annotation for an overload #523

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(typing): User may not have provided a return annotation for an overload #523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e01f730
fix: User may not have provided return annotation
bzoracler May 13, 2025
8c0e091
fix: add missing release notes
bzoracler Jun 26, 2025
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
2 changes: 1 addition & 1 deletion autoapi/_objects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ def __init__(self, *args, **kwargs):

Can be only be: async.
"""
self.overloads: list[tuple[str, str]] = [
self.overloads: list[tuple[str, str | None]] = [
(_format_args(args), return_annotation)
for args, return_annotation in self.obj["overloads"]
]
Expand Down
1 change: 1 addition & 0 deletions docs/changes/523.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix `PythonFunction.overloads` typing when source code overload(s) do not provide a return type