<spanid="config-manager-module"></span><h1>config.manager module<aclass="headerlink" href="#module-config.manager" title="Link to this heading">¶</a></h1>
<p>Provides a way to create and execute configuration files.</p>
<li><p><strong>filepath</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Location where the configuration should be stored. The extension
<codeclass="docutils literal notranslate"><spanclass="pre">.cfg</span></code> can be skipped. It will be added automatically.</p></li>
<li><p><strong>cvar_prefix</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – A prefix that should be added to every console variable.</p></li>
<li><p><strong>indention</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Number of spaces used to indent values within the configuration
file.</p></li>
<li><p><strong>max_line_length</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#int" title="(in Python v3.13)"><em>int</em></a>) – Maximum line length within the configuration file.</p></li>
<spanclass="sig-name descname"><spanclass="pre">command</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">description</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">''</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/config/manager.html#ConfigManager.command"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#config.manager.ConfigManager.command" title="Link to this definition">¶</a></dt>
<dd><p>Add/return a command instance to add to the config file.</p>
<li><p><strong>name</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Name of the command to add.</p></li>
<li><p><strong>description</strong> (<em>str/TranslationString</em>) – Description of the command.</p></li>
<li><p><strong>name</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – Name of the console variable.</p></li>
<li><p><strong>default</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/functions.html#object" title="(in Python v3.13)"><em>object</em></a>) – A default value for the console variable. It will be converted to
a string.</p></li>
<li><p><strong>description</strong> (<em>str/TranslationStrings</em>) – A description of the console variable.</p></li>
<li><p><strong>flags</strong> (<aclass="reference internal" href="cvars.flags.html#cvars.flags.ConVarFlags" title="cvars.flags.ConVarFlags"><em>ConVarFlags</em></a>) – Flags that should be used for the console variable.</p></li>
<spanclass="sig-name descname"><spanclass="pre">execute</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/config/manager.html#ConfigManager.execute"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#config.manager.ConfigManager.execute" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">section</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">name</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">separator</span></span><spanclass="o"><spanclass="pre">=</span></span><spanclass="default_value"><spanclass="pre">'#'</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/config/manager.html#ConfigManager.section"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#config.manager.ConfigManager.section" title="Link to this definition">¶</a></dt>
<dd><p>Add/return a section instance to add to the config file.</p>
<li><p><strong>name</strong> (<em>str/TranslationStrings</em>) – Name of the section to add.</p></li>
<li><p><strong>separator</strong> (<aclass="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)"><em>str</em></a>) – A single separator character to use to separate the section.</p></li>
<spanclass="sig-name descname"><spanclass="pre">text</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">text</span></span></em><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/config/manager.html#ConfigManager.text"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#config.manager.ConfigManager.text" title="Link to this definition">¶</a></dt>
<spanclass="sig-name descname"><spanclass="pre">write</span></span><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal" href="../../_modules/config/manager.html#ConfigManager.write"><spanclass="viewcode-link"><spanclass="pre">[source]</span></span></a><aclass="headerlink" href="#config.manager.ConfigManager.write" title="Link to this definition">¶</a></dt>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">cvar_prefix</span></span><aclass="headerlink" href="#config.manager.ConfigManager.cvar_prefix" title="Link to this definition">¶</a></dt>
<dd><p>Return the convar prefix for the config file.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">filepath</span></span><aclass="headerlink" href="#config.manager.ConfigManager.filepath" title="Link to this definition">¶</a></dt>
<dd><p>Return the file path for the config file.</p>
<p>The path does not include the <codeclass="docutils literal notranslate"><spanclass="pre">.cfg</span></code> file extension.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">fullpath</span></span><aclass="headerlink" href="#config.manager.ConfigManager.fullpath" title="Link to this definition">¶</a></dt>
<dd><p>Return the full path to the configuration file.</p>
<p>The path include the <codeclass="docutils literal notranslate"><spanclass="pre">.cfg</span></code> file extension.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">indention</span></span><aclass="headerlink" href="#config.manager.ConfigManager.indention" title="Link to this definition">¶</a></dt>
<dd><p>Return the indention value for the config file.</p>
<emclass="property"><spanclass="k"><spanclass="pre">property</span></span><spanclass="w"></span></em><spanclass="sig-name descname"><spanclass="pre">max_line_length</span></span><aclass="headerlink" href="#config.manager.ConfigManager.max_line_length" title="Link to this definition">¶</a></dt>
<dd><p>Return the max line length for the config file.</p>