Docs build 2025-07-08

Author: github-actions

en/latest/apidoc/pyinfra.api.arguments.html

@@ -236,7 +236,7 @@ <h3>Navigation</h3>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pyinfra.api.arguments.pop_global_arguments">
-<span class="sig-prename descclassname"><span class="pre">pyinfra.api.arguments.</span></span><span class="sig-name descname"><span class="pre">pop_global_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="s"><span class="pre">'State'</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="s"><span class="pre">'Host'</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keys_to_check</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyinfra.api.arguments.AllArguments" title="pyinfra.api.arguments.AllArguments"><span class="pre">AllArguments</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyinfra.api.arguments.pop_global_arguments" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">pyinfra.api.arguments.</span></span><span class="sig-name descname"><span class="pre">pop_global_arguments</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyinfra.api.state.html#pyinfra.api.state.State" title="pyinfra.api.state.State"><span class="pre">State</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyinfra.api.host.html#pyinfra.api.host.Host" title="pyinfra.api.host.Host"><span class="pre">Host</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#pyinfra.api.arguments.AllArguments" title="pyinfra.api.arguments.AllArguments"><span class="pre">AllArguments</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyinfra.api.arguments.pop_global_arguments" title="Link to this definition">¶</a></dt>
 <dd><p>Pop and return operation global keyword arguments, in preferred order:</p>
 <ul class="simple">
 <li><p>From the current context (a direct &#64;operator or &#64;deploy function being called)</p></li>

en/latest/apidoc/pyinfra.api.facts.html

@@ -130,7 +130,6 @@ <h3>Navigation</h3>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.facts.ShortFactBase"><code class="docutils literal notranslate"><span class="pre">ShortFactBase</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.facts.get_fact"><code class="docutils literal notranslate"><span class="pre">get_fact()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.facts.get_facts"><code class="docutils literal notranslate"><span class="pre">get_facts()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.facts.get_host_fact"><code class="docutils literal notranslate"><span class="pre">get_host_fact()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.facts.get_short_facts"><code class="docutils literal notranslate"><span class="pre">get_short_facts()</span></code></a></li>
 </ul>
 </li>
@@ -247,12 +246,7 @@ <h3>Navigation</h3>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pyinfra.api.facts.get_facts">
-<span class="sig-prename descclassname"><span class="pre">pyinfra.api.facts.</span></span><span class="sig-name descname"><span class="pre">get_facts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyinfra.api.state.html#pyinfra.api.state.State" title="pyinfra.api.state.State"><span class="pre">State</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.facts.get_facts" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="pyinfra.api.facts.get_host_fact">
-<span class="sig-prename descclassname"><span class="pre">pyinfra.api.facts.</span></span><span class="sig-name descname"><span class="pre">get_host_fact</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyinfra.api.state.html#pyinfra.api.state.State" title="pyinfra.api.state.State"><span class="pre">State</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="pyinfra.api.host.html#pyinfra.api.host.Host" title="pyinfra.api.host.Host"><span class="pre">Host</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">cls</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="headerlink" href="#pyinfra.api.facts.get_host_fact" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">pyinfra.api.facts.</span></span><span class="sig-name descname"><span class="pre">get_facts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">state</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.facts.get_facts" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py function">

en/latest/apidoc/pyinfra.api.inventory.html

@@ -191,7 +191,7 @@ <h3>Navigation</h3>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="pyinfra.api.inventory.Inventory.get_group">
-<span class="sig-name descname"><span class="pre">get_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default=&lt;class</span> <span class="pre">'pyinfra.api.exceptions.NoGroupError'&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.inventory.Inventory.get_group" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">get_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default=&lt;class</span> <span class="pre">'pyinfra.api.exceptions.NoGroupError'&gt;</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyinfra.api.host.html#pyinfra.api.host.Host" title="pyinfra.api.host.Host"><span class="pre">Host</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyinfra.api.inventory.Inventory.get_group" title="Link to this definition">¶</a></dt>
 <dd><p>Get a list of hosts belonging to a group.</p>
 </dd></dl>
 
@@ -210,7 +210,7 @@ <h3>Navigation</h3>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="pyinfra.api.inventory.Inventory.get_host">
-<span class="sig-name descname"><span class="pre">get_host</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default=&lt;class</span> <span class="pre">'pyinfra.api.exceptions.NoHostError'&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.inventory.Inventory.get_host" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">get_host</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default=&lt;class</span> <span class="pre">'pyinfra.api.exceptions.NoHostError'&gt;</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="pyinfra.api.host.html#pyinfra.api.host.Host" title="pyinfra.api.host.Host"><span class="pre">Host</span></a></span></span><a class="headerlink" href="#pyinfra.api.inventory.Inventory.get_host" title="Link to this definition">¶</a></dt>
 <dd><p>Get a single host by name.</p>
 </dd></dl>
 
@@ -226,6 +226,11 @@ <h3>Navigation</h3>
 <dd><p>Get override data for this inventory.</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyinfra.api.inventory.Inventory.groups">
+<span class="sig-name descname"><span class="pre">groups</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyinfra.api.host.html#pyinfra.api.host.Host" title="pyinfra.api.host.Host"><span class="pre">Host</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyinfra.api.inventory.Inventory.groups" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="pyinfra.api.inventory.Inventory.iter_activated_hosts">
 <span class="sig-name descname"><span class="pre">iter_activated_hosts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Iterator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyinfra.api.host.html#pyinfra.api.host.Host" title="pyinfra.api.host.Host"><span class="pre">Host</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#pyinfra.api.inventory.Inventory.iter_activated_hosts" title="Link to this definition">¶</a></dt>

en/latest/apidoc/pyinfra.api.util.html

@@ -138,6 +138,7 @@ <h3>Navigation</h3>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_file_io"><code class="docutils literal notranslate"><span class="pre">get_file_io</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_file_path"><code class="docutils literal notranslate"><span class="pre">get_file_path()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_file_sha1"><code class="docutils literal notranslate"><span class="pre">get_file_sha1()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_file_sha256"><code class="docutils literal notranslate"><span class="pre">get_file_sha256()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_kwargs_str"><code class="docutils literal notranslate"><span class="pre">get_kwargs_str()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_operation_order_from_stack"><code class="docutils literal notranslate"><span class="pre">get_operation_order_from_stack()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pyinfra.api.util.get_path_permissions_mode"><code class="docutils literal notranslate"><span class="pre">get_path_permissions_mode()</span></code></a></li>
@@ -196,7 +197,7 @@ <h3>Navigation</h3>
 
 <dl class="py class">
 <dt class="sig sig-object py" id="pyinfra.api.util.get_file_io">
-<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyinfra.api.util.</span></span><span class="sig-name descname"><span class="pre">get_file_io</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_io</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'rb'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.util.get_file_io" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyinfra.api.util.</span></span><span class="sig-name descname"><span class="pre">get_file_io</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_io</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">IO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'rb'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.util.get_file_io" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <p>Given either a filename or an existing IO object, this context processor
 will open and close filenames, and leave IO objects alone.</p>
@@ -225,8 +226,12 @@ <h3>Navigation</h3>
 <dl class="py function">
 <dt class="sig sig-object py" id="pyinfra.api.util.get_file_sha1">
 <span class="sig-prename descclassname"><span class="pre">pyinfra.api.util.</span></span><span class="sig-name descname"><span class="pre">get_file_sha1</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_io</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.util.get_file_sha1" title="Link to this definition">¶</a></dt>
-<dd><p>Calculates the SHA1 of a file or file object using a buffer to handle larger files.</p>
-</dd></dl>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="pyinfra.api.util.get_file_sha256">
+<span class="sig-prename descclassname"><span class="pre">pyinfra.api.util.</span></span><span class="sig-name descname"><span class="pre">get_file_sha256</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename_or_io</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyinfra.api.util.get_file_sha256" title="Link to this definition">¶</a></dt>
+<dd></dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="pyinfra.api.util.get_kwargs_str">