added options, head and routeprefix decorators

fixed dependencies syntax in pyproject.toml

Author: clickonben

pyproject.toml

@@ -17,6 +17,22 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
+dependencies = [
+  "annotated-types = 0.6.0",
+  "anyio = 4.2.0",
+  "click = 8.1.7",
+  "colorama = 0.4.6",
+  "fastapi = 0.109.0",
+  "h11 = 0.14.0",
+  "idna = 3.6",
+  "pydantic = 2.5.3",
+  "pydantic_core = 2.14.6",
+  "sniffio = 1.3.0",
+  "starlette = 0.35.1",
+  "typing_extensions = 4.9.0",
+  "uvicorn = 0.27.0"
+]
+
 [project.urls]
 Homepage = "https://github.com/codingflowdev/web-api-controllers"
 
@@ -28,17 +44,3 @@ exclude = ["src/app.py"]
 # Exclude app.py from the source distribution
 exclude = ["src/app.py"]
 
-[dependencies]
-annotated-types = "0.6.0"
-anyio = "4.2.0"
-click = "8.1.7"
-colorama = "0.4.6"
-fastapi = "0.109.0"
-h11 = "0.14.0"
-idna = "3.6"
-pydantic = "2.5.3"
-pydantic_core = "2.14.6"
-sniffio = "1.3.0"
-starlette = "0.35.1"
-typing_extensions = "4.9.0"
-uvicorn = "0.27.0"

src/app.py

@@ -1,7 +1,8 @@
 from fastapi import FastAPI
-from src.webapicontrollers import APIController, Get, Post
+from src.webapicontrollers import APIController, Get, Post, RoutePrefix
 
 
+#@RoutePrefix('/test')
 class TestController(APIController):
 
     def __init__(self, app: FastAPI) -> None:

src/webapicontrollers/__init__.py

@@ -5,3 +5,6 @@
 from .routing.delete import Delete
 from .routing.patch import Patch
 from .routing.route import Route
+from .routing.head import Head
+from .routing.options import Options
+from .routing.route_prefix import RoutePrefix

src/webapicontrollers/controllers/api_controller.py

@@ -10,33 +10,40 @@ class APIController:
     routes = []
 
     def __init__(self,
-                 app: FastAPI = None,
+                 app: FastAPI,
                  cors_origins=None,
+                 generate_options_endpoints=True,
+                 generate_head_endpoints=True
                  ) -> None:
-        if app is None:
-            app = FastAPI()
-        self.__app = app
+        self.__app = app        
+        self.__generate_options_endpoints = generate_options_endpoints
+        self.__generate_head_endpoints = generate_head_endpoints        
         if cors_origins is not None:
             self.__add_cors(cors_origins)
+
         self.__register_routes()
 
     def __register_routes(self) -> None:
         container = DIContainer(Registry())
         registry = container.get(Registry)
-        self.__routes = registry.get_routes()
+        self.__routes = registry.get_routes()        
+
         for func, path, method in self.__routes:
-            bound_method = getattr(self, func.__name__)
+            if hasattr(self,'_route_prefix'):
+                path = self._route_prefix + path
+            bound_method = getattr(self, func.__name__)            
             self.__add_route(bound_method, method, path)
 
-        self.__add_options_endpoints()
+        if self.__generate_options_endpoints:
+            self.__add_options_endpoints()
 
     def __add_route(self, bound_method, method, path):
         self.__app.add_api_route(
             path=path,
             endpoint=bound_method,
             methods=[method.value]
         )
-        if method.value == 'GET':
+        if method.value == 'GET' and self.__generate_head_endpoints:
             self.__add_head(path)
 
     def __add_head(self, path):

src/webapicontrollers/routing/__init__.py

@@ -5,3 +5,6 @@
 from .put import Put
 from .delete import Delete
 from .patch import Patch
+from .head import Head
+from .options import Options
+from .route_prefix import RoutePrefix

src/webapicontrollers/routing/head.py

@@ -0,0 +1,6 @@
+from .route import Route
+from ..enums import HTTPMethods
+
+class Head(Route):
+    def __init__(self, path: str):
+        super().__init__(path, HTTPMethods.HEAD)

src/webapicontrollers/routing/options.py

@@ -0,0 +1,6 @@
+from .route import Route
+from ..enums import HTTPMethods
+
+class Options(Route):
+    def __init__(self, path: str):
+        super().__init__(path, HTTPMethods.OPTIONS)

src/webapicontrollers/routing/route_prefix.py

@@ -0,0 +1,5 @@
+def RoutePrefix(prefix: str):
+    def decorator(cls):
+        cls._route_prefix = prefix
+        return cls
+    return decorator