Skip to content

refactor(event_source): fix type hint #4165

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

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
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
32 changes: 22 additions & 10 deletions aws_lambda_powertools/middleware_factory/factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import inspect
import logging
import os
from typing import Any, Callable, Optional
from typing import Any, Callable, Optional, TypeVar, cast

from ..shared import constants
from ..shared.functions import resolve_truthy_env_var_choice
Expand All @@ -11,9 +11,14 @@

logger = logging.getLogger(__name__)

FuncType = TypeVar("FuncType", bound=Callable[..., Any])


# Maintenance: we can't yet provide an accurate return type without ParamSpec etc. see #1066
def lambda_handler_decorator(decorator: Optional[Callable] = None, trace_execution: Optional[bool] = None) -> Callable:
def lambda_handler_decorator(
decorator: Optional[Callable[..., Any]] = None,
trace_execution: Optional[bool] = None,
) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
"""Decorator factory for decorating Lambda handlers.

You can use lambda_handler_decorator to create your own middlewares,
Expand All @@ -34,7 +39,7 @@ def lambda_handler_decorator(decorator: Optional[Callable] = None, trace_executi

Parameters
----------
decorator: Callable
decorator: Callable[..., Any]
Middleware to be wrapped by this factory
trace_execution: bool
Flag to explicitly enable trace execution for middlewares.\n
Expand Down Expand Up @@ -104,18 +109,21 @@ def lambda_handler(event, context):
"""

if decorator is None:
return functools.partial(lambda_handler_decorator, trace_execution=trace_execution)
return cast(
Callable[[Callable[..., Any]], Callable[..., Any]],
functools.partial(lambda_handler_decorator, trace_execution=trace_execution),
)

trace_execution = resolve_truthy_env_var_choice(
env=os.getenv(constants.MIDDLEWARE_FACTORY_TRACE_ENV, "false"),
choice=trace_execution,
)

@functools.wraps(decorator)
def final_decorator(func: Optional[Callable] = None, **kwargs: Any):
def final_decorator(*args: Any, func: Optional[FuncType] = None, **kwargs: Any) -> FuncType:
# If called with kwargs return new func with kwargs
if func is None:
return functools.partial(final_decorator, **kwargs)
return cast(FuncType, functools.partial(final_decorator, *args, **kwargs))

if not inspect.isfunction(func):
# @custom_middleware(True) vs @custom_middleware(log_event=True)
Expand All @@ -124,9 +132,11 @@ def final_decorator(func: Optional[Callable] = None, **kwargs: Any):
)

@functools.wraps(func)
def wrapper(event, context, **handler_kwargs):
def wrapper(*args: Any, **kwargs: Any) -> Any:
try:
middleware = functools.partial(decorator, func, event, context, **kwargs, **handler_kwargs)
if decorator is None:
raise ValueError("Decorator cannot be None")
middleware = functools.partial(decorator, func, *args, **kwargs)
if trace_execution:
tracer = Tracer(auto_patch=False)
with tracer.provider.in_subsegment(name=f"## {decorator.__qualname__}"):
Expand All @@ -135,9 +145,11 @@ def wrapper(event, context, **handler_kwargs):
response = middleware()
return response
except Exception:
logger.exception(f"Caught exception in {decorator.__qualname__}")
logger.exception(
f"Caught exception in {decorator.__qualname__ if decorator is not None else 'UnknownDecorator'}",
)
raise

return wrapper
return cast(FuncType, wrapper)

return final_decorator
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def event_source(
event: Dict[str, Any],
context: LambdaContext,
data_class: Type[DictWrapper],
):
) -> Any:
"""Middleware to create an instance of the passed in event source data class

Parameters
Expand Down
Loading