diff --git a/docs/build/doctrees/cpl.application.doctree b/docs/build/doctrees/cpl.application.doctree index 560c8ea5..40c60815 100644 Binary files a/docs/build/doctrees/cpl.application.doctree and b/docs/build/doctrees/cpl.application.doctree differ diff --git a/docs/build/doctrees/cpl.configuration.doctree b/docs/build/doctrees/cpl.configuration.doctree index 2d85bac5..412dbfb9 100644 Binary files a/docs/build/doctrees/cpl.configuration.doctree and b/docs/build/doctrees/cpl.configuration.doctree differ diff --git a/docs/build/doctrees/cpl.doctree b/docs/build/doctrees/cpl.doctree index 7a450865..362f23e8 100644 Binary files a/docs/build/doctrees/cpl.doctree and b/docs/build/doctrees/cpl.doctree differ diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 0f490a0d..4f3ac721 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/html/_sources/cpl.rst.txt b/docs/build/html/_sources/cpl.rst.txt index d795b28b..6afbf38c 100644 --- a/docs/build/html/_sources/cpl.rst.txt +++ b/docs/build/html/_sources/cpl.rst.txt @@ -15,10 +15,3 @@ CPL cpl.time cpl.utils -Module contents ---------------- - -.. automodule:: cpl - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/cpl.application.html b/docs/build/html/cpl.application.html index 5968025d..fe3e47b7 100644 --- a/docs/build/html/cpl.application.html +++ b/docs/build/html/cpl.application.html @@ -102,7 +102,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • @@ -243,7 +242,7 @@

    Sets the custom startup class to use

    -
    startup: Type[cpl.application.startup_abc.StartupABC]

    Type of cpl.application.startup_abc.StartupABC

    +
    startup: Type[cpl.application.startup_abc.StartupABC]

    Startup class to use

    @@ -274,7 +273,7 @@

    Sets the custom startup class to use

    -
    startup: Type[cpl.application.startup_abc.StartupABC]

    Type of cpl.application.startup_abc.StartupABC

    +
    startup: Type[cpl.application.startup_abc.StartupABC]

    Startup class to use

    diff --git a/docs/build/html/cpl.configuration.html b/docs/build/html/cpl.configuration.html index ca822655..4235fba0 100644 --- a/docs/build/html/cpl.configuration.html +++ b/docs/build/html/cpl.configuration.html @@ -103,7 +103,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • @@ -186,45 +185,53 @@
    add_configuration(key_type: Union[str, type], value: cpl.configuration.configuration_model_abc.ConfigurationModelABC)
    -

    Add configuration object -:param key_type: -:param value: -:return:

    +

    Add configuration object

    +
    +

    key_type: Union[str, type] +value: cpl.configuration.configuration_model_abc.ConfigurationModelABC

    +
    add_console_argument(argument: cpl.configuration.console_argument.ConsoleArgument)
    -

    Adds console argument to known console arguments -:param argument: -:return:

    +

    Adds console argument to known console arguments

    +
    +

    argument: cpl.console.console_argument.ConsoleArgument

    +
    add_console_arguments(error: Optional[bool] = None)
    -

    Reads the console arguments -:param error: defines is invalid argument error will be shown or not -:return:

    +

    Reads the console arguments

    +
    +
    +
    error: bool

    Defines is invalid argument error will be shown or not

    +
    +
    +
    add_environment_variables(prefix: str)
    -

    Reads the environment variables -:param prefix: -:return:

    +

    Reads the environment variables

    +
    +

    prefix: str

    +
    add_json_file(name: str, optional: Optional[bool] = None, output: bool = True, path: Optional[str] = None)
    -

    Reads and saves settings from given json file -:param name: -:param optional: -:param output: -:param path: -:return:

    +

    Reads and saves settings from given json file

    +
    +

    name (str): Name of the file +optional: str +output: bool +path: str

    +
    @@ -245,9 +252,13 @@
    get_configuration(search_type: Union[str, Type[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]) → Union[str, collections.abc.Callable[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]
    -

    Returns value in configuration by given type -:param search_type: -:return:

    +

    Returns value from configuration by given type

    +
    +
    +
    +
    @@ -261,46 +272,54 @@

    Bases: abc.ABC

    -abstract add_configuration(key_type: Union[str, type], value: object)
    -

    Add configuration object -:param key_type: -:param value: -:return:

    +abstract add_configuration(key_type: Union[str, type], value: cpl.configuration.configuration_model_abc.ConfigurationModelABC) +

    Add configuration object

    +
    +

    key_type: Union[str, type] +value: cpl.configuration.configuration_model_abc.ConfigurationModelABC

    +
    abstract add_console_argument(argument: cpl.configuration.console_argument.ConsoleArgument)
    -

    Adds console argument to known console arguments -:param argument: -:return:

    +

    Adds console argument to known console arguments

    +
    +

    argument: cpl.console.console_argument.ConsoleArgument

    +
    abstract add_console_arguments(error: Optional[bool] = None)
    -

    Reads the console arguments -:param error: defines is invalid argument error will be shown or not -:return:

    +

    Reads the console arguments

    +
    +
    +
    error: bool

    Defines is invalid argument error will be shown or not

    +
    +
    +
    abstract add_environment_variables(prefix: str)
    -

    Reads the environment variables -:param prefix: -:return:

    +

    Reads the environment variables

    +
    +

    prefix: str

    +
    abstract add_json_file(name: str, optional: Optional[bool] = None, output: bool = True, path: Optional[str] = None)
    -

    Reads and saves settings from given json file -:param name: -:param optional: -:param output: -:param path: -:return:

    +

    Reads and saves settings from given json file

    +
    +

    name (str): Name of the file +optional: str +output: bool +path: str

    +
    @@ -321,9 +340,13 @@
    abstract get_configuration(search_type: Union[str, Type[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]) → Union[str, collections.abc.Callable[cpl.configuration.configuration_model_abc.ConfigurationModelABC]]
    -

    Returns value in configuration by given type -:param search_type: -:return:

    +

    Returns value from configuration by given type

    +
    +
    +
    +
    diff --git a/docs/build/html/cpl.console.html b/docs/build/html/cpl.console.html index 91b46497..9b456b14 100644 --- a/docs/build/html/cpl.console.html +++ b/docs/build/html/cpl.console.html @@ -103,7 +103,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.database.connection.html b/docs/build/html/cpl.database.connection.html index dc165f53..5fca1026 100644 --- a/docs/build/html/cpl.database.connection.html +++ b/docs/build/html/cpl.database.connection.html @@ -108,7 +108,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.database.context.html b/docs/build/html/cpl.database.context.html index fa9b5b99..9ce6d4a5 100644 --- a/docs/build/html/cpl.database.context.html +++ b/docs/build/html/cpl.database.context.html @@ -108,7 +108,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.database.html b/docs/build/html/cpl.database.html index 254db858..ae07374e 100644 --- a/docs/build/html/cpl.database.html +++ b/docs/build/html/cpl.database.html @@ -104,7 +104,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.dependency_injection.html b/docs/build/html/cpl.dependency_injection.html index 53c010eb..c480dd0d 100644 --- a/docs/build/html/cpl.dependency_injection.html +++ b/docs/build/html/cpl.dependency_injection.html @@ -104,7 +104,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.environment.html b/docs/build/html/cpl.environment.html index c9b1c20a..1ae3cce7 100644 --- a/docs/build/html/cpl.environment.html +++ b/docs/build/html/cpl.environment.html @@ -101,7 +101,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.html b/docs/build/html/cpl.html index e385a5e2..1cff5bb5 100644 --- a/docs/build/html/cpl.html +++ b/docs/build/html/cpl.html @@ -96,10 +96,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents -
    • @@ -257,47 +253,6 @@ -
    -

    Module contents

    -
    -

    sh_cpl sh-edraft Common Python library

    -

    sh-edraft Common Python library

    -
    -
    copyright
    -
      -

    1. 2020 - 2021 sh-edraft.de

      2. -
    -
    -
    license
    -

    MIT, see LICENSE for more details.

    -
    -
    -
    -
    -class cpl.VersionInfo(major, minor, micro)
    -

    Bases: tuple

    -
    -
    -major
    -

    Alias for field number 0

    -
    - -
    -
    -micro
    -

    Alias for field number 2

    -
    - -
    -
    -minor
    -

    Alias for field number 1

    -
    - -
    - -
    -
    diff --git a/docs/build/html/cpl.logging.html b/docs/build/html/cpl.logging.html index 426b6c87..6c82e33d 100644 --- a/docs/build/html/cpl.logging.html +++ b/docs/build/html/cpl.logging.html @@ -103,7 +103,6 @@
  • cpl.mailing
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.mailing.html b/docs/build/html/cpl.mailing.html index f45db848..f5e20219 100644 --- a/docs/build/html/cpl.mailing.html +++ b/docs/build/html/cpl.mailing.html @@ -103,7 +103,6 @@
  • cpl.time
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.time.html b/docs/build/html/cpl.time.html index 059ea17b..2d20b516 100644 --- a/docs/build/html/cpl.time.html +++ b/docs/build/html/cpl.time.html @@ -100,7 +100,6 @@
  • cpl.utils
    • -
  • Module contents
    • diff --git a/docs/build/html/cpl.utils.html b/docs/build/html/cpl.utils.html index fb16443a..b1c968d1 100644 --- a/docs/build/html/cpl.utils.html +++ b/docs/build/html/cpl.utils.html @@ -100,7 +100,6 @@
  • cpl.utils.string
    • -
  • Module contents
    • diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 2ed2fcca..bebd5175 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -390,13 +390,6 @@
  • convert_to_snake_case() (cpl.utils.string.String static method)
  • - cpl - -
    • -
  • cpl.application.application_abc
  • main() (cpl.application.application_abc.ApplicationABC method) -
    • -
  • major (cpl.VersionInfo attribute) -
    • -
  • micro (cpl.VersionInfo attribute) -
    • -
  • minor (cpl.VersionInfo attribute)
  • module
    • -
  • Module contents -
    • diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index e43e2b70..a5faa26a 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index 48cc3020..28ab8d35 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -165,7 +165,7 @@ - cpl + cpl diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 3515e753..4a466f51 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["cpl","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","index","modules"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cpl.rst","cpl.application.rst","cpl.configuration.rst","cpl.console.rst","cpl.database.rst","cpl.database.connection.rst","cpl.database.context.rst","cpl.dependency_injection.rst","cpl.environment.rst","cpl.logging.rst","cpl.mailing.rst","cpl.time.rst","cpl.utils.rst","index.rst","modules.rst"],objects:{"":{cpl:[0,0,0,"-"]},"cpl.VersionInfo":{major:[0,2,1,""],micro:[0,2,1,""],minor:[0,2,1,""]},"cpl.application":{application_abc:[1,0,0,"-"],application_builder:[1,0,0,"-"],application_builder_abc:[1,0,0,"-"],startup_abc:[1,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[1,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[1,3,1,""],main:[1,3,1,""],run:[1,3,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[1,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[1,3,1,""],use_startup:[1,3,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[1,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[1,3,1,""],use_startup:[1,3,1,""]},"cpl.application.startup_abc":{StartupABC:[1,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[1,3,1,""],configure_services:[1,3,1,""]},"cpl.configuration":{configuration:[2,0,0,"-"],configuration_abc:[2,0,0,"-"],configuration_model_abc:[2,0,0,"-"],configuration_variable_name_enum:[2,0,0,"-"],console_argument:[2,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[2,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[2,3,1,""],add_console_argument:[2,3,1,""],add_console_arguments:[2,3,1,""],add_environment_variables:[2,3,1,""],add_json_file:[2,3,1,""],additional_arguments:[2,3,1,""],argument_error_function:[2,3,1,""],environment:[2,3,1,""],get_configuration:[2,3,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[2,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[2,3,1,""],add_console_argument:[2,3,1,""],add_console_arguments:[2,3,1,""],add_environment_variables:[2,3,1,""],add_json_file:[2,3,1,""],additional_arguments:[2,3,1,""],argument_error_function:[2,3,1,""],environment:[2,3,1,""],get_configuration:[2,3,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[2,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[2,3,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[2,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[2,2,1,""],environment:[2,2,1,""],name:[2,2,1,""],to_list:[2,3,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[2,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[2,3,1,""],console_arguments:[2,3,1,""],is_value_token_optional:[2,3,1,""],name:[2,3,1,""],token:[2,3,1,""],value_token:[2,3,1,""]},"cpl.console":{background_color_enum:[3,0,0,"-"],console:[3,0,0,"-"],console_call:[3,0,0,"-"],foreground_color_enum:[3,0,0,"-"],spinner_thread:[3,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[3,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[3,2,1,""],blue:[3,2,1,""],cyan:[3,2,1,""],green:[3,2,1,""],grey:[3,2,1,""],magenta:[3,2,1,""],red:[3,2,1,""],white:[3,2,1,""],yellow:[3,2,1,""]},"cpl.console.console":{Console:[3,1,1,""]},"cpl.console.console.Console":{background_color:[3,2,1,""],banner:[3,3,1,""],clear:[3,3,1,""],close:[3,3,1,""],color_reset:[3,3,1,""],disable:[3,3,1,""],enable:[3,3,1,""],error:[3,3,1,""],foreground_color:[3,2,1,""],read:[3,3,1,""],read_line:[3,3,1,""],reset_cursor_position:[3,3,1,""],select:[3,3,1,""],set_background_color:[3,3,1,""],set_cursor_position:[3,3,1,""],set_foreground_color:[3,3,1,""],set_hold_back:[3,3,1,""],spinner:[3,3,1,""],table:[3,3,1,""],write:[3,3,1,""],write_at:[3,3,1,""],write_line:[3,3,1,""],write_line_at:[3,3,1,""]},"cpl.console.console_call":{ConsoleCall:[3,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[3,3,1,""],args:[3,3,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[3,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[3,2,1,""],blue:[3,2,1,""],cyan:[3,2,1,""],green:[3,2,1,""],grey:[3,2,1,""],magenta:[3,2,1,""],red:[3,2,1,""],white:[3,2,1,""],yellow:[3,2,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[3,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[3,3,1,""],run:[3,3,1,""],stop_spinning:[3,3,1,""]},"cpl.database":{database_model:[4,0,0,"-"],database_settings:[4,0,0,"-"],database_settings_name_enum:[4,0,0,"-"]},"cpl.database.connection":{database_connection:[5,0,0,"-"],database_connection_abc:[5,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[5,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[5,3,1,""],engine:[5,3,1,""],session:[5,3,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[5,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[5,3,1,""],engine:[5,3,1,""],session:[5,3,1,""]},"cpl.database.context":{database_context:[6,0,0,"-"],database_context_abc:[6,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[6,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[6,3,1,""],engine:[6,3,1,""],save_changes:[6,3,1,""],session:[6,3,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[6,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[6,3,1,""],engine:[6,3,1,""],save_changes:[6,3,1,""],session:[6,3,1,""]},"cpl.database.database_settings":{DatabaseSettings:[4,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[4,3,1,""],case_sensitive:[4,3,1,""],connection_string:[4,3,1,""],credentials:[4,3,1,""],echo:[4,3,1,""],encoding:[4,3,1,""],from_dict:[4,3,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[4,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[4,2,1,""],case_sensitive:[4,2,1,""],connection_string:[4,2,1,""],credentials:[4,2,1,""],echo:[4,2,1,""],encoding:[4,2,1,""]},"cpl.dependency_injection":{service_collection:[7,0,0,"-"],service_collection_abc:[7,0,0,"-"],service_descriptor:[7,0,0,"-"],service_lifetime_enum:[7,0,0,"-"],service_provider:[7,0,0,"-"],service_provider_abc:[7,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[7,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[7,3,1,""],add_logging:[7,3,1,""],add_scoped:[7,3,1,""],add_singleton:[7,3,1,""],add_transient:[7,3,1,""],build_service_provider:[7,3,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[7,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[7,3,1,""],add_logging:[7,3,1,""],add_scoped:[7,3,1,""],add_singleton:[7,3,1,""],add_transient:[7,3,1,""],build_service_provider:[7,3,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[7,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[7,3,1,""],lifetime:[7,3,1,""],service_type:[7,3,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[7,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[7,2,1,""],scoped:[7,2,1,""],singleton:[7,2,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[7,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[7,3,1,""],get_service:[7,3,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[7,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[7,3,1,""],get_service:[7,3,1,""]},"cpl.environment":{application_environment:[8,0,0,"-"],application_environment_abc:[8,0,0,"-"],environment_name_enum:[8,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[8,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[8,3,1,""],customer:[8,3,1,""],date_time_now:[8,3,1,""],end_time:[8,3,1,""],environment_name:[8,3,1,""],host_name:[8,3,1,""],runtime_directory:[8,3,1,""],set_runtime_directory:[8,3,1,""],set_working_directory:[8,3,1,""],start_time:[8,3,1,""],working_directory:[8,3,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[8,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[8,3,1,""],customer:[8,3,1,""],date_time_now:[8,3,1,""],end_time:[8,3,1,""],environment_name:[8,3,1,""],host_name:[8,3,1,""],runtime_directory:[8,3,1,""],set_runtime_directory:[8,3,1,""],set_working_directory:[8,3,1,""],start_time:[8,3,1,""],working_directory:[8,3,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[8,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[8,2,1,""],production:[8,2,1,""],staging:[8,2,1,""],testing:[8,2,1,""]},"cpl.logging":{logger_abc:[9,0,0,"-"],logger_service:[9,0,0,"-"],logging_level_enum:[9,0,0,"-"],logging_settings:[9,0,0,"-"],logging_settings_name_enum:[9,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[9,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[9,3,1,""],error:[9,3,1,""],fatal:[9,3,1,""],header:[9,3,1,""],info:[9,3,1,""],trace:[9,3,1,""],warn:[9,3,1,""]},"cpl.logging.logger_service":{Logger:[9,1,1,""]},"cpl.logging.logger_service.Logger":{create:[9,3,1,""],debug:[9,3,1,""],error:[9,3,1,""],fatal:[9,3,1,""],header:[9,3,1,""],info:[9,3,1,""],trace:[9,3,1,""],warn:[9,3,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[9,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[9,2,1,""],ERROR:[9,2,1,""],FATAL:[9,2,1,""],INFO:[9,2,1,""],OFF:[9,2,1,""],TRACE:[9,2,1,""],WARN:[9,2,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[9,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[9,3,1,""],filename:[9,3,1,""],from_dict:[9,3,1,""],level:[9,3,1,""],path:[9,3,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[9,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[9,2,1,""],file_level:[9,2,1,""],filename:[9,2,1,""],path:[9,2,1,""]},"cpl.mailing":{email:[10,0,0,"-"],email_client_abc:[10,0,0,"-"],email_client_service:[10,0,0,"-"],email_client_settings:[10,0,0,"-"],email_client_settings_name_enum:[10,0,0,"-"]},"cpl.mailing.email":{EMail:[10,1,1,""]},"cpl.mailing.email.EMail":{add_header:[10,3,1,""],add_receiver:[10,3,1,""],body:[10,3,1,""],check_mail:[10,3,1,""],get_content:[10,3,1,""],header:[10,3,1,""],header_list:[10,3,1,""],receiver:[10,3,1,""],receiver_list:[10,3,1,""],subject:[10,3,1,""],transceiver:[10,3,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[10,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[10,3,1,""],send_mail:[10,3,1,""]},"cpl.mailing.email_client_service":{EMailClient:[10,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[10,3,1,""],create:[10,3,1,""],login:[10,3,1,""],send_mail:[10,3,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[10,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[10,3,1,""],from_dict:[10,3,1,""],host:[10,3,1,""],port:[10,3,1,""],user_name:[10,3,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[10,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[10,2,1,""],host:[10,2,1,""],port:[10,2,1,""],user_name:[10,2,1,""]},"cpl.time":{time_format_settings:[11,0,0,"-"],time_format_settings_names_enum:[11,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[11,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[11,3,1,""],date_time_format:[11,3,1,""],date_time_log_format:[11,3,1,""],from_dict:[11,3,1,""],time_format:[11,3,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[11,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[11,2,1,""],date_time_format:[11,2,1,""],date_time_log_format:[11,2,1,""],time_format:[11,2,1,""]},"cpl.utils":{credential_manager:[12,0,0,"-"],pip:[12,0,0,"-"],string:[12,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[12,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[12,3,1,""],decrypt:[12,3,1,""],encrypt:[12,3,1,""]},"cpl.utils.pip":{Pip:[12,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[12,3,1,""],get_outdated:[12,3,1,""],get_package:[12,3,1,""],install:[12,3,1,""],reset_executable:[12,3,1,""],set_executable:[12,3,1,""],uninstall:[12,3,1,""]},"cpl.utils.string":{String:[12,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[12,3,1,""],convert_to_snake_case:[12,3,1,""],first_to_lower:[12,3,1,""],first_to_upper:[12,3,1,""],random_string:[12,3,1,""]},cpl:{VersionInfo:[0,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method"},terms:{"2020":0,"2021":0,"abstract":[1,2,5,6,7,8,9,10],"byte":12,"case":12,"char":[3,12],"class":[0,1,2,3,4,5,6,7,8,9,10,11,12],"default":3,"enum":[2,3,4,7,8,9,10,11],"function":[3,12],"int":[3,12],"new":3,"return":[2,3,4,5,6,7,8,9,10,11,12],"static":[2,10,12],"transient":7,"true":2,The:13,These:13,Useful:[3,12],abc:[1,2,3,5,6,7,8,9,10],about:13,activ:3,add:[2,7,10],add_configur:2,add_console_argu:2,add_db_context:7,add_environment_vari:2,add_head:10,add_json_fil:2,add_log:7,add_receiv:10,add_scop:7,add_singleton:7,add_transi:7,additional_argu:2,address:10,alia:0,alias:2,ani:3,app:[1,13],applic:[0,3,13,14],application_abc:[0,14],application_build:[0,14],application_builder_abc:[0,14],application_environ:[0,14],application_environment_abc:[0,9,10,14],application_nam:8,applicationabc:1,applicationbuild:1,applicationbuilderabc:1,applicationenviron:8,applicationenvironmentabc:[8,9,10],appset:1,arg:[1,3,6,12],argument:2,argument_error_funct:2,attribut:[2,4,9,10,11],auth_plugin:4,authplugin:4,background:3,background_color:3,background_color_enum:[0,14],backgroundcolorenum:3,banner:3,base64:12,base:[0,1,2,3,4,5,6,7,8,9,10,11,12],blue:3,bodi:10,bool:[2,3,10],build:[1,12],build_servic:7,build_service_provid:7,build_str:12,call:[1,3],callabl:[2,3,7],camel:12,can:13,case_sensit:4,casesensit:4,chang:6,check:10,check_mail:10,classmethod:[3,12],clear:3,close:3,collect:[2,3,7],color:3,color_reset:3,command:12,common:[13,14],complex:13,config:[1,7],configur:[0,1,4,7,9,10,11,14],configuration_abc:[0,1,7,14],configuration_model_abc:[0,4,9,10,11,14],configuration_variable_name_enum:[0,14],configurationabc:[1,2,7],configurationmodelabc:[2,4,9,10,11],configurationvariablenameenum:2,configure_configur:1,configure_servic:1,connect:[0,4,6,10,14],connection_str:[4,5,6],connectionstr:4,consol:[0,2,9,14],console_argu:[0,14],console_cal:[0,14],console_level:9,consoleargu:2,consolecal:3,consoleloglevel:9,contain:1,content:14,context:[0,4,7,14],convert:[2,4,9,10,11,12],convert_to_camel_cas:12,convert_to_snake_cas:12,copyright:0,creat:[1,7,9,10,12,13],credenti:[4,10,12],credential_manag:[0,14],credentialmanag:12,current:8,cursor:3,cursor_background_color:3,cursor_foreground_color:3,custom:[1,2,8],cyan:3,databas:[0,7,14],database_connect:[0,4,14],database_connection_abc:[0,4,14],database_context:[0,4,14],database_context_abc:[0,4,7,14],database_model:[0,14],database_set:[0,5,6,7,14],database_settings_name_enum:[0,14],databaseconnect:5,databaseconnectionabc:5,databasecontext:6,databasecontextabc:[6,7],databaseset:[4,5,6,7],databasesettingsnameenum:4,date_format:11,date_time_format:11,date_time_log_format:11,date_time_now:8,dateformat:11,datetimeformat:11,datetimelogformat:11,db_context:7,db_context_typ:7,db_set:7,debug:9,decod:12,decrypt:12,defin:2,dependency_inject:[0,1,14],desktop:13,detail:[0,13],develop:[8,13],dict:[2,4,9,10,11],directori:8,disabl:3,echo:4,edraft:14,effici:13,email:[0,14],email_client_abc:[0,14],email_client_servic:[0,14],email_client_set:[0,14],email_client_settings_name_enum:[0,14],emailcli:10,emailclientabc:10,emailclientset:10,emailclientsettingsnameenum:10,enabl:3,encod:[4,12],encrypt:12,end:3,end_tim:8,engin:[5,6],enterpris:13,entri:[1,3],enumer:[2,3,4,7,8,9,10,11],env:9,environ:[0,2,9,10,14],environment_nam:8,environment_name_enum:[0,14],environmentnameenum:8,error:[2,3,9],everyth:13,except:9,execut:12,exit:[3,9],fatal:9,field:0,file:2,file_level:9,fileloglevel:9,filenam:9,first:[12,13],first_to_low:12,first_to_upp:12,foreground:3,foreground_color:3,foreground_color_enum:[0,14],foregroundcolorenum:3,from:[1,2,13],from_dict:[2,4,9,10,11],get:12,get_configur:2,get_cont:10,get_execut:12,get_outd:12,get_packag:12,get_servic:7,given:[2,3,7,12],great:13,green:3,grei:3,handl:[3,12],has:3,header:[3,9,10],header_background_color:3,header_foreground_color:3,header_list:10,help:13,host:10,host_nam:8,implement:7,info:9,inform:9,input:3,instal:12,instanc:[1,7],instance_typ:7,interact:3,intern:7,invalid:2,is_value_token_opt:2,json:2,key_typ:2,known:2,kwarg:3,learn:13,length:12,level:9,librari:[13,14],licens:0,lifetim:7,line:3,list:[2,3,7,10,12],load:1,local:12,log:[0,10,14],logfil:9,logger:[7,9,10],logger_abc:[0,10,14],logger_servic:[0,14],loggerabc:[9,10],logging_level_enum:[0,14],logging_set:[0,14],logging_settings_name_enum:[0,14],logginglevelenum:9,loggingset:9,loggingsettingsnameenum:9,login:10,lower:12,magenta:3,mail:[0,14],mail_set:10,main:1,major:0,meant:13,menu:3,messag:[3,9],micro:0,minor:0,mit:0,modul:14,more:0,msg_len:3,name:[2,8,9],next:3,none:[2,3,7,9,10,12],number:0,object:[1,2,3,7,10,12],off:9,on_blu:3,on_cyan:3,on_default:3,on_green:3,on_grei:3,on_magenta:3,on_r:3,on_whit:3,on_yellow:3,option:[2,3,7,9,10,12],option_background_color:3,option_foreground_color:3,outdat:12,output:[2,3],packag:[12,13],page:13,param:[2,3,4,5,6,7,8,9,10,11,12],path:[2,9],pip:[0,14],platform:13,point:[1,3],port:10,posit:3,prefix:2,prepar:1,print:3,product:8,properti:[2,3,4,5,6,7,8,9,10,11],provid:[1,7],python:[13,14],random:12,random_str:12,read:[2,3],read_lin:3,receiv:10,receiver_list:10,red:3,reset:[3,12],reset_cursor_posit:3,reset_execut:12,run:[1,3],runtim:8,runtime_directori:8,save:[2,6],save_chang:6,scope:7,search_typ:2,see:0,select:3,send:10,send_mail:10,server:[10,13],servic:[1,7],service_collect:[0,14],service_collection_abc:[0,14],service_descriptor:[0,14],service_lifetime_enum:[0,14],service_provid:[0,14],service_provider_abc:[0,1,14],service_typ:7,servicecollect:7,servicecollectionabc:7,servicedescriptor:7,servicelifetimeenum:7,serviceprovid:7,serviceproviderabc:[1,7],session:[5,6],set:[1,2,3,4,8,9,10,11,12],set_background_color:3,set_cursor_posit:3,set_execut:12,set_foreground_color:3,set_hold_back:3,set_runtime_directori:8,set_working_directori:8,sh_cpl:14,show:3,shown:2,simpl:13,singleton:7,snake:12,sourc:12,spinner:3,spinner_background_color:3,spinner_foreground_color:3,spinner_thread:[0,14],spinnerthread:3,stage:8,standard:12,start_tim:8,startup:1,startup_abc:[0,14],startupabc:1,stderr:12,stdout:12,stop:3,stop_spin:3,str:[2,3,5,6,8,9,10,12],string:[0,3,5,6,9,10,14],subject:10,submodul:[0,14],system:12,tabl:[3,12],test:8,text_background_color:3,text_foreground_color:3,thi:[1,13],thread:3,time:[0,9,14],time_format:[9,11],time_format_set:[0,9,14],time_format_settings_names_enum:[0,14],timeformat:11,timeformatset:[9,11],timeformatsettingsnamesenum:11,to_list:2,token:2,trace:9,traceback:3,transceiv:10,tree:9,tupl:0,type:[1,2,7],understand:13,uninstal:12,union:[2,3,7],upper:12,use:[1,13],use_startup:1,used:1,user_nam:10,usernam:10,util:[0,14],valid:10,valu:[2,3,4,7,8,9,10,11],value_token:2,variabl:2,versioninfo:0,warn:9,when:3,white:3,work:8,working_directori:8,write:[3,9],write_at:3,write_lin:3,write_line_at:3,yellow:3,you:13,your:13},titles:["CPL","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","Introduction to the CPL Docs","cpl"],titleterms:{applic:1,application_abc:1,application_build:1,application_builder_abc:1,application_environ:8,application_environment_abc:8,background_color_enum:3,common:0,configur:2,configuration_abc:2,configuration_model_abc:2,configuration_variable_name_enum:2,connect:5,consol:3,console_argu:2,console_cal:3,content:0,context:6,cpl:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],credential_manag:12,databas:[4,5,6],database_connect:5,database_connection_abc:5,database_context:6,database_context_abc:6,database_model:4,database_set:4,database_settings_name_enum:4,dependency_inject:7,doc:13,edraft:0,email:10,email_client_abc:10,email_client_servic:10,email_client_set:10,email_client_settings_name_enum:10,environ:8,environment_name_enum:8,foreground_color_enum:3,introduct:13,librari:0,log:9,logger_abc:9,logger_servic:9,logging_level_enum:9,logging_set:9,logging_settings_name_enum:9,mail:10,manual:13,modul:0,pip:12,python:0,service_collect:7,service_collection_abc:7,service_descriptor:7,service_lifetime_enum:7,service_provid:7,service_provider_abc:7,sh_cpl:0,spinner_thread:3,startup_abc:1,string:12,submodul:4,time:11,time_format_set:11,time_format_settings_names_enum:11,util:12}}) \ No newline at end of file +Search.setIndex({docnames:["cpl","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","index","modules"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["cpl.rst","cpl.application.rst","cpl.configuration.rst","cpl.console.rst","cpl.database.rst","cpl.database.connection.rst","cpl.database.context.rst","cpl.dependency_injection.rst","cpl.environment.rst","cpl.logging.rst","cpl.mailing.rst","cpl.time.rst","cpl.utils.rst","index.rst","modules.rst"],objects:{"cpl.application":{application_abc:[1,0,0,"-"],application_builder:[1,0,0,"-"],application_builder_abc:[1,0,0,"-"],startup_abc:[1,0,0,"-"]},"cpl.application.application_abc":{ApplicationABC:[1,1,1,""]},"cpl.application.application_abc.ApplicationABC":{configure:[1,2,1,""],main:[1,2,1,""],run:[1,2,1,""]},"cpl.application.application_builder":{ApplicationBuilder:[1,1,1,""]},"cpl.application.application_builder.ApplicationBuilder":{build:[1,2,1,""],use_startup:[1,2,1,""]},"cpl.application.application_builder_abc":{ApplicationBuilderABC:[1,1,1,""]},"cpl.application.application_builder_abc.ApplicationBuilderABC":{build:[1,2,1,""],use_startup:[1,2,1,""]},"cpl.application.startup_abc":{StartupABC:[1,1,1,""]},"cpl.application.startup_abc.StartupABC":{configure_configuration:[1,2,1,""],configure_services:[1,2,1,""]},"cpl.configuration":{configuration:[2,0,0,"-"],configuration_abc:[2,0,0,"-"],configuration_model_abc:[2,0,0,"-"],configuration_variable_name_enum:[2,0,0,"-"],console_argument:[2,0,0,"-"]},"cpl.configuration.configuration":{Configuration:[2,1,1,""]},"cpl.configuration.configuration.Configuration":{add_configuration:[2,2,1,""],add_console_argument:[2,2,1,""],add_console_arguments:[2,2,1,""],add_environment_variables:[2,2,1,""],add_json_file:[2,2,1,""],additional_arguments:[2,2,1,""],argument_error_function:[2,2,1,""],environment:[2,2,1,""],get_configuration:[2,2,1,""]},"cpl.configuration.configuration_abc":{ConfigurationABC:[2,1,1,""]},"cpl.configuration.configuration_abc.ConfigurationABC":{add_configuration:[2,2,1,""],add_console_argument:[2,2,1,""],add_console_arguments:[2,2,1,""],add_environment_variables:[2,2,1,""],add_json_file:[2,2,1,""],additional_arguments:[2,2,1,""],argument_error_function:[2,2,1,""],environment:[2,2,1,""],get_configuration:[2,2,1,""]},"cpl.configuration.configuration_model_abc":{ConfigurationModelABC:[2,1,1,""]},"cpl.configuration.configuration_model_abc.ConfigurationModelABC":{from_dict:[2,2,1,""]},"cpl.configuration.configuration_variable_name_enum":{ConfigurationVariableNameEnum:[2,1,1,""]},"cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum":{customer:[2,3,1,""],environment:[2,3,1,""],name:[2,3,1,""],to_list:[2,2,1,""]},"cpl.configuration.console_argument":{ConsoleArgument:[2,1,1,""]},"cpl.configuration.console_argument.ConsoleArgument":{aliases:[2,2,1,""],console_arguments:[2,2,1,""],is_value_token_optional:[2,2,1,""],name:[2,2,1,""],token:[2,2,1,""],value_token:[2,2,1,""]},"cpl.console":{background_color_enum:[3,0,0,"-"],console:[3,0,0,"-"],console_call:[3,0,0,"-"],foreground_color_enum:[3,0,0,"-"],spinner_thread:[3,0,0,"-"]},"cpl.console.background_color_enum":{BackgroundColorEnum:[3,1,1,""]},"cpl.console.background_color_enum.BackgroundColorEnum":{"default":[3,3,1,""],blue:[3,3,1,""],cyan:[3,3,1,""],green:[3,3,1,""],grey:[3,3,1,""],magenta:[3,3,1,""],red:[3,3,1,""],white:[3,3,1,""],yellow:[3,3,1,""]},"cpl.console.console":{Console:[3,1,1,""]},"cpl.console.console.Console":{background_color:[3,3,1,""],banner:[3,2,1,""],clear:[3,2,1,""],close:[3,2,1,""],color_reset:[3,2,1,""],disable:[3,2,1,""],enable:[3,2,1,""],error:[3,2,1,""],foreground_color:[3,3,1,""],read:[3,2,1,""],read_line:[3,2,1,""],reset_cursor_position:[3,2,1,""],select:[3,2,1,""],set_background_color:[3,2,1,""],set_cursor_position:[3,2,1,""],set_foreground_color:[3,2,1,""],set_hold_back:[3,2,1,""],spinner:[3,2,1,""],table:[3,2,1,""],write:[3,2,1,""],write_at:[3,2,1,""],write_line:[3,2,1,""],write_line_at:[3,2,1,""]},"cpl.console.console_call":{ConsoleCall:[3,1,1,""]},"cpl.console.console_call.ConsoleCall":{"function":[3,2,1,""],args:[3,2,1,""]},"cpl.console.foreground_color_enum":{ForegroundColorEnum:[3,1,1,""]},"cpl.console.foreground_color_enum.ForegroundColorEnum":{"default":[3,3,1,""],blue:[3,3,1,""],cyan:[3,3,1,""],green:[3,3,1,""],grey:[3,3,1,""],magenta:[3,3,1,""],red:[3,3,1,""],white:[3,3,1,""],yellow:[3,3,1,""]},"cpl.console.spinner_thread":{SpinnerThread:[3,1,1,""]},"cpl.console.spinner_thread.SpinnerThread":{exit:[3,2,1,""],run:[3,2,1,""],stop_spinning:[3,2,1,""]},"cpl.database":{database_model:[4,0,0,"-"],database_settings:[4,0,0,"-"],database_settings_name_enum:[4,0,0,"-"]},"cpl.database.connection":{database_connection:[5,0,0,"-"],database_connection_abc:[5,0,0,"-"]},"cpl.database.connection.database_connection":{DatabaseConnection:[5,1,1,""]},"cpl.database.connection.database_connection.DatabaseConnection":{connect:[5,2,1,""],engine:[5,2,1,""],session:[5,2,1,""]},"cpl.database.connection.database_connection_abc":{DatabaseConnectionABC:[5,1,1,""]},"cpl.database.connection.database_connection_abc.DatabaseConnectionABC":{connect:[5,2,1,""],engine:[5,2,1,""],session:[5,2,1,""]},"cpl.database.context":{database_context:[6,0,0,"-"],database_context_abc:[6,0,0,"-"]},"cpl.database.context.database_context":{DatabaseContext:[6,1,1,""]},"cpl.database.context.database_context.DatabaseContext":{connect:[6,2,1,""],engine:[6,2,1,""],save_changes:[6,2,1,""],session:[6,2,1,""]},"cpl.database.context.database_context_abc":{DatabaseContextABC:[6,1,1,""]},"cpl.database.context.database_context_abc.DatabaseContextABC":{connect:[6,2,1,""],engine:[6,2,1,""],save_changes:[6,2,1,""],session:[6,2,1,""]},"cpl.database.database_settings":{DatabaseSettings:[4,1,1,""]},"cpl.database.database_settings.DatabaseSettings":{auth_plugin:[4,2,1,""],case_sensitive:[4,2,1,""],connection_string:[4,2,1,""],credentials:[4,2,1,""],echo:[4,2,1,""],encoding:[4,2,1,""],from_dict:[4,2,1,""]},"cpl.database.database_settings_name_enum":{DatabaseSettingsNameEnum:[4,1,1,""]},"cpl.database.database_settings_name_enum.DatabaseSettingsNameEnum":{auth_plugin:[4,3,1,""],case_sensitive:[4,3,1,""],connection_string:[4,3,1,""],credentials:[4,3,1,""],echo:[4,3,1,""],encoding:[4,3,1,""]},"cpl.dependency_injection":{service_collection:[7,0,0,"-"],service_collection_abc:[7,0,0,"-"],service_descriptor:[7,0,0,"-"],service_lifetime_enum:[7,0,0,"-"],service_provider:[7,0,0,"-"],service_provider_abc:[7,0,0,"-"]},"cpl.dependency_injection.service_collection":{ServiceCollection:[7,1,1,""]},"cpl.dependency_injection.service_collection.ServiceCollection":{add_db_context:[7,2,1,""],add_logging:[7,2,1,""],add_scoped:[7,2,1,""],add_singleton:[7,2,1,""],add_transient:[7,2,1,""],build_service_provider:[7,2,1,""]},"cpl.dependency_injection.service_collection_abc":{ServiceCollectionABC:[7,1,1,""]},"cpl.dependency_injection.service_collection_abc.ServiceCollectionABC":{add_db_context:[7,2,1,""],add_logging:[7,2,1,""],add_scoped:[7,2,1,""],add_singleton:[7,2,1,""],add_transient:[7,2,1,""],build_service_provider:[7,2,1,""]},"cpl.dependency_injection.service_descriptor":{ServiceDescriptor:[7,1,1,""]},"cpl.dependency_injection.service_descriptor.ServiceDescriptor":{implementation:[7,2,1,""],lifetime:[7,2,1,""],service_type:[7,2,1,""]},"cpl.dependency_injection.service_lifetime_enum":{ServiceLifetimeEnum:[7,1,1,""]},"cpl.dependency_injection.service_lifetime_enum.ServiceLifetimeEnum":{"transient":[7,3,1,""],scoped:[7,3,1,""],singleton:[7,3,1,""]},"cpl.dependency_injection.service_provider":{ServiceProvider:[7,1,1,""]},"cpl.dependency_injection.service_provider.ServiceProvider":{build_service:[7,2,1,""],get_service:[7,2,1,""]},"cpl.dependency_injection.service_provider_abc":{ServiceProviderABC:[7,1,1,""]},"cpl.dependency_injection.service_provider_abc.ServiceProviderABC":{build_service:[7,2,1,""],get_service:[7,2,1,""]},"cpl.environment":{application_environment:[8,0,0,"-"],application_environment_abc:[8,0,0,"-"],environment_name_enum:[8,0,0,"-"]},"cpl.environment.application_environment":{ApplicationEnvironment:[8,1,1,""]},"cpl.environment.application_environment.ApplicationEnvironment":{application_name:[8,2,1,""],customer:[8,2,1,""],date_time_now:[8,2,1,""],end_time:[8,2,1,""],environment_name:[8,2,1,""],host_name:[8,2,1,""],runtime_directory:[8,2,1,""],set_runtime_directory:[8,2,1,""],set_working_directory:[8,2,1,""],start_time:[8,2,1,""],working_directory:[8,2,1,""]},"cpl.environment.application_environment_abc":{ApplicationEnvironmentABC:[8,1,1,""]},"cpl.environment.application_environment_abc.ApplicationEnvironmentABC":{application_name:[8,2,1,""],customer:[8,2,1,""],date_time_now:[8,2,1,""],end_time:[8,2,1,""],environment_name:[8,2,1,""],host_name:[8,2,1,""],runtime_directory:[8,2,1,""],set_runtime_directory:[8,2,1,""],set_working_directory:[8,2,1,""],start_time:[8,2,1,""],working_directory:[8,2,1,""]},"cpl.environment.environment_name_enum":{EnvironmentNameEnum:[8,1,1,""]},"cpl.environment.environment_name_enum.EnvironmentNameEnum":{development:[8,3,1,""],production:[8,3,1,""],staging:[8,3,1,""],testing:[8,3,1,""]},"cpl.logging":{logger_abc:[9,0,0,"-"],logger_service:[9,0,0,"-"],logging_level_enum:[9,0,0,"-"],logging_settings:[9,0,0,"-"],logging_settings_name_enum:[9,0,0,"-"]},"cpl.logging.logger_abc":{LoggerABC:[9,1,1,""]},"cpl.logging.logger_abc.LoggerABC":{debug:[9,2,1,""],error:[9,2,1,""],fatal:[9,2,1,""],header:[9,2,1,""],info:[9,2,1,""],trace:[9,2,1,""],warn:[9,2,1,""]},"cpl.logging.logger_service":{Logger:[9,1,1,""]},"cpl.logging.logger_service.Logger":{create:[9,2,1,""],debug:[9,2,1,""],error:[9,2,1,""],fatal:[9,2,1,""],header:[9,2,1,""],info:[9,2,1,""],trace:[9,2,1,""],warn:[9,2,1,""]},"cpl.logging.logging_level_enum":{LoggingLevelEnum:[9,1,1,""]},"cpl.logging.logging_level_enum.LoggingLevelEnum":{DEBUG:[9,3,1,""],ERROR:[9,3,1,""],FATAL:[9,3,1,""],INFO:[9,3,1,""],OFF:[9,3,1,""],TRACE:[9,3,1,""],WARN:[9,3,1,""]},"cpl.logging.logging_settings":{LoggingSettings:[9,1,1,""]},"cpl.logging.logging_settings.LoggingSettings":{console:[9,2,1,""],filename:[9,2,1,""],from_dict:[9,2,1,""],level:[9,2,1,""],path:[9,2,1,""]},"cpl.logging.logging_settings_name_enum":{LoggingSettingsNameEnum:[9,1,1,""]},"cpl.logging.logging_settings_name_enum.LoggingSettingsNameEnum":{console_level:[9,3,1,""],file_level:[9,3,1,""],filename:[9,3,1,""],path:[9,3,1,""]},"cpl.mailing":{email:[10,0,0,"-"],email_client_abc:[10,0,0,"-"],email_client_service:[10,0,0,"-"],email_client_settings:[10,0,0,"-"],email_client_settings_name_enum:[10,0,0,"-"]},"cpl.mailing.email":{EMail:[10,1,1,""]},"cpl.mailing.email.EMail":{add_header:[10,2,1,""],add_receiver:[10,2,1,""],body:[10,2,1,""],check_mail:[10,2,1,""],get_content:[10,2,1,""],header:[10,2,1,""],header_list:[10,2,1,""],receiver:[10,2,1,""],receiver_list:[10,2,1,""],subject:[10,2,1,""],transceiver:[10,2,1,""]},"cpl.mailing.email_client_abc":{EMailClientABC:[10,1,1,""]},"cpl.mailing.email_client_abc.EMailClientABC":{connect:[10,2,1,""],send_mail:[10,2,1,""]},"cpl.mailing.email_client_service":{EMailClient:[10,1,1,""]},"cpl.mailing.email_client_service.EMailClient":{connect:[10,2,1,""],create:[10,2,1,""],login:[10,2,1,""],send_mail:[10,2,1,""]},"cpl.mailing.email_client_settings":{EMailClientSettings:[10,1,1,""]},"cpl.mailing.email_client_settings.EMailClientSettings":{credentials:[10,2,1,""],from_dict:[10,2,1,""],host:[10,2,1,""],port:[10,2,1,""],user_name:[10,2,1,""]},"cpl.mailing.email_client_settings_name_enum":{EMailClientSettingsNameEnum:[10,1,1,""]},"cpl.mailing.email_client_settings_name_enum.EMailClientSettingsNameEnum":{credentials:[10,3,1,""],host:[10,3,1,""],port:[10,3,1,""],user_name:[10,3,1,""]},"cpl.time":{time_format_settings:[11,0,0,"-"],time_format_settings_names_enum:[11,0,0,"-"]},"cpl.time.time_format_settings":{TimeFormatSettings:[11,1,1,""]},"cpl.time.time_format_settings.TimeFormatSettings":{date_format:[11,2,1,""],date_time_format:[11,2,1,""],date_time_log_format:[11,2,1,""],from_dict:[11,2,1,""],time_format:[11,2,1,""]},"cpl.time.time_format_settings_names_enum":{TimeFormatSettingsNamesEnum:[11,1,1,""]},"cpl.time.time_format_settings_names_enum.TimeFormatSettingsNamesEnum":{date_format:[11,3,1,""],date_time_format:[11,3,1,""],date_time_log_format:[11,3,1,""],time_format:[11,3,1,""]},"cpl.utils":{credential_manager:[12,0,0,"-"],pip:[12,0,0,"-"],string:[12,0,0,"-"]},"cpl.utils.credential_manager":{CredentialManager:[12,1,1,""]},"cpl.utils.credential_manager.CredentialManager":{build_string:[12,2,1,""],decrypt:[12,2,1,""],encrypt:[12,2,1,""]},"cpl.utils.pip":{Pip:[12,1,1,""]},"cpl.utils.pip.Pip":{get_executable:[12,2,1,""],get_outdated:[12,2,1,""],get_package:[12,2,1,""],install:[12,2,1,""],reset_executable:[12,2,1,""],set_executable:[12,2,1,""],uninstall:[12,2,1,""]},"cpl.utils.string":{String:[12,1,1,""]},"cpl.utils.string.String":{convert_to_camel_case:[12,2,1,""],convert_to_snake_case:[12,2,1,""],first_to_lower:[12,2,1,""],first_to_upper:[12,2,1,""],random_string:[12,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"abstract":[1,2,5,6,7,8,9,10],"byte":12,"case":12,"char":[3,12],"class":[1,2,3,4,5,6,7,8,9,10,11,12],"default":3,"enum":[2,3,4,7,8,9,10,11],"function":[3,12],"int":[3,12],"new":3,"return":[2,3,4,5,6,7,8,9,10,11,12],"static":[2,10,12],"transient":7,"true":2,The:13,These:13,Useful:[3,12],abc:[1,2,3,5,6,7,8,9,10],about:13,activ:3,add:[2,7,10],add_configur:2,add_console_argu:2,add_db_context:7,add_environment_vari:2,add_head:10,add_json_fil:2,add_log:7,add_receiv:10,add_scop:7,add_singleton:7,add_transi:7,additional_argu:2,address:10,alias:2,ani:3,app:[1,13],applic:[0,3,13,14],application_abc:[0,14],application_build:[0,14],application_builder_abc:[0,14],application_environ:[0,14],application_environment_abc:[0,9,10,14],application_nam:8,applicationabc:1,applicationbuild:1,applicationbuilderabc:1,applicationenviron:8,applicationenvironmentabc:[8,9,10],appset:1,arg:[1,3,6,12],argument:2,argument_error_funct:2,attribut:[2,4,9,10,11],auth_plugin:4,authplugin:4,background:3,background_color:3,background_color_enum:[0,14],backgroundcolorenum:3,banner:3,base64:12,base:[1,2,3,4,5,6,7,8,9,10,11,12],blue:3,bodi:10,bool:[2,3,10],build:[1,12],build_servic:7,build_service_provid:7,build_str:12,call:[1,3],callabl:[2,3,7],camel:12,can:13,case_sensit:4,casesensit:4,chang:6,check:10,check_mail:10,classmethod:[3,12],clear:3,close:3,collect:[2,3,7],color:3,color_reset:3,command:12,common:13,complex:13,config:[1,7],configur:[0,1,4,7,9,10,11,14],configuration_abc:[0,1,7,14],configuration_model_abc:[0,4,9,10,11,14],configuration_variable_name_enum:[0,14],configurationabc:[1,2,7],configurationmodelabc:[2,4,9,10,11],configurationvariablenameenum:2,configure_configur:1,configure_servic:1,connect:[0,4,6,10,14],connection_str:[4,5,6],connectionstr:4,consol:[0,2,9,14],console_argu:[0,14],console_cal:[0,14],console_level:9,consoleargu:2,consolecal:3,consoleloglevel:9,contain:1,context:[0,4,7,14],convert:[2,4,9,10,11,12],convert_to_camel_cas:12,convert_to_snake_cas:12,creat:[1,7,9,10,12,13],credenti:[4,10,12],credential_manag:[0,14],credentialmanag:12,current:8,cursor:3,cursor_background_color:3,cursor_foreground_color:3,custom:[1,2,8],cyan:3,databas:[0,7,14],database_connect:[0,4,14],database_connection_abc:[0,4,14],database_context:[0,4,14],database_context_abc:[0,4,7,14],database_model:[0,14],database_set:[0,5,6,7,14],database_settings_name_enum:[0,14],databaseconnect:5,databaseconnectionabc:5,databasecontext:6,databasecontextabc:[6,7],databaseset:[4,5,6,7],databasesettingsnameenum:4,date_format:11,date_time_format:11,date_time_log_format:11,date_time_now:8,dateformat:11,datetimeformat:11,datetimelogformat:11,db_context:7,db_context_typ:7,db_set:7,debug:9,decod:12,decrypt:12,defin:2,dependency_inject:[0,1,14],desktop:13,detail:13,develop:[8,13],dict:[2,4,9,10,11],directori:8,disabl:3,echo:4,effici:13,email:[0,14],email_client_abc:[0,14],email_client_servic:[0,14],email_client_set:[0,14],email_client_settings_name_enum:[0,14],emailcli:10,emailclientabc:10,emailclientset:10,emailclientsettingsnameenum:10,enabl:3,encod:[4,12],encrypt:12,end:3,end_tim:8,engin:[5,6],enterpris:13,entri:[1,3],enumer:[2,3,4,7,8,9,10,11],env:9,environ:[0,2,9,10,14],environment_nam:8,environment_name_enum:[0,14],environmentnameenum:8,error:[2,3,9],everyth:13,except:9,execut:12,exit:[3,9],fatal:9,file:2,file_level:9,fileloglevel:9,filenam:9,first:[12,13],first_to_low:12,first_to_upp:12,foreground:3,foreground_color:3,foreground_color_enum:[0,14],foregroundcolorenum:3,from:[1,2,13],from_dict:[2,4,9,10,11],get:12,get_configur:2,get_cont:10,get_execut:12,get_outd:12,get_packag:12,get_servic:7,given:[2,3,7,12],great:13,green:3,grei:3,handl:[3,12],has:3,header:[3,9,10],header_background_color:3,header_foreground_color:3,header_list:10,help:13,host:10,host_nam:8,implement:7,info:9,inform:9,input:3,instal:12,instanc:[1,7],instance_typ:7,interact:3,intern:7,invalid:2,is_value_token_opt:2,json:2,key_typ:2,known:2,kwarg:3,learn:13,length:12,level:9,librari:13,lifetim:7,line:3,list:[2,3,7,10,12],load:1,local:12,log:[0,10,14],logfil:9,logger:[7,9,10],logger_abc:[0,10,14],logger_servic:[0,14],loggerabc:[9,10],logging_level_enum:[0,14],logging_set:[0,14],logging_settings_name_enum:[0,14],logginglevelenum:9,loggingset:9,loggingsettingsnameenum:9,login:10,lower:12,magenta:3,mail:[0,14],mail_set:10,main:1,meant:13,menu:3,messag:[3,9],msg_len:3,name:[2,8,9],next:3,none:[2,3,7,9,10,12],object:[1,2,3,7,10,12],off:9,on_blu:3,on_cyan:3,on_default:3,on_green:3,on_grei:3,on_magenta:3,on_r:3,on_whit:3,on_yellow:3,option:[2,3,7,9,10,12],option_background_color:3,option_foreground_color:3,outdat:12,output:[2,3],packag:[12,13],page:13,param:[2,3,4,5,6,7,8,9,10,11,12],path:[2,9],pip:[0,14],platform:13,point:[1,3],port:10,posit:3,prefix:2,prepar:1,print:3,product:8,properti:[2,3,4,5,6,7,8,9,10,11],provid:[1,7],python:13,random:12,random_str:12,read:[2,3],read_lin:3,receiv:10,receiver_list:10,red:3,reset:[3,12],reset_cursor_posit:3,reset_execut:12,run:[1,3],runtim:8,runtime_directori:8,save:[2,6],save_chang:6,scope:7,search_typ:2,select:3,send:10,send_mail:10,server:[10,13],servic:[1,7],service_collect:[0,14],service_collection_abc:[0,14],service_descriptor:[0,14],service_lifetime_enum:[0,14],service_provid:[0,14],service_provider_abc:[0,1,14],service_typ:7,servicecollect:7,servicecollectionabc:7,servicedescriptor:7,servicelifetimeenum:7,serviceprovid:7,serviceproviderabc:[1,7],session:[5,6],set:[1,2,3,4,8,9,10,11,12],set_background_color:3,set_cursor_posit:3,set_execut:12,set_foreground_color:3,set_hold_back:3,set_runtime_directori:8,set_working_directori:8,show:3,shown:2,simpl:13,singleton:7,snake:12,sourc:12,spinner:3,spinner_background_color:3,spinner_foreground_color:3,spinner_thread:[0,14],spinnerthread:3,stage:8,standard:12,start_tim:8,startup:1,startup_abc:[0,14],startupabc:1,stderr:12,stdout:12,stop:3,stop_spin:3,str:[2,3,5,6,8,9,10,12],string:[0,3,5,6,9,10,14],subject:10,submodul:[0,14],system:12,tabl:[3,12],test:8,text_background_color:3,text_foreground_color:3,thi:[1,13],thread:3,time:[0,9,14],time_format:[9,11],time_format_set:[0,9,14],time_format_settings_names_enum:[0,14],timeformat:11,timeformatset:[9,11],timeformatsettingsnamesenum:11,to_list:2,token:2,trace:9,traceback:3,transceiv:10,tree:9,type:[1,2,7],understand:13,uninstal:12,union:[2,3,7],upper:12,use:[1,13],use_startup:1,used:1,user_nam:10,usernam:10,util:[0,14],valid:10,valu:[2,3,4,7,8,9,10,11],value_token:2,variabl:2,warn:9,when:3,white:3,work:8,working_directori:8,write:[3,9],write_at:3,write_lin:3,write_line_at:3,yellow:3,you:13,your:13},titles:["CPL","cpl.application","cpl.configuration","cpl.console","cpl.database","cpl.database.connection","cpl.database.context","cpl.dependency_injection","cpl.environment","cpl.logging","cpl.mailing","cpl.time","cpl.utils","Introduction to the CPL Docs","cpl"],titleterms:{applic:1,application_abc:1,application_build:1,application_builder_abc:1,application_environ:8,application_environment_abc:8,background_color_enum:3,configur:2,configuration_abc:2,configuration_model_abc:2,configuration_variable_name_enum:2,connect:5,consol:3,console_argu:2,console_cal:3,context:6,cpl:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14],credential_manag:12,databas:[4,5,6],database_connect:5,database_connection_abc:5,database_context:6,database_context_abc:6,database_model:4,database_set:4,database_settings_name_enum:4,dependency_inject:7,doc:13,email:10,email_client_abc:10,email_client_servic:10,email_client_set:10,email_client_settings_name_enum:10,environ:8,environment_name_enum:8,foreground_color_enum:3,introduct:13,log:9,logger_abc:9,logger_servic:9,logging_level_enum:9,logging_set:9,logging_settings_name_enum:9,mail:10,manual:13,pip:12,service_collect:7,service_collection_abc:7,service_descriptor:7,service_lifetime_enum:7,service_provid:7,service_provider_abc:7,spinner_thread:3,startup_abc:1,string:12,submodul:4,time:11,time_format_set:11,time_format_settings_names_enum:11,util:12}}) \ No newline at end of file diff --git a/docs/source/cpl.rst b/docs/source/cpl.rst index d795b28b..6afbf38c 100644 --- a/docs/source/cpl.rst +++ b/docs/source/cpl.rst @@ -15,10 +15,3 @@ CPL cpl.time cpl.utils -Module contents ---------------- - -.. automodule:: cpl - :members: - :undoc-members: - :show-inheritance: diff --git a/src/cpl/application/application_builder_abc.py b/src/cpl/application/application_builder_abc.py index c316807d..13c0e2d3 100644 --- a/src/cpl/application/application_builder_abc.py +++ b/src/cpl/application/application_builder_abc.py @@ -19,7 +19,7 @@ class ApplicationBuilderABC(ABC): Parameter --------- startup: Type[:class:`cpl.application.startup_abc.StartupABC`] - Type of :class:`cpl.application.startup_abc.StartupABC` + Startup class to use """ pass diff --git a/src/cpl/configuration/configuration.py b/src/cpl/configuration/configuration.py index 4c7edc7b..0aaf67ca 100644 --- a/src/cpl/configuration/configuration.py +++ b/src/cpl/configuration/configuration.py @@ -18,9 +18,7 @@ from cpl.environment.environment_name_enum import EnvironmentNameEnum class Configuration(ConfigurationABC): def __init__(self): - """ - Representation of configuration - """ + r"""Representation of configuration""" ConfigurationABC.__init__(self) self._application_environment = ApplicationEnvironment() @@ -51,11 +49,12 @@ class Configuration(ConfigurationABC): @staticmethod def _print_info(name: str, message: str): - """ - Prints an info message - :param name: - :param message: - :return: + r"""Prints an info message + + Parameter + --------- + name: :class:`str` + message: :class:`str` """ Console.set_foreground_color(ForegroundColorEnum.green) Console.write_line(f'[{name}] {message}') @@ -63,11 +62,12 @@ class Configuration(ConfigurationABC): @staticmethod def _print_warn(name: str, message: str): - """ - Prints a warning - :param name: - :param message: - :return: + r"""Prints a warning + + Parameter + --------- + name: :class:`str` + message: :class:`str` """ Console.set_foreground_color(ForegroundColorEnum.yellow) Console.write_line(f'[{name}] {message}') @@ -75,22 +75,24 @@ class Configuration(ConfigurationABC): @staticmethod def _print_error(name: str, message: str): - """ - Prints an error - :param name: - :param message: - :return: + r"""Prints an error + + Parameter + --------- + name: :class:`str` + message: :class:`str` """ Console.set_foreground_color(ForegroundColorEnum.red) Console.write_line(f'[{name}] {message}') Console.set_foreground_color(ForegroundColorEnum.default) def _set_variable(self, name: str, value: any): - """ - Sets variable to given value - :param name: - :param value: - :return: + r"""Sets variable to given value + + Parameter + --------- + name: :class:`str` + value: :class:`any` """ if name == ConfigurationVariableNameEnum.environment.value: self._application_environment.environment_name = EnvironmentNameEnum(value) @@ -106,12 +108,21 @@ class Configuration(ConfigurationABC): def _validate_argument_by_argument_type(self, argument: str, argument_type: ConsoleArgument, next_arguments: list[str] = None) -> bool: - """ - Validate argument by argument type - :param argument: - :param argument_type: - :param next_arguments: - :return: + r"""Validate argument by argument type + + Parameter + --------- + argument: :class:`str` + argument_type: :class:`cpl.configuration.console_argument.ConsoleArgument` + next_arguments: list[:class:`str`] + + Returns + ------- + Object of :class:`bool` + + Raises + ------ + Exception: An error occurred getting an argument for a command """ argument_name = '' value = '' @@ -240,6 +251,33 @@ class Configuration(ConfigurationABC): return result + def _load_json_file(self, file: str, output: bool) -> dict: + r"""Reads the json file + + Parameter + --------- + file: :class:`str` + Name of the file + output: :class:`bool` + Specifies whether an output should take place + + Returns + ------- + Object of :class:`dict` + """ + try: + # open config file, create if not exists + with open(file, encoding='utf-8') as cfg: + # load json + json_cfg = json.load(cfg) + if output: + self._print_info(__name__, f'Loaded config file: {file}') + + return json_cfg + except Exception as e: + self._print_error(__name__, f'Cannot load config file: {file}! -> {e}') + return {} + def add_environment_variables(self, prefix: str): for variable in ConfigurationVariableNameEnum.to_list(): var_name = f'{prefix}{variable}' @@ -325,31 +363,11 @@ class Configuration(ConfigurationABC): configuration.from_dict(value) self.add_configuration(sub, configuration) - def _load_json_file(self, file: str, output: bool) -> dict: - """ - Reads the json file - :param file: - :param output: - :return: - """ - try: - # open config file, create if not exists - with open(file, encoding='utf-8') as cfg: - # load json - json_cfg = json.load(cfg) - if output: - self._print_info(__name__, f'Loaded config file: {file}') - - return json_cfg - except Exception as e: - self._print_error(__name__, f'Cannot load config file: {file}! -> {e}') - return {} - def add_configuration(self, key_type: Union[str, type], value: ConfigurationModelABC): self._config[key_type] = value - def get_configuration(self, search_type: Union[str, Type[ConfigurationModelABC]]) -> Union[ - str, Callable[ConfigurationModelABC]]: + def get_configuration(self, search_type: Union[str, Type[ConfigurationModelABC]]) -> \ + Union[str, Callable[ConfigurationModelABC]]: if type(search_type) is str: if search_type == ConfigurationVariableNameEnum.environment.value: return self._application_environment.environment_name diff --git a/src/cpl/configuration/configuration_abc.py b/src/cpl/configuration/configuration_abc.py index 0d0e7ed7..0aaf7f17 100644 --- a/src/cpl/configuration/configuration_abc.py +++ b/src/cpl/configuration/configuration_abc.py @@ -11,9 +11,7 @@ class ConfigurationABC(ABC): @abstractmethod def __init__(self): - """ - ABC of configuration - """ + r"""ABC for the :class:`cpl.configuration.configuration.Configuration`""" pass @property @@ -34,58 +32,73 @@ class ConfigurationABC(ABC): @abstractmethod def add_environment_variables(self, prefix: str): - """ - Reads the environment variables - :param prefix: - :return: + r"""Reads the environment variables + + Parameter + --------- + prefix: :class:`str` """ pass @abstractmethod def add_console_argument(self, argument: ConsoleArgument): - """ - Adds console argument to known console arguments - :param argument: - :return: + r"""Adds console argument to known console arguments + + Parameter + --------- + argument: :class:`cpl.configuration.console_argument.ConsoleArgument` """ pass @abstractmethod def add_console_arguments(self, error: bool = None): - """ - Reads the console arguments - :param error: defines is invalid argument error will be shown or not - :return: + r"""Reads the console arguments + + Parameter + --------- + error: :class:`bool` + Defines is invalid argument error will be shown or not """ pass @abstractmethod def add_json_file(self, name: str, optional: bool = None, output: bool = True, path: str = None): - """ - Reads and saves settings from given json file - :param name: - :param optional: - :param output: - :param path: - :return: + r"""Reads and saves settings from given json file + + Parameter + --------- + name: :class:`str` + Name of the file + optional: :class:`str` + Specifies whether an error should occur if the file was not found + output: :class:`bool` + Specifies whether an output should take place + path: :class:`str` + Path in which the file should be stored """ pass @abstractmethod - def add_configuration(self, key_type: Union[str, type], value: object): - """ - Add configuration object - :param key_type: - :param value: - :return: + def add_configuration(self, key_type: Union[str, type], value: ConfigurationModelABC): + r"""Add configuration object + + Parameter + --------- + key_type: Union[:class:`str`, :class:`type`] + value: :class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC` """ pass @abstractmethod def get_configuration(self, search_type: Union[str, Type[ConfigurationModelABC]]) -> Union[str, Callable[ConfigurationModelABC]]: - """ - Returns value in configuration by given type - :param search_type: - :return: + r"""Returns value from configuration by given type + + Parameter + --------- + search_type: Union[:class:`str`, Type[:class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`]] + + Returns + ------- + Object of Union[:class:`str`, Callable[:class:`cpl.configuration.configuration_model_abc.ConfigurationModelABC`]] """ pass diff --git a/src/cpl/configuration/configuration_model_abc.py b/src/cpl/configuration/configuration_model_abc.py index bcc6ab37..8c1e6849 100644 --- a/src/cpl/configuration/configuration_model_abc.py +++ b/src/cpl/configuration/configuration_model_abc.py @@ -5,16 +5,15 @@ class ConfigurationModelABC(ABC): @abstractmethod def __init__(self): - """ - ABC for settings representation - """ + r"""ABC for settings representation""" pass @abstractmethod def from_dict(self, settings: dict): - """ - Converts attributes to dict - :param settings: - :return: + r"""Converts attributes to dict + + Parameter + --------- + settings: :class:`dict` """ pass diff --git a/src/cpl/configuration/console_argument.py b/src/cpl/configuration/console_argument.py index bc8a4e13..807f74ae 100644 --- a/src/cpl/configuration/console_argument.py +++ b/src/cpl/configuration/console_argument.py @@ -8,14 +8,16 @@ class ConsoleArgument: is_value_token_optional: bool = None, console_arguments: list['ConsoleArgument'] = None ): - """ - Representation of an console argument - :param token: - :param name: - :param aliases: - :param value_token: - :param is_value_token_optional: - :param console_arguments: + r"""Representation of an console argument + + Parameter + --------- + token: :class:`str` + name: :class:`str` + aliases: list[:class:`str`] + value_token: :class:`str` + is_value_token_optional: :class:`bool` + console_arguments: List[:class:`cpl.configuration.console_argument.ConsoleArgument`] """ self._token = token self._name = name