Merge pull request #43 from python-ellar/ellar_081_upgrade

fixed deprecated reference due to ellar 0.8.1

Author: eadwinCode

docs/migrations/env.md

@@ -8,8 +8,8 @@ but it also introduces a certain level of complexity.
 from logging.config import fileConfig
 
 from alembic import context
-from ellar.app import current_injector
-from ellar.threading import run_as_async
+from ellar.core import current_injector
+from ellar.threading import run_as_sync
 
 from ellar_sql.migrations import SingleDatabaseAlembicEnvMigration
 from ellar_sql.services import EllarSQLService
@@ -28,7 +28,7 @@ fileConfig(config.config_file_name)  # type:ignore[arg-type]
 # my_important_option = config.get_main_option("my_important_option")
 # ... etc.
 
-@run_as_async
+@run_as_sync
 async def main() -> None:
     db_service: EllarSQLService = current_injector.get(EllarSQLService)
 
@@ -91,8 +91,8 @@ from logging.config import fileConfig
 from alembic import context
 from ellar_sql.migrations import AlembicEnvMigrationBase
 from ellar_sql.model.database_binds import get_metadata
-from ellar.app import current_injector
-from ellar.threading import run_as_async
+from ellar.core import current_injector
+from ellar.threading import run_as_sync
 from ellar_sql.services import EllarSQLService
 
 # This is the Alembic Config object, which provides
@@ -156,7 +156,7 @@ class MyCustomMigrationEnv(AlembicEnvMigrationBase):
                 context.run_migrations()
 
 
-@run_as_async
+@run_as_sync
 async def main() -> None:
     db_service: EllarSQLService = current_injector.get(EllarSQLService)
 

docs/models/index.md

@@ -176,7 +176,7 @@ class User(model.Model):
 We have created a `User` model but the data does not exist. Let's fix that
 
 ```python
-from ellar.app import current_injector
+from ellar.core import current_injector
 from ellar_sql import EllarSQLService
 
 db_service = current_injector.get(EllarSQLService)
@@ -285,7 +285,7 @@ Although with `EllarSQLService` you can get the `engine` and `session`. It's the
 ```python
 import sqlalchemy as sa
 import sqlalchemy.orm as sa_orm
-from ellar.app import current_injector
+from ellar.core import current_injector
 from ellar_sql import EllarSQLService
 
 db_service = current_injector.get(EllarSQLService)
@@ -303,7 +303,7 @@ assert isinstance(db_service.session_factory(), sa_orm.Session)
 ```python
 import sqlalchemy as sa
 import sqlalchemy.orm as sa_orm
-from ellar.app import current_injector
+from ellar.core import current_injector
 
 # get engine from DI
 default_engine = current_injector.get(sa.Engine)
@@ -317,7 +317,7 @@ assert isinstance(session, sa_orm.Session)
 For Async Database options
 ```python
 from sqlalchemy.ext.asyncio import AsyncSession, AsyncEngine
-from ellar.app import current_injector
+from ellar.core import current_injector
 
 # get engine from DI
 default_engine = current_injector.get(AsyncEngine)

docs/multiple/index.md

@@ -75,7 +75,7 @@ It also requires the `database` argument to target a specific database.
 
 ```python
 # Create tables for all binds
-from ellar.app import current_injector
+from ellar.core import current_injector
 from ellar_sql import EllarSQLService
 
 db_service = current_injector.get(EllarSQLService)

ellar_sql/cli/commands.py

@@ -1,5 +1,5 @@
 import ellar_cli.click as click
-from ellar.app import current_injector
+from ellar.core import current_injector
 
 from ellar_sql.services import EllarSQLService
 

ellar_sql/factory/base.py

@@ -2,7 +2,7 @@
 
 import sqlalchemy as sa
 import sqlalchemy.orm as sa_orm
-from ellar.threading import run_as_async
+from ellar.threading import run_as_sync
 from factory.alchemy import (
     SESSION_PERSISTENCE_COMMIT,
     SESSION_PERSISTENCE_FLUSH,
@@ -36,7 +36,7 @@ class Meta:
         abstract = True
 
     @classmethod
-    @run_as_async
+    @run_as_sync
     async def _session_execute(
         cls, session_func: t.Callable, *args: t.Any, **kwargs: t.Any
     ) -> t.Union[sa.Result, sa.CursorResult, t.Any]:

ellar_sql/model/base.py

@@ -3,7 +3,7 @@
 
 import sqlalchemy as sa
 import sqlalchemy.orm as sa_orm
-from ellar.app import current_injector
+from ellar.core import current_injector
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from ellar_sql.constant import DATABASE_BIND_KEY, DATABASE_KEY, DEFAULT_KEY

ellar_sql/model/typeDecorator/file/exceptions.py

@@ -6,19 +6,14 @@
 from sqlalchemy_file.exceptions import ValidationError
 
 from ellar.common import IExecutionContext
-from ellar.common.exceptions import CallableExceptionHandler
+from ellar.core.exceptions import as_exception_handler
 
 
-def _exception_handlers(ctx: IExecutionContext, exc: ValidationError):
+# Register to application config.EXCEPTION_HANDLERS to add exception handler for sqlalchemy-file
+@as_exception_handler(ValidationError)
+async def FileExceptionHandler(ctx: IExecutionContext, exc: ValidationError):
     app_config = ctx.get_app().config
     return app_config.DEFAULT_JSON_CLASS(
         {"message": exc.msg, "key": exc.key},
         status_code=400,
     )
-
-
-# Register to application config.EXCEPTION_HANDLERS to add exception handler for sqlalchemy-file
-FileExceptionHandler = CallableExceptionHandler(
-    exc_class_or_status_code=ValidationError,
-    callable_exception_handler=_exception_handlers,
-)

ellar_sql/model/typeDecorator/file/file.py

@@ -3,8 +3,8 @@
 import warnings
 from datetime import datetime
 
-from ellar.app import current_injector
 from ellar.common.compatible import AttributeDictAccessMixin
+from ellar.core import current_injector
 from ellar_storage import StorageService, StoredFile
 from sqlalchemy_file.file import File as BaseFile
 from starlette.datastructures import UploadFile

ellar_sql/model/typeDecorator/file/file_tracker.py

@@ -1,6 +1,6 @@
 import typing as t
 
-from ellar.app import current_injector
+from ellar.core import current_injector
 from ellar_storage import StorageService
 from sqlalchemy import event, orm
 from sqlalchemy_file.types import FileFieldSessionTracker

ellar_sql/module.py

@@ -2,10 +2,11 @@
 import typing as t
 
 import sqlalchemy as sa
-from ellar.common import IExecutionContext, IModuleSetup, Module, middleware
+from ellar.common import IHostContext, IModuleSetup, Module
 from ellar.core import Config, DynamicModule, ModuleBase, ModuleSetup
+from ellar.core.middleware import as_middleware
+from ellar.core.modules import ModuleRefBase
 from ellar.di import ProviderConfig, request_or_transient_scope
-from ellar.events import app_context_teardown
 from ellar.utils.importer import get_main_directory_by_stack
 from sqlalchemy.ext.asyncio import (
     AsyncEngine,
@@ -26,32 +27,49 @@ def _raise_exception():
     return _raise_exception
 
 
-@Module(commands=[DBCommands])
-class EllarSQLModule(ModuleBase, IModuleSetup):
-    @middleware()
-    async def session_middleware(
-        cls, context: IExecutionContext, call_next: t.Callable[..., t.Coroutine]
-    ):
-        connection = context.switch_to_http_connection().get_client()
-
-        db_session = connection.service_provider.get(EllarSQLService)
-        session = db_session.session_factory()
+@as_middleware
+async def session_middleware(
+    context: IHostContext, call_next: t.Callable[..., t.Coroutine]
+):
+    connection = context.switch_to_http_connection().get_client()
 
-        connection.state.session = session
+    db_service = context.get_service_provider().get(EllarSQLService)
+    session = db_service.session_factory()
 
-        try:
-            await call_next()
-        except Exception as ex:
-            res = session.rollback()
-            if isinstance(res, t.Coroutine):
-                await res
-            raise ex
+    connection.state.session = session
 
-    @classmethod
-    async def _on_application_tear_down(cls, db_service: EllarSQLService) -> None:
-        res = db_service.session_factory.remove()
+    try:
+        await call_next()
+    except Exception as ex:
+        res = session.rollback()
         if isinstance(res, t.Coroutine):
             await res
+        raise ex
+
+    res = db_service.session_factory.remove()
+    if isinstance(res, t.Coroutine):
+        await res
+
+
+@Module(
+    commands=[DBCommands],
+    exports=[
+        EllarSQLService,
+        Session,
+        AsyncSession,
+        AsyncEngine,
+        sa.Engine,
+        MigrationOption,
+    ],
+    providers=[EllarSQLService],
+    name="EllarSQL",
+)
+class EllarSQLModule(ModuleBase, IModuleSetup):
+    @classmethod
+    def post_build(cls, module_ref: "ModuleRefBase") -> None:
+        module_ref.config.MIDDLEWARE = list(module_ref.config.MIDDLEWARE) + [
+            session_middleware
+        ]
 
     @classmethod
     def setup(
@@ -155,8 +173,10 @@ def __setup_module(cls, sql_alchemy_config: SQLAlchemyConfig) -> DynamicModule:
             )
 
         providers.append(ProviderConfig(EllarSQLService, use_value=db_service))
-        app_context_teardown.connect(
-            functools.partial(cls._on_application_tear_down, db_service=db_service)
+        providers.append(
+            ProviderConfig(
+                MigrationOption, use_value=lambda: db_service.migration_options
+            )
         )
 
         return DynamicModule(
@@ -182,7 +202,7 @@ def register_setup(cls, **override_config: t.Any) -> ModuleSetup:
 
     @staticmethod
     def __register_setup_factory(
-        module: t.Type["EllarSQLModule"],
+        module_ref: ModuleRefBase,
         config: Config,
         root_path: str,
         override_config: t.Dict[str, t.Any],
@@ -201,6 +221,7 @@ def __register_setup_factory(
                 stack_level=0,
                 from_dir=defined_config["root_path"],
             )
+            module = t.cast(t.Type["EllarSQLModule"], module_ref.module)
 
             return module.__setup_module(schema)
         raise RuntimeError("Could not find `ELLAR_SQL` in application config.")