Deploying to gh-pages from @ cbb13a6 🚀

api.html

@@ -1511,7 +1511,7 @@ <h1>API documentation<a class="headerlink" href="#api-documentation" title="Perm
 
 <dl class="py class">
 <dt class="sig sig-object py" id="pytest_container.inspect.PortForwarding">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pytest_container.inspect.</span></span><span class="sig-name descname"><span class="pre">PortForwarding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container_port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pytest_container.inspect.NetworkProtocol" title="pytest_container.inspect.NetworkProtocol"><span class="pre">NetworkProtocol</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">NetworkProtocol.TCP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pytest_container.inspect.PortForwarding" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pytest_container.inspect.</span></span><span class="sig-name descname"><span class="pre">PortForwarding</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container_port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pytest_container.inspect.NetworkProtocol" title="pytest_container.inspect.NetworkProtocol"><span class="pre">NetworkProtocol</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">NetworkProtocol.TCP</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host_port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">-1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bind_ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pytest_container.inspect.PortForwarding" title="Permalink to this definition">¶</a></dt>
 <dd><p>Representation of a port forward from a container to the host.</p>
 <p>To expose a port of a container automatically, create an instance of this
 class, set the attribute <a class="reference internal" href="#pytest_container.inspect.PortForwarding.container_port" title="pytest_container.inspect.PortForwarding.container_port"><code class="xref py py-attr docutils literal notranslate"><span class="pre">container_port</span></code></a> and optionally
@@ -1522,6 +1522,12 @@ <h1>API documentation<a class="headerlink" href="#api-documentation" title="Perm
 <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">Container</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="s2">&quot;my-webserver&quot;</span><span class="p">,</span> <span class="n">forwarded_ports</span><span class="o">=</span><span class="p">[</span><span class="n">PortForwarding</span><span class="p">(</span><span class="n">container_port</span><span class="o">=</span><span class="mi">8000</span><span class="p">)])</span>
 </pre></div>
 </div>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pytest_container.inspect.PortForwarding.bind_ip">
+<span class="sig-name descname"><span class="pre">bind_ip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">''</span></em><a class="headerlink" href="#pytest_container.inspect.PortForwarding.bind_ip" title="Permalink to this definition">¶</a></dt>
+<dd><p>The IP address to which to bind. By default, it will be ‘::’ (all addresses).</p>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pytest_container.inspect.PortForwarding.container_port">
 <span class="sig-name descname"><span class="pre">container_port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></em><a class="headerlink" href="#pytest_container.inspect.PortForwarding.container_port" title="Permalink to this definition">¶</a></dt>

changelog.html

@@ -47,6 +47,12 @@ <h2>Next Release<a class="headerlink" href="#next-release" title="Permalink to t
 instead.</p></li>
 </ul>
 <p>Improvements and new features:</p>
+<ul class="simple">
+<li><p>Add property <a class="reference internal" href="api.html#pytest_container.inspect.PortForwarding.bind_ip" title="pytest_container.inspect.PortForwarding.bind_ip"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bind_ip</span></code></a>
+to support binding to arbitrary IP addresses.</p></li>
+<li><p>Fix <a class="reference internal" href="api.html#pytest_container.inspect.PortForwarding.host_port" title="pytest_container.inspect.PortForwarding.host_port"><code class="xref py py-attr docutils literal notranslate"><span class="pre">host_port</span></code></a> being
+ignored when picking the host port</p></li>
+</ul>
 <p>Documentation:</p>
 <p>Internal changes:</p>
 </section>

genindex.html

@@ -95,6 +95,8 @@ <h2 id="B">B</h2>
 </li>
       </ul></li>
       <li><a href="api.html#pytest_container.container.EntrypointSelection.BASH">BASH (pytest_container.container.EntrypointSelection attribute)</a>
+</li>
+      <li><a href="api.html#pytest_container.inspect.PortForwarding.bind_ip">bind_ip (pytest_container.inspect.PortForwarding attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>