aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a32eeaf2b4c5b8b287c2a874a28d0d3c49dd69e0
docs/hexa/lib/philosophy/index.html
Vishesh 'ironeagle' Bangotra a32eeaf2b4 feat: serve docs flat at /<repo>/ with no redirects 
- collect.py copies each repo's built site contents directly to a
  top-level <repo>/ dir (was libs|apis|wiki/<repo>/site nesting)
- nginx uses `index index.html lib/index.html api/index.html` so
  /dagpipe/ -> lib/index.html, /auth-server/ -> api/index.html are
  served internally with no redirects
- _index regenerates links against the flat layout
  (/dagpipe/lib/, /auth-server/api/, /mongo-ops/, /blog/...)
- config.yml static entries point at vendored blog/ + media-manager/
- Dockerfile copies per-repo dirs flat into the nginx html root
- removed stale libs/, apis/, wiki/, tutorials/ category trees
2026-09-11 21:32:30 +05:30

1308 lines
37 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../design/">
<link rel="next" href="../model/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>hexa — Philosophy - hexa</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#hexa-philosophy" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="hexa" class="md-header__button md-logo" aria-label="hexa" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10.25 2c.19 0 .36.11.44.26l2.22 3.96.09.28-.09.28-2.22 3.96c-.08.15-.25.26-.44.26h-4.5c-.19 0-.36-.11-.44-.26L3.09 6.78 3 6.5l.09-.28 2.22-3.96c.08-.15.25-.26.44-.26zm0 11c.19 0 .36.11.44.26l2.22 3.96.09.28-.09.28-2.22 3.96c-.08.15-.25.26-.44.26h-4.5c-.19 0-.36-.11-.44-.26l-2.22-3.96L3 17.5l.09-.28 2.22-3.96c.08-.15.25-.26.44-.26zm9.25-5.5c.19 0 .36.11.44.26l2.22 3.96.09.28-.09.28-2.22 3.96c-.08.15-.25.26-.44.26H15c-.19 0-.36-.11-.44-.26l-2.22-3.96-.09-.28.09-.28 2.22-3.96c.08-.15.25-.26.44-.26z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
hexa
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
hexa — Philosophy
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan" aria-hidden="true" type="radio" name="__palette" id="__palette_0">
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="hexa" class="md-nav__button md-logo" aria-label="hexa" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10.25 2c.19 0 .36.11.44.26l2.22 3.96.09.28-.09.28-2.22 3.96c-.08.15-.25.26-.44.26h-4.5c-.19 0-.36-.11-.44-.26L3.09 6.78 3 6.5l.09-.28 2.22-3.96c.08-.15.25-.26.44-.26zm0 11c.19 0 .36.11.44.26l2.22 3.96.09.28-.09.28-2.22 3.96c-.08.15-.25.26-.44.26h-4.5c-.19 0-.36-.11-.44-.26l-2.22-3.96L3 17.5l.09-.28 2.22-3.96c.08-.15.25-.26.44-.26zm9.25-5.5c.19 0 .36.11.44.26l2.22 3.96.09.28-.09.28-2.22 3.96c-.08.15-.25.26-.44.26H15c-.19 0-.36-.11-.44-.26l-2.22-3.96-.09-.28.09-.28 2.22-3.96c.08-.15.25-.26.44-.26z"/></svg>
</a>
hexa
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../" class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<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>
<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>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../model/" class="md-nav__link">
<span class="md-ellipsis">
Model
</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_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Container
</span>
<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">
<span class="md-nav__icon md-icon"></span>
Container
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../container/" class="md-nav__link">
<span class="md-ellipsis">
Container
</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_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
Parsing
</span>
<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">
<span class="md-nav__icon md-icon"></span>
Parsing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../parse_yaml/" class="md-nav__link">
<span class="md-ellipsis">
Parse Yaml
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../parse_abc/" class="md-nav__link">
<span class="md-ellipsis">
Parse Abc
</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_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-ellipsis">
Generation
</span>
<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">
<span class="md-nav__icon md-icon"></span>
Generation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../generate_abc/" class="md-nav__link">
<span class="md-ellipsis">
Generate Abc
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../generate_yaml/" class="md-nav__link">
<span class="md-ellipsis">
Generate Yaml
</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_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="">
<span class="md-ellipsis">
Verification
</span>
<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">
<span class="md-nav__icon md-icon"></span>
Verification
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../check_matches/" class="md-nav__link">
<span class="md-ellipsis">
Check Matches
</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_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="">
<span class="md-ellipsis">
CLI
</span>
<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">
<span class="md-nav__icon md-icon"></span>
CLI
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../cli/" class="md-nav__link">
<span class="md-ellipsis">
Cli
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<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>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="hexa-philosophy">hexa — Philosophy</h1>
<p>This document explains the <em>why</em> behind the type-declared dependency pattern used
for the extraction pipeline sample — specifically the Axis/Icici bank variation. It is,
together with <a href="../design/">design.md</a>, self-sufficient: a fresh agent should be able
to pick up the codebase from here and reason about (and extend) the pattern without
needing the original session context.</p>
<h2 id="one-idea">One idea</h2>
<blockquote>
<p><strong>A concrete class's annotated slot type <em>is</em> the dependency decision.</strong></p>
</blockquote>
<p>Bank variation is expressed entirely as <strong>class annotations</strong> — never as imperative
wiring, never as <code>__init__</code> parameters, never as a composition-root that assembles
objects by hand. The tree of ports a pipeline needs is declared once, and a bank
differs from the generic pipeline <em>only</em> by which concrete types are pinned onto
which slots.</p>
<h2 id="the-three-layers">The three layers</h2>
<p>The pattern is built from three fixed layers. Understanding which layer something
belongs to is the whole mental model.</p>
<h3 id="layer-1-abc-contracts-samplesextraction_pipelineextraction_pipeline_abcpy">Layer 1 — ABC contracts (<code>samples/extraction_pipeline/extraction_pipeline_abc.py</code>)</h3>
<p>Authoritative <em>declaration of need</em> ("WHAT a stage requires").</p>
<ul>
<li>Each port is an <code>ABC</code>.</li>
<li>It declares <strong>attributes</strong> as class-level annotated defaults
(e.g. <code>TransactionParserPort.min_numbers: int = 3</code>), optionally grouped as a
nested <strong>struct</strong> via a <code>@dataclass</code> (e.g. <code>source: ExtractionSource</code>).</li>
<li>It declares <strong>port slots</strong> as annotated attributes whose type is another ABC
(e.g. <code>TransactionParserPort.number: NumberPort</code>, <code>amount_balance: AmountBalancePort</code>).</li>
<li>It declares <strong><code>@abstractmethod</code> bodies</strong> — the method signatures each concrete
implementation must provide.</li>
</ul>
<p>The ABC never runs, never holds an instance, and never says <em>which</em> implementation
to use. It only says <em>what the shape is</em>.</p>
<h3 id="layer-2-generic-concurrent-implementations-samplesextraction_pipelineextraction_pipeline_implpy">Layer 2 — generic concurrent implementations (<code>samples/extraction_pipeline/extraction_pipeline_impl.py</code>)</h3>
<p>The <strong>common default behavior</strong> ("Imple — the shared adaptor").</p>
<ul>
<li><code>class ImplTransactionParserPort(TransactionParserPort)</code> subclasses the ABC,
implements every <code>@abstractmethod</code>, and <strong>re-pins its port slots to concrete
<code>Impl*</code> types</strong>: <code>number: ImplNumberPort</code>, <code>desc: ImplDescPort</code>,
<code>amount_balance: ImplAmountBalancePort</code>.</li>
<li><code>ImplAmountBalancePort</code> in turn pins <code>number: ImplNumberPort</code> and
<code>ambiguity: ImplAmbiguityPort</code>.</li>
<li>The root, <code>ImplExtractionPipeline</code>, pins its five stage slots to <code>Impl*</code> ports:
<code>ingest</code>, <code>raw_lines</code>, <code>txn_blocks</code>, <code>txn_dicts</code>, <code>raw_expense</code>.</li>
</ul>
<p><code>Impl*</code> is the <strong>default that shared, bank-agnostic behavior lives in</strong>. Any slot a
bank does <em>not</em> override falls back to <code>Impl*</code> at runtime.</p>
<h3 id="layer-3-bank-specializations-samplesextraction_pipelinebanksaxisicicipdfpy-samplesextraction_pipelineextraction_pipeline_bankspy">Layer 3 — bank specializations (<code>samples/extraction_pipeline/banks/{axis,icici}/pdf.py</code>, <code>samples/extraction_pipeline/extraction_pipeline_banks.py</code>)</h3>
<p>The <strong>variation</strong> ("what differs per bank").</p>
<ul>
<li>Bank classes subclass the <strong>concrete <code>Impl*</code> classes, never the ABC</strong> — they
<em>extend</em>, they never <em>reinvent</em> the contract.</li>
<li>Each <code>Axis*</code>/<code>Icici*</code> class overrides <strong>only the members that differ</strong> from the
generic <code>Impl*</code>; everything shared is inherited.</li>
<li>A bank root is a <strong>thin annotated subclass of <code>ImplExtractionPipeline</code></strong> that
re-pins only the slots that differ:</li>
</ul>
<div class="language-python highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">AxisExtractionPipeline</span><span class="p">(</span><span class="n">ImplExtractionPipeline</span><span class="p">):</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">txn_dicts</span><span class="p">:</span> <span class="n">AxisTxnDictsPort</span>
</span></code></pre></div></td></tr></table></div>
<h2 id="the-re-pinning-cascade">The re-pinning cascade</h2>
<p>Bank-specific wiring is <strong>hierarchical and cascading</strong>. Each level narrows exactly
one slot, and its narrowed type drags the next level's narrowing along with it:</p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1">1</a></span>
<span class="normal"><a href="#__codelineno-1-2">2</a></span>
<span class="normal"><a href="#__codelineno-1-3">3</a></span>
<span class="normal"><a href="#__codelineno-1-4">4</a></span>
<span class="normal"><a href="#__codelineno-1-5">5</a></span>
<span class="normal"><a href="#__codelineno-1-6">6</a></span>
<span class="normal"><a href="#__codelineno-1-7">7</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a>AxisExtractionPipeline
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a> └─ txn_dicts: AxisTxnDictsPort (only override on the root)
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a> └─ parser: AxisTransactionParserPort
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a> ├─ number: AxisNumberPort (get_numbers → all clean nums)
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5"></a> ├─ desc: AxisDescPort (STARTTERS)
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6"></a> └─ amount_balance: AxisAmountBalancePort
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7"></a> └─ number: AxisNumberPort (re-pin: same bank's number port)
</span></code></pre></div></td></tr></table></div>
<p>Siblings that are already correct in <code>Impl*</code> are <strong>inherited, not redeclared</strong>.
E.g. the parser's <code>date</code> slot comes from <code>ImplTransactionParserPort</code>; the
amount-balance port's <code>ambiguity</code> comes from <code>ImplAmountBalancePort</code>. Re-declaring
them adds mental load on the extender with zero behavior change.</p>
<blockquote>
<p><strong>Rule — only redeclare the slot you are actually changing.</strong> If a slot's
behavior is already correct from <code>Impl*</code>, leave it out.</p>
</blockquote>
<h2 id="the-two-fidelity-guarantees-this-pattern-preserves">The two fidelity guarantees this pattern preserves</h2>
<ol>
<li><strong>Shared behavior stays shared.</strong> Slots like <code>ingest</code>, <code>raw_lines</code>, <code>txn_blocks</code>,
<code>raw_expense</code>, parser <code>date</code>, and <code>ambiguity</code> are bank-agnostic. Leaving them at
the <code>Impl*</code> default is deliberate, not an omission.</li>
<li><strong>Banks never reinvent.</strong> <code>Axis*</code>/<code>Icici*</code> only <em>extend</em> <code>Impl*</code>. The ABC contract
in <code>samples/extraction_pipeline/extraction_pipeline_abc.py</code> is defined once and shared by every bank.</li>
</ol>
<h2 id="what-this-pattern-is-not">What this pattern is NOT</h2>
<ul>
<li><strong>No imperative assembly.</strong> No <code>build_axis_pipeline()</code> wiring objects by hand.</li>
<li><strong>No constructor injection.</strong> <code>Impl*</code> classes have no <code>__init__</code>; wiring is done by
assigning concrete port instances onto annotated slots.</li>
<li><strong>YAML and ABCs are interchangeable, and both optional.</strong> The <code>.yaml</code> spec and
the <code>_abc.py</code> module are two representations of the <em>same contract</em>. hexa is
agnostic of the extraction pipeline sample and never imposes a workflow: a user can hand-write the
ABC file, start from YAML (ABC generated), start from an ABC file (YAML
emitted), or use both as a spec. The optional utilities in
<a href="../design/">design.md</a> § <em>Utilities</em> translate between them and can verify they
agree — but the bank <code>Impl*</code>/specialization files are always hand-written
(their slots are a manual choice) and never generated.</li>
</ul>
<h2 id="runtime-instantiation">Runtime instantiation</h2>
<p>The annotations are the decision; <code>hexa.build(cls)</code> (see <a href="../design/">design.md</a> §
<em>Container</em>) turns a root class into a wired instance by reading <code>__annotations__</code>
+ MRO, recursively instantiating each pinned concrete type, and <code>setattr</code>ing the
child onto the parent slot. This document is scoped to the <em>notation</em> — the rest
of the tree can be expressed purely as class annotations and filled at runtime by
the container.</p>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink