Merge pull request #209 from python-ellar/may_patch

May 22/24 patches

Author: eadwinCode

ellar/app/factory.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 import click
-from ellar.common import Module
+from ellar.common import IApplicationReady, Module
 from ellar.common.constants import MODULE_METADATA, MODULE_WATERMARK
 from ellar.common.models import GuardCanActivate
 from ellar.core import Config, DynamicModule, LazyModuleImport, ModuleBase, ModuleSetup
@@ -174,6 +174,13 @@ def _get_config_kwargs() -> t.Dict:
 
         # app.setup_jinja_environment
         app.setup_jinja_environment()
+
+        for module, module_ref in app.injector.get_modules().items():
+            module_ref.run_module_register_services()
+
+            if issubclass(module, IApplicationReady):
+                app.injector.get(module).on_ready(app)
+
         return app
 
     @classmethod

ellar/app/lifespan.py

@@ -30,8 +30,7 @@ def __init__(
         )
 
     def _get_startup_modules(self, app: "App") -> t.Iterator[IApplicationStartup]:
-        for module, module_ref in app.injector.get_modules().items():
-            module_ref.run_module_register_services()
+        for module in app.injector.get_modules():
             if issubclass(module, IApplicationStartup):
                 yield app.injector.get(module)
 

ellar/common/__init__.py

@@ -30,6 +30,7 @@
     WebSocketException,
 )
 from .interfaces import (
+    IApplicationReady,
     IApplicationShutdown,
     IApplicationStartup,
     IExceptionHandler,
@@ -185,6 +186,7 @@
     "IApplicationStartup",
     "IApplicationShutdown",
     "IIdentitySchemes",
+    "IApplicationReady",
 ]
 
 

ellar/common/interfaces/__init__.py

@@ -1,4 +1,4 @@
-from .application import IApplicationShutdown, IApplicationStartup
+from .application import IApplicationReady, IApplicationShutdown, IApplicationStartup
 from .context import (
     IExecutionContext,
     IExecutionContextFactory,
@@ -41,4 +41,5 @@
     "IAPIVersioningResolver",
     "IEllarMiddleware",
     "IIdentitySchemes",
+    "IApplicationReady",
 ]

ellar/common/interfaces/application.py

@@ -6,12 +6,30 @@
 
 
 class IApplicationStartup:
+    """
+    Module Interface called during application LifeSpan starts up
+    """
+
     @abstractmethod
     async def on_startup(self, app: "App") -> None:
         """Application Startup Actions"""
 
 
 class IApplicationShutdown:
+    """
+    Module Interface called during application LifeSpan shutdown
+    """
+
     @abstractmethod
     async def on_shutdown(self) -> None:
         """Application Shutdown Actions"""
+
+
+class IApplicationReady:
+    """
+    Module Interface called when all modules have been registered just before lifespan execution starts
+    """
+
+    @abstractmethod
+    def on_ready(self, app: "App") -> None:
+        """Application Shutdown Actions"""

ellar/common/params/resolvers/bulk_parameter.py

@@ -82,12 +82,14 @@ async def resolve_grouped_fields(
         request_logger.debug(
             f"Resolving Form Grouped Field - '{self.__class__.__name__}'"
         )
-        value, resolver_errors = await self._get_resolver_data(ctx, body, by_alias=True)
+        values, resolver_errors = await self._get_resolver_data(
+            ctx, body, by_alias=True
+        )
         if resolver_errors:
-            return value, resolver_errors
+            return values, resolver_errors
         # Combining resolved values into one pydantic model specified by the user in Route function parameter
         processed_value, processed_errors = self.model_field.validate(
-            value,
+            values,
             {},
             loc=(self.model_field.field_info.in_.value, self.model_field.alias),
         )
@@ -148,4 +150,4 @@ async def resolve_handle(
             return values, self.validate_error_sequence(errors)
 
         _, body_value = values.popitem()
-        return body_value.dict(), []
+        return {k: getattr(body_value, k) for k in body_value.model_fields_set}, []

ellar/common/templating/renderer.py

@@ -41,22 +41,32 @@ def render_template_string(
     :param template_string: Template String
     :param template_context: variables that should be available in the context of the template.
     """
-    jinja_environment = request.service_provider.get(Environment)
-    jinja_template = jinja_environment.from_string(template_string)
+    try:
+        jinja_template, template_context_ = _get_jinja_and_template_context(
+            template_name=template_string,
+            request=request,
+            **process_view_model(template_context),
+        )
+        return jinja_template.render(template_context_)
+    except jinja2.TemplateNotFound:
+        jinja_environment = request.service_provider.get(Environment)
+        jinja_template = jinja_environment.from_string(template_string)
 
-    _template_context = dict(template_context)
-    _template_context.update(request=request)
+        _template_context = dict(template_context)
+        _template_context.update(request=request)
 
-    return jinja_template.render(_template_context)  # type:ignore[no-any-return]
+        return jinja_template.render(_template_context)
 
 
 def render_template(
     template_name: str,
     request: "Request",
     background: t.Optional[BackgroundTask] = None,
+    status_code: int = 200,
     **template_kwargs: t.Any,
 ) -> TemplateResponse:
     """Renders a template from the template folder with the given context.
+    :param status_code: Template Response status code
     :param request: Request instance
     :param template_name: the name of the template to be rendered
     :param template_kwargs: variables that should be available in the context of the template.
@@ -69,5 +79,8 @@ def render_template(
         **process_view_model(template_kwargs),
     )
     return TemplateResponse(
-        template=jinja_template, context=template_context, background=background
+        template=jinja_template,
+        context=template_context,
+        background=background,
+        status_code=status_code,
     )

ellar/testing/module.py

@@ -50,17 +50,14 @@ def override_provider(
     def create_application(self) -> App:
         if self._app:
             return self._app
+
         self._app = AppFactory.create_app(
             modules=[self._testing_module],
             global_guards=self._global_guards,
             config_module=self._config_module,
             providers=self._providers,
         )
 
-        for _, module_ref in self._app.injector.get_modules().items():
-            # setup module just in case lifespan function will not be called during testing.
-            module_ref.run_module_register_services()
-
         return self._app
 
     def get_test_client(

tests/test_modules/test_module_startup_shutdown.py

@@ -1,6 +1,12 @@
 from contextlib import asynccontextmanager
 
-from ellar.common import IApplicationShutdown, IApplicationStartup, Module, ModuleRouter
+from ellar.common import (
+    IApplicationReady,
+    IApplicationShutdown,
+    IApplicationStartup,
+    Module,
+    ModuleRouter,
+)
 from ellar.testing import Test
 
 router = ModuleRouter("")
@@ -29,6 +35,15 @@ async def on_shutdown(self) -> None:
         self.on_shutdown_called = True
 
 
+@Module()
+class OnApplicationReadyModule(IApplicationReady):
+    def __init__(self):
+        self.on_ready_called = False
+
+    def on_ready(self, app) -> None:
+        self.on_ready_called = True
+
+
 @asynccontextmanager
 async def _testing_life_span(app):
     yield {"life_span_testing": "Ellar"}
@@ -40,6 +55,15 @@ async def _testing_life_span(app):
 )
 
 
+def test_on_ready_works():
+    _tm = Test.create_test_module(
+        modules=[OnApplicationReadyModule],
+        config_module={"DEFAULT_LIFESPAN_HANDLER": _testing_life_span},
+    )
+    on_ready_module_instance = _tm.get(OnApplicationReadyModule)
+    assert on_ready_module_instance.on_ready_called
+
+
 def test_on_startup_and_on_shutdown_works():
     client = tm.get_test_client()
     on_shutdown_module_instance = tm.get(OnShutdownModule)

tests/test_templating/test_renderer.py

@@ -40,6 +40,14 @@ def another_index(self, first_name: str, last_name: str):
             last_name=last_name,
         )
 
+    @get("/render-as-string")
+    def render_template_as_string(self):
+        """Render template as string with template name"""
+        return render_template_string(
+            request=self.context.switch_to_http_connection().get_request(),
+            template_string="index.html",
+        )
+
 
 @Controller(prefix="/template-static")
 class TemplateWithStaticsController(ControllerBase):
@@ -74,6 +82,18 @@ def test_render_template():
     )
 
 
+def test_render_template_as_string_from_template_name():
+    client = tm.get_test_client()
+
+    response = client.get("/ellar/render-as-string")
+    assert response.status_code == 200
+
+    content = re.sub("\\s+", " ", response.text).strip()
+    assert (
+        "<title>Index Page</title>\\n</head>\\n<body>\\n\\n</body>\\n</html>" in content
+    )
+
+
 def test_ellar_controller_index():
     client = tm.get_test_client()
     response = client.get("/ellar/index")