Deployed f20d351 to v0.7.4 with MkDocs 1.6.1 and mike 1.1.2

latest/changelog/index.html

@@ -647,6 +647,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#v074-2025-01-15" class="md-nav__link">
+    v0.7.4 (2025-01-15)
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#v073-2024-12-11" class="md-nav__link">
     v0.7.3 (2024-12-11)
@@ -1067,6 +1074,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#v074-2025-01-15" class="md-nav__link">
+    v0.7.4 (2025-01-15)
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#v073-2024-12-11" class="md-nav__link">
     v0.7.3 (2024-12-11)
@@ -1459,6 +1473,12 @@
 
 
 <h1 id="changelog">Changelog</h1>
+<h2 id="v074-2025-01-15">v0.7.4 (2025-01-15)</h2>
+<ul>
+<li>Allow larger than 4096 bytes config files</li>
+<li>Escape tabs and newline when serializing to a config file</li>
+<li>Fix an infinite loop that occured when resolving a reference to a field with a null value</li>
+</ul>
 <h2 id="v073-2024-12-11">v0.7.3 (2024-12-11)</h2>
 <ul>
 <li>Support interpolated seed in the config file (as a reminder, the seed is treated specifically by confit to initialize random generators <strong>before</strong> any object is resolved)</li>

latest/en/changelog/index.html

@@ -384,6 +384,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#v074-2025-01-15" class="md-nav__link">
+    v0.7.4 (2025-01-15)
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#v073-2024-12-11" class="md-nav__link">
     v0.7.3 (2024-12-11)
@@ -804,6 +811,13 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#v074-2025-01-15" class="md-nav__link">
+    v0.7.4 (2025-01-15)
+  </a>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#v073-2024-12-11" class="md-nav__link">
     v0.7.3 (2024-12-11)
@@ -1196,6 +1210,12 @@
 
 
 <h1 id="changelog">Changelog</h1>
+<h2 id="v074-2025-01-15">v0.7.4 (2025-01-15)</h2>
+<ul>
+<li>Allow larger than 4096 bytes config files</li>
+<li>Escape tabs and newline when serializing to a config file</li>
+<li>Fix an infinite loop that occured when resolving a reference to a field with a null value</li>
+</ul>
 <h2 id="v073-2024-12-11">v0.7.3 (2024-12-11)</h2>
 <ul>
 <li>Support interpolated seed in the config file (as a reminder, the seed is treated specifically by confit to initialize random generators <strong>before</strong> any object is resolved)</li>

latest/en/getting-started/index.html

@@ -589,10 +589,10 @@ <h2 id="a-simple-example">A simple example</h2>
 <p>You can pass multiple configuration files by repeating the <code>--config</code> option. Configuration will be merged in order.</p>
 </div>
 <p>You can still call the <code>function</code> method from your code, but now also benefit from argument validation !</p>
-<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">script</span> <span class="kn">import</span> <span class="n">func</span><span class="p">,</span> <span class="n">BigModel</span><span class="p">,</span> <span class="n">SubModel</span>
+<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">script</span><span class="w"> </span><span class="kn">import</span> <span class="n">func</span><span class="p">,</span> <span class="n">BigModel</span><span class="p">,</span> <span class="n">SubModel</span>
 
 <span class="c1"># To seed before creating the models</span>
-<span class="kn">from</span> <span class="nn">confit.utils.random</span> <span class="kn">import</span> <span class="n">set_seed</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">confit.utils.random</span><span class="w"> </span><span class="kn">import</span> <span class="n">set_seed</span>
 
 <span class="n">seed</span> <span class="o">=</span> <span class="mi">42</span>
 <span class="n">set_seed</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>

latest/en/index.html

@@ -600,17 +600,17 @@ <h3 id="registry">Registry</h3>
 decorator, these objects are accessible as [entry points] and can be
 used in the configuration system.
 To start, you can create a simple registry <code>"factory"</code> as follows:</p>
-<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">confit</span> <span class="kn">import</span> <span class="n">Registry</span><span class="p">,</span> <span class="n">RegistryCollection</span>
+<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">confit</span><span class="w"> </span><span class="kn">import</span> <span class="n">Registry</span><span class="p">,</span> <span class="n">RegistryCollection</span>
 
 
-<span class="k">class</span> <span class="nc">registry</span><span class="p">(</span><span class="n">RegistryCollection</span><span class="p">):</span>
+<span class="k">class</span><span class="w"> </span><span class="nc">registry</span><span class="p">(</span><span class="n">RegistryCollection</span><span class="p">):</span>
     <span class="n">factory</span> <span class="o">=</span> <span class="n">Registry</span><span class="p">((</span><span class="s2">&quot;my_library&quot;</span><span class="p">,</span> <span class="s2">&quot;factory&quot;</span><span class="p">),</span> <span class="n">entry_points</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 </code></pre></div>
 <div class="admonition tip">
 <p class="admonition-title">What is this useful for?</p>
 <p>With this registry, you can <em>register</em> a function or a class:</p>
 <div class="highlight"><pre><span></span><code><span class="nd">@registry</span><span class="o">.</span><span class="n">factory</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s2">&quot;my-function&quot;</span><span class="p">)</span>
-<span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="mi">10</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">my_function</span><span class="p">(</span><span class="n">value</span><span class="o">=</span><span class="mi">10</span><span class="p">):</span>
     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;The value is </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">!&quot;</span><span class="p">)</span>
 </code></pre></div>
 <p>Now you can dynamically retrieve the function from anywhere:</p>
@@ -633,8 +633,8 @@ <h2 id="the-config-object">The Config object</h2>
 <p>We will show partial examples with increasing complexity below. See <a class="autorefs autorefs-internal" href="getting-started/#a-simple-example">here</a> for an end-to-end example.</p>
 <h3 id="instantiating-an-object">Instantiating an object</h3>
 <div class="highlight"><span class="filename">script.py</span><pre><span></span><code><span class="nd">@registry</span><span class="o">.</span><span class="n">factory</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="s2">&quot;my-class&quot;</span><span class="p">)</span>
-<span class="k">class</span> <span class="nc">MyClass</span><span class="p">:</span>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value1</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">value2</span><span class="p">:</span> <span class="nb">float</span><span class="p">):</span>
+<span class="k">class</span><span class="w"> </span><span class="nc">MyClass</span><span class="p">:</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value1</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">value2</span><span class="p">:</span> <span class="nb">float</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">value1</span> <span class="o">=</span> <span class="n">value1</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">value2</span> <span class="o">=</span> <span class="n">value2</span>
 </code></pre></div>

latest/en/reference/cli/index.html

@@ -605,7 +605,7 @@ <h2 id="confit.cli.Cli" class="doc doc-heading">
 <span class="normal">177</span>
 <span class="normal">178</span>
 <span class="normal">179</span>
-<span class="normal">180</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">Cli</span><span class="p">(</span><span class="n">Typer</span><span class="p">):</span>
+<span class="normal">180</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">Cli</span><span class="p">(</span><span class="n">Typer</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Custom Typer object that:</span>
 
@@ -614,7 +614,7 @@ <h2 id="confit.cli.Cli" class="doc doc-heading">
 <span class="sd">    - automatically instantiates parameters given a dictionary when type hinted</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="nf">command</span><span class="p">(</span>  <span class="c1"># noqa</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">command</span><span class="p">(</span>  <span class="c1"># noqa</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">name</span><span class="p">,</span>
         <span class="o">*</span><span class="p">,</span>
@@ -651,11 +651,11 @@ <h2 id="confit.cli.Cli" class="doc doc-heading">
             <span class="p">},</span>
         <span class="p">)</span>
 
-        <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
+        <span class="k">def</span><span class="w"> </span><span class="nf">wrapper</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
             <span class="n">validated</span> <span class="o">=</span> <span class="n">validate_arguments</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span>
 
             <span class="nd">@typer_command</span>
-            <span class="k">def</span> <span class="nf">command</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">Context</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Path</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
+            <span class="k">def</span><span class="w"> </span><span class="nf">command</span><span class="p">(</span><span class="n">ctx</span><span class="p">:</span> <span class="n">Context</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Path</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
                 <span class="n">config_path</span> <span class="o">=</span> <span class="n">config</span>
 
                 <span class="n">has_meta</span> <span class="o">=</span> <span class="n">_fn_has_meta</span><span class="p">(</span><span class="n">fn</span><span class="p">)</span>
@@ -717,7 +717,7 @@ <h2 id="confit.cli.Cli" class="doc doc-heading">
                     <span class="k">if</span> <span class="n">is_debug</span><span class="p">()</span> <span class="ow">or</span> <span class="n">e</span><span class="o">.</span><span class="n">__cause__</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
                         <span class="k">raise</span> <span class="n">e</span>
                     <span class="k">try</span><span class="p">:</span>
-                        <span class="kn">import</span> <span class="nn">rich</span>
+                        <span class="kn">import</span><span class="w"> </span><span class="nn">rich</span>
 
                         <span class="n">console</span> <span class="o">=</span> <span class="n">rich</span><span class="o">.</span><span class="n">console</span><span class="o">.</span><span class="n">Console</span><span class="p">(</span><span class="n">stderr</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
                         <span class="n">console</span><span class="o">.</span><span class="n">print</span><span class="p">(</span><span class="s2">&quot;Validation error:&quot;</span><span class="p">,</span> <span class="n">style</span><span class="o">=</span><span class="s2">&quot;red&quot;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s2">&quot; &quot;</span><span class="p">)</span>
@@ -727,7 +727,7 @@ <h2 id="confit.cli.Cli" class="doc doc-heading">
                         <span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">),</span> <span class="n">file</span><span class="o">=</span><span class="n">sys</span><span class="o">.</span><span class="n">stderr</span><span class="p">)</span>
                     <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
                 <span class="k">except</span> <span class="ne">KeyboardInterrupt</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>  <span class="c1"># pragma: no cover</span>
-                    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Interrupted by user&quot;</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">e</span>
+                    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Interrupted by user&quot;</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="nn">e</span>
 
             <span class="k">return</span> <span class="n">validated</span>
 
@@ -855,7 +855,7 @@ <h2 id="confit.cli.parse_overrides" class="doc doc-heading">
 <span class="normal">48</span>
 <span class="normal">49</span>
 <span class="normal">50</span>
-<span class="normal">51</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">parse_overrides</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
+<span class="normal">51</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">parse_overrides</span><span class="p">(</span><span class="n">args</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Parse the overrides from the command line into a dictionary</span>
 <span class="sd">    of key-value pairs.</span>