deploy: f6e8eed

Author: tode-rl

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5a61b43c55d686f15c7fa4f1489434a7
+config: 68c839e41f4ac02ea1555c21354c5891
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_modules/index.html

@@ -4,10 +4,11 @@
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../../genindex.html"><link rel="search" title="Search" href="../../../search.html">
 
-    <!-- Generated with Sphinx 7.4.7 and Furo 2025.09.25 -->
+    <link rel="shortcut icon" href="../../../_static/favicon.png"><!-- Generated with Sphinx 7.4.7 and Furo 2025.12.19 -->
         <title>runloop_api_client.lib.polling - Runloop Python SDK documentation</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d111a655" />
-    <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=580074bf" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=7bdb33bb" />
+    <link rel="stylesheet" type="text/css" href="../../../_static/tabs.css?v=a5c4661c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo-extensions.css?v=8dab3a3b" />
 
 
@@ -189,28 +190,29 @@
   <input type="hidden" name="area" value="default">
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
-  <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+  <p class="caption" role="heading"><span class="caption-text">API Reference</span></p>
 <ul>
-<li class="toctree-l1 has-children"><a class="reference internal" href="../../../sdk/index.html">SDK Reference</a><input aria-label="Toggle navigation of SDK Reference" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
-<li class="toctree-l2 has-children"><a class="reference internal" href="../../../sdk/sync/index.html">Synchronous SDK</a><input aria-label="Toggle navigation of Synchronous SDK" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/sync/devbox.html">Devbox</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/sync/execution.html">Execution</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/sync/execution_result.html">Execution Result</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/sync/blueprint.html">Blueprint</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/sync/snapshot.html">Snapshot</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/sync/storage_object.html">Storage Object</a></li>
-</ul>
-</li>
-<li class="toctree-l2 has-children"><a class="reference internal" href="../../../sdk/async/index.html">Asynchronous SDK</a><input aria-label="Toggle navigation of Asynchronous SDK" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/async/devbox.html">Devbox</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/async/execution.html">Execution</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/async/execution_result.html">Execution Result</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/async/blueprint.html">Blueprint</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/async/snapshot.html">Snapshot</a></li>
-<li class="toctree-l3"><a class="reference internal" href="../../../sdk/async/storage_object.html">Storage Object</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="../../../sdk/types.html">Type Reference</a></li>
+<li class="toctree-l1 has-children"><a class="reference internal" href="../../../api/index.html">API Reference</a><input aria-label="Toggle navigation of API Reference" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/core.html">Core Module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/devbox.html">Devbox</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/execution.html">Execution</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/execution_result.html">Execution Result</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/blueprint.html">Blueprint</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/snapshot.html">Snapshot</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/storage_object.html">Storage Object</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/agent.html">Agent</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/scorer.html">Scorer</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/scenario.html">Scenario</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/scenario_builder.html">Scenario Builder</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/scenario_run.html">Scenario Run</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/benchmark.html">Benchmark</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/benchmark_run.html">Benchmark Run</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/axon.html">Axon</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/secret.html">Secret</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/mcp_config.html">MCP Config</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/gateway_config.html">Gateway Config</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/network_policy.html">Network Policy</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../../../api/types.html">Type Reference</a></li>
 </ul>
 </li>
 </ul>
@@ -247,14 +249,14 @@
         <article role="main" id="furo-main-content">
           <h1>Source code for runloop_api_client.lib.polling</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
-<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Optional</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Union</span><span class="p">,</span> <span class="n">TypeVar</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Optional</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">dataclasses</span><span class="w"> </span><span class="kn">import</span> <span class="n">dataclass</span>
 
 <span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;T&quot;</span><span class="p">)</span>
 
 
 <div class="viewcode-block" id="PollingConfig">
-<a class="viewcode-back" href="../../../sdk/types.html#runloop_api_client.sdk._types.PollingConfig">[docs]</a>
+<a class="viewcode-back" href="../../../api/types.html#runloop_api_client.sdk._types.PollingConfig">[docs]</a>
 <span class="nd">@dataclass</span>
 <span class="k">class</span><span class="w"> </span><span class="nc">PollingConfig</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Configuration for polling behavior&quot;&quot;&quot;</span>
@@ -324,6 +326,49 @@ <h1>Source code for runloop_api_client.lib.polling</h1><div class="highlight"><p
                 <span class="k">raise</span> <span class="n">PollingTimeout</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Exceeded timeout of </span><span class="si">{</span><span class="n">config</span><span class="o">.</span><span class="n">timeout_seconds</span><span class="si">}</span><span class="s2"> seconds&quot;</span><span class="p">,</span> <span class="n">last_result</span><span class="p">)</span>
 
         <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">interval_seconds</span><span class="p">)</span>
+
+
+<span class="k">def</span><span class="w"> </span><span class="nf">retry_server_poll_until</span><span class="p">(</span>
+    <span class="n">retriever</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="nb">float</span><span class="p">],</span> <span class="n">T</span><span class="p">],</span>
+    <span class="n">is_terminal</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">T</span><span class="p">],</span> <span class="nb">bool</span><span class="p">],</span>
+    <span class="n">timeout_seconds</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">30.0</span><span class="p">,</span>
+    <span class="n">on_error</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">[[</span><span class="ne">Exception</span><span class="p">],</span> <span class="n">T</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
+<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Retry a server-side long-poll until a condition is met or max timeout is reached.</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        retriever: Callable that takes the remaining timeout (seconds) and</span>
+<span class="sd">            returns the object to check.</span>
+<span class="sd">        is_terminal: Callable that returns True when polling should stop</span>
+<span class="sd">        timeout_seconds: Total time to wait.  Must be &gt; 0</span>
+<span class="sd">        on_error: Optional error handler that can return a value to continue polling</span>
+<span class="sd">                 or re-raise the exception to stop polling</span>
+
+<span class="sd">    Returns:</span>
+<span class="sd">        The final state of the polled object</span>
+
+<span class="sd">    Raises:</span>
+<span class="sd">        PollingTimeout: When max attempts or timeout is reached</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="n">last_result</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
+    <span class="n">start_time</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+
+    <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
+        <span class="n">remaining_time</span> <span class="o">=</span> <span class="n">timeout_seconds</span> <span class="o">-</span> <span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">start_time</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">remaining_time</span> <span class="o">&lt;=</span> <span class="mi">0</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="n">PollingTimeout</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Exceeded timeout of </span><span class="si">{</span><span class="n">timeout_seconds</span><span class="si">}</span><span class="s2"> seconds&quot;</span><span class="p">,</span> <span class="n">last_result</span><span class="p">)</span>
+
+        <span class="k">try</span><span class="p">:</span>
+            <span class="n">last_result</span> <span class="o">=</span> <span class="n">retriever</span><span class="p">(</span><span class="n">remaining_time</span><span class="p">)</span>
+        <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
+            <span class="k">if</span> <span class="n">on_error</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
+                <span class="n">last_result</span> <span class="o">=</span> <span class="n">on_error</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="k">raise</span>
+
+        <span class="k">if</span> <span class="n">is_terminal</span><span class="p">(</span><span class="n">last_result</span><span class="p">):</span>
+            <span class="k">return</span> <span class="n">last_result</span>
 </pre></div>
         </article>
       </div>
@@ -356,9 +401,10 @@ <h1>Source code for runloop_api_client.lib.polling</h1><div class="highlight"><p
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
+</div><script src="../../../_static/documentation_options.js?v=8a448e45"></script>
     <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=46bd48cc"></script>
+    <script src="../../../_static/tabs.js?v=3030b3cb"></script>
     </body>
 </html>