Added some Route Handler args resolver

Author: eadwinCode

ellar/common/__init__.py

@@ -32,10 +32,14 @@
     File,
     Form,
     Header,
+    Host,
+    Http,
     Path,
     Provide,
     Query,
     Req,
+    Res,
+    Session,
     Ws,
     WsBody,
 )
@@ -81,4 +85,8 @@
     "on_startup",
     "template_filter",
     "template_global",
+    "Res",
+    "Session",
+    "Host",
+    "Http",
 ]

ellar/common/decorators/controller.py

@@ -100,7 +100,7 @@ def Controller(
     :param description: OPENAPI description
     :param external_doc_description: OPENAPI External Doc Description
     :param external_doc_url: OPENAPI External Document URL
-    :param name: route name prefix for url reversing, eg name:route_name default=''
+    :param name: route name prefix for url reversing, eg name:route_name default=controller_name
     :param version: default URL versioning for all defined route in a controller
     :param guards: default guard for all routes defined under this controller
     :param include_in_schema: include controller in OPENAPI schema
@@ -114,7 +114,7 @@ def Controller(
         assert _prefix == "" or str(_prefix).startswith(
             "/"
         ), "Controller Prefix must start with '/'"
-
+    # TODO: replace with a ControllerTypeDict and OpenAPITypeDict
     kwargs = AttributeDict(
         openapi=AttributeDict(
             tag=tag,

ellar/common/routing/__init__.py

@@ -8,10 +8,14 @@
     File,
     Form,
     Header,
+    Host,
+    Http,
     Path,
     Provide,
     Query,
     Req,
+    Res,
+    Session,
     Ws,
     WsBody,
 )
@@ -58,4 +62,8 @@
     "head",
     "http_route",
     "ws_route",
+    "Res",
+    "Session",
+    "Host",
+    "Http",
 ]

ellar/common/routing/params.py

@@ -2,11 +2,13 @@
 
 from pydantic.error_wrappers import ErrorWrapper
 from pydantic.fields import Undefined
+from starlette.responses import Response
 
-from ellar.core.connection import Request, WebSocket
+from ellar.core.connection import HTTPConnection, Request, WebSocket
 from ellar.core.context import IExecutionContext
 from ellar.core.params import params
 from ellar.core.params.resolvers import (
+    BaseRequestRouteParameterResolver,
     NonFieldRouteParameterResolver,
     ParameterInjectable,
 )
@@ -368,6 +370,49 @@ async def resolve(
         return {self.parameter_name: ctx}, []
 
 
+class _HostRequestParam(BaseRequestRouteParameterResolver):
+    lookup_connection_field = None
+
+    async def get_value(self, ctx: IExecutionContext) -> t.Any:
+        connection = ctx.switch_to_http_connection()
+        if connection.client:
+            return connection.client.host
+
+
+class _SessionRequestParam(BaseRequestRouteParameterResolver):
+    lookup_connection_field = "session"
+
+
+class _ConnectionParam(NonFieldRouteParameterResolver):
+    async def resolve(
+        self, ctx: IExecutionContext, **kwargs: t.Any
+    ) -> t.Tuple[t.Dict, t.List]:
+        try:
+            connection = ctx.switch_to_http_connection()
+            return {self.parameter_name: connection}, []
+        except Exception as ex:
+            return {}, [ErrorWrapper(ex, loc=self.parameter_name or "connection")]
+
+
+class _ResponseRequestParam(NonFieldRouteParameterResolver):
+    async def resolve(
+        self, ctx: IExecutionContext, **kwargs: t.Any
+    ) -> t.Tuple[t.Dict, t.List]:
+        try:
+            response = ctx.get_response()
+            return {self.parameter_name: response}, []
+        except Exception as ex:
+            return {}, [ErrorWrapper(ex, loc=self.parameter_name or "response")]
+
+
+def Http() -> HTTPConnection:
+    """
+    Route Function Parameter for retrieving Current Request Instance
+    :return: Request
+    """
+    return t.cast(Request, _ConnectionParam())
+
+
 def Req() -> Request:
     """
     Route Function Parameter for retrieving Current Request Instance
@@ -398,3 +443,28 @@ def Provide(service: t.Optional[t.Type[T]] = None) -> T:
     :return: T
     """
     return t.cast(T, ParameterInjectable(service))
+
+
+def Session() -> t.Dict:
+    """
+    Route Function Parameter for resolving registered `HTTPConnection.sessions`
+    Ensure SessionMiddleware is registered to application middlewares
+    :return: Dict
+    """
+    return t.cast(t.Dict, _SessionRequestParam())
+
+
+def Host() -> str:
+    """
+    Route Function Parameter for resolving registered `HTTPConnection.client.host`
+    :return: str
+    """
+    return t.cast(str, _HostRequestParam())
+
+
+def Res() -> Response:
+    """
+    Route Function Parameter for resolving registered Response
+    :return: Response
+    """
+    return t.cast(Response, _ResponseRequestParam())

ellar/core/params/__init__.py

@@ -5,14 +5,20 @@
     WebsocketEndpointArgsModel,
 )
 from .params import Body, Cookie, File, Form, Header, Param, ParamTypes, Path, Query
-from .resolvers import NonFieldRouteParameterResolver
+from .resolvers import (
+    BaseRequestRouteParameterResolver,
+    BaseRouteParameterResolver,
+    NonFieldRouteParameterResolver,
+)
 
 __all__ = [
     "WebsocketEndpointArgsModel",
     "RequestEndpointArgsModel",
     "ExtraEndpointArg",
     "EndpointArgsModel",
     "NonFieldRouteParameterResolver",
+    "BaseRequestRouteParameterResolver",
+    "BaseRouteParameterResolver",
     "Body",
     "Cookie",
     "File",