Merge pull request #2 from KiraPC/class-depends-attributes

Introduce FastAPI Depends support

Author: KiraPC

README.md

@@ -13,18 +13,27 @@ pip install fastapi-router-controller
 In a Class module
 
 ```python
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends
 from fastapi_router_controller import Controller
 
 router = APIRouter()
 controller = Controller(router)
 
+async def amazing_fn():
+    return 'amazing_variable'
+
 @controller.resource()
 class ExampleController():
+    # you can define in the Controller init some FastApi Dependency and them are automatically loaded in controller methods
+    def __init__(self, x: Foo = Depends(amazing_fn)):
+        self.x = x
+    
     @controller.route.get(
         '/some_aoi', 
         summary='A sample description')
-    def sample_api(_):
+    def sample_api(self):
+        print(self.x) # -> amazing_variable
+        
         return 'A sample response'
 ```
 

example/sample_app/app.py

@@ -1,4 +1,6 @@
+import unittest
 from fastapi import FastAPI
+from fastapi.testclient import TestClient
 from fastapi_router_controller import ControllersTags
 from controller.sample_controller import SampleController
 from controller.sample_controller_2 import AnotherSampleController
@@ -14,4 +16,17 @@
 app.include_router(sample_controller.router())
 app.include_router(another_sample_controller.router())
 
-print(app.openapi())
+class TestRoutes(unittest.TestCase):
+    def setUp(self):
+        self.client = TestClient(app)
+
+    def test_get_sample_controller(self):
+        response = self.client.get("/sample_controller/?id=1234")
+        self.assertEqual(response.status_code, 200)
+
+    def test_post_sample_controller(self):
+        response = self.client.post("/sample_controller/", json={"id": "test"})
+        self.assertEqual(response.status_code, 201)
+
+if __name__ == "__main__":
+    unittest.main()

example/sample_app/controller/sample_controller.py

@@ -1,4 +1,4 @@
-from fastapi import APIRouter, status, Query, Body
+from fastapi import APIRouter, status, Query, Body, Depends
 from fastapi_router_controller import Controller
 from fastapi.responses import JSONResponse
 from pydantic import BaseModel, Field
@@ -12,20 +12,34 @@
 class SampleObject(BaseModel):
     id: str = Field(..., description='sample id')
 
+    def to_json(self):
+        return {'id': self.id}
+
+class Foo():
+    def create_foo(_, item):
+        print('Created Foo', str(item))
+
+def get_foo():
+    return Foo()
+
 # With the "resource" decorator define the controller Class linked to the Controller router arguments 
 @controller.resource()
 class SampleController():
+    def __init__(self, foo: Foo = Depends(get_foo)):
+        self.foo = foo
+
     @controller.route.get(
         '/',
         tags=['sample_controller'], 
         summary='return a sample object')
     def sample_get_request(self, id: str = Query(..., title="itemId", description="The id of the sample object")):
-        return JSONResponse(status_code=status.HTTP_200_OK, content=SampleObject(id))
+        return JSONResponse(status_code=status.HTTP_200_OK, content=SampleObject(**{'id': id}).to_json())
 
     @controller.route.post(
         '/', 
         tags=['sample_controller'], 
         summary='create another sample object', 
         status_code=201)
-    def sample_post_request(self, simple_object: SampleObject = Body(None, title="SampleObject", description="A sample object model")):
+    def sample_post_request(self, simple_object: SampleObject = Body({}, title="SampleObject", description="A sample object model")):
+        self.foo.create_foo(simple_object)
         return JSONResponse(status_code=status.HTTP_201_CREATED, content={})

example/sample_app_with_auto_import/app.py

@@ -1,4 +1,6 @@
+import unittest
 from fastapi import FastAPI
+from fastapi.testclient import TestClient
 from fastapi_router_controller import Controller, ControllersTags
 
 # just import the main package to load all the controllers in
@@ -13,4 +15,17 @@
 for router in Controller.routers():
     app.include_router(router)
 
-print(app.openapi())
+class TestRoutes(unittest.TestCase):
+    def setUp(self):
+        self.client = TestClient(app)
+
+    def test_get_sample_extended_controller(self):
+        response = self.client.get("/sample_extended_controller/?id=1234")
+        self.assertEqual(response.status_code, 200)
+
+    def test_get_sample_extended_controller_parent_api(self):
+        response = self.client.get("/sample_extended_controller/parent_api")
+        self.assertEqual(response.status_code, 200)
+
+if __name__ == "__main__":
+    unittest.main()

example/sample_app_with_auto_import/controller/sample_controller.py

@@ -14,6 +14,9 @@
 class SampleObject(BaseModel):
     id: str = Field(..., description='sample id')
 
+    def to_json(self):
+        return {'id': self.id}
+
 # With the "use" decorator the lib save the Controller Class to load it automatically
 @controller.use()
 # With the "resource" decorator define the controller Class linked to the Controller router arguments 
@@ -24,7 +27,7 @@ class SampleController(SampleParentController):
         tags=['sample_extended_controller'], 
         summary='return a sample object')
     def sample_get_request(self, id: str = Query(..., title="itemId", description="The id of the sample object")):
-        return JSONResponse(status_code=status.HTTP_200_OK, content=SampleObject(id))
+        return JSONResponse(status_code=status.HTTP_200_OK, content=SampleObject(**{'id': id}).to_json())
 
     @controller.route.post(
         '/', 

fastapi_router_controller/lib/controller.py

@@ -1,4 +1,5 @@
-from fastapi import APIRouter
+import inspect
+from fastapi import APIRouter, Depends
 
 OPEN_API_TAGS = []
 __app_controllers__ = []
@@ -32,7 +33,8 @@ class Controller():
 
         It expose some utilities and decorator functions to define a router controller class
     '''
-    router: APIRouter
+    RC_KEY = '__router__'
+    SIGNATURE_KEY = '__signature__'
 
     def __init__(self, router: APIRouter, openapi_tag: dict = None) -> None:
         '''
@@ -63,7 +65,8 @@ def resource(self):
             A decorator function to mark a Class as a Controller
         '''
         def wrapper(cls):
-            if hasattr(cls, '__router__'):
+            # check if cls was extended from another Controller
+            if hasattr(cls, Controller.RC_KEY):
                 self.__get_parent_routes(cls.__router__)
 
             cls.__router__ = self.router
@@ -87,12 +90,20 @@ def __parse_controller_router(controller):
         '''
             Private utility to parse the router controller property and extract the correct functions handlers
         '''
-        for route in controller.__router__.routes:
-            func = route.endpoint
-            if hasattr(func, '__get__'):
-                route.endpoint = func.__get__(controller, controller.__class__)
+        router = getattr(controller, Controller.RC_KEY)
+
+        for route in router.routes:
+            # get the signature of the endpoint function
+            signature = inspect.signature(route.endpoint)
+            # get the parameters of the endpoint function
+            signature_parameters = list(signature.parameters.values())
+
+            # replace the class instance with the itself FastApi Dependecy
+            signature_parameters[0] = signature_parameters[0].replace(default=Depends(controller.__class__))
+            new_signature = signature.replace(parameters=signature_parameters)
+            setattr(route.endpoint, Controller.SIGNATURE_KEY, new_signature)
 
-        return controller.__router__
+        return router
 
     @staticmethod
     def routers():