Restructuring

src/cpl-application/cpl/application/__init__.py

@@ -0,0 +1,6 @@
+from .application_abc import ApplicationABC
+from .application_builder import ApplicationBuilder
+from .application_builder_abc import ApplicationBuilderABC
+from .application_extension_abc import ApplicationExtensionABC
+from .startup_abc import StartupABC
+from .startup_extension_abc import StartupExtensionABC

src/cpl-application/cpl/application/application_abc.py

@@ -0,0 +1,57 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from cpl.dependency.service_provider_abc import ServiceProviderABC
+
+from cpl.core.console.console import Console
+
+
+class ApplicationABC(ABC):
+    r"""ABC for the Application class
+
+    Parameters:
+        config: :class:`cpl.core.configuration.configuration_abc.ConfigurationABC`
+            Contains object loaded from appsettings
+        services: :class:`cpl.dependency.service_provider_abc.ServiceProviderABC`
+            Contains instances of prepared objects
+    """
+
+    @abstractmethod
+    def __init__(self, services: ServiceProviderABC):
+        self._services: Optional[ServiceProviderABC] = services
+
+    def run(self):
+        r"""Entry point
+
+        Called by custom Application.main
+        """
+        try:
+            self.configure()
+            self.main()
+        except KeyboardInterrupt:
+            Console.close()
+
+    async def run_async(self):
+        r"""Entry point
+
+        Called by custom Application.main
+        """
+        try:
+            await self.configure()
+            await self.main()
+        except KeyboardInterrupt:
+            Console.close()
+
+    @abstractmethod
+    def configure(self):
+        r"""Configure the application
+
+        Called by :class:`cpl.application.application_abc.ApplicationABC.run`
+        """
+
+    @abstractmethod
+    def main(self):
+        r"""Custom entry point
+
+        Called by :class:`cpl.application.application_abc.ApplicationABC.run`
+        """

src/cpl-application/cpl/application/application_builder.py

@@ -0,0 +1,97 @@
+from typing import Type, Optional, Callable, Union
+
+from cpl.application.application_abc import ApplicationABC
+from cpl.application.application_builder_abc import ApplicationBuilderABC
+from cpl.application.application_extension_abc import ApplicationExtensionABC
+from cpl.application.async_application_extension_abc import AsyncApplicationExtensionABC
+from cpl.application.async_startup_abc import AsyncStartupABC
+from cpl.application.async_startup_extension_abc import AsyncStartupExtensionABC
+from cpl.application.startup_abc import StartupABC
+from cpl.application.startup_extension_abc import StartupExtensionABC
+from cpl.core.configuration.configuration import Configuration
+from cpl.dependency.service_collection import ServiceCollection
+from cpl.core.environment import Environment
+
+
+class ApplicationBuilder(ApplicationBuilderABC):
+    r"""This is class is used to build an object of :class:`cpl.application.application_abc.ApplicationABC`
+
+    Parameter:
+        app: Type[:class:`cpl.application.application_abc.ApplicationABC`]
+            Application to build
+    """
+
+    def __init__(self, app: Type[ApplicationABC]):
+        ApplicationBuilderABC.__init__(self)
+        self._app = app
+        self._startup: Optional[StartupABC | AsyncStartupABC] = None
+
+        self._services = ServiceCollection()
+
+        self._app_extensions: list[Type[ApplicationExtensionABC | AsyncApplicationExtensionABC]] = []
+        self._startup_extensions: list[Type[StartupExtensionABC | AsyncStartupABC]] = []
+
+    def use_startup(self, startup: Type[StartupABC | AsyncStartupABC]) -> "ApplicationBuilder":
+        self._startup = startup()
+        return self
+
+    def use_extension(
+        self,
+        extension: Type[
+            ApplicationExtensionABC | AsyncApplicationExtensionABC | StartupExtensionABC | AsyncStartupExtensionABC
+        ],
+    ) -> "ApplicationBuilder":
+        if (
+            issubclass(extension, ApplicationExtensionABC) or issubclass(extension, AsyncApplicationExtensionABC)
+        ) and extension not in self._app_extensions:
+            self._app_extensions.append(extension)
+        elif (
+            issubclass(extension, StartupExtensionABC) or issubclass(extension, AsyncStartupExtensionABC)
+        ) and extension not in self._startup_extensions:
+            self._startup_extensions.append(extension)
+
+        return self
+
+    def _build_startup(self):
+        for ex in self._startup_extensions:
+            extension = ex()
+            extension.configure_configuration(Configuration, Environment)
+            extension.configure_services(self._services, Environment)
+
+        if self._startup is not None:
+            self._startup.configure_configuration(Configuration, Environment)
+            self._startup.configure_services(self._services, Environment)
+
+    async def _build_async_startup(self):
+        for ex in self._startup_extensions:
+            extension = ex()
+            await extension.configure_configuration(Configuration, Environment)
+            await extension.configure_services(self._services, Environment)
+
+        if self._startup is not None:
+            await self._startup.configure_configuration(Configuration, Environment)
+            await self._startup.configure_services(self._services, Environment)
+
+    def build(self) -> ApplicationABC:
+        self._build_startup()
+
+        config = Configuration
+        services = self._services.build_service_provider()
+
+        for ex in self._app_extensions:
+            extension = ex()
+            extension.run(config, services)
+
+        return self._app(services)
+
+    async def build_async(self) -> ApplicationABC:
+        await self._build_async_startup()
+
+        config = Configuration
+        services = self._services.build_service_provider()
+
+        for ex in self._app_extensions:
+            extension = ex()
+            await extension.run(config, services)
+
+        return self._app(services)

src/cpl-application/cpl/application/application_builder_abc.py

@@ -0,0 +1,47 @@
+from abc import ABC, abstractmethod
+from typing import Type
+
+from cpl.application.application_abc import ApplicationABC
+from cpl.application.startup_abc import StartupABC
+
+
+class ApplicationBuilderABC(ABC):
+    r"""ABC for the :class:`cpl.application.application_builder.ApplicationBuilder`"""
+
+    @abstractmethod
+    def __init__(self, *args):
+        pass
+
+    @abstractmethod
+    def use_startup(self, startup: Type[StartupABC]):
+        r"""Sets the custom startup class to use
+
+        Parameter:
+            startup: Type[:class:`cpl.application.startup_abc.StartupABC`]
+                Startup class to use
+        """
+
+    @abstractmethod
+    async def use_startup(self, startup: Type[StartupABC]):
+        r"""Sets the custom startup class to use async
+
+        Parameter:
+            startup: Type[:class:`cpl.application.startup_abc.StartupABC`]
+                Startup class to use
+        """
+
+    @abstractmethod
+    def build(self) -> ApplicationABC:
+        r"""Creates custom application object
+
+        Returns:
+            Object of :class:`cpl.application.application_abc.ApplicationABC`
+        """
+
+    @abstractmethod
+    async def build_async(self) -> ApplicationABC:
+        r"""Creates custom application object async
+
+        Returns:
+            Object of :class:`cpl.application.application_abc.ApplicationABC`
+        """

src/cpl-application/cpl/application/application_extension_abc.py

@@ -0,0 +1,14 @@
+from abc import ABC, abstractmethod
+
+from cpl.core.configuration.configuration import Configuration
+from cpl.dependency import ServiceProviderABC
+
+
+class ApplicationExtensionABC(ABC):
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    def run(self, config: Configuration, services: ServiceProviderABC):
+        pass

src/cpl-application/cpl/application/async_application_extension_abc.py

@@ -0,0 +1,14 @@
+from abc import ABC, abstractmethod
+
+from cpl.core.configuration.configuration import Configuration
+from cpl.dependency import ServiceProviderABC
+
+
+class AsyncApplicationExtensionABC(ABC):
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    async def run(self, config: Configuration, services: ServiceProviderABC):
+        pass

src/cpl-application/cpl/application/async_startup_abc.py

@@ -0,0 +1,23 @@
+from abc import ABC, abstractmethod
+
+from cpl.dependency.service_collection_abc import ServiceCollectionABC
+
+
+class AsyncStartupABC(ABC):
+    r"""ABC for the startup class"""
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    async def configure_configuration(self):
+        r"""Creates configuration of application"""
+
+    @abstractmethod
+    async def configure_services(self, service: ServiceCollectionABC):
+        r"""Creates service provider
+
+        Parameter:
+            services: :class:`cpl.dependency.service_collection_abc`
+        """

src/cpl-application/cpl/application/async_startup_extension_abc.py

@@ -0,0 +1,31 @@
+from abc import ABC, abstractmethod
+
+from cpl.core.configuration.configuration import Configuration
+from cpl.dependency.service_collection_abc import ServiceCollectionABC
+from cpl.core.environment.environment import Environment
+
+
+class AsyncStartupExtensionABC(ABC):
+    r"""ABC for startup extension classes"""
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    async def configure_configuration(self, config: Configuration, env: Environment):
+        r"""Creates configuration of application
+
+        Parameter:
+            config: :class:`cpl.core.configuration.configuration_abc.Configuration`
+            env: :class:`cpl.core.environment.application_environment_abc`
+        """
+
+    @abstractmethod
+    async def configure_services(self, service: ServiceCollectionABC, env: Environment):
+        r"""Creates service provider
+
+        Parameter:
+            services: :class:`cpl.dependency.service_collection_abc`
+            env: :class:`cpl.core.environment.application_environment_abc`
+        """

src/cpl-application/cpl/application/startup_abc.py

@@ -0,0 +1,31 @@
+from abc import ABC, abstractmethod
+
+from cpl.core.configuration import Configuration
+from cpl.dependency.service_collection_abc import ServiceCollectionABC
+from cpl.core.environment import Environment
+
+
+class StartupABC(ABC):
+    r"""ABC for the startup class"""
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    def configure_configuration(self, config: Configuration, env: Environment):
+        r"""Creates configuration of application
+
+        Parameter:
+            config: :class:`cpl.core.configuration.configuration_abc.ConfigurationABC`
+            env: :class:`cpl.core.environment.application_environment_abc`
+        """
+
+    @abstractmethod
+    def configure_services(self, service: ServiceCollectionABC, env: Environment):
+        r"""Creates service provider
+
+        Parameter:
+            services: :class:`cpl.dependency.service_collection_abc`
+            env: :class:`cpl.core.environment.application_environment_abc`
+        """

src/cpl-application/cpl/application/startup_extension_abc.py

@@ -0,0 +1,33 @@
+from abc import ABC, abstractmethod
+
+
+from cpl.core.configuration import Configuration
+from cpl.dependency.service_collection_abc import ServiceCollectionABC
+
+from cpl.core.environment.environment import Environment
+
+
+class StartupExtensionABC(ABC):
+    r"""ABC for startup extension classes"""
+
+    @abstractmethod
+    def __init__(self):
+        pass
+
+    @abstractmethod
+    def configure_configuration(self, config: Configuration, env: Environment):
+        r"""Creates configuration of application
+
+        Parameter:
+            config: :class:`cpl.core.configuration.configuration_abc.ConfigurationABC`
+            env: :class:`cpl.core.environment.application_environment_abc`
+        """
+
+    @abstractmethod
+    def configure_services(self, service: ServiceCollectionABC, env: Environment):
+        r"""Creates service provider
+
+        Parameter:
+            services: :class:`cpl.dependency.service_collection_abc`
+            env: :class:`cpl.core.environment.application_environment_abc`
+        """

src/cpl-application/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=70.1.0", "wheel>=0.43.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cpl-application"
+version = "2024.7.0"
+description = "CPL application"
+readme ="CPL application package"
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [
+    { name = "Sven Heidemann", email = "sven.heidemann@sh-edraft.de" }
+]
+keywords = ["cpl", "application", "backend", "shared", "library"]
+
+dynamic = ["dependencies", "optional-dependencies"]
+
+[project.urls]
+Homepage = "https://www.sh-edraft.de"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["cpl*"]
+
+[tool.setuptools.dynamic]
+dependencies = { file = ["requirements.txt"] }
+optional-dependencies.dev = { file = ["requirements.dev.txt"] }
+
+

src/cpl-application/requirements.dev.txt

@@ -0,0 +1 @@
+black==25.1.0

src/cpl-application/requirements.txt

@@ -0,0 +1,2 @@
+cpl-core
+cpl-dependency