<spanid="cpl-core-configuration-argument-abc-module"></span><h2>cpl_core.configuration.argument_abc module<aclass="headerlink"href="#module-cpl_core.configuration.argument_abc"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.argument_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">ArgumentABC</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">token</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">aliases</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prevent_next_executable</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">console_arguments</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="s"><spanclass="pre">'ArgumentABC'</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_console_argument</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">arg_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"title="cpl_core.configuration.argument_type_enum.ArgumentTypeEnum"><spanclass="pre">ArgumentTypeEnum</span></a></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">*</span></span><spanclass="n"><spanclass="pre">args</span></span></em>, <emclass="sig-param"><spanclass="o"><spanclass="pre">**</span></span><spanclass="n"><spanclass="pre">kwargs</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><aclass="reference internal"href="#cpl_core.configuration.argument_abc.ArgumentABC"title="cpl_core.configuration.argument_abc.ArgumentABC"><spanclass="pre">ArgumentABC</span></a></span></span><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC.add_console_argument"title="Permalink to this definition"></a></dt>
<dd><p>Creates and adds a console argument to known console arguments</p>
<dlclass="simple">
<dt>Parameter:</dt><dd><dlclass="simple">
<dt>arg_type: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Specifies the specific type of the argument</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><p>self <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">cpl_core.configuration.console_argument.ConsoleArgument</span></code> not created argument!</p>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">aliases</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC.aliases"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">console_arguments</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="s"><spanclass="pre">'ArgumentABC'</span></span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC.console_arguments"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">name</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC.name"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">prevent_next_executable</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">bool</span></em><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC.prevent_next_executable"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">token</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><aclass="headerlink"href="#cpl_core.configuration.argument_abc.ArgumentABC.token"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-argument-builder-module"></span><h2>cpl_core.configuration.argument_builder module<aclass="headerlink"href="#module-cpl_core.configuration.argument_builder"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.argument_builder.</span></span><spanclass="sig-name descname"><spanclass="pre">ArgumentBuilder</span></span><aclass="headerlink"href="#cpl_core.configuration.argument_builder.ArgumentBuilder"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-argument-executable-abc-module"></span><h2>cpl_core.configuration.argument_executable_abc module<aclass="headerlink"href="#module-cpl_core.configuration.argument_executable_abc"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.argument_executable_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">ArgumentExecutableABC</span></span><aclass="headerlink"href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">run</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">args</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC.run"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-argument-type-enum-module"></span><h2>cpl_core.configuration.argument_type_enum module<aclass="headerlink"href="#module-cpl_core.configuration.argument_type_enum"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.argument_type_enum.</span></span><spanclass="sig-name descname"><spanclass="pre">ArgumentTypeEnum</span></span><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.argument_type_enum.ArgumentTypeEnum"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">Executable</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">1</span></em><aclass="headerlink"href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Executable"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">Flag</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">0</span></em><aclass="headerlink"href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Flag"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">Variable</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="pre">3</span></em><aclass="headerlink"href="#cpl_core.configuration.argument_type_enum.ArgumentTypeEnum.Variable"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-configuration-module"></span><h2>cpl_core.configuration.configuration module<aclass="headerlink"href="#module-cpl_core.configuration.configuration"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration.</span></span><spanclass="sig-name descname"><spanclass="pre">Configuration</span></span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_configuration</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">T</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">any</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.add_configuration"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">add_console_argument</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">argument</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.argument_abc.ArgumentABC"title="cpl_core.configuration.argument_abc.ArgumentABC"><spanclass="pre">ArgumentABC</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>
<spanclass="sig-name descname"><spanclass="pre">add_environment_variables</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></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>
<spanclass="sig-name descname"><spanclass="pre">add_json_file</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></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="w"></span><spanclass="n"><spanclass="pre">bool</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></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="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></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="w"></span><spanclass="n"><spanclass="pre">str</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></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><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">additional_arguments</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.additional_arguments"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">argument_error_function</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">Callable</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></em><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.argument_error_function"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">arguments</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.argument_abc.ArgumentABC"title="cpl_core.configuration.argument_abc.ArgumentABC"><spanclass="pre">cpl_core.configuration.argument_abc.ArgumentABC</span></a><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.arguments"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>Specifies name of argument</p>
</dd>
<dt>aliases list[<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>]</dt><dd><p>Specifies possible aliases of name</p>
</dd>
<dt>value_token <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Specifies were the value begins</p>
</dd>
<dt>is_value_token_optional <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></dt><dd><p>Specifies if values are optional</p>
</dd>
<dt>runnable: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies class to run when called if value is not None</p>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">environment</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><aclass="reference internal"href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><spanclass="pre">ApplicationEnvironmentABC</span></a></em><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.environment"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">for_each_argument</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">call</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Callable</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.for_each_argument"title="Permalink to this definition"></a></dt>
<dd><p>Iterates through all arguments and calls the call function</p>
<spanclass="sig-name descname"><spanclass="pre">get_configuration</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">search_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Type</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">T</span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">T</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span></span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.get_configuration"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">parse_console_arguments</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">services</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><spanclass="pre">ServiceProviderABC</span></a></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">bool</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span></span></span><aclass="headerlink"href="#cpl_core.configuration.configuration.Configuration.parse_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>
<spanid="cpl-core-configuration-configuration-abc-module"></span><h2>cpl_core.configuration.configuration_abc module<aclass="headerlink"href="#module-cpl_core.configuration.configuration_abc"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">ConfigurationABC</span></span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">add_configuration</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">key_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">T</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">any</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><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">add_console_argument</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">argument</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.argument_abc.ArgumentABC"title="cpl_core.configuration.argument_abc.ArgumentABC"><spanclass="pre">ArgumentABC</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><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">add_environment_variables</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">prefix</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></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><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">add_json_file</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></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="w"></span><spanclass="n"><spanclass="pre">bool</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></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="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></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="w"></span><spanclass="n"><spanclass="pre">str</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></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="w"></span><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">additional_arguments</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></em><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="w"></span><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">argument_error_function</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">Callable</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></em><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="w"></span><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">arguments</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.argument_abc.ArgumentABC"title="cpl_core.configuration.argument_abc.ArgumentABC"><spanclass="pre">cpl_core.configuration.argument_abc.ArgumentABC</span></a><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.arguments"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>Specifies name of argument</p>
</dd>
<dt>aliases list[<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>]</dt><dd><p>Specifies possible aliases of name</p>
</dd>
<dt>value_token <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code></dt><dd><p>Specifies were the value begins</p>
</dd>
<dt>is_value_token_optional <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code></dt><dd><p>Specifies if values are optional</p>
</dd>
<dt>runnable: <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">cpl_core.configuration.console_argument.ConsoleArgumentABC</span></code></dt><dd><p>Specifies class to run when called if value is not None</p>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">environment</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><aclass="reference internal"href="cpl_core.environment.html#cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"title="cpl_core.environment.application_environment_abc.ApplicationEnvironmentABC"><spanclass="pre">ApplicationEnvironmentABC</span></a></em><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.environment"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">for_each_argument</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">call</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Callable</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.for_each_argument"title="Permalink to this definition"></a></dt>
<dd><p>Iterates through all arguments and calls the call function</p>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">get_configuration</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">search_type</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">Type</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">T</span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">T</span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span></span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.get_configuration"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">parse_console_arguments</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">services</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="cpl_core.dependency_injection.html#cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"title="cpl_core.dependency_injection.service_provider_abc.ServiceProviderABC"><spanclass="pre">ServiceProviderABC</span></a></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">error</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span></span></span><aclass="headerlink"href="#cpl_core.configuration.configuration_abc.ConfigurationABC.parse_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>
<spanid="cpl-core-configuration-configuration-model-abc-module"></span><h2>cpl_core.configuration.configuration_model_abc module<aclass="headerlink"href="#module-cpl_core.configuration.configuration_model_abc"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_model_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">ConfigurationModelABC</span></span><aclass="headerlink"href="#cpl_core.configuration.configuration_model_abc.ConfigurationModelABC"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">from_dict</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">settings</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></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>
<dd><p>DEPRECATED: Set attributes as typed arguments in __init__ instead. See <> for further information
<spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_model_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">base_func</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">method</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.configuration_model_abc.base_func"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-configuration-variable-name-enum-module"></span><h2>cpl_core.configuration.configuration_variable_name_enum module<aclass="headerlink"href="#module-cpl_core.configuration.configuration_variable_name_enum"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.configuration_variable_name_enum.</span></span><spanclass="sig-name descname"><spanclass="pre">ConfigurationVariableNameEnum</span></span><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>
<spanclass="sig-name descname"><spanclass="pre">customer</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></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>
<spanclass="sig-name descname"><spanclass="pre">environment</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></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>
<spanclass="sig-name descname"><spanclass="pre">name</span></span><emclass="property"><spanclass="w"></span><spanclass="p"><spanclass="pre">=</span></span><spanclass="w"></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><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">to_list</span></span><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-executable-argument-module"></span><h2>cpl_core.configuration.executable_argument module<aclass="headerlink"href="#module-cpl_core.configuration.executable_argument"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">executable_type</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">type</span></em><aclass="headerlink"href="#cpl_core.configuration.executable_argument.ExecutableArgument.executable_type"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">run</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">args</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.executable_argument.ExecutableArgument.run"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">set_executable</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">executable</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><aclass="reference internal"href="#cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"title="cpl_core.configuration.argument_executable_abc.ArgumentExecutableABC"><spanclass="pre">ArgumentExecutableABC</span></a></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.executable_argument.ExecutableArgument.set_executable"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">validators</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">Type</span><spanclass="p"><spanclass="pre">[</span></span><aclass="reference internal"href="#cpl_core.configuration.validator_abc.ValidatorABC"title="cpl_core.configuration.validator_abc.ValidatorABC"><spanclass="pre">cpl_core.configuration.validator_abc.ValidatorABC</span></a><spanclass="p"><spanclass="pre">]</span></span><spanclass="p"><spanclass="pre">]</span></span></em><aclass="headerlink"href="#cpl_core.configuration.executable_argument.ExecutableArgument.validators"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-flag-argument-module"></span><h2>cpl_core.configuration.flag_argument module<aclass="headerlink"href="#module-cpl_core.configuration.flag_argument"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.flag_argument.</span></span><spanclass="sig-name descname"><spanclass="pre">FlagArgument</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">token</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">aliases</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="pre">str</span><spanclass="p"><spanclass="pre">]</span></span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">prevent_next_executable</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">bool</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">False</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">console_arguments</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">list</span><spanclass="p"><spanclass="pre">[</span></span><spanclass="s"><spanclass="pre">'ArgumentABC'</span></span><spanclass="p"><spanclass="pre">]</span></span><spanclass="w"></span><spanclass="p"><spanclass="pre">|</span></span><spanclass="w"></span><spanclass="pre">None</span></span><spanclass="w"></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="w"></span><spanclass="default_value"><spanclass="pre">None</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.flag_argument.FlagArgument"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-validator-abc-module"></span><h2>cpl_core.configuration.validator_abc module<aclass="headerlink"href="#module-cpl_core.configuration.validator_abc"title="Permalink to this heading"></a></h2>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.validator_abc.</span></span><spanclass="sig-name descname"><spanclass="pre">ValidatorABC</span></span><aclass="headerlink"href="#cpl_core.configuration.validator_abc.ValidatorABC"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">abstract</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">validate</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><spanclass="sig-return"><spanclass="sig-return-icon">→</span><spanclass="sig-return-typehint"><spanclass="pre">bool</span></span></span><aclass="headerlink"href="#cpl_core.configuration.validator_abc.ValidatorABC.validate"title="Permalink to this definition"></a></dt>
<spanid="cpl-core-configuration-variable-argument-module"></span><h2>cpl_core.configuration.variable_argument module<aclass="headerlink"href="#module-cpl_core.configuration.variable_argument"title="Permalink to this heading"></a></h2>
<spanclass="sig-name descname"><spanclass="pre">set_value</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">value</span></span><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="n"><spanclass="pre">str</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.variable_argument.VariableArgument.set_value"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">value</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><aclass="headerlink"href="#cpl_core.configuration.variable_argument.VariableArgument.value"title="Permalink to this definition"></a></dt>
<emclass="property"><spanclass="pre">property</span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">value_token</span></span><emclass="property"><spanclass="p"><spanclass="pre">:</span></span><spanclass="w"></span><spanclass="pre">str</span></em><aclass="headerlink"href="#cpl_core.configuration.variable_argument.VariableArgument.value_token"title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<sectionid="module-cpl_core.configuration">
<spanid="module-contents"></span><h2>Module contents<aclass="headerlink"href="#module-cpl_core.configuration"title="Permalink to this heading"></a></h2>
<sectionid="cpl-core-cpl-core">
<h3>cpl-core CPL core<aclass="headerlink"href="#cpl-core-cpl-core"title="Permalink to this heading"></a></h3>
<emclass="property"><spanclass="pre">class</span><spanclass="w"></span></em><spanclass="sig-prename descclassname"><spanclass="pre">cpl_core.configuration.</span></span><spanclass="sig-name descname"><spanclass="pre">VersionInfo</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">major</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">minor</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">micro</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#cpl_core.configuration.VersionInfo"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">major</span></span><aclass="headerlink"href="#cpl_core.configuration.VersionInfo.major"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">micro</span></span><aclass="headerlink"href="#cpl_core.configuration.VersionInfo.micro"title="Permalink to this definition"></a></dt>
<spanclass="sig-name descname"><spanclass="pre">minor</span></span><aclass="headerlink"href="#cpl_core.configuration.VersionInfo.minor"title="Permalink to this definition"></a></dt>