Swap registration from a function of blueprints to a function of the app

Author: Brian Villemarette

aws_lambda_powertools/event_handler/api_gateway.py

@@ -631,12 +631,17 @@ def _to_response(self, result: Union[Dict, Response]) -> Response:
     def _json_dump(self, obj: Any) -> str:
         return self._serializer(obj)
 
+    def register_blueprint(self, blueprint: "Blueprint") -> None:
+        """Adds all routes defined in a blueprint"""
+        for route, func in blueprint.api.items():
+            self.route(*route)(func(app=self))
+
 
 class Blueprint:
     """Blueprint helper class to allow splitting ApiGatewayResolver into multiple files"""
 
     def __init__(self):
-        self._api: Dict[tuple, Callable] = {}
+        self.api: Dict[tuple, Callable] = {}
 
     def route(
         self,
@@ -656,9 +661,9 @@ def inner_wrapper():
 
             if isinstance(method, (list, tuple)):
                 for item in method:
-                    self._api[(rule, item, cors, compress, cache_control)] = wrapper
+                    self.api[(rule, item, cors, compress, cache_control)] = wrapper
             else:
-                self._api[(rule, method, cors, compress, cache_control)] = wrapper
+                self.api[(rule, method, cors, compress, cache_control)] = wrapper
 
         return actual_decorator
 
@@ -680,8 +685,3 @@ def patch(
         self, rule: str, cors: Optional[bool] = None, compress: bool = False, cache_control: Optional[str] = None
     ):
         return self.route(rule, "PATCH", cors, compress, cache_control)
-
-    def register_to_app(self, app: ApiGatewayResolver):
-        """Bind a blueprint object to an existing ApiGatewayResolver instance"""
-        for route, func in self._api.items():
-            app.route(*route)(func(app=app))

tests/functional/event_handler/test_api_gateway.py

@@ -872,7 +872,7 @@ def test_api_gateway_app_proxy():
     def foo(app):
         return {}
 
-    blueprint.register_to_app(app)
+    app.register_blueprint(blueprint)
     # WHEN calling the event handler after applying routes from blueprint object
     result = app(LOAD_GW_EVENT, {})