feat: collect dagpipe wiki, refresh lib and mcp artifacts
Enables dagpipe wiki on the docs hub alongside lib and mcp, removes stale nested lib pages, and picks up regenerated GSDFC docstrings in the MCP bundle.
This commit is contained in:
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@@ -728,6 +728,36 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="ProgressMessage">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.engine.ProgressMessage-functions" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Functions
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Functions">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.engine.ProgressMessage.as_dict" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
as_dict
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1029,6 +1059,36 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="ProgressMessage">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.engine.ProgressMessage-functions" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Functions
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Functions">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.engine.ProgressMessage.as_dict" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
as_dict
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1174,6 +1234,77 @@ It orchestrates execution order, branching, and state propagation.</p>
|
||||
- Thread-safe for concurrent execution.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Create an engine from a node sequence or a graph.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>nodes_or_graph</code></td>
|
||||
<td>
|
||||
<code><span title="collections.abc.Sequence">Sequence</span>[<a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a>] | <a class="autorefs autorefs-internal" title="dagpipe.graph.Graph" href="../dagpipe/graph/#dagpipe.graph.Graph">Graph</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Either an ordered sequence of <code>Node</code> instances (linear mode) or
|
||||
a <code>Graph</code> defining the execution topology (graph mode).</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<em>required</em>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>on_step</code></td>
|
||||
<td>
|
||||
<code><span title="dagpipe.engine.StepHook">StepHook</span> | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Default per-step callback <code>(step, status, message)</code> used when a
|
||||
step run does not supply its own hook.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Raises:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>TypeError</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If a sequence element is not a <code>Node</code>, or if
|
||||
<code>nodes_or_graph</code> is neither a <code>Sequence[Node]</code> nor a <code>Graph</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1752,6 +1883,246 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
|
||||
callers can surface counts/lines/errors without coupling the engine to pydantic.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Attributes:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.lines">lines</span></code></td>
|
||||
<td>
|
||||
<code>int | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional count of processed lines.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.blocks">blocks</span></code></td>
|
||||
<td>
|
||||
<code>int | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional count of processed blocks.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.count">count</span></code></td>
|
||||
<td>
|
||||
<code>int | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional generic item count.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.unit">unit</span></code></td>
|
||||
<td>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional unit for the count (e.g., 'pages').</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.raw_ocr_line">raw_ocr_line</span></code></td>
|
||||
<td>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional raw OCR line payload.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.error">error</span></code></td>
|
||||
<td>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional error description.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.step">step</span></code></td>
|
||||
<td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Identifier of the step that emitted the message.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code><span title="dagpipe.engine.ProgressMessage.status">status</span></code></td>
|
||||
<td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Status label associated with the step.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Immutable after construction (attributes are never reassigned).
|
||||
- Independent of pydantic; safe to construct in the engine core.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Create a progress message.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>lines</code></td>
|
||||
<td>
|
||||
<code>int | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional count of processed lines.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>blocks</code></td>
|
||||
<td>
|
||||
<code>int | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional count of processed blocks.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>count</code></td>
|
||||
<td>
|
||||
<code>int | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional generic item count.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>unit</code></td>
|
||||
<td>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional unit for the count (e.g., 'pages').</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>raw_ocr_line</code></td>
|
||||
<td>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional raw OCR line payload.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>error</code></td>
|
||||
<td>
|
||||
<code>str | None</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Optional error description.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>None</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>step</code></td>
|
||||
<td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Identifier of the step that emitted the message.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>''</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>status</code></td>
|
||||
<td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Status label associated with the step.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>''</code>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="doc doc-children">
|
||||
@@ -1762,7 +2133,50 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
|
||||
|
||||
|
||||
|
||||
<h5 id="dagpipe.engine.ProgressMessage-functions">Functions</h5>
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.engine.ProgressMessage.as_dict" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">as_dict</span>
|
||||
|
||||
|
||||
</h6>
|
||||
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">as_dict</span><span class="p">()</span> <span class="o">-></span> <span class="nb">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></code></pre></div></td></tr></table></div>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return the message as a plain dictionary.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>dict[str, <span title="typing.Any">Any</span>]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>dict[str, Any]:
|
||||
All attribute values keyed by their attribute name.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -553,15 +553,6 @@
|
||||
<nav class="md-nav" aria-label="Graph">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph--initializes-node-registry-and-edge-mappings" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Initializes node registry and edge mappings.
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph-functions" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -579,15 +570,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.__repr__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -912,15 +894,6 @@
|
||||
<nav class="md-nav" aria-label="Graph">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph--initializes-node-registry-and-edge-mappings" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Initializes node registry and edge mappings.
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph-functions" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -938,15 +911,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.graph.Graph.__repr__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1109,7 +1073,7 @@
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Create an empty Graph.</p>
|
||||
<h6 id="dagpipe.graph.Graph--initializes-node-registry-and-edge-mappings">Initializes node registry and edge mappings.</h6>
|
||||
<p>Initializes node registry and edge mappings.</p>
|
||||
|
||||
|
||||
|
||||
@@ -1137,9 +1101,31 @@
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return debug representation.</p>
|
||||
<h6 id="dagpipe.graph.Graph.__repr__--returns">Returns</h6>
|
||||
<p>str</p>
|
||||
<p>Return a compact graph description.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>str</code></td> <td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A string describing the graph as <code>Graph(nodes=N, edges=M)</code> where
|
||||
<code>N</code> and <code>M</code> describe the current registry size.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -494,9 +494,9 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.__hash__--returns" class="md-nav__link">
|
||||
<a href="#dagpipe.node.AsyncNode.__new__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
__new__
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -509,15 +509,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.__repr__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -527,15 +518,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.__str__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -572,6 +554,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.resolve" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
resolve
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -638,15 +629,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.Node.__hash__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -665,15 +647,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.Node.__repr__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -683,15 +656,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.Node.__str__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1115,9 +1079,9 @@
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.__hash__--returns" class="md-nav__link">
|
||||
<a href="#dagpipe.node.AsyncNode.__new__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
__new__
|
||||
</span>
|
||||
</a>
|
||||
|
||||
@@ -1130,15 +1094,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.__repr__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1148,15 +1103,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.__str__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1193,6 +1139,15 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.AsyncNode.resolve" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
resolve
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1259,15 +1214,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.Node.__hash__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1286,15 +1232,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.Node.__repr__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1304,15 +1241,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.node.Node.__str__--returns" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Returns
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1496,8 +1424,115 @@ an async engine is required.</p>
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return stable hash based on node ID.</p>
|
||||
<h6 id="dagpipe.node.AsyncNode.__hash__--returns">Returns</h6>
|
||||
<p>int</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>int</code></td> <td>
|
||||
<code>int</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Hash of the node ID, allowing nodes to be used as dict keys.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.node.AsyncNode.__new__" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">__new__</span>
|
||||
|
||||
|
||||
</h6>
|
||||
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="fm">__new__</span><span class="p">(</span><span class="o">*</span><span class="nf">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncNode</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Create or reuse an async node instance.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>*args</code></td>
|
||||
<td>
|
||||
<code><span title="typing.Any">Any</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Positional constructor arguments forwarded to <code>__init__</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>()</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>**kwargs</code></td>
|
||||
<td>
|
||||
<code><span title="typing.Any">Any</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Keyword constructor arguments forwarded to <code>__init__</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>{}</code>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>AsyncNode</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.AsyncNode" href="../dagpipe/node/#dagpipe.node.AsyncNode">AsyncNode</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A fresh instance for subclasses declaring a parameterized
|
||||
<code>__init__</code>, or the shared singleton for stateless subclasses.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -1516,9 +1551,30 @@ an async engine is required.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return debug representation.</p>
|
||||
<h6 id="dagpipe.node.AsyncNode.__repr__--returns">Returns</h6>
|
||||
<p>str</p>
|
||||
<p>Return computation identity based on node ID.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>str</code></td> <td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>String of the form <code><Node {id}></code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -1537,9 +1593,30 @@ an async engine is required.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return display representation.</p>
|
||||
<h6 id="dagpipe.node.AsyncNode.__str__--returns">Returns</h6>
|
||||
<p>str</p>
|
||||
<p>Return user-facing display name.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>str</code></td> <td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>String of the form <code><Node {name}></code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -1761,6 +1838,29 @@ an async engine is required.</p>
|
||||
|
||||
<p>Return whether this node executes asynchronously.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>bool</code></td> <td>
|
||||
<code>bool</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>True if the node is an <code>AsyncNode</code> instance.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -1843,6 +1943,82 @@ an async engine is required.</p>
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.node.AsyncNode.resolve" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">resolve</span>
|
||||
|
||||
|
||||
</h6>
|
||||
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">resolve</span><span class="p">(</span><span class="n">state</span><span class="p">:</span> <span class="n">State</span><span class="p">)</span> <span class="o">-></span> <span class="n">Iterable</span><span class="p">[</span><span class="n">State</span><span class="p">]</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Execute no-op resolution in sync contexts.</p>
|
||||
<p>Sync-only engines (and the base <code>Node.run</code>) treat an <code>AsyncNode</code> as a
|
||||
no-op consumer: this returns no states, signalling that an async engine
|
||||
is required.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>state</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../dagpipe/state/#dagpipe.state.State">State</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Input execution state.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<em>required</em>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><span title="collections.abc.Iterable">Iterable</span>[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../dagpipe/state/#dagpipe.state.State">State</a>]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Iterable[State]:
|
||||
Empty tuple, since async execution is handled by
|
||||
<code>resolve_async</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.node.AsyncNode.resolve_async" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">resolve_async</span>
|
||||
|
||||
@@ -1915,8 +2091,13 @@ Derived execution state(s).</p>
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p>Subclasses implement this. Must not mutate the input state.
|
||||
Should use <code>fork()</code> to create child states.</p>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Subclasses implement this.
|
||||
- Must not mutate the input state.
|
||||
- Should use `fork()` to create child states.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
@@ -2036,6 +2217,82 @@ Derived execution states.</p>
|
||||
|
||||
<p>Execute this node asynchronously on a state, validating outputs.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>state</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../dagpipe/state/#dagpipe.state.State">State</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Input execution state.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<em>required</em>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../dagpipe/state/#dagpipe.state.State">State</a>, ...]</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>tuple[State, ...]:
|
||||
Derived execution states.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Raises:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code>TypeError</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If <code>resolve_async()</code> yields a non-<code>State</code> object.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -2145,8 +2402,29 @@ Derived execution states.</p>
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return stable hash based on node ID.</p>
|
||||
<h6 id="dagpipe.node.Node.__hash__--returns">Returns</h6>
|
||||
<p>int</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>int</code></td> <td>
|
||||
<code>int</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Hash of the node ID, allowing nodes to be used as dict keys.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2165,13 +2443,92 @@ Derived execution states.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Create or reuse a Node instance.</p>
|
||||
<p>Stateless subclasses (no parameterized <code>__init__</code>) share one singleton
|
||||
instance per class — matching the original dagpipe behaviour underpinning
|
||||
<code>set_registry</code>-style configuration. Subclasses that declare an <code>__init__</code>
|
||||
requiring instance-state arguments get a fresh instance per construction
|
||||
so pipeline builders can inject per-run dependencies.</p>
|
||||
<p>Create or reuse a node instance.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Parameters:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>*args</code></td>
|
||||
<td>
|
||||
<code><span title="typing.Any">Any</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Positional constructor arguments forwarded to <code>__init__</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>()</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>**kwargs</code></td>
|
||||
<td>
|
||||
<code><span title="typing.Any">Any</span></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Keyword constructor arguments forwarded to <code>__init__</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<code>{}</code>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>Node</code></td> <td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.node.Node" href="../dagpipe/node/#dagpipe.node.Node">Node</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>A fresh instance for subclasses declaring a parameterized
|
||||
<code>__init__</code>, or the shared singleton for stateless subclasses.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span>
|
||||
<span class="normal">5</span>
|
||||
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><code>- Stateless subclasses (no parameterized `__init__`) share one
|
||||
singleton instance per class — matching the original dagpipe
|
||||
behaviour underpinning `set_registry`-style configuration.
|
||||
- Subclasses that declare an `__init__` requiring instance-state
|
||||
arguments get a fresh instance per construction so pipeline
|
||||
builders can inject per-run dependencies.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -2189,9 +2546,30 @@ so pipeline builders can inject per-run dependencies.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return debug representation.</p>
|
||||
<h6 id="dagpipe.node.Node.__repr__--returns">Returns</h6>
|
||||
<p>str</p>
|
||||
<p>Return computation identity based on node ID.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>str</code></td> <td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>String of the form <code><Node {id}></code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2210,9 +2588,30 @@ so pipeline builders can inject per-run dependencies.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return display representation.</p>
|
||||
<h6 id="dagpipe.node.Node.__str__--returns">Returns</h6>
|
||||
<p>str</p>
|
||||
<p>Return user-facing display name.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>str</code></td> <td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>String of the form <code><Node {name}></code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -2434,6 +2833,29 @@ so pipeline builders can inject per-run dependencies.</p>
|
||||
|
||||
<p>Return whether this node executes asynchronously.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>bool</code></td> <td>
|
||||
<code>bool</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>True if the node is an <code>AsyncNode</code> instance.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Binary file not shown.
File diff suppressed because one or more lines are too long
Binary file not shown.
@@ -405,6 +405,15 @@
|
||||
<nav class="md-nav" aria-label="Functions">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.Payload.__repr__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
__repr__
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.Payload.as_dict" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -524,21 +533,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="SchemaError">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.SchemaError--indicates-invalid-structure-invalid-path-or-invalid-type" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Indicates invalid structure, invalid path, or invalid type.
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -561,6 +555,15 @@
|
||||
<nav class="md-nav" aria-label="Functions">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.State.__post_init__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
__post_init__
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.State.__repr__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1042,6 +1045,15 @@
|
||||
<nav class="md-nav" aria-label="Functions">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.Payload.__repr__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
__repr__
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.Payload.as_dict" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1161,21 +1173,6 @@
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="SchemaError">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.SchemaError--indicates-invalid-structure-invalid-path-or-invalid-type" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Indicates invalid structure, invalid path, or invalid type.
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@@ -1198,6 +1195,15 @@
|
||||
<nav class="md-nav" aria-label="Functions">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.State.__post_init__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
__post_init__
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#dagpipe.state.State.__repr__" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -1396,6 +1402,48 @@ modifying an existing state, nodes create new child states via <code>fork()</cod
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.state.Payload.__repr__" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">__repr__</span>
|
||||
|
||||
|
||||
</h6>
|
||||
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="fm">__repr__</span><span class="p">()</span> <span class="o">-></span> <span class="nb">str</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Return a concise payload description.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Returns:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th> <th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>str</code></td> <td>
|
||||
<code>str</code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>String of the form <code>Payload(keys=[...])</code> listing top-level keys.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.state.Payload.as_dict" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">as_dict</span>
|
||||
|
||||
@@ -2053,7 +2101,7 @@ Iterator over top-level keys.</p>
|
||||
|
||||
|
||||
<p>Raised when payload data violates the declared schema.</p>
|
||||
<h6 id="dagpipe.state.SchemaError--indicates-invalid-structure-invalid-path-or-invalid-type">Indicates invalid structure, invalid path, or invalid type.</h6>
|
||||
<p>Indicates invalid structure, invalid path, or invalid type.</p>
|
||||
|
||||
|
||||
</div>
|
||||
@@ -2215,6 +2263,48 @@ Iterator over top-level keys.</p>
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.state.State.__post_init__" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">__post_init__</span>
|
||||
|
||||
|
||||
</h6>
|
||||
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">__post_init__</span><span class="p">()</span> <span class="o">-></span> <span class="kc">None</span>
|
||||
</span></code></pre></div></td></tr></table></div>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
<p>Validate the payload against the declared schema.</p>
|
||||
|
||||
|
||||
<p><span class="doc-section-title">Raises:</span></p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="dagpipe.state.SchemaError" href="../dagpipe/state/#dagpipe.state.SchemaError">SchemaError</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>If the payload violates the schema declared on the subclass.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="doc doc-object doc-function">
|
||||
|
||||
|
||||
<h6 id="dagpipe.state.State.__repr__" class="doc doc-heading">
|
||||
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">__repr__</span>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user