-
Notifications
You must be signed in to change notification settings - Fork 473
feat(event_handler): add Dependency injection with Depends() #8128
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
Open
leandrodamascena
wants to merge
7
commits into
develop
Choose a base branch
from
feat/8099-dependency-injection
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
53402b9
feat: add Dependency injection feature
leandrodamascena 0fde368
Merging from develop
leandrodamascena 0ee7308
Merging from develop
leandrodamascena 67f9034
feat: add Dependency injection feature
leandrodamascena 4b463a9
feat: add Dependency injection feature
leandrodamascena 15f7ea1
feat: add Dependency injection feature
leandrodamascena 5f579bc
feat: add Dependency injection feature
leandrodamascena File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,222 @@ | ||
| """Lightweight dependency injection primitives — no pydantic import.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import TYPE_CHECKING, Annotated, Any, get_args, get_origin, get_type_hints | ||
|
|
||
| if TYPE_CHECKING: | ||
| from collections.abc import Callable | ||
|
|
||
| from aws_lambda_powertools.event_handler.openapi.params import Dependant | ||
| from aws_lambda_powertools.event_handler.request import Request | ||
|
|
||
|
|
||
| class DependencyResolutionError(Exception): | ||
| """Raised when a dependency cannot be resolved.""" | ||
|
|
||
|
|
||
| class Depends: | ||
| """ | ||
| Declares a dependency for a route handler parameter. | ||
|
|
||
| Dependencies are resolved automatically before the handler is called. The return value | ||
| of the dependency callable is injected as the parameter value. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| dependency: Callable[..., Any] | ||
| A callable whose return value will be injected into the handler parameter. | ||
| The callable can itself declare ``Depends()`` parameters to form a dependency tree. | ||
| use_cache: bool | ||
| If ``True`` (default), the dependency result is cached per invocation so that | ||
| the same dependency used multiple times is only called once. | ||
|
|
||
| Examples | ||
| -------- | ||
|
|
||
| ```python | ||
| from typing import Annotated | ||
|
|
||
| from aws_lambda_powertools.event_handler import APIGatewayHttpResolver, Depends | ||
|
|
||
| app = APIGatewayHttpResolver() | ||
|
|
||
| def get_tenant() -> str: | ||
| return "default-tenant" | ||
|
|
||
| @app.get("/orders") | ||
| def list_orders(tenant_id: Annotated[str, Depends(get_tenant)]): | ||
| return {"tenant": tenant_id} | ||
| ``` | ||
| """ | ||
|
|
||
| def __init__(self, dependency: Callable[..., Any], *, use_cache: bool = True) -> None: | ||
| if not callable(dependency): | ||
| raise DependencyResolutionError( | ||
| f"Depends() requires a callable, got {type(dependency).__name__}: {dependency!r}", | ||
| ) | ||
| self.dependency = dependency | ||
| self.use_cache = use_cache | ||
|
|
||
|
|
||
| class _DependencyNode: | ||
| """Lightweight node in a dependency tree — used by ``build_dependency_tree``.""" | ||
|
|
||
| def __init__(self, *, param_name: str, depends: Depends, sub_tree: DependencyTree) -> None: | ||
| self.param_name = param_name | ||
| self.depends = depends | ||
| self.dependant = sub_tree | ||
|
|
||
|
|
||
| class DependencyTree: | ||
| """Lightweight dependency tree — no pydantic required. | ||
|
|
||
| This mirrors the shape that ``solve_dependencies`` expects (a ``.dependencies`` | ||
| attribute containing nodes with ``.param_name``, ``.depends``, and ``.dependant``), | ||
| but can be built without importing pydantic. | ||
| """ | ||
|
|
||
| def __init__(self, *, dependencies: list[_DependencyNode] | None = None) -> None: | ||
| self.dependencies: list[_DependencyNode] = dependencies or [] | ||
|
|
||
|
|
||
| class DependencyParam: | ||
| """Holds a dependency's parameter name and its resolved Dependant sub-tree (OpenAPI path).""" | ||
|
|
||
| def __init__(self, *, param_name: str, depends: Depends, dependant: Dependant) -> None: | ||
| self.param_name = param_name | ||
| self.depends = depends | ||
| self.dependant = dependant | ||
|
|
||
|
|
||
| def _get_depends_from_annotation(annotation: Any) -> Depends | None: | ||
| """Extract a Depends instance from an Annotated[Type, Depends(...)] annotation.""" | ||
| if get_origin(annotation) is Annotated: | ||
| for arg in get_args(annotation)[1:]: | ||
| if isinstance(arg, Depends): | ||
| return arg | ||
| return None | ||
|
|
||
|
|
||
| def _has_depends(func: Callable[..., Any]) -> bool: | ||
| """Check if a callable has any Depends() parameters, without importing pydantic.""" | ||
| try: | ||
| hints = get_type_hints(func, include_extras=True) | ||
| except Exception: | ||
| return False | ||
|
|
||
| for annotation in hints.values(): | ||
| if _get_depends_from_annotation(annotation) is not None: | ||
| return True | ||
| return False | ||
|
|
||
|
|
||
| def build_dependency_tree(func: Callable[..., Any]) -> DependencyTree: | ||
| """Build a lightweight dependency tree from a callable's signature. | ||
|
|
||
| This inspects the function parameters for ``Annotated[Type, Depends(...)]`` | ||
| annotations and recursively builds the tree — all without importing pydantic. | ||
| """ | ||
| try: | ||
| hints = get_type_hints(func, include_extras=True) | ||
| except Exception: | ||
| return DependencyTree() | ||
|
|
||
| dependencies: list[_DependencyNode] = [] | ||
|
|
||
| for param_name, annotation in hints.items(): | ||
| if param_name == "return": | ||
| continue | ||
|
|
||
| depends_instance = _get_depends_from_annotation(annotation) | ||
| if depends_instance is not None: | ||
| sub_tree = build_dependency_tree(depends_instance.dependency) | ||
| dependencies.append( | ||
| _DependencyNode( | ||
| param_name=param_name, | ||
| depends=depends_instance, | ||
| sub_tree=sub_tree, | ||
| ), | ||
| ) | ||
|
|
||
| return DependencyTree(dependencies=dependencies) | ||
|
|
||
|
|
||
| def solve_dependencies( | ||
|
Check failure on line 145 in aws_lambda_powertools/event_handler/depends.py
|
||
| *, | ||
| dependant: Dependant | DependencyTree, | ||
| request: Request | None = None, | ||
| dependency_overrides: dict[Callable[..., Any], Callable[..., Any]] | None = None, | ||
| dependency_cache: dict[Callable[..., Any], Any] | None = None, | ||
| ) -> dict[str, Any]: | ||
| """ | ||
| Recursively resolve all ``Depends()`` parameters for a given dependant. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| dependant: Dependant | ||
| The dependant model containing dependency declarations | ||
| request: Request, optional | ||
| The current request object, injected into dependencies that declare a Request parameter | ||
| dependency_overrides: dict, optional | ||
| Mapping of original dependency callable to override callable (for testing) | ||
| dependency_cache: dict, optional | ||
| Per-invocation cache of resolved dependency values | ||
|
|
||
| Returns | ||
| ------- | ||
| dict[str, Any] | ||
| Mapping of parameter name to resolved dependency value | ||
| """ | ||
| from aws_lambda_powertools.event_handler.request import Request as RequestClass | ||
|
|
||
| if dependency_cache is None: | ||
| dependency_cache = {} | ||
|
|
||
| values: dict[str, Any] = {} | ||
|
|
||
| for dep in dependant.dependencies: | ||
| use_fn = dep.depends.dependency | ||
|
|
||
| # Apply overrides (for testing) | ||
| if dependency_overrides and use_fn in dependency_overrides: | ||
| use_fn = dependency_overrides[use_fn] | ||
|
|
||
| # Check cache | ||
| if dep.depends.use_cache and use_fn in dependency_cache: | ||
| values[dep.param_name] = dependency_cache[use_fn] | ||
| continue | ||
|
|
||
| # Recursively resolve sub-dependencies | ||
| sub_values = solve_dependencies( | ||
| dependant=dep.dependant, | ||
| request=request, | ||
| dependency_overrides=dependency_overrides, | ||
| dependency_cache=dependency_cache, | ||
| ) | ||
|
|
||
| # Inject Request if the dependency declares it | ||
| if request is not None: | ||
| try: | ||
| hints = get_type_hints(use_fn) | ||
| except Exception: # pragma: no cover - defensive for broken annotations | ||
| hints = {} | ||
| for param_name, annotation in hints.items(): | ||
| if annotation is RequestClass: | ||
| sub_values[param_name] = request | ||
|
|
||
| try: | ||
| solved = use_fn(**sub_values) | ||
| except Exception as exc: | ||
| dep_name = getattr(use_fn, "__name__", repr(use_fn)) | ||
| raise DependencyResolutionError( | ||
| f"Failed to resolve dependency '{dep_name}' for parameter '{dep.param_name}': {exc}", | ||
| ) from exc | ||
|
|
||
| # Cache result | ||
| if dep.depends.use_cache: | ||
| dependency_cache[use_fn] = solved | ||
|
|
||
| values[dep.param_name] = solved | ||
|
|
||
| return values | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just for my own curioisty, are mimicking the Pydantic interface here so that it stays compatible without us having to actually subclass any Pydantic classes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep! I'm mimicking the Pydantic Dependant class, so
solve_dependenciescan works seamlessly with both:1/
DependencyTree(no pydantic needed) - Customers can use Depends without Pydantic.2/
Dependant(when pydantic is installed for OpenAPI).This way this feature works regardless of whether customers have pydantic installed or not.