Skip to content

Add proper type hints to add_exception_handler #1308

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

Closed
phillipuniverse wants to merge 2 commits into from
Closed

Add proper type hints to add_exception_handler #1308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb584f8
Add proper type hints to add_exception_handler
phillipuniverse Oct 11, 2021
b46982f
Add proper imports, allow the exception handler to be a normal functi…
phillipuniverse Oct 12, 2021
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
4 changes: 3 additions & 1 deletion starlette/applications.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
from starlette.middleware import Middleware
from starlette.middleware.base import BaseHTTPMiddleware
from starlette.middleware.errors import ServerErrorMiddleware
from starlette.requests import Request
from starlette.responses import Response
from starlette.routing import BaseRoute, Router
from starlette.types import ASGIApp, Receive, Scope, Send

Expand Down Expand Up @@ -129,7 +131,7 @@ def add_middleware(self, middleware_class: type, **options: typing.Any) -> None:
def add_exception_handler(
self,
exc_class_or_status_code: typing.Union[int, typing.Type[Exception]],
handler: typing.Callable,
handler: typing.Callable[[Request, Exception], typing.Union[Response, typing.Coroutine[typing.Any, typing.Any, Response]]],
Copy link
Owner

@Kludex Kludex Nov 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we perhaps use Awaitable instead? It looks better. 😗

Suggested change
handler: typing.Callable[[Request, Exception], typing.Union[Response, typing.Coroutine[typing.Any, typing.Any, Response]]],
handler: typing.Callable[[Request, Exception], typing.Union[Response, Awaitable[Response]]],

) -> None:
self.exception_handlers[exc_class_or_status_code] = handler
self.middleware_stack = self.build_middleware_stack()
Expand Down