Renamed project

src/cpl_core/application/__init__.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+"""
+sh_cpl-core sh-edraft Common Python library
+~~~~~~~~~~~~~~~~~~~
+
+sh-edraft Common Python library
+
+:copyright: (c) 2020 - 2021 sh-edraft.de
+:license: MIT, see LICENSE for more details.
+
+"""
+
+__title__ = 'cpl_core.application'
+__author__ = 'Sven Heidemann'
+__license__ = 'MIT'
+__copyright__ = 'Copyright (c) 2020 - 2021 sh-edraft.de'
+__version__ = '2021.10.6'
+
+from collections import namedtuple
+
+# imports:
+from .application_abc import ApplicationABC
+from .application_builder import ApplicationBuilder
+from .application_builder_abc import ApplicationBuilderABC
+from .startup_abc import StartupABC
+
+VersionInfo = namedtuple('VersionInfo', 'major minor micro')
+version_info = VersionInfo(major='2021', minor='10', micro='6')

src/cpl_core/application/application_abc.py

@@ -0,0 +1,52 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from cpl.configuration.configuration_abc import ConfigurationABC
+from cpl.console.console import Console
+from cpl.dependency_injection.service_provider_abc import ServiceProviderABC
+from cpl.environment import ApplicationEnvironmentABC
+
+
+class ApplicationABC(ABC):
+    r"""ABC for the Application class
+
+    Parameters
+    ----------
+        config: :class:`cpl.configuration.configuration_abc.ConfigurationABC`
+            Contains object loaded from appsettings
+        services: :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC`
+            Contains instances of prepared objects
+    """
+
+    @abstractmethod
+    def __init__(self, config: ConfigurationABC, services: ServiceProviderABC):
+        self._configuration: Optional[ConfigurationABC] = config
+        self._environment: Optional[ApplicationEnvironmentABC] = self._configuration.environment
+        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()
+
+    @abstractmethod
+    def configure(self):
+        r"""Configure the application
+
+        Called by :class:`cpl.application.application_abc.ApplicationABC.run`
+        """
+        pass
+
+    @abstractmethod
+    def main(self):
+        r"""Custom entry point
+
+        Called by :class:`cpl.application.application_abc.ApplicationABC.run`
+        """
+        pass

src/cpl_core/application/application_builder.py

@@ -0,0 +1,36 @@
+from typing import Type, Optional
+
+from cpl.application.application_abc import ApplicationABC
+from cpl.application.application_builder_abc import ApplicationBuilderABC
+from cpl.application.startup_abc import StartupABC
+from cpl.configuration.configuration import Configuration
+from cpl.dependency_injection.service_collection import ServiceCollection
+
+
+class ApplicationBuilder(ApplicationBuilderABC):
+    r"""This is class is used to build a 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] = None
+
+        self._configuration = Configuration()
+        self._environment = self._configuration.environment
+        self._services = ServiceCollection(self._configuration)
+
+    def use_startup(self, startup: Type[StartupABC]):
+        self._startup = startup(self._configuration, self._services)
+
+    def build(self) -> ApplicationABC:
+        if self._startup is not None:
+            self._startup.configure_configuration()
+            self._startup.configure_services()
+
+        return self._app(self._configuration, self._services.build_service_provider())

src/cpl_core/application/application_builder_abc.py

@@ -0,0 +1,34 @@
+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
+        """
+        pass
+
+    @abstractmethod
+    def build(self) -> ApplicationABC:
+        r"""Creates custom application object
+
+        Returns
+        -------
+            Object of :class:`cpl.application.application_abc.ApplicationABC`
+        """
+        pass

src/cpl_core/application/startup_abc.py

@@ -0,0 +1,32 @@
+from abc import ABC, abstractmethod
+
+from cpl.configuration.configuration_abc import ConfigurationABC
+from cpl.dependency_injection.service_provider_abc import ServiceProviderABC
+
+
+class StartupABC(ABC):
+    r"""ABC for the startup class"""
+
+    @abstractmethod
+    def __init__(self, *args):
+        pass
+
+    @abstractmethod
+    def configure_configuration(self) -> ConfigurationABC:
+        r"""Creates configuration of application
+
+        Returns
+        -------
+            Object of :class:`cpl.configuration.configuration_abc.ConfigurationABC`
+        """
+        pass
+
+    @abstractmethod
+    def configure_services(self) -> ServiceProviderABC:
+        r"""Creates service provider
+
+        Returns
+        -------
+            Object of :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC`
+        """
+        pass