cpl_core.configuration¶
cpl_core.configuration.configuration¶
-
class
cpl_core.configuration.configuration.
Configuration
¶ Bases:
cpl_core.configuration.configuration_abc.ConfigurationABC
-
add_configuration
(key_type: Union[str, type], value: cpl_core.configuration.configuration_model_abc.ConfigurationModelABC)¶ Add configuration object
- key_type: Union[
str
,type
] Type of the value
- value: Union[
str
,cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
] Object of the value
- key_type: Union[
-
add_console_argument
(argument: cpl_core.configuration.console_argument.ConsoleArgument)¶ Adds console argument to known console arguments
- argument:
cpl_core.configuration.console_argument.ConsoleArgument
Specifies the console argument
- argument:
-
add_console_arguments
(error: Optional[bool] = None)¶ Reads the console arguments
- error:
bool
Defines is invalid argument error will be shown or not
- error:
-
add_environment_variables
(prefix: str)¶ Reads the environment variables
- prefix:
str
Prefix of the variables
- prefix:
-
add_json_file
(name: str, optional: Optional[bool] = None, output: bool = True, path: Optional[str] = None)¶ Reads and saves settings from given json file
- name:
str
Name of the file
- optional:
str
Specifies whether an error should occur if the file was not found
- output:
bool
Specifies whether an output should take place
- path:
str
Path in which the file should be stored
- name:
-
property
additional_arguments
¶
-
property
argument_error_function
¶
-
property
environment
¶
-
get_configuration
(search_type: Union[str, Type[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]]) → Union[str, collections.abc.Callable[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]]¶ Returns value from configuration by given type
- search_type: Union[
str
, Type[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
]] Type to search for
Object of Union[
str
, Callable[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
]]- search_type: Union[
-
cpl_core.configuration.configuration_abc¶
-
class
cpl_core.configuration.configuration_abc.
ConfigurationABC
¶ Bases:
abc.ABC
-
abstract
add_configuration
(key_type: Union[str, type], value: Union[str, cpl_core.configuration.configuration_model_abc.ConfigurationModelABC])¶ Add configuration object
- key_type: Union[
str
,type
] Type of the value
- value: Union[
str
,cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
] Object of the value
- key_type: Union[
-
abstract
add_console_argument
(argument: cpl_core.configuration.console_argument.ConsoleArgument)¶ Adds console argument to known console arguments
- argument:
cpl_core.configuration.console_argument.ConsoleArgument
Specifies the console argument
- argument:
-
abstract
add_console_arguments
(error: Optional[bool] = None)¶ Reads the console arguments
- error:
bool
Defines is invalid argument error will be shown or not
- error:
-
abstract
add_environment_variables
(prefix: str)¶ Reads the environment variables
- prefix:
str
Prefix of the variables
- prefix:
-
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
- name:
str
Name of the file
- optional:
str
Specifies whether an error should occur if the file was not found
- output:
bool
Specifies whether an output should take place
- path:
str
Path in which the file should be stored
- name:
-
abstract property
additional_arguments
¶
-
abstract property
argument_error_function
¶
-
abstract property
environment
¶
-
abstract
get_configuration
(search_type: Union[str, Type[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]]) → Union[str, collections.abc.Callable[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC]]¶ Returns value from configuration by given type
- search_type: Union[
str
, Type[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
]] Type to search for
Object of Union[
str
, Callable[cpl_core.configuration.configuration_model_abc.ConfigurationModelABC
]]- search_type: Union[
-
abstract
cpl_core.configuration.configuration_model_abc¶
cpl_core.configuration.configuration_variable_name_enum¶
cpl_core.configuration.console_argument¶
-
class
cpl_core.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
¶
-
property