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

updated hexa and docforge docs

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-15 16:53:19 +05:30
parent 27f76c7831
commit b1f5ce092a
78 changed files with 2653 additions and 54095 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
hexa/lib/404.html
View File

@@ -244,8 +244,6 @@
@@ -269,7 +267,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -279,108 +277,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="/design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="/philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -442,10 +338,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -458,8 +354,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -523,10 +419,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -539,8 +435,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -627,10 +523,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -643,8 +539,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -729,10 +625,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -745,8 +641,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -808,10 +704,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -824,8 +720,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>

295
hexa/lib/check_matches/index.html
View File

@@ -253,8 +253,6 @@
@@ -278,7 +276,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -288,108 +286,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -451,10 +347,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -467,8 +363,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -532,10 +428,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -548,8 +444,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -636,10 +532,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -652,8 +548,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -738,10 +634,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -754,8 +650,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -834,6 +730,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.check_matches--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -862,30 +767,6 @@
</span>
</a>
<nav class="md-nav" aria-label="check_matches">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.check_matches.check_matches--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.check_matches.check_matches--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -940,10 +821,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -956,8 +837,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1036,6 +917,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.check_matches--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1064,30 +954,6 @@
</span>
</a>
<nav class="md-nav" aria-label="check_matches">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.check_matches.check_matches--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.check_matches.check_matches--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1133,6 +999,13 @@
<h3 id="hexa.check_matches--summary">Summary</h3>
<p>Verify that two hexa representations agree.</p>
<p><code>check_matches</code> parses two representations — one YAML spec and/or ABC Python
module each — and reports whether they describe the same port tree.</p>
<hr />
<h3 id="hexa.check_matches--notes">Notes</h3>
<ul>
<li>Uses <code>PortNode.diff</code> to produce human-readable difference strings.</li>
</ul>
@@ -1164,14 +1037,74 @@
<div class="doc doc-contents ">
<p>Verify two representations agree.</p>
<h6 id="hexa.check_matches.check_matches--parameters">Parameters</h6>
<p>path_a : str | Path
Path to a .yaml or .py file.
path_b : str | Path
Path to a .yaml or .py file.</p>
<h6 id="hexa.check_matches.check_matches--returns">Returns</h6>
<p>bool | list[str]
True if they match exactly, otherwise a list of difference strings.</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>path_a</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Path to a <code>.yaml</code> or <code>.py</code> file.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>path_b</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Path to a <code>.yaml</code> or <code>.py</code> file.</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>bool | list[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>bool | list[str]:
<code>True</code> if they match exactly, otherwise a list of difference
strings.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>

176
hexa/lib/cli/index.html
View File

@@ -251,8 +251,6 @@
@@ -276,7 +274,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -286,108 +284,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -449,10 +345,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -465,8 +361,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -530,10 +426,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -546,8 +442,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -634,10 +530,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -650,8 +546,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -736,10 +632,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -752,8 +648,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -815,10 +711,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -831,8 +727,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -911,6 +807,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.cli--usage" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
@@ -986,6 +891,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.cli--usage" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1035,6 +949,18 @@
<h3 id="hexa.cli--summary">Summary</h3>
<p>Command-line interface for hexa utilities.</p>
<hr />
<h3 id="hexa.cli--usage">Usage</h3>
<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></pre></div></td><td class="code"><div><pre><span></span><code>hexa parse-yaml PATH
hexa generate-abc PATH [--out FILE]
hexa parse-abc PATH
hexa generate-yaml PATH [--out FILE]
hexa check PATH_A PATH_B
</code></pre></div></td></tr></table></div>

318
hexa/lib/container/index.html
View File

@@ -253,8 +253,6 @@
@@ -278,7 +276,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -288,108 +286,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -451,10 +347,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -467,8 +363,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -547,6 +443,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.container--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -566,30 +471,6 @@
</span>
</a>
<nav class="md-nav" aria-label="build">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.container.build--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.container.build--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -646,10 +527,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -662,8 +543,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -750,10 +631,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -766,8 +647,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -852,10 +733,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -868,8 +749,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -931,10 +812,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -947,8 +828,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1027,6 +908,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.container--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1046,30 +936,6 @@
</span>
</a>
<nav class="md-nav" aria-label="build">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.container.build--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.container.build--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1115,6 +981,13 @@
<h3 id="hexa.container--summary">Summary</h3>
<p>Container to build a wired hexa pipeline from annotations.</p>
<p><code>build</code> recursively instantiates the port tree implied by a root class's
annotations, injecting provided runtime instances and config values by name.</p>
<hr />
<h3 id="hexa.container--notes">Notes</h3>
<ul>
<li>Runtime instances and config values are applied by name across the whole tree.</li>
</ul>
@@ -1152,20 +1025,91 @@
<div class="doc doc-contents ">
<p>Recursively instantiate the port tree from annotations.</p>
<h6 id="hexa.container.build--parameters">Parameters</h6>
<p>cls : type
The root class to build (e.g. <code>AxisExtractionPipeline</code>).
instances : dict, optional
<code>{slot_name: object}</code> injected verbatim into every node whose
annotations contain that name (runtime values — repos, handlers,
clients — that must not be re-constructed). Applied to the whole
tree by name.
config : dict, optional
<code>{field_name: value}</code> propagated by name to every node's annotated
config fields (non-port attributes), replacing the default <code>None</code>.</p>
<h6 id="hexa.container.build--returns">Returns</h6>
<p>instance
A fully wired instance of <code>cls</code> and all its nested ports.</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>cls</code></td>
<td>
<code>type[<span title="hexa.container.T">T</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>The root class to build (e.g. <code>AxisExtractionPipeline</code>).</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>instances</code></td>
<td>
<code>dict[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
<p><code>{slot_name: object}</code> injected verbatim into every node whose
annotations contain that name (runtime values — repos, handlers,
clients — that must not be re-constructed). Applied to the whole
tree by name.</p>
</div>
</td>
<td>
<code>None</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>config</code></td>
<td>
<code>dict[str, <span title="typing.Any">Any</span>] | None</code>
</td>
<td>
<div class="doc-md-description">
<p><code>{field_name: value}</code> propagated by name to every node's
annotated config fields (non-port attributes), replacing the
default <code>None</code>.</p>
</div>
</td>
<td>
<code>None</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>T</code></td> <td>
<code><span title="hexa.container.T">T</span></code>
</td>
<td>
<div class="doc-md-description">
<p>A fully wired instance of <code>cls</code> and all its nested ports.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>

369
hexa/lib/design/index.html
View File

@@ -9,10 +9,6 @@
<link rel="prev" href="..">
<link rel="next" href="../philosophy/">
<link rel="icon" href="../assets/images/favicon.png">
@@ -245,323 +241,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#file-map-samplesextraction_pipeline" class="md-nav__link">
<span class="md-ellipsis">
File map (samples/extraction_pipeline/)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#the-port-tree-abc-contract" class="md-nav__link">
<span class="md-ellipsis">
The port tree (ABC contract)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#generic-default-impl" class="md-nav__link">
<span class="md-ellipsis">
Generic default (Impl*)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bank-variation-only-what-differs" class="md-nav__link">
<span class="md-ellipsis">
Bank variation (only what differs)
</span>
</a>
<nav class="md-nav" aria-label="Bank variation (only what differs)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#axis-banksaxispdfpy" class="md-nav__link">
<span class="md-ellipsis">
Axis (banks/axis/pdf.py)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#icici-banksicicipdfpy" class="md-nav__link">
<span class="md-ellipsis">
Icici (banks/icici/pdf.py)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#redundancy-rule-applied-in-both-banks" class="md-nav__link">
<span class="md-ellipsis">
Redundancy rule (applied in both banks)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#container-buildcls-in-hexacontainerpy" class="md-nav__link">
<span class="md-ellipsis">
Container (build(cls) in hexa/container.py)
</span>
</a>
<nav class="md-nav" aria-label="Container (build(cls) in hexa/container.py)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#control-flow-at-runtime-target" class="md-nav__link">
<span class="md-ellipsis">
Control flow at runtime (target)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#utilities-optional-hexa-agnostic" class="md-nav__link">
<span class="md-ellipsis">
Utilities (optional, hexa-agnostic)
</span>
</a>
<nav class="md-nav" aria-label="Utilities (optional, hexa-agnostic)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#shared-model" class="md-nav__link">
<span class="md-ellipsis">
Shared model
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#1-parse_yamlpath-portnode" class="md-nav__link">
<span class="md-ellipsis">
1. parse_yaml(path) -&gt; PortNode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-generate_abcpath_yaml-out_pathnone-str" class="md-nav__link">
<span class="md-ellipsis">
2. generate_abc(path_yaml, out_path=None) -&gt; str
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-parse_abcmodule_or_path-portnode" class="md-nav__link">
<span class="md-ellipsis">
3. parse_abc(module_or_path) -&gt; PortNode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-generate_yamlmodule_or_path-out_pathnone-str" class="md-nav__link">
<span class="md-ellipsis">
4. generate_yaml(module_or_path, out_path=None) -&gt; str
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-check_matchespath_a-path_b-bool" class="md-nav__link">
<span class="md-ellipsis">
5. check_matches(path_a, path_b) -&gt; bool
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#workflows-users-choice" class="md-nav__link">
<span class="md-ellipsis">
Workflows (user's choice)
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -585,10 +264,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
@@ -601,8 +280,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -664,10 +343,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -680,8 +359,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -745,10 +424,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -761,8 +440,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -849,10 +528,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -865,8 +544,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -951,10 +630,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -967,8 +646,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -1030,10 +709,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -1046,8 +725,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>

268
hexa/lib/generate_abc/index.html
View File

@@ -253,8 +253,6 @@
@@ -278,7 +276,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -288,108 +286,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -451,10 +347,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -467,8 +363,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -532,10 +428,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -548,8 +444,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -636,10 +532,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -652,8 +548,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -760,30 +656,6 @@
</span>
</a>
<nav class="md-nav" aria-label="generate_abc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.generate_abc.generate_abc--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.generate_abc.generate_abc--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -861,10 +733,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -877,8 +749,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -940,10 +812,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -956,8 +828,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1064,30 +936,6 @@
</span>
</a>
<nav class="md-nav" aria-label="generate_abc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.generate_abc.generate_abc--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.generate_abc.generate_abc--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1164,14 +1012,72 @@
<div class="doc doc-contents ">
<p>Generate ABC Python source from a :class:<code>PortNode</code> tree.</p>
<h6 id="hexa.generate_abc.generate_abc--parameters">Parameters</h6>
<p>node : PortNode
The root of the parsed YAML (or generated) tree.
out_path : str | Path | None
Optional file path to write the generated source to.</p>
<h6 id="hexa.generate_abc.generate_abc--returns">Returns</h6>
<p>str
The generated Python source code.</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>node</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="../model/#hexa.model.PortNode">PortNode</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The root of the parsed YAML (or generated) tree.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>out_path</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span> | None</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional file path to write the generated source to.</p>
</div>
</td>
<td>
<code>None</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>str</code></td> <td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>The generated Python source code.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>

268
hexa/lib/generate_yaml/index.html
View File

@@ -253,8 +253,6 @@
@@ -278,7 +276,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -288,108 +286,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -451,10 +347,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -467,8 +363,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -532,10 +428,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -548,8 +444,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -636,10 +532,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -652,8 +548,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -783,30 +679,6 @@
</span>
</a>
<nav class="md-nav" aria-label="generate_yaml">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.generate_yaml.generate_yaml--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.generate_yaml.generate_yaml--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -861,10 +733,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -877,8 +749,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -940,10 +812,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -956,8 +828,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1064,30 +936,6 @@
</span>
</a>
<nav class="md-nav" aria-label="generate_yaml">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.generate_yaml.generate_yaml--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.generate_yaml.generate_yaml--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1164,14 +1012,72 @@
<div class="doc doc-contents ">
<p>Generate YAML source from a :class:<code>PortNode</code> tree.</p>
<h6 id="hexa.generate_yaml.generate_yaml--parameters">Parameters</h6>
<p>node : PortNode
The root of the tree.
out_path : str | Path | None
Optional file path to write the generated source to.</p>
<h6 id="hexa.generate_yaml.generate_yaml--returns">Returns</h6>
<p>str
The generated YAML source.</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>node</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="../model/#hexa.model.PortNode">PortNode</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The root of the tree.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>out_path</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span> | None</code>
</td>
<td>
<div class="doc-md-description">
<p>Optional file path to write the generated source to.</p>
</div>
</td>
<td>
<code>None</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>str</code></td> <td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>The generated YAML source.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>

1123
hexa/lib/hexa/check_matches/index.html
View File

File diff suppressed because it is too large Load Diff

1044
hexa/lib/hexa/cli/index.html
View File

File diff suppressed because it is too large Load Diff

1126
hexa/lib/hexa/container/index.html
View File

File diff suppressed because it is too large Load Diff

1123
hexa/lib/hexa/generate_abc/index.html
View File

File diff suppressed because it is too large Load Diff

1123
hexa/lib/hexa/generate_yaml/index.html
View File

File diff suppressed because it is too large Load Diff

1407
hexa/lib/hexa/index.html
View File

File diff suppressed because it is too large Load Diff

1310
hexa/lib/hexa/model/index.html
View File

File diff suppressed because it is too large Load Diff

1121
hexa/lib/hexa/parse_abc/index.html
View File

File diff suppressed because it is too large Load Diff

1170
hexa/lib/hexa/parse_yaml/index.html
View File

File diff suppressed because it is too large Load Diff

888
hexa/lib/index.html
View File

File diff suppressed because it is too large Load Diff

496
hexa/lib/model/index.html
View File

@@ -9,7 +9,7 @@
<link rel="prev" href="../philosophy/">
<link rel="prev" href="..">
<link rel="next" href="../container/">
@@ -246,110 +246,6 @@
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
@@ -372,10 +268,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
@@ -388,8 +284,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -468,6 +364,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.model--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -499,15 +404,6 @@
<nav class="md-nav" aria-label="PortNode">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.model.PortNode--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.model.PortNode-functions" class="md-nav__link">
<span class="md-ellipsis">
@@ -607,10 +503,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -623,8 +519,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -688,10 +584,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -704,8 +600,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -792,10 +688,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -808,8 +704,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -894,10 +790,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -910,8 +806,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -973,10 +869,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -989,8 +885,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1069,6 +965,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.model--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1100,15 +1005,6 @@
<nav class="md-nav" aria-label="PortNode">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.model.PortNode--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.model.PortNode-functions" class="md-nav__link">
<span class="md-ellipsis">
@@ -1200,8 +1096,12 @@
<h3 id="hexa.model--summary">Summary</h3>
<p>Shared neutral model for hexa port trees.</p>
<p>All utilities (<code>parse_yaml</code>, <code>generate_abc</code>, <code>parse_abc</code>,
<code>generate_yaml</code>, <code>check_matches</code>) serialize through this single model.
It is NOT tied to any sample — any port tree fits.</p>
<code>generate_yaml</code>, <code>check_matches</code>) serialize through this single model.</p>
<hr />
<h3 id="hexa.model--notes">Notes</h3>
<ul>
<li>The model is NOT tied to any sample — any port tree fits.</li>
</ul>
@@ -1244,6 +1144,53 @@ It is NOT tied to any sample — any port tree fits.</p>
<p>Specification of a single abstract method.</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="hexa.model.MethodSpec.name">name</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Name of the method.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.MethodSpec.args">args</span></code></td>
<td>
<code>list[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Positional parameter names.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.MethodSpec.kwargs">kwargs</span></code></td>
<td>
<code>dict[str, str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Keyword-only parameter names mapped to their type expressions.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
@@ -1298,24 +1245,94 @@ It is NOT tied to any sample — any port tree fits.</p>
<p>A node in the hexa port tree.</p>
<h6 id="hexa.model.PortNode--parameters">Parameters</h6>
<p>name : str
Slot name, e.g. <code>"parser"</code>, <code>"amount_balance"</code>.
kind : str
One of <code>"leaf"</code>, <code>"port"</code>, or <code>"parent"</code>.
- <code>"leaf"</code>: no children (e.g. <code>NumberPort</code>)
- <code>"port"</code>: has children (e.g. <code>TransactionParserPort</code>)
- <code>"parent"</code>: the root of the tree (e.g. <code>ExtractionPipeline</code>)
port_cls : str
ABC class name that gives this port its shape, e.g.
<code>"TransactionParserPort"</code>. Every port has a concrete typed shape.
attributes : dict[str, ConfigValue]
Annotated attributes: <code>name -&gt; type_expr</code> for scalars, or a nested
<code>dict</code> of sub-attributes (a struct) for grouped/structured values.
children : list[PortNode]
Nested port slots.
methods : dict[str, MethodSpec]
Abstract methods keyed by method name.</p>
<p>Each node is a leaf (no children), a port (has nested port slots), or the
parent root of the tree. Every node carries a concrete typed shape derived
from an ABC class name.</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="hexa.model.PortNode.name">name</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Slot name, e.g. <code>"parser"</code>, <code>"amount_balance"</code>.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.PortNode.port_cls">port_cls</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>ABC class name that gives this port its shape, e.g.
<code>"TransactionParserPort"</code>. Every port has a concrete typed shape.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.PortNode.kind">kind</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>One of <code>"leaf"</code>, <code>"port"</code>, or <code>"parent"</code>.
- <code>"leaf"</code>: no children (e.g. <code>NumberPort</code>)
- <code>"port"</code>: has children (e.g. <code>TransactionParserPort</code>)
- <code>"parent"</code>: the root of the tree (e.g. <code>ExtractionPipeline</code>)</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.PortNode.attributes">attributes</span></code></td>
<td>
<code>dict[str, <span title="hexa.model.ConfigValue">ConfigValue</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Annotated attributes: <code>name -&gt; type_expr</code> for scalars, or a
nested <code>dict</code> of sub-attributes (a struct) for grouped values.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.PortNode.children">children</span></code></td>
<td>
<code>list[<a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="#hexa.model.PortNode">PortNode</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Nested port slots.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="hexa.model.PortNode.methods">methods</span></code></td>
<td>
<code>dict[str, <a class="autorefs autorefs-internal" title="hexa.model.MethodSpec" href="#hexa.model.MethodSpec">MethodSpec</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Abstract methods keyed by method name.</p>
</div>
</td>
</tr>
</tbody>
</table>
@@ -1346,6 +1363,74 @@ methods : dict[str, MethodSpec]
<p>Return a list of human-readable difference strings.</p>
<p>An empty list means the trees are equal.</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>other</code></td>
<td>
<code><a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="#hexa.model.PortNode">PortNode</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Tree to compare against.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>path</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Path prefix used when recursing into nested nodes; defaults to
the root path.</p>
</div>
</td>
<td>
<code>&#39;&#39;</code>
</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>list[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>list[str]:
Human-readable difference strings, one per discrepancy.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
@@ -1365,6 +1450,59 @@ methods : dict[str, MethodSpec]
<p>Find a direct child by slot name.</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>name</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Slot name of the child to look up.</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><a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="#hexa.model.PortNode">PortNode</a> | None</code>
</td>
<td>
<div class="doc-md-description">
<p>PortNode | None:
The matching child node, or <code>None</code> if no child has that name.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
@@ -1384,6 +1522,30 @@ methods : dict[str, MethodSpec]
<p>Return all nodes in depth-first order (self first).</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>list[<a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="#hexa.model.PortNode">PortNode</a>]</code>
</td>
<td>
<div class="doc-md-description">
<p>list[PortNode]:
All nodes of the tree, self first, depth-first.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>

BIN
hexa/lib/objects.inv
View File

Binary file not shown.

280
hexa/lib/parse_abc/index.html
View File

@@ -253,8 +253,6 @@
@@ -278,7 +276,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -288,108 +286,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -451,10 +347,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -467,8 +363,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -532,10 +428,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -548,8 +444,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -651,6 +547,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_abc--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -679,30 +584,6 @@
</span>
</a>
<nav class="md-nav" aria-label="parse_abc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.parse_abc.parse_abc--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_abc.parse_abc--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -759,10 +640,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -775,8 +656,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -861,10 +742,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -877,8 +758,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -940,10 +821,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -956,8 +837,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1036,6 +917,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_abc--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1064,30 +954,6 @@
</span>
</a>
<nav class="md-nav" aria-label="parse_abc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.parse_abc.parse_abc--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_abc.parse_abc--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1133,6 +999,15 @@
<h3 id="hexa.parse_abc--summary">Summary</h3>
<p>Parse an ABC Python module into a hexa PortNode tree.</p>
<p>ABC classes become port nodes. A nested-struct attribute is expressed as a
<code>@dataclass</code> annotation on an ABC port (e.g. <code>source: ExtractionSource</code>
where <code>ExtractionSource</code> is a <code>@dataclass</code>); the dataclass's fields are
expanded into a nested <code>attributes</code> entry.</p>
<hr />
<h3 id="hexa.parse_abc--notes">Notes</h3>
<ul>
<li>Accepts a file path, a module import string, or an already-loaded module.</li>
</ul>
@@ -1164,12 +1039,59 @@
<code>@dataclass</code> annotation on an ABC port (e.g. <code>source: ExtractionSource</code>
where <code>ExtractionSource</code> is a <code>@dataclass</code>); the dataclass's fields are
expanded into a nested <code>attributes</code> entry.</p>
<h6 id="hexa.parse_abc.parse_abc--parameters">Parameters</h6>
<p>module_or_path : str | Path | Any
A file path to a <code>.py</code> file, a module import string, or a loaded module.</p>
<h6 id="hexa.parse_abc.parse_abc--returns">Returns</h6>
<p>PortNode
The root node of the tree.</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>module_or_path</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span> | <span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
<p>A file path to a <code>.py</code> file, a module import string, or a loaded
module.</p>
</div>
</td>
<td>
<em>required</em>
</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>PortNode</code></td> <td>
<code><a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="../model/#hexa.model.PortNode">PortNode</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The root node of the tree.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>

377
hexa/lib/parse_yaml/index.html
View File

@@ -253,8 +253,6 @@
@@ -278,7 +276,7 @@
<span class="md-ellipsis">
Concepts
Shared Model
</span>
@@ -288,108 +286,6 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../philosophy/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<span class="md-ellipsis">
Shared Model
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -451,10 +347,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -467,8 +363,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -532,10 +428,10 @@
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -548,8 +444,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -628,6 +524,24 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml--examples" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -656,39 +570,6 @@
</span>
</a>
<nav class="md-nav" aria-label="parse_yaml">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.parse_yaml.parse_yaml--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml.parse_yaml--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml.parse_yaml--raises" class="md-nav__link">
<span class="md-ellipsis">
Raises
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -768,10 +649,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -784,8 +665,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -870,10 +751,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -886,8 +767,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -949,10 +830,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -965,8 +846,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
@@ -1045,6 +926,24 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml--examples" class="md-nav__link">
<span class="md-ellipsis">
Examples
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml--notes" class="md-nav__link">
<span class="md-ellipsis">
Notes
</span>
</a>
</li>
<li class="md-nav__item">
@@ -1073,39 +972,6 @@
</span>
</a>
<nav class="md-nav" aria-label="parse_yaml">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#hexa.parse_yaml.parse_yaml--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml.parse_yaml--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#hexa.parse_yaml.parse_yaml--raises" class="md-nav__link">
<span class="md-ellipsis">
Raises
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
@@ -1158,7 +1024,29 @@
<li><strong>port</strong>: a <code>name:</code> mapping whose single key is a class whose value is a
body, or a class key with a <code>...</code> body. A port carries a class shape.</li>
</ul>
<p>Example::</p>
<details class="disambiguation-of-a-mapping-value" open>
<summary>Disambiguation of a mapping value</summary>
<p>A mapping with exactly one key whose value is a non-scalar body (a mapping,
<code>...</code>, or a list) is a <strong>port</strong>. Any other mapping (multiple keys, or all
scalar-typed values) is a <strong>nested struct</strong> of attributes.</p>
</details> <hr />
<h3 id="hexa.parse_yaml--examples">Examples</h3>
<p>Parse a spec into a port tree:</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>```python
from hexa import parse_yaml
node = parse_yaml(&quot;samples/minimal/sample.yaml&quot;)
print(node)
```
</code></pre></div></td></tr></table></div>
<p>The YAML grammar:</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>
@@ -1170,7 +1058,10 @@
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span></pre></div></td><td class="code"><div><pre><span></span><code>RootClassName:
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span></pre></div></td><td class="code"><div><pre><span></span><code>```yaml
RootClassName:
attr: type # scalar attribute
source: # nested struct (all scalar sub-attributes)
source_type: str
@@ -1182,16 +1073,14 @@
IngestPort:
source_type: str
methods: {Method: ...}
```
</code></pre></div></td></tr></table></div>
<details class="disambiguation-of-a-mapping-value" open>
<summary>Disambiguation of a mapping value</summary>
<p>A mapping with exactly one key whose value is a non-scalar body (a mapping,
<code>...</code>, or a list) is a <strong>port</strong>. Any other mapping (multiple keys, or all
scalar-typed values) is a <strong>nested struct</strong> of attributes.</p>
</details> <p>See <code>samples/minimal/sample.yaml</code> and
<code>samples/extraction_pipeline/extraction_pipeline.yaml</code> for examples.</p>
<hr />
<h3 id="hexa.parse_yaml--notes">Notes</h3>
<ul>
<li>See <code>samples/minimal/sample.yaml</code> and
<code>samples/extraction_pipeline/extraction_pipeline.yaml</code> for worked examples.</li>
</ul>
@@ -1219,15 +1108,81 @@ scalar-typed values) is a <strong>nested struct</strong> of attributes.</p>
<div class="doc doc-contents ">
<p>Parse a hexa YAML spec file into a :class:<code>PortNode</code> tree.</p>
<h6 id="hexa.parse_yaml.parse_yaml--parameters">Parameters</h6>
<p>path : str | Path
Path to the <code>.yaml</code> file.</p>
<h6 id="hexa.parse_yaml.parse_yaml--returns">Returns</h6>
<p>PortNode
The root node of the parsed tree.</p>
<h6 id="hexa.parse_yaml.parse_yaml--raises">Raises</h6>
<p>ValueError
On structural errors in the YAML.</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>path</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Path to the <code>.yaml</code> file.</p>
</div>
</td>
<td>
<em>required</em>
</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>PortNode</code></td> <td>
<code><a class="autorefs autorefs-internal" title="hexa.model.PortNode" href="../model/#hexa.model.PortNode">PortNode</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The root node of the parsed tree.</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>ValueError</code>
</td>
<td>
<div class="doc-md-description">
<p>On structural errors in the YAML.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>

285
hexa/lib/philosophy/index.html
View File

@@ -9,10 +9,6 @@
<link rel="prev" href="../design/">
<link rel="next" href="../model/">
<link rel="icon" href="../assets/images/favicon.png">
@@ -245,239 +241,6 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../design/" class="md-nav__link">
<span class="md-ellipsis">
hexa — Design (extraction pipeline, Axis/Icici)
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
hexa — Philosophy
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#one-idea" class="md-nav__link">
<span class="md-ellipsis">
One idea
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#the-three-layers" class="md-nav__link">
<span class="md-ellipsis">
The three layers
</span>
</a>
<nav class="md-nav" aria-label="The three layers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#layer-1-abc-contracts-samplesextraction_pipelineextraction_pipeline_abcpy" class="md-nav__link">
<span class="md-ellipsis">
Layer 1 — ABC contracts (samples/extraction_pipeline/extraction_pipeline_abc.py)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#layer-2-generic-concurrent-implementations-samplesextraction_pipelineextraction_pipeline_implpy" class="md-nav__link">
<span class="md-ellipsis">
Layer 2 — generic concurrent implementations (samples/extraction_pipeline/extraction_pipeline_impl.py)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#layer-3-bank-specializations-samplesextraction_pipelinebanksaxisicicipdfpy-samplesextraction_pipelineextraction_pipeline_bankspy" class="md-nav__link">
<span class="md-ellipsis">
Layer 3 — bank specializations (samples/extraction_pipeline/banks/{axis,icici}/pdf.py, samples/extraction_pipeline/extraction_pipeline_banks.py)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#the-re-pinning-cascade" class="md-nav__link">
<span class="md-ellipsis">
The re-pinning cascade
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#the-two-fidelity-guarantees-this-pattern-preserves" class="md-nav__link">
<span class="md-ellipsis">
The two fidelity guarantees this pattern preserves
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-this-pattern-is-not" class="md-nav__link">
<span class="md-ellipsis">
What this pattern is NOT
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#runtime-instantiation" class="md-nav__link">
<span class="md-ellipsis">
Runtime instantiation
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@@ -501,10 +264,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
@@ -517,8 +280,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Shared Model
</label>
@@ -580,10 +343,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
@@ -596,8 +359,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Container
</label>
@@ -661,10 +424,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -677,8 +440,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
@@ -765,10 +528,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
@@ -781,8 +544,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
@@ -867,10 +630,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
@@ -883,8 +646,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
@@ -946,10 +709,10 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
@@ -962,8 +725,8 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
CLI
</label>

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

File diff suppressed because one or more lines are too long

BIN
hexa/lib/sitemap.xml.gz
View File

Binary file not shown.