cpl.configuration

cpl.configuration.configuration module

class cpl.configuration.configuration.Configuration

Bases: cpl.configuration.configuration_abc.ConfigurationABC

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

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

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

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

add_console_arguments(error: Optional[bool] = None)

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

add_environment_variables(prefix: str)

Reads the environment variables :param prefix: :return:

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:

property additional_arguments

property argument_error_function

property environment

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:

cpl.configuration.configuration_abc module

class cpl.configuration.configuration_abc.ConfigurationABC

Bases: abc.ABC

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

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

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

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

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:

abstract add_environment_variables(prefix: str)

Reads the environment variables :param prefix: :return:

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:

abstract property additional_arguments

abstract property argument_error_function

abstract property environment

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:

cpl.configuration.configuration_model_abc module

class cpl.configuration.configuration_model_abc.ConfigurationModelABC

Bases: abc.ABC

abstract from_dict(settings: dict)

Converts attributes to dict :param settings: :return:

cpl.configuration.configuration_variable_name_enum module

class cpl.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum(value)

Bases: enum.Enum

An enumeration.

customer = 'CUSTOMER'

environment = 'ENVIRONMENT'

name = 'NAME'

static to_list()

cpl.configuration.console_argument module

class cpl.configuration.console_argument.ConsoleArgument(token: str, name: str, aliases: list, value_token: str, is_value_token_optional: Optional[bool] = None, console_arguments: Optional[list] = None)

Bases: object

property aliases

property console_arguments

property is_value_token_optional

property name

property token

property value_token