Skip to content
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

Jump to bottom

refactor(typing): Update event_handler to pass strict checks #5139

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

refactor(typing): Update event_handler to pass strict checks #5139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
025ce72
fix(event_handler): Update typing of route and exception handling to …
Sep 7, 2024
d75e6a3
Update typing of append_context
Sep 7, 2024
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
36 changes: 20 additions & 16 deletions aws_lambda_powertools/event_handler/api_gateway.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@

ResponseEventT = TypeVar("ResponseEventT", bound=BaseProxyEvent)
ResponseT = TypeVar("ResponseT")
P = TypeVar("P")
T = TypeVar("T")
SimpleFunction = Callable[P, T]
DecoratorFunction = Callable[[SimpleFunction], SimpleFunction]

if TYPE_CHECKING:
from aws_lambda_powertools.event_handler.openapi.compat import (
Expand Down Expand Up @@ -951,7 +955,7 @@ def route(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
raise NotImplementedError()

def use(self, middlewares: List[Callable[..., Response]]) -> None:
Expand Down Expand Up @@ -1011,7 +1015,7 @@ def get(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
"""Get route decorator with GET `method`

Examples
Expand Down Expand Up @@ -1068,7 +1072,7 @@ def post(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
"""Post route decorator with POST `method`

Examples
Expand Down Expand Up @@ -1126,7 +1130,7 @@ def put(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
"""Put route decorator with PUT `method`

Examples
Expand Down Expand Up @@ -1184,7 +1188,7 @@ def delete(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
"""Delete route decorator with DELETE `method`

Examples
Expand Down Expand Up @@ -1241,7 +1245,7 @@ def patch(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable]] = None,
):
) -> DecoratorFunction:
"""Patch route decorator with PATCH `method`

Examples
Expand Down Expand Up @@ -1301,7 +1305,7 @@ def head(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable]] = None,
):
) -> DecoratorFunction:
"""Head route decorator with HEAD `method`

Examples
Expand Down Expand Up @@ -1356,7 +1360,7 @@ def _reset_processed_stack(self):
"""Reset the Processed Stack Frames"""
self.processed_stack_frames.clear()

def append_context(self, **additional_context):
def append_context(self, **additional_context) -> None:
"""Append key=value data as routing context"""
self.context.update(**additional_context)

Expand Down Expand Up @@ -1528,7 +1532,7 @@ def __init__(
self._dynamic_routes: List[Route] = []
self._static_routes: List[Route] = []
self._route_keys: List[str] = []
self._exception_handlers: Dict[Type, Callable] = {}
self._exception_handlers: Dict[Type, DecoratorFunction] = {}
self._cors = cors
self._cors_enabled: bool = cors is not None
self._cors_methods: Set[str] = {"OPTIONS"}
Expand Down Expand Up @@ -1988,7 +1992,7 @@ def route(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
"""Route decorator includes parameter `method`"""

def register_resolver(func: Callable):
Expand Down Expand Up @@ -2345,7 +2349,7 @@ def not_found(self, func: Optional[Callable] = None):
return self.exception_handler(NotFoundError)
return self.exception_handler(NotFoundError)(func)

def exception_handler(self, exc_class: Union[Type[Exception], List[Type[Exception]]]):
def exception_handler(self, exc_class: Union[Type[Exception], List[Type[Exception]]]) -> DecoratorFunction:
def register_exception_handler(func: Callable):
if isinstance(exc_class, list): # pragma: no cover
for exp in exc_class:
Expand All @@ -2356,7 +2360,7 @@ def register_exception_handler(func: Callable):

return register_exception_handler

def _lookup_exception_handler(self, exp_type: Type) -> Optional[Callable]:
def _lookup_exception_handler(self, exp_type: Type) -> Optional[DecoratorFunction]:
# Use "Method Resolution Order" to allow for matching against a base class
# of an exception
for cls in exp_type.__mro__:
Expand Down Expand Up @@ -2506,12 +2510,12 @@ def _get_fields_from_routes(routes: Sequence[Route]) -> List["ModelField"]:
class Router(BaseRouter):
"""Router helper class to allow splitting ApiGatewayResolver into multiple files"""

def __init__(self):
def __init__(self) -> "Router":
self._routes: Dict[tuple, Callable] = {}
self._routes_with_middleware: Dict[tuple, List[Callable]] = {}
self.api_resolver: Optional[BaseRouter] = None
self.context = {} # early init as customers might add context before event resolution
self._exception_handlers: Dict[Type, Callable] = {}
self._exception_handlers: Dict[Type, DecoratorFunction] = {}

def route(
self,
Expand All @@ -2530,7 +2534,7 @@ def route(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
def register_route(func: Callable):
# All dict keys needs to be hashable. So we'll need to do some conversions:
methods = (method,) if isinstance(method, str) else tuple(method)
Expand Down Expand Up @@ -2636,7 +2640,7 @@ def route(
security: Optional[List[Dict[str, List[str]]]] = None,
openapi_extensions: Optional[Dict[str, Any]] = None,
middlewares: Optional[List[Callable[..., Any]]] = None,
):
) -> DecoratorFunction:
# NOTE: see #1552 for more context.
return super().route(
rule.rstrip("/"),
Expand Down
Loading