sh-edraft.de/sh_cpl
2
1
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Sven Heidemann
2023-02-20 15:55:20 +01:00
parent 48d0daabf5
commit 9e28dce5ce
632 changed files with 10917 additions and 6775 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/cpl_core/application/__init__.py
View File

@@ -1,21 +1,21 @@
# -*- coding: utf-8 -*-
"""
cpl-core sh-edraft Common Python library
cpl-core CPL core
~~~~~~~~~~~~~~~~~~~
sh-edraft Common Python library
CPL core package
:copyright: (c) 2020 - 2023 sh-edraft.de
:license: MIT, see LICENSE for more details.
"""
__title__ = 'cpl_core.application'
__author__ = 'Sven Heidemann'
__license__ = 'MIT'
__copyright__ = 'Copyright (c) 2020 - 2023 sh-edraft.de'
__version__ = '2022.12.1'
__title__ = "cpl_core.application"
__author__ = "Sven Heidemann"
__license__ = "MIT"
__copyright__ = "Copyright (c) 2020 - 2023 sh-edraft.de"
__version__ = "2023.2.0"
from collections import namedtuple
@@ -28,5 +28,5 @@ from .application_extension_abc import ApplicationExtensionABC
from .startup_abc import StartupABC
from .startup_extension_abc import StartupExtensionABC
VersionInfo = namedtuple('VersionInfo', 'major minor micro')
version_info = VersionInfo(major='2022', minor='12', micro='1')
VersionInfo = namedtuple("VersionInfo", "major minor micro")
version_info = VersionInfo(major="2023", minor="2", micro="0")

5
src/cpl_core/application/application_abc.py
View File

@@ -10,8 +10,7 @@ from cpl_core.environment.application_environment_abc import ApplicationEnvironm
class ApplicationABC(ABC):
r"""ABC for the Application class
Parameters
----------
Parameters:
config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
Contains object loaded from appsettings
services: :class:`cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC`
@@ -34,7 +33,7 @@ class ApplicationABC(ABC):
self.main()
except KeyboardInterrupt:
Console.close()
async def run_async(self):
r"""Entry point

9
src/cpl_core/application/application_builder.py
View File

@@ -12,8 +12,7 @@ from cpl_core.dependency_injection.service_collection import ServiceCollection
class ApplicationBuilder(ApplicationBuilderABC):
r"""This is class is used to build an object of :class:`cpl_core.application.application_abc.ApplicationABC`
Parameter
---------
Parameter:
app: Type[:class:`cpl_core.application.application_abc.ApplicationABC`]
Application to build
"""
@@ -30,11 +29,13 @@ class ApplicationBuilder(ApplicationBuilderABC):
self._app_extensions: list[Callable] = []
self._startup_extensions: list[Callable] = []
def use_startup(self, startup: Type[StartupABC]) -> 'ApplicationBuilder':
def use_startup(self, startup: Type[StartupABC]) -> "ApplicationBuilder":
self._startup = startup()
return self
def use_extension(self, extension: Type[Union[ApplicationExtensionABC, StartupExtensionABC]]) -> 'ApplicationBuilder':
def use_extension(
self, extension: Type[Union[ApplicationExtensionABC, StartupExtensionABC]]
) -> "ApplicationBuilder":
if issubclass(extension, ApplicationExtensionABC) and extension not in self._app_extensions:
self._app_extensions.append(extension)
elif issubclass(extension, StartupExtensionABC) and extension not in self._startup_extensions:

12
src/cpl_core/application/application_builder_abc.py
View File

@@ -16,8 +16,7 @@ class ApplicationBuilderABC(ABC):
def use_startup(self, startup: Type[StartupABC]):
r"""Sets the custom startup class to use
Parameter
---------
Parameter:
startup: Type[:class:`cpl_core.application.startup_abc.StartupABC`]
Startup class to use
"""
@@ -27,8 +26,7 @@ class ApplicationBuilderABC(ABC):
async def use_startup(self, startup: Type[StartupABC]):
r"""Sets the custom startup class to use async
Parameter
---------
Parameter:
startup: Type[:class:`cpl_core.application.startup_abc.StartupABC`]
Startup class to use
"""
@@ -38,8 +36,7 @@ class ApplicationBuilderABC(ABC):
def build(self) -> ApplicationABC:
r"""Creates custom application object
Returns
-------
Returns:
Object of :class:`cpl_core.application.application_abc.ApplicationABC`
"""
pass
@@ -48,8 +45,7 @@ class ApplicationBuilderABC(ABC):
async def build_async(self) -> ApplicationABC:
r"""Creates custom application object async
Returns
-------
Returns:
Object of :class:`cpl_core.application.application_abc.ApplicationABC`
"""
pass

12
src/cpl_core/application/application_extension_abc.py
View File

@@ -5,12 +5,14 @@ from cpl_core.dependency_injection import ServiceProviderABC
class ApplicationExtensionABC(ABC):
@abstractmethod
def __init__(self):
pass
@abstractmethod
def __init__(self): pass
def run(self, config: ConfigurationABC, services: ServiceProviderABC):
pass
@abstractmethod
def run(self, config: ConfigurationABC, services: ServiceProviderABC): pass
@abstractmethod
async def run(self, config: ConfigurationABC, services: ServiceProviderABC): pass
async def run(self, config: ConfigurationABC, services: ServiceProviderABC):
pass

15
src/cpl_core/application/startup_abc.py
View File

@@ -10,19 +10,18 @@ class StartupABC(ABC):
r"""ABC for the startup class"""
@abstractmethod
def __init__(self): pass
def __init__(self):
pass
@abstractmethod
def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC) -> ConfigurationABC:
r"""Creates configuration of application
Parameter
---------
Parameter:
config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
env: :class:`cpl_core.environment.application_environment_abc`
Returns
-------
Returns:
Object of :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
"""
pass
@@ -31,13 +30,11 @@ class StartupABC(ABC):
def configure_services(self, service: ServiceCollectionABC, env: ApplicationEnvironmentABC) -> ServiceProviderABC:
r"""Creates service provider
Parameter
---------
Parameter:
services: :class:`cpl_core.dependency_injection.service_collection_abc`
env: :class:`cpl_core.environment.application_environment_abc`
Returns
-------
Returns:
Object of :class:`cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC`
"""
pass

9
src/cpl_core/application/startup_extension_abc.py
View File

@@ -9,14 +9,14 @@ class StartupExtensionABC(ABC):
r"""ABC for startup extension classes"""
@abstractmethod
def __init__(self): pass
def __init__(self):
pass
@abstractmethod
def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC):
r"""Creates configuration of application
Parameter
---------
Parameter:
config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
env: :class:`cpl_core.environment.application_environment_abc`
"""
@@ -26,8 +26,7 @@ class StartupExtensionABC(ABC):
def configure_services(self, service: ServiceCollectionABC, env: ApplicationEnvironmentABC):
r"""Creates service provider
Parameter
---------
Parameter:
services: :class:`cpl_core.dependency_injection.service_collection_abc`
env: :class:`cpl_core.environment.application_environment_abc`
"""