changed interceptors to UseInterceptors

Author: eadwinCode

ellar/common/__init__.py

@@ -8,11 +8,11 @@
     Controller,
     Module,
     UseGuards,
+    UseInterceptors,
     Version,
     exception_handler,
     extra_args,
     file,
-    interceptors,
     middleware,
     openapi_info,
     render,
@@ -198,7 +198,7 @@
     "IInterceptorsConsumer",
     "IGuardsConsumer",
     "EllarInterceptor",
-    "interceptors",
+    "UseInterceptors",
 ]
 
 

ellar/common/decorators/__init__.py

@@ -7,7 +7,7 @@
 from .file import file
 from .guards import UseGuards
 from .html import render, template_filter, template_global
-from .interceptor import interceptors
+from .interceptor import UseInterceptors
 from .middleware import middleware
 from .modules import Module
 from .openapi import openapi_info
@@ -29,7 +29,7 @@
     "openapi_info",
     "Module",
     "extra_args",
-    "interceptors",
+    "UseInterceptors",
 ]
 
 

ellar/common/decorators/interceptor.py

@@ -8,15 +8,26 @@
     from ellar.common import EllarInterceptor
 
 
-def interceptors(
+def UseInterceptors(
     *args: t.Union[t.Type["EllarInterceptor"], "EllarInterceptor"]
 ) -> t.Callable:
     """
-    =========FUNCTION DECORATOR ==============
+    =========CONTROLLER AND FUNCTION DECORATOR ==============
 
-    Programmatically adds extra route function parameter.
-    see https://github.com/eadwinCode/ellar/blob/main/tests/test_routing/test_extra_args.py for usages
-    :param args: Collection EllarInterceptor
+    Decorator that binds interceptors to the scope of the controller or method,
+    depending on its context.
+
+    When `@UseInterceptors` is used at the controller level, the interceptor will
+    be applied to every handler (method) in the controller.
+
+    When `@UseInterceptors` is used at the individual handler level, the interceptor
+    will apply only to that specific method.
+
+    Note
+    Interceptors can also be set up globally for all controllers and routes
+    using `app.use_global_interceptors()`.
+
+    :param args: A single EllarInterceptor instance or class, or a list of EllarInterceptor instances or classes.
     :return:
     """
     return set_meta(ROUTE_INTERCEPTORS, list(args))

ellar/common/decorators/middleware.py

@@ -16,7 +16,7 @@ def middleware() -> t.Callable:
     """
     ========= MODULE DECORATOR ==============
 
-    Defines middle functions at module level
+    Defines middleware functions at  @Module decorated class level
     :return: Function
     """
 

tests/test_interceptors/test_interceptor.py

@@ -5,8 +5,8 @@
     ControllerBase,
     EllarInterceptor,
     IExecutionContext,
+    UseInterceptors,
     get,
-    interceptors,
     ws_route,
 )
 from ellar.di import injectable
@@ -41,19 +41,19 @@ async def intercept(
             return {"message": str(cex)}
 
 
+@UseInterceptors(Interceptor1)
 @Controller("")
 class InterceptorControllerTest(ControllerBase):
-    @interceptors(Interceptor1)
+    @UseInterceptors(Interceptor1)
     @get("/interceptor-1")
     async def interceptor_1(self):
         return {"message": "intercepted okay"}
 
-    @interceptors(InterceptCustomException())
+    @UseInterceptors(InterceptCustomException())
     @get("/interceptor-exception")
     async def interceptor_exception(self):
         raise CustomException("Wrong data!!")
 
-    @interceptors(Interceptor1)
     @ws_route("/interceptor-ws")
     async def interceptor_1_ws(self):
         ws = self.context.switch_to_websocket().get_client()