2021.10 #41

Merged
edraft merged 53 commits from 2021.10 into master 2021-10-04 09:32:42 +02:00
24 changed files with 83 additions and 78 deletions
Showing only changes of commit 1c6794dc40 - Show all commits

View File

@ -12,9 +12,9 @@ class ApplicationABC(ABC):
Parameters Parameters
---------- ----------
config: :class:`cpl.configuration.configuration_abc.ConfigurationABC` config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
Contains object loaded from appsettings Contains object loaded from appsettings
services: :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC` services: :class:`cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC`
Contains instances of prepared objects Contains instances of prepared objects
""" """
@ -39,7 +39,7 @@ class ApplicationABC(ABC):
def configure(self): def configure(self):
r"""Configure the application r"""Configure the application
Called by :class:`cpl.application.application_abc.ApplicationABC.run` Called by :class:`cpl_core.application.application_abc.ApplicationABC.run`
""" """
pass pass
@ -47,6 +47,6 @@ class ApplicationABC(ABC):
def main(self): def main(self):
r"""Custom entry point r"""Custom entry point
Called by :class:`cpl.application.application_abc.ApplicationABC.run` Called by :class:`cpl_core.application.application_abc.ApplicationABC.run`
""" """
pass pass

View File

@ -8,11 +8,11 @@ from cpl_core.dependency_injection.service_collection import ServiceCollection
class ApplicationBuilder(ApplicationBuilderABC): class ApplicationBuilder(ApplicationBuilderABC):
r"""This is class is used to build a object of :class:`cpl.application.application_abc.ApplicationABC` r"""This is class is used to build a object of :class:`cpl_core.application.application_abc.ApplicationABC`
Parameter Parameter
--------- ---------
app: Type[:class:`cpl.application.application_abc.ApplicationABC`] app: Type[:class:`cpl_core.application.application_abc.ApplicationABC`]
Application to build Application to build
""" """
@ -26,11 +26,11 @@ class ApplicationBuilder(ApplicationBuilderABC):
self._services = ServiceCollection(self._configuration) self._services = ServiceCollection(self._configuration)
def use_startup(self, startup: Type[StartupABC]): def use_startup(self, startup: Type[StartupABC]):
self._startup = startup(self._configuration, self._services) self._startup = startup()
def build(self) -> ApplicationABC: def build(self) -> ApplicationABC:
if self._startup is not None: if self._startup is not None:
self._startup.configure_configuration() self._startup.configure_configuration(self._configuration, self._environment)
self._startup.configure_services() self._startup.configure_services(self._services, self._environment)
return self._app(self._configuration, self._services.build_service_provider()) return self._app(self._configuration, self._services.build_service_provider())

View File

@ -6,7 +6,7 @@ from cpl_core.application.startup_abc import StartupABC
class ApplicationBuilderABC(ABC): class ApplicationBuilderABC(ABC):
r"""ABC for the :class:`cpl.application.application_builder.ApplicationBuilder`""" r"""ABC for the :class:`cpl_core.application.application_builder.ApplicationBuilder`"""
@abstractmethod @abstractmethod
def __init__(self, *args): def __init__(self, *args):
@ -18,7 +18,7 @@ class ApplicationBuilderABC(ABC):
Parameter Parameter
--------- ---------
startup: Type[:class:`cpl.application.startup_abc.StartupABC`] startup: Type[:class:`cpl_core.application.startup_abc.StartupABC`]
Startup class to use Startup class to use
""" """
pass pass
@ -29,6 +29,6 @@ class ApplicationBuilderABC(ABC):
Returns Returns
------- -------
Object of :class:`cpl.application.application_abc.ApplicationABC` Object of :class:`cpl_core.application.application_abc.ApplicationABC`
""" """
pass pass

View File

@ -1,7 +1,9 @@
from abc import ABC, abstractmethod from abc import ABC, abstractmethod
from cpl_core.configuration.configuration_abc import ConfigurationABC from cpl_core.configuration.configuration_abc import ConfigurationABC
from cpl_core.dependency_injection.service_collection_abc import ServiceCollectionABC
from cpl_core.dependency_injection.service_provider_abc import ServiceProviderABC from cpl_core.dependency_injection.service_provider_abc import ServiceProviderABC
from cpl_core.environment.application_environment_abc import ApplicationEnvironmentABC
class StartupABC(ABC): class StartupABC(ABC):
@ -12,21 +14,26 @@ class StartupABC(ABC):
pass pass
@abstractmethod @abstractmethod
def configure_configuration(self) -> ConfigurationABC: def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC) -> ConfigurationABC:
r"""Creates configuration of application r"""Creates configuration of application
Parameter
---------
config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
env: :class:`cpl_core.environment.application_environment_abc`
Returns Returns
------- -------
Object of :class:`cpl.configuration.configuration_abc.ConfigurationABC` Object of :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
""" """
pass pass
@abstractmethod @abstractmethod
def configure_services(self) -> ServiceProviderABC: def configure_services(self, service: ServiceCollectionABC, env: ApplicationEnvironmentABC) -> ServiceProviderABC:
r"""Creates service provider r"""Creates service provider
Returns Returns
------- -------
Object of :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC` Object of :class:`cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC`
""" """
pass pass

View File

@ -122,7 +122,7 @@ class Configuration(ConfigurationABC):
--------- ---------
argument: :class:`str` argument: :class:`str`
Command as string Command as string
argument_type: :class:`cpl.configuration.console_argument.ConsoleArgument` argument_type: :class:`cpl_core.configuration.console_argument.ConsoleArgument`
Command type as ConsoleArgument Command type as ConsoleArgument
next_arguments: list[:class:`str`] next_arguments: list[:class:`str`]
Following arguments of argument Following arguments of argument

View File

@ -11,7 +11,7 @@ class ConfigurationABC(ABC):
@abstractmethod @abstractmethod
def __init__(self): def __init__(self):
r"""ABC for the :class:`cpl.configuration.configuration.Configuration`""" r"""ABC for the :class:`cpl_core.configuration.configuration.Configuration`"""
pass pass
@property @property
@ -47,7 +47,7 @@ class ConfigurationABC(ABC):
Parameter Parameter
--------- ---------
argument: :class:`cpl.configuration.console_argument.ConsoleArgument` argument: :class:`cpl_core.configuration.console_argument.ConsoleArgument`
Specifies the console argument Specifies the console argument
""" """
pass pass
@ -88,7 +88,7 @@ class ConfigurationABC(ABC):
--------- ---------
key_type: Union[:class:`str`, :class:`type`] key_type: Union[:class:`str`, :class:`type`]
Type of the value Type of the value
value: Union[:class:`str`, :class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`] value: Union[:class:`str`, :class:`cpl_core.configuration.configuration_model_abc.ConfigurationModelABC`]
Object of the value Object of the value
""" """
pass pass
@ -99,11 +99,11 @@ class ConfigurationABC(ABC):
Parameter Parameter
--------- ---------
search_type: Union[:class:`str`, Type[:class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`]] search_type: Union[:class:`str`, Type[:class:`cpl_core.configuration.configuration_model_abc.ConfigurationModelABC`]]
Type to search for Type to search for
Returns Returns
------- -------
Object of Union[:class:`str`, Callable[:class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`]] Object of Union[:class:`str`, Callable[:class:`cpl_core.configuration.configuration_model_abc.ConfigurationModelABC`]]
""" """
pass pass

View File

@ -17,7 +17,7 @@ class ConsoleArgument:
aliases: list[:class:`str`] aliases: list[:class:`str`]
value_token: :class:`str` value_token: :class:`str`
is_value_token_optional: :class:`bool` is_value_token_optional: :class:`bool`
console_arguments: List[:class:`cpl.configuration.console_argument.ConsoleArgument`] console_arguments: List[:class:`cpl_core.configuration.console_argument.ConsoleArgument`]
""" """
self._token = token self._token = token
self._name = name self._name = name

View File

@ -64,7 +64,7 @@ class Console:
Parameter Parameter
--------- ---------
color: Union[:class:`cpl.console.background_color_enum.BackgroundColorEnum`, :class:`str`] color: Union[:class:`cpl_core.console.background_color_enum.BackgroundColorEnum`, :class:`str`]
Background color of the console Background color of the console
""" """
if type(color) is str: if type(color) is str:
@ -78,7 +78,7 @@ class Console:
Parameter Parameter
--------- ---------
color: Union[:class:`cpl.console.background_color_enum.BackgroundColorEnum`, :class:`str`] color: Union[:class:`cpl_core.console.background_color_enum.BackgroundColorEnum`, :class:`str`]
Foreground color of the console Foreground color of the console
""" """
if type(color) is str: if type(color) is str:
@ -365,17 +365,17 @@ class Console:
Message or header of the selection Message or header of the selection
options: List[:class:`str`] options: List[:class:`str`]
Selectable options Selectable options
header_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] header_foreground_color: Union[:class:`str`, :class:`cpl_core.console.foreground_color_enum.ForegroundColorEnum`]
Foreground color of the header Foreground color of the header
header_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] header_background_color: Union[:class:`str`, :class:`cpl_core.console.background_color_enum.BackgroundColorEnum`]
Background color of the header Background color of the header
option_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] option_foreground_color: Union[:class:`str`, :class:`cpl_core.console.foreground_color_enum.ForegroundColorEnum`]
Foreground color of the options Foreground color of the options
option_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] option_background_color: Union[:class:`str`, :class:`cpl_core.console.background_color_enum.BackgroundColorEnum`]
Background color of the options Background color of the options
cursor_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] cursor_foreground_color: Union[:class:`str`, :class:`cpl_core.console.foreground_color_enum.ForegroundColorEnum`]
Foreground color of the cursor Foreground color of the cursor
cursor_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] cursor_background_color: Union[:class:`str`, :class:`cpl_core.console.background_color_enum.BackgroundColorEnum`]
Background color of the cursor Background color of the cursor
Returns Returns
@ -423,13 +423,13 @@ class Console:
Function to call Function to call
args: :class:`list` args: :class:`list`
Arguments of the function Arguments of the function
text_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] text_foreground_color: Union[:class:`str`, :class:`cpl_core.console.foreground_color_enum.ForegroundColorEnum`]
Foreground color of the text Foreground color of the text
spinner_foreground_color: Union[:class:`str`, :class:`cpl.console.foreground_color_enum.ForegroundColorEnum`] spinner_foreground_color: Union[:class:`str`, :class:`cpl_core.console.foreground_color_enum.ForegroundColorEnum`]
Foreground color of the spinner Foreground color of the spinner
text_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] text_background_color: Union[:class:`str`, :class:`cpl_core.console.background_color_enum.BackgroundColorEnum`]
Background color of the text Background color of the text
spinner_background_color: Union[:class:`str`, :class:`cpl.console.background_color_enum.BackgroundColorEnum`] spinner_background_color: Union[:class:`str`, :class:`cpl_core.console.background_color_enum.BackgroundColorEnum`]
Background color of the spinner Background color of the spinner
kwargs: :class:`dict` kwargs: :class:`dict`
Keyword arguments of the call Keyword arguments of the call

View File

@ -16,9 +16,9 @@ class SpinnerThread(threading.Thread):
--------- ---------
msg_len: :class:`int` msg_len: :class:`int`
Length of the message Length of the message
foreground_color: :class:`cpl.console.foreground_color.ForegroundColorEnum` foreground_color: :class:`cpl_core.console.foreground_color.ForegroundColorEnum`
Foreground color of the spinner Foreground color of the spinner
background_color: :class:`cpl.console.background_color.BackgroundColorEnum` background_color: :class:`cpl_core.console.background_color.BackgroundColorEnum`
Background color of the spinner Background color of the spinner
""" """

View File

@ -14,7 +14,7 @@ class DatabaseConnection(DatabaseConnectionABC):
Parameter Parameter
--------- ---------
database_settings: :class:`cpl.database.database_settings.DatabaseSettings` database_settings: :class:`cpl_core.database.database_settings.DatabaseSettings`
""" """
def __init__(self, database_settings: DatabaseSettings): def __init__(self, database_settings: DatabaseSettings):

View File

@ -5,7 +5,7 @@ from sqlalchemy.orm import Session
class DatabaseConnectionABC(ABC): class DatabaseConnectionABC(ABC):
r"""ABC for the :class:`cpl.database.connection.database_connection.DatabaseConnection`""" r"""ABC for the :class:`cpl_core.database.connection.database_connection.DatabaseConnection`"""
@abstractmethod @abstractmethod
def __init__(self): pass def __init__(self): pass

View File

@ -15,7 +15,7 @@ class DatabaseContext(DatabaseContextABC):
Parameter Parameter
--------- ---------
database_settings: :class:`cpl.database.database_settings.DatabaseSettings` database_settings: :class:`cpl_core.database.database_settings.DatabaseSettings`
""" """
def __init__(self, database_settings: DatabaseSettings): def __init__(self, database_settings: DatabaseSettings):

View File

@ -5,7 +5,7 @@ from sqlalchemy.orm import Session
class DatabaseContextABC(ABC): class DatabaseContextABC(ABC):
r"""ABC for the :class:`cpl.database.context.database_context.DatabaseContext`""" r"""ABC for the :class:`cpl_core.database.context.database_context.DatabaseContext`"""
@abstractmethod @abstractmethod
def __init__(self, *args): def __init__(self, *args):

View File

@ -8,7 +8,7 @@ from cpl_core.dependency_injection.service_provider_abc import ServiceProviderAB
class ServiceCollectionABC(ABC): class ServiceCollectionABC(ABC):
r"""ABC for the class :class:`cpl.dependency_injection.service_collection.ServiceCollection`""" r"""ABC for the class :class:`cpl_core.dependency_injection.service_collection.ServiceCollection`"""
@abstractmethod @abstractmethod
def __init__(self): def __init__(self):
@ -20,9 +20,9 @@ class ServiceCollectionABC(ABC):
Parameter Parameter
--------- ---------
db_context: Type[:class:`cpl.database.context.database_context_abc.DatabaseContextABC`] db_context: Type[:class:`cpl_core.database.context.database_context_abc.DatabaseContextABC`]
Database context Database context
db_settings: :class:`cpl.database.database_settings.DatabaseSettings` db_settings: :class:`cpl_core.database.database_settings.DatabaseSettings`
Database settings Database settings
""" """
pass pass
@ -77,6 +77,6 @@ class ServiceCollectionABC(ABC):
Returns Returns
------- -------
Object of type :class:`cpl.dependency_injection.service_provider_abc.ServiceProviderABC` Object of type :class:`cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC`
""" """
pass pass

View File

@ -10,7 +10,7 @@ class ServiceDescriptor:
--------- ---------
implementation: Union[:class:`type`, Optional[:class:`object`]] implementation: Union[:class:`type`, Optional[:class:`object`]]
Object or type of service Object or type of service
lifetime: :class:`cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum` lifetime: :class:`cpl_core.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum`
Lifetime of the service Lifetime of the service
""" """

View File

@ -16,11 +16,11 @@ class ServiceProvider(ServiceProviderABC):
Parameter Parameter
--------- ---------
service_descriptors: list[:class:`cpl.dependency_injection.service_descriptor.ServiceDescriptor`] service_descriptors: list[:class:`cpl_core.dependency_injection.service_descriptor.ServiceDescriptor`]
Descriptor of the service Descriptor of the service
config: :class:`cpl.configuration.configuration_abc.ConfigurationABC` config: :class:`cpl_core.configuration.configuration_abc.ConfigurationABC`
CPL Configuration CPL Configuration
db_context: Optional[:class:`cpl.database.context.database_context_abc.DatabaseContextABC`] db_context: Optional[:class:`cpl_core.database.context.database_context_abc.DatabaseContextABC`]
Database representation Database representation
""" """

View File

@ -4,7 +4,7 @@ from typing import Type, Optional
class ServiceProviderABC(ABC): class ServiceProviderABC(ABC):
r"""ABC for the class :class:`cpl.dependency_injection.service_provider.ServiceProvider`""" r"""ABC for the class :class:`cpl_core.dependency_injection.service_provider.ServiceProvider`"""
@abstractmethod @abstractmethod
def __init__(self): def __init__(self):

View File

@ -12,7 +12,7 @@ class ApplicationEnvironment(ApplicationEnvironmentABC):
Parameter Parameter
--------- ---------
name: :class:`cpl.environment.environment_name_enum.EnvironmentNameEnum` name: :class:`cpl_core.environment.environment_name_enum.EnvironmentNameEnum`
""" """
def __init__(self, name: EnvironmentNameEnum = EnvironmentNameEnum.production): def __init__(self, name: EnvironmentNameEnum = EnvironmentNameEnum.production):

View File

@ -3,7 +3,7 @@ from datetime import datetime
class ApplicationEnvironmentABC(ABC): class ApplicationEnvironmentABC(ABC):
r"""ABC of the class :class:`cpl.environment.application_environment.ApplicationEnvironment`""" r"""ABC of the class :class:`cpl_core.environment.application_environment.ApplicationEnvironment`"""
@abstractmethod @abstractmethod
def __init__(self): def __init__(self):

View File

@ -2,7 +2,7 @@ from abc import abstractmethod, ABC
class LoggerABC(ABC): class LoggerABC(ABC):
r"""ABC for :class:`cpl.logging.logger_service.Logger`""" r"""ABC for :class:`cpl_core.logging.logger_service.Logger`"""
@abstractmethod @abstractmethod
def __init__(self): def __init__(self):

View File

@ -17,11 +17,11 @@ class Logger(LoggerABC):
Parameter Parameter
--------- ---------
logging_settings: :class:`cpl.logging.logging_settings.LoggingSettings` logging_settings: :class:`cpl_core.logging.logging_settings.LoggingSettings`
Settings for the logger Settings for the logger
time_format: :class:`cpl.time.time_format_settings.TimeFormatSettings` time_format: :class:`cpl_core.time.time_format_settings.TimeFormatSettings`
Time format settings Time format settings
env: :class:`cpl.environment.application_environment_abc.ApplicationEnvironmentABC` env: :class:`cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC`
Environment of the application Environment of the application
""" """
@ -116,7 +116,7 @@ class Logger(LoggerABC):
--------- ---------
name: :class:`str` name: :class:`str`
Name of the message Name of the message
level: :class:`cpl.logging.logging_level_enum.LoggingLevelEnum` level: :class:`cpl_core.logging.logging_level_enum.LoggingLevelEnum`
Logging level Logging level
message: :class:`str` message: :class:`str`
Log message Log message

View File

@ -4,7 +4,7 @@ from cpl_core.mailing.email import EMail
class EMailClientABC(ABC): class EMailClientABC(ABC):
"""ABC of :class:`cpl.mailing.email_client_service.EMailClient`""" """ABC of :class:`cpl_core.mailing.email_client_service.EMailClient`"""
@abstractmethod @abstractmethod
def __init__(self): def __init__(self):
@ -21,7 +21,7 @@ class EMailClientABC(ABC):
Parameter Parameter
--------- ---------
email: :class:`cpl.mailing.email.EMail` email: :class:`cpl_core.mailing.email.EMail`
Object of the E-Mail to send Object of the E-Mail to send
""" """
pass pass

View File

@ -15,11 +15,11 @@ class EMailClient(EMailClientABC):
Parameter Parameter
--------- ---------
environment: :class:`cpl.environment.application_environment_abc.ApplicationEnvironmentABC` environment: :class:`cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC`
Environment of the application Environment of the application
logger: :class:`cpl.logging.logger_abc.LoggerABC` logger: :class:`cpl_core.logging.logger_abc.LoggerABC`
The logger to use The logger to use
mail_settings: :class:`cpl.mailing.email_client_settings.EMailClientSettings` mail_settings: :class:`cpl_core.mailing.email_client_settings.EMailClientSettings`
Settings for mailing Settings for mailing
""" """

View File

@ -2,6 +2,7 @@ from cpl_core.application.startup_abc import StartupABC
from cpl_core.configuration.configuration_abc import ConfigurationABC from cpl_core.configuration.configuration_abc import ConfigurationABC
from cpl_core.dependency_injection.service_collection_abc import ServiceCollectionABC from cpl_core.dependency_injection.service_collection_abc import ServiceCollectionABC
from cpl_core.dependency_injection.service_provider_abc import ServiceProviderABC from cpl_core.dependency_injection.service_provider_abc import ServiceProviderABC
from cpl_core.environment import ApplicationEnvironmentABC
from cpl_core.logging.logger_service import Logger from cpl_core.logging.logger_service import Logger
from cpl_core.logging.logger_abc import LoggerABC from cpl_core.logging.logger_abc import LoggerABC
from cpl_core.mailing.email_client_service import EMailClient from cpl_core.mailing.email_client_service import EMailClient
@ -11,24 +12,21 @@ from test_service import TestService
class Startup(StartupABC): class Startup(StartupABC):
def __init__(self, config: ConfigurationABC, services: ServiceCollectionABC): def __init__(self):
StartupABC.__init__(self) StartupABC.__init__(self)
self._configuration = config def configure_configuration(self, config: ConfigurationABC, env: ApplicationEnvironmentABC) -> ConfigurationABC:
self._services = services config.add_environment_variables('PYTHON_')
config.add_environment_variables('CPL_')
config.add_json_file(f'appsettings.json')
config.add_json_file(f'appsettings.{config.environment.environment_name}.json')
config.add_json_file(f'appsettings.{config.environment.host_name}.json', optional=True)
def configure_configuration(self) -> ConfigurationABC: return config
self._configuration.add_environment_variables('PYTHON_')
self._configuration.add_environment_variables('CPL_')
self._configuration.add_json_file(f'appsettings.json')
self._configuration.add_json_file(f'appsettings.{self._configuration.environment.environment_name}.json')
self._configuration.add_json_file(f'appsettings.{self._configuration.environment.host_name}.json', optional=True)
return self._configuration def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC) -> ServiceProviderABC:
services.add_singleton(LoggerABC, Logger)
services.add_singleton(EMailClientABC, EMailClient)
services.add_singleton(TestService)
def configure_services(self) -> ServiceProviderABC: return services.build_service_provider()
self._services.add_singleton(LoggerABC, Logger)
self._services.add_singleton(EMailClientABC, EMailClient)
self._services.add_singleton(TestService)
return self._services.build_service_provider()