aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refresh collected sites/mcp for docstring changes in dagpipe, mail-intake, openapi-first

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-14 00:18:17 +05:30
parent 9516e0b4cb
commit bbd9863d23
36 changed files with 1037 additions and 299 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
dagpipe/lib/dagpipe/engine/index.html
View File

@@ -812,6 +812,21 @@
</span>
</a>
<nav class="md-nav" aria-label="StepResult">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dagpipe.engine.StepResult-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1286,7 +1301,7 @@ are both supported.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1301,7 +1316,7 @@ Steps are 0-indexed.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.StepHook">StepHook</span></code>
<code><span title="dagpipe.engine.StepHook">StepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1408,7 +1423,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1422,7 +1437,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span></code>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1594,7 +1609,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code><span title="dagpipe.engine.StepResult.states">states</span></code></td>
<td>
<code>Tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../state/#dagpipe.state.State">State</a>, ...]</code>
<code>tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../state/#dagpipe.state.State">State</a>, ...]</code>
</td>
<td>
<div class="doc-md-description">
@@ -1616,6 +1631,79 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
</tbody>
</table>
<p>Initialise StepResult.</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>index</code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Ordinal index of the step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Identifier of the node associated with this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>states</code></td>
<td>
<code>tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../state/#dagpipe.state.State">State</a>, ...]</code>
</td>
<td>
<div class="doc-md-description">
<p>States produced by running this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>completed</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether this step succeeded (vs. paused/interrupted).</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
@@ -1627,7 +1715,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<h5 id="dagpipe.engine.StepResult-functions">Functions</h5>

8
dagpipe/lib/dagpipe/graph/index.html
View File

@@ -1176,7 +1176,7 @@
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Outgoing neighbors.</p>
</div>
</td>
@@ -1219,7 +1219,7 @@ Outgoing neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
All registered nodes.</p>
</div>
</td>
@@ -1291,7 +1291,7 @@ All registered nodes.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Incoming neighbors.</p>
</div>
</td>
@@ -1334,7 +1334,7 @@ Incoming neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Entry point nodes.</p>
</div>
</td>

144
dagpipe/lib/dagpipe/index.html
View File

@@ -1538,6 +1538,21 @@
</span>
</a>
<nav class="md-nav" aria-label="StepResult">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dagpipe.StepResult-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1908,7 +1923,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -1936,7 +1951,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -2696,7 +2711,7 @@ are both supported.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2711,7 +2726,7 @@ Steps are 0-indexed.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.StepHook">StepHook</span></code>
<code><span title="dagpipe.engine.StepHook">StepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2818,7 +2833,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2832,7 +2847,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span></code>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -3185,7 +3200,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Outgoing neighbors.</p>
</div>
</td>
@@ -3228,7 +3243,7 @@ Outgoing neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
All registered nodes.</p>
</div>
</td>
@@ -3300,7 +3315,7 @@ All registered nodes.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Incoming neighbors.</p>
</div>
</td>
@@ -3343,7 +3358,7 @@ Incoming neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Entry point nodes.</p>
</div>
</td>
@@ -3656,7 +3671,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -3684,7 +3699,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -3877,22 +3892,23 @@ so pipeline builders can inject per-run dependencies.</p>
</table>
<p><span class="doc-section-title">Yields:</span></p>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>State</code></td> <td>
<td>
<code><span title="collections.abc.Iterable">Iterable</span>[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="state/#dagpipe.state.State">State</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Derived execution state(s).</p>
<p>Iterable[State]:
Derived execution state(s).</p>
</div>
</td>
</tr>
@@ -4355,23 +4371,22 @@ Read-only view of the underlying data.</p>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<p><span class="doc-section-title">Yields:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<td><code>str</code></td> <td>
<code><span title="collections.abc.Iterable">Iterable</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Iterable[str]:
Generator yielding dot-paths.</p>
<p>Dot-path for each leaf node.</p>
</div>
</td>
</tr>
@@ -4647,7 +4662,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>payload_override</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -5224,7 +5239,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -5252,7 +5267,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -5266,7 +5281,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -5505,7 +5520,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
</td>
<td>
<div class="doc-md-description">
<p>Tuple[State, ...]:
<p>tuple[State, ...]:
Ordered execution lineage (root first).</p>
</div>
</td>
@@ -5588,7 +5603,7 @@ Ordered execution lineage (root first).</p>
<tr class="doc-section-item">
<td><code><span title="dagpipe.StepResult.states">states</span></code></td>
<td>
<code>Tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="state/#dagpipe.state.State">State</a>, ...]</code>
<code>tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="state/#dagpipe.state.State">State</a>, ...]</code>
</td>
<td>
<div class="doc-md-description">
@@ -5610,6 +5625,79 @@ Ordered execution lineage (root first).</p>
</tbody>
</table>
<p>Initialise StepResult.</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>index</code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Ordinal index of the step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Identifier of the node associated with this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>states</code></td>
<td>
<code>tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="state/#dagpipe.state.State">State</a>, ...]</code>
</td>
<td>
<div class="doc-md-description">
<p>States produced by running this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>completed</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether this step succeeded (vs. paused/interrupted).</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
@@ -5621,7 +5709,7 @@ Ordered execution lineage (root first).</p>
<h5 id="dagpipe.StepResult-functions">Functions</h5>

17
dagpipe/lib/dagpipe/node/index.html
View File

@@ -1280,7 +1280,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -1308,7 +1308,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -1953,7 +1953,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -1981,7 +1981,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -2174,22 +2174,23 @@ so pipeline builders can inject per-run dependencies.</p>
</table>
<p><span class="doc-section-title">Yields:</span></p>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>State</code></td> <td>
<td>
<code><span title="collections.abc.Iterable">Iterable</span>[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../state/#dagpipe.state.State">State</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Derived execution state(s).</p>
<p>Iterable[State]:
Derived execution state(s).</p>
</div>
</td>
</tr>

17
dagpipe/lib/dagpipe/state/index.html
View File

@@ -1334,23 +1334,22 @@ Read-only view of the underlying data.</p>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<p><span class="doc-section-title">Yields:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<td><code>str</code></td> <td>
<code><span title="collections.abc.Iterable">Iterable</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Iterable[str]:
Generator yielding dot-paths.</p>
<p>Dot-path for each leaf node.</p>
</div>
</td>
</tr>
@@ -1950,7 +1949,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1978,7 +1977,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1992,7 +1991,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2231,7 +2230,7 @@ Iterator over top-level keys.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[State, ...]:
<p>tuple[State, ...]:
Ordered execution lineage (root first).</p>
</div>
</td>

2
dagpipe/lib/dagpipe/yaml_loader/index.html
View File

@@ -943,7 +943,7 @@ and initial payloads.</p>
<tr class="doc-section-item">
<td><code>payload_override</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">

115
dagpipe/lib/engine/index.html
View File

@@ -737,6 +737,21 @@
</span>
</a>
<nav class="md-nav" aria-label="StepResult">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dagpipe.engine.StepResult-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1023,6 +1038,21 @@
</span>
</a>
<nav class="md-nav" aria-label="StepResult">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dagpipe.engine.StepResult-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1497,7 +1527,7 @@ are both supported.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1512,7 +1542,7 @@ Steps are 0-indexed.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.StepHook">StepHook</span></code>
<code><span title="dagpipe.engine.StepHook">StepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1619,7 +1649,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1633,7 +1663,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span></code>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -1805,7 +1835,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code><span title="dagpipe.engine.StepResult.states">states</span></code></td>
<td>
<code>Tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="../dagpipe/state/#dagpipe.state.State">State</a>, ...]</code>
<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">
@@ -1827,6 +1857,79 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
</tbody>
</table>
<p>Initialise StepResult.</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>index</code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Ordinal index of the step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Identifier of the node associated with this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>states</code></td>
<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>States produced by running this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>completed</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether this step succeeded (vs. paused/interrupted).</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
@@ -1838,7 +1941,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<h5 id="dagpipe.engine.StepResult-functions">Functions</h5>

8
dagpipe/lib/graph/index.html
View File

@@ -1381,7 +1381,7 @@
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Outgoing neighbors.</p>
</div>
</td>
@@ -1424,7 +1424,7 @@ Outgoing neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
All registered nodes.</p>
</div>
</td>
@@ -1496,7 +1496,7 @@ All registered nodes.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Incoming neighbors.</p>
</div>
</td>
@@ -1539,7 +1539,7 @@ Incoming neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Entry point nodes.</p>
</div>
</td>

159
dagpipe/lib/index.html
View File

@@ -1153,6 +1153,21 @@
</span>
</a>
<nav class="md-nav" aria-label="StepResult">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dagpipe.StepResult-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -2497,6 +2512,21 @@
</span>
</a>
<nav class="md-nav" aria-label="StepResult">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#dagpipe.StepResult-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -2867,7 +2897,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -2895,7 +2925,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -3655,7 +3685,7 @@ are both supported.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -3670,7 +3700,7 @@ Steps are 0-indexed.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.StepHook">StepHook</span></code>
<code><span title="dagpipe.engine.StepHook">StepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -3777,7 +3807,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>resume_from</code></td>
<td>
<code>int</code>
<code>int | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -3791,7 +3821,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
<tr class="doc-section-item">
<td><code>on_step</code></td>
<td>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span></code>
<code><span title="dagpipe.engine.AsyncStepHook">AsyncStepHook</span> | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -4144,7 +4174,7 @@ orchestrator. Use <code>run_steps_async</code> for async nodes.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Outgoing neighbors.</p>
</div>
</td>
@@ -4187,7 +4217,7 @@ Outgoing neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
All registered nodes.</p>
</div>
</td>
@@ -4259,7 +4289,7 @@ All registered nodes.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Incoming neighbors.</p>
</div>
</td>
@@ -4302,7 +4332,7 @@ Incoming neighbors.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[Node, ...]:
<p>tuple[Node, ...]:
Entry point nodes.</p>
</div>
</td>
@@ -4615,7 +4645,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -4643,7 +4673,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -4836,22 +4866,23 @@ so pipeline builders can inject per-run dependencies.</p>
</table>
<p><span class="doc-section-title">Yields:</span></p>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>State</code></td> <td>
<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>Derived execution state(s).</p>
<p>Iterable[State]:
Derived execution state(s).</p>
</div>
</td>
</tr>
@@ -5314,23 +5345,22 @@ Read-only view of the underlying data.</p>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<p><span class="doc-section-title">Yields:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<td><code>str</code></td> <td>
<code><span title="collections.abc.Iterable">Iterable</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Iterable[str]:
Generator yielding dot-paths.</p>
<p>Dot-path for each leaf node.</p>
</div>
</td>
</tr>
@@ -5606,7 +5636,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>payload_override</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -6183,7 +6213,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -6211,7 +6241,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -6225,7 +6255,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -6464,7 +6494,7 @@ callers can surface counts/lines/errors without coupling the engine to pydantic.
</td>
<td>
<div class="doc-md-description">
<p>Tuple[State, ...]:
<p>tuple[State, ...]:
Ordered execution lineage (root first).</p>
</div>
</td>
@@ -6547,7 +6577,7 @@ Ordered execution lineage (root first).</p>
<tr class="doc-section-item">
<td><code><span title="dagpipe.StepResult.states">states</span></code></td>
<td>
<code>Tuple[<a class="autorefs autorefs-internal" title="dagpipe.state.State" href="dagpipe/state/#dagpipe.state.State">State</a>, ...]</code>
<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">
@@ -6569,6 +6599,79 @@ Ordered execution lineage (root first).</p>
</tbody>
</table>
<p>Initialise StepResult.</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>index</code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Ordinal index of the step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Identifier of the node associated with this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>states</code></td>
<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>States produced by running this step.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>completed</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether this step succeeded (vs. paused/interrupted).</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
@@ -6580,7 +6683,7 @@ Ordered execution lineage (root first).</p>
<h5 id="dagpipe.StepResult-functions">Functions</h5>

17
dagpipe/lib/node/index.html
View File

@@ -1668,7 +1668,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -1696,7 +1696,7 @@ an async engine is required.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -2341,7 +2341,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -2369,7 +2369,7 @@ so pipeline builders can inject per-run dependencies.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code>Mapping[str, <span title="typing.Any">Any</span>]</code>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
@@ -2562,22 +2562,23 @@ so pipeline builders can inject per-run dependencies.</p>
</table>
<p><span class="doc-section-title">Yields:</span></p>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Name</th> <th>Type</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>State</code></td> <td>
<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>Derived execution state(s).</p>
<p>Iterable[State]:
Derived execution state(s).</p>
</div>
</td>
</tr>

2
dagpipe/lib/search/search_index.json
View File

File diff suppressed because one or more lines are too long

17
dagpipe/lib/state/index.html
View File

@@ -1659,23 +1659,22 @@ Read-only view of the underlying data.</p>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<p><span class="doc-section-title">Yields:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Name</th> <th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<td><code>str</code></td> <td>
<code><span title="collections.abc.Iterable">Iterable</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Iterable[str]:
Generator yielding dot-paths.</p>
<p>Dot-path for each leaf node.</p>
</div>
</td>
</tr>
@@ -2275,7 +2274,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>payload_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2303,7 +2302,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>node_id</code></td>
<td>
<code>str</code>
<code>str | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2317,7 +2316,7 @@ Iterator over top-level keys.</p>
<tr class="doc-section-item">
<td><code>metadata_update</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
@@ -2556,7 +2555,7 @@ Iterator over top-level keys.</p>
</td>
<td>
<div class="doc-md-description">
<p>Tuple[State, ...]:
<p>tuple[State, ...]:
Ordered execution lineage (root first).</p>
</div>
</td>

2
dagpipe/lib/yaml_loader/index.html
View File

@@ -1089,7 +1089,7 @@ and initial payloads.</p>
<tr class="doc-section-item">
<td><code>payload_override</code></td>
<td>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
<code><span title="collections.abc.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">