<spanid="cpl-core-configuration-configuration"></span><h2>cpl_core.configuration.configuration<aclass="headerlink"href="#module-cpl_core.configuration.configuration"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration.</span></code><codeclass="sig-name descname"><spanclass="pre">Configuration</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">add_configuration</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="pre">type</span><spanclass="p"><spanclass="pre">]</span></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><spanclass="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.add_configuration"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">add_console_argument</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">argument</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.console_argument.ConsoleArgument"title="cpl_core.configuration.console_argument.ConsoleArgument"><spanclass="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.add_console_argument"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">add_console_arguments</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">bool</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.add_console_arguments"title="Permalink to this definition">¶</a></dt>
<dt>error: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></dt><dd><p>Defines is invalid argument error will be shown or not</p>
<codeclass="sig-name descname"><spanclass="pre">add_environment_variables</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.add_environment_variables"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">add_json_file</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">optional</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">bool</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">output</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.add_json_file"title="Permalink to this definition">¶</a></dt>
<dt>name: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Name of the file</p>
</dd>
<dt>optional: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Specifies whether an error should occur if the file was not found</p>
</dd>
<dt>output: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></dt><dd><p>Specifies whether an output should take place</p>
</dd>
<dt>path: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Path in which the file should be stored</p>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">additional_arguments</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.additional_arguments"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">argument_error_function</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.argument_error_function"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">environment</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.environment"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">get_configuration</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">search_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="pre">Type</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><spanclass="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span>→<spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="pre">collections.abc.Callable</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><spanclass="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.get_configuration"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-core-configuration-configuration-abc"></span><h2>cpl_core.configuration.configuration_abc<aclass="headerlink"href="#module-cpl_core.configuration.configuration_abc"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_abc.</span></code><codeclass="sig-name descname"><spanclass="pre">ConfigurationABC</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">add_configuration</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="pre">type</span><spanclass="p"><spanclass="pre">]</span></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><aclass="reference internal"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><spanclass="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_configuration"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">add_console_argument</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">argument</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.console_argument.ConsoleArgument"title="cpl_core.configuration.console_argument.ConsoleArgument"><spanclass="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></a></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_argument"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">add_console_arguments</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">bool</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_console_arguments"title="Permalink to this definition">¶</a></dt>
<dt>error: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></dt><dd><p>Defines is invalid argument error will be shown or not</p>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">add_environment_variables</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_environment_variables"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">add_json_file</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">optional</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">bool</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">output</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">True</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">path</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Optional</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.add_json_file"title="Permalink to this definition">¶</a></dt>
<dt>name: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Name of the file</p>
</dd>
<dt>optional: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Specifies whether an error should occur if the file was not found</p>
</dd>
<dt>output: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></dt><dd><p>Specifies whether an output should take place</p>
</dd>
<dt>path: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Path in which the file should be stored</p>
<emclass="property"><spanclass="pre">abstract</span><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">additional_arguments</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.additional_arguments"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">argument_error_function</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.argument_error_function"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">environment</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">get_configuration</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">search_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="pre">Type</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><spanclass="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span>→<spanclass="pre">Union</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">,</span></span><spanclass="pre">collections.abc.Callable</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"><spanclass="pre">cpl_core.configuration.configuration_model_abc.ConfigurationModelABC</span></a><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-core-configuration-configuration-model-abc"></span><h2>cpl_core.configuration.configuration_model_abc<aclass="headerlink"href="#module-cpl_core.configuration.configuration_model_abc"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_model_abc.</span></code><codeclass="sig-name descname"><spanclass="pre">ConfigurationModelABC</span></code><aclass="headerlink"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">abstract</span></em><codeclass="sig-name descname"><spanclass="pre">from_dict</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">settings</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="n"><spanclass="pre">dict</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC.from_dict"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-core-configuration-configuration-variable-name-enum"></span><h2>cpl_core.configuration.configuration_variable_name_enum<aclass="headerlink"href="#module-cpl_core.configuration.configuration_variable_name_enum"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">class</span></em><codeclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_variable_name_enum.</span></code><codeclass="sig-name descname"><spanclass="pre">ConfigurationVariableNameEnum</span></code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">customer</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'CUSTOMER'</span></em><aclass="headerlink"href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.customer"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">environment</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'ENVIRONMENT'</span></em><aclass="headerlink"href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.environment"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname"><spanclass="pre">name</span></code><emclass="property"><spanclass="pre">=</span><spanclass="pre">'NAME'</span></em><aclass="headerlink"href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.name"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">static</span></em><codeclass="sig-name descname"><spanclass="pre">to_list</span></code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_variable_name_enum.ConfigurationVariableNameEnum.to_list"title="Permalink to this definition">¶</a></dt>
<spanid="cpl-core-configuration-console-argument"></span><h2>cpl_core.configuration.console_argument<aclass="headerlink"href="#module-cpl_core.configuration.console_argument"title="Permalink to this headline">¶</a></h2>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">aliases</span></code><aclass="headerlink"href="#cpl_core.configuration.console_argument.ConsoleArgument.aliases"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">console_arguments</span></code><aclass="headerlink"href="#cpl_core.configuration.console_argument.ConsoleArgument.console_arguments"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">is_value_token_optional</span></code><aclass="headerlink"href="#cpl_core.configuration.console_argument.ConsoleArgument.is_value_token_optional"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">name</span></code><aclass="headerlink"href="#cpl_core.configuration.console_argument.ConsoleArgument.name"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">token</span></code><aclass="headerlink"href="#cpl_core.configuration.console_argument.ConsoleArgument.token"title="Permalink to this definition">¶</a></dt>
<emclass="property"><spanclass="pre">property</span></em><codeclass="sig-name descname"><spanclass="pre">value_token</span></code><aclass="headerlink"href="#cpl_core.configuration.console_argument.ConsoleArgument.value_token"title="Permalink to this definition">¶</a></dt>