Merge pull request #81 from eadwinCode/starlette_upgrade

Starlette Upgrade

Author: eadwinCode

docs/basics/testing.md

@@ -246,10 +246,19 @@ During testing, there two ways to apply or modify configuration.
             test_module = Test.create_test_module(
                 controllers=[CarController,], 
                 providers=[ProviderConfig(CarRepository, use_class=CarRepository)],
-                config_module='project_name.config.TestingConfiguration'
+                config_module='project_name.config:TestingConfiguration'
             )
             self.controller: CarController = test_module.get(CarController)
     ```
+    Also, we can expose the testing config to environment for more global scope, for example:
+    
+    ```python
+    # project_name/tests/conftest.py
+    import os
+    from ellar.constants import ELLAR_CONFIG_MODULE
+    os.environ.setdefault(ELLAR_CONFIG_MODULE, 'project_name.config:TestingConfiguration')
+    ```
+
 === "Inline"
     This method doesn't require configuration file, we simply go ahead and define the configuration variables in a dictionary type set to `config_module`. 
 

ellar/common/__init__.py

@@ -13,8 +13,6 @@
     extra_args,
     file,
     middleware,
-    on_shutdown,
-    on_startup,
     openapi_info,
     render,
     serializer_filter,
@@ -89,8 +87,6 @@
     "middleware",
     "exception_handler",
     "serializer_filter",
-    "on_shutdown",
-    "on_startup",
     "template_filter",
     "template_global",
     "Res",

ellar/common/decorators/__init__.py

@@ -11,7 +11,6 @@
 from .middleware import middleware
 from .modules import Module
 from .openapi import openapi_info
-from .request import on_shutdown, on_startup
 from .serializer import serializer_filter
 from .versioning import Version
 
@@ -24,9 +23,7 @@
     "template_global",
     "file",
     "render",
-    "on_startup",
     "exception_handler",
-    "on_shutdown",
     "command",
     "set_metadata",
     "middleware",

ellar/common/decorators/request.py

@@ -64,9 +64,6 @@ def __new__(mcls, name, bases, namespace):
 RESPONSE_OVERRIDE_KEY = "RESPONSE_OVERRIDE"
 EXCEPTION_HANDLERS_KEY = "EXCEPTION_HANDLERS"
 
-ON_REQUEST_STARTUP_KEY = "ON_REQUEST_STARTUP"
-ON_REQUEST_SHUTDOWN_KEY = "ON_REQUEST_SHUTDOWN"
-
 TEMPLATE_GLOBAL_KEY = "TEMPLATE_GLOBAL_FILTERS"
 TEMPLATE_FILTER_KEY = "TEMPLATE_FILTERS"
 

ellar/constants.py

@@ -11,19 +11,15 @@
 from ellar.serializer import Serializer, SerializerFilter
 from ellar.types import ASGIApp, TReceive, TScope, TSend
 
-from .mixins import (
-    ConfigDefaultTypesMixin,
-    TEventHandler,
-    TExceptionHandler,
-    TMiddleware,
-    TVersioning,
-)
+from .mixins import ConfigDefaultTypesMixin, TExceptionHandler, TMiddleware, TVersioning
 
 if t.TYPE_CHECKING:  # pragma: no cover
     from ellar.core.main import App
 
 
-async def _not_found(scope: TScope, receive: TReceive, send: TSend) -> None:
+async def _not_found(
+    scope: TScope, receive: TReceive, send: TSend
+) -> None:  # pragma: no cover
     if scope["type"] == "websocket":
         websocket_close = WebSocketClose()
         await websocket_close(scope, receive, send)
@@ -113,9 +109,6 @@ class Config:
     # logging Level
     LOG_LEVEL: t.Optional[log_levels] = log_levels.info
 
-    ON_REQUEST_STARTUP: t.List[TEventHandler] = []
-    ON_REQUEST_SHUTDOWN: t.List[TEventHandler] = []
-
     TEMPLATE_FILTERS: t.Dict[str, t.Callable[..., t.Any]] = {}
     TEMPLATE_GLOBAL_FILTERS: t.Dict[str, t.Callable[..., t.Any]] = {}
 

ellar/core/conf/app_settings_models.py

@@ -8,7 +8,6 @@
 from ellar.core.exceptions.interfaces import IExceptionHandler
 from ellar.core.middleware import Middleware
 from ellar.core.versioning import BaseAPIVersioning
-from ellar.events import EventHandler
 
 if t.TYPE_CHECKING:  # pragma: no cover
     from ellar.core import App
@@ -17,7 +16,6 @@
     "ConfigDefaultTypesMixin",
     "TVersioning",
     "TMiddleware",
-    "TEventHandler",
     "TExceptionHandler",
 ]
 
@@ -70,18 +68,18 @@ def validate(cls: t.Type["Middleware"], v: t.Any) -> t.Any:
         return v
 
 
-class TEventHandler(EventHandler):
-    @classmethod
-    def __get_validators__(
-        cls: t.Type["TEventHandler"],
-    ) -> t.Iterable[t.Callable[..., t.Any]]:
-        yield cls.validate
-
-    @classmethod
-    def validate(cls: t.Type["EventHandler"], v: t.Any) -> t.Any:
-        if not isinstance(v, EventHandler):
-            raise ValueError(f"Expected EventHandler, received: {type(v)}")
-        return v
+# class TEventHandler(EventHandler):
+#     @classmethod
+#     def __get_validators__(
+#         cls: t.Type["TEventHandler"],
+#     ) -> t.Iterable[t.Callable[..., t.Any]]:
+#         yield cls.validate
+#
+#     @classmethod
+#     def validate(cls: t.Type["EventHandler"], v: t.Any) -> t.Any:
+#         if not isinstance(v, EventHandler):
+#             raise ValueError(f"Expected EventHandler, received: {type(v)}")
+#         return v
 
 
 class ConfigDefaultTypesMixin:
@@ -126,12 +124,6 @@ class ConfigDefaultTypesMixin:
     # defines other custom json encoders
     SERIALIZER_CUSTOM_ENCODER: t.Dict[t.Any, t.Callable[[t.Any], t.Any]]
 
-    # will be set automatically when @on_startup is found in a Module class
-    ON_REQUEST_STARTUP: t.List[TEventHandler]
-
-    # will be set automatically when @on_shutdown is found in a Module class
-    ON_REQUEST_SHUTDOWN: t.List[TEventHandler]
-
     # will be set automatically when @template_filter is found in a Module class
     TEMPLATE_FILTERS: t.Dict[str, t.Callable[..., t.Any]]
 

ellar/core/conf/mixins.py

@@ -137,14 +137,9 @@ def _get_config_kwargs() -> t.Dict:
 
         cls._build_modules(app_module=module, injector=injector, config=config)
 
-        shutdown_event = config.ON_REQUEST_STARTUP
-        startup_event = config.ON_REQUEST_SHUTDOWN
-
         app = App(
             config=config,
             injector=injector,
-            on_shutdown_event_handlers=shutdown_event if shutdown_event else None,
-            on_startup_event_handlers=startup_event if startup_event else None,
             lifespan=config.DEFAULT_LIFESPAN_HANDLER,
             global_guards=global_guards,
         )

ellar/core/factory.py

@@ -29,7 +29,6 @@
 from ellar.core.templating import AppTemplating, Environment
 from ellar.core.versioning import BaseAPIVersioning, VersioningSchemes
 from ellar.di.injector import EllarInjector
-from ellar.events import EventHandler, RouterEventManager
 from ellar.logger import logger
 from ellar.types import ASGIApp, T, TReceive, TScope, TSend
 
@@ -41,8 +40,6 @@ def __init__(
         self,
         config: "Config",
         injector: EllarInjector,
-        on_startup_event_handlers: t.Optional[t.Sequence[EventHandler]] = None,
-        on_shutdown_event_handlers: t.Optional[t.Sequence[EventHandler]] = None,
         lifespan: t.Optional[t.Callable[["App"], t.AsyncContextManager]] = None,
         global_guards: t.List[
             t.Union[t.Type[GuardCanActivate], GuardCanActivate]
@@ -53,12 +50,6 @@ def __init__(
             injector, EllarInjector
         ), "injector must instance of EllarInjector"
 
-        # The lifespan context function is a newer style that replaces
-        # on_startup / on_shutdown handlers. Use one or the other, not both.
-        assert lifespan is None or (
-            on_startup_event_handlers is None and on_shutdown_event_handlers is None
-        ), "Use either 'lifespan' or 'on_startup'/'on_shutdown', not both."
-
         self._config = config
         self._injector: EllarInjector = injector
 
@@ -67,15 +58,6 @@ def __init__(
 
         self._user_middleware = list(t.cast(list, self.config.MIDDLEWARE))
 
-        self.on_startup = RouterEventManager(
-            [] if on_startup_event_handlers is None else list(on_startup_event_handlers)
-        )
-        self.on_shutdown = RouterEventManager(
-            []
-            if on_shutdown_event_handlers is None
-            else list(on_shutdown_event_handlers)
-        )
-
         self._static_app: t.Optional[ASGIApp] = None
 
         self.state = State()
@@ -85,12 +67,6 @@ def __init__(
         self.router = ApplicationRouter(
             routes=self._get_module_routes(),
             redirect_slashes=self.config.REDIRECT_SLASHES,
-            on_startup=[self.on_startup.async_run]
-            if self.config.DEFAULT_LIFESPAN_HANDLER is None
-            else None,
-            on_shutdown=[self.on_shutdown.async_run]
-            if self.config.DEFAULT_LIFESPAN_HANDLER is None
-            else None,
             default=self.config.DEFAULT_NOT_FOUND_HANDLER,  # type: ignore
             lifespan=self.config.DEFAULT_LIFESPAN_HANDLER,
         )

ellar/core/main.py

@@ -4,12 +4,9 @@
     EXCEPTION_HANDLERS_KEY,
     MIDDLEWARE_HANDLERS_KEY,
     MODULE_FIELDS,
-    ON_REQUEST_SHUTDOWN_KEY,
-    ON_REQUEST_STARTUP_KEY,
     TEMPLATE_FILTER_KEY,
     TEMPLATE_GLOBAL_KEY,
 )
-from ellar.events import EventHandler
 from ellar.reflect import reflect
 
 from ..exceptions.callable_exceptions import CallableExceptionHandler
@@ -34,8 +31,6 @@ def __init__(self, cls: t.Union[t.Type["ModuleBase"], "ModuleBaseMeta"]) -> None
             {
                 EXCEPTION_HANDLERS_KEY: self.exception_config,
                 MIDDLEWARE_HANDLERS_KEY: self.middleware_config,
-                ON_REQUEST_SHUTDOWN_KEY: self.on_request_shut_down_config,
-                ON_REQUEST_STARTUP_KEY: self.on_request_startup_config,
                 TEMPLATE_GLOBAL_KEY: self.template_global_config,
                 TEMPLATE_FILTER_KEY: self.template_filter_config,
             },
@@ -57,26 +52,6 @@ def middleware_config(self, middleware: "MiddlewareSchema") -> None:
             self._cls,
         )
 
-    def on_request_shut_down_config(self, on_shutdown_event: EventHandler) -> None:
-        on_shutdown_event.handler = module_callable_factory(
-            on_shutdown_event.handler, self._cls
-        )
-        reflect.define_metadata(
-            ON_REQUEST_SHUTDOWN_KEY,
-            [on_shutdown_event],
-            self._cls,
-        )
-
-    def on_request_startup_config(self, on_startup_event: EventHandler) -> None:
-        on_startup_event.handler = module_callable_factory(
-            on_startup_event.handler, self._cls
-        )
-        reflect.define_metadata(
-            ON_REQUEST_STARTUP_KEY,
-            [on_startup_event],
-            self._cls,
-        )
-
     def template_filter_config(self, template_filter: "TemplateFunctionData") -> None:
         reflect.define_metadata(
             TEMPLATE_FILTER_KEY,