Files

2378 lines
69 KiB
HTML

<!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="icon" href="../../../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Abc - Khata App — Library Reference</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="#abc" 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="Khata App — Library Reference" class="md-header__button md-logo" aria-label="Khata App — Library Reference" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11 8c0 2.21-1.79 4-4 4s-4-1.79-4-4 1.79-4 4-4 4 1.79 4 4m0 6.72V20H0v-2c0-2.21 3.13-4 7-4 1.5 0 2.87.27 4 .72M24 20H13V3h11zm-8-8.5a2.5 2.5 0 0 1 5 0 2.5 2.5 0 0 1-5 0M22 7a2 2 0 0 1-2-2h-3c0 1.11-.89 2-2 2v9a2 2 0 0 1 2 2h3c0-1.1.9-2 2-2z"/></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">
Khata App — Library Reference
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Abc
</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="Khata App — Library Reference" class="md-nav__button md-logo" aria-label="Khata App — Library Reference" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11 8c0 2.21-1.79 4-4 4s-4-1.79-4-4 1.79-4 4-4 4 1.79 4 4m0 6.72V20H0v-2c0-2.21 3.13-4 7-4 1.5 0 2.87.27 4 .72M24 20H13V3h11zm-8-8.5a2.5 2.5 0 0 1 5 0 2.5 2.5 0 0 1-5 0M22 7a2 2 0 0 1-2-2h-3c0 1.11-.89 2-2 2v9a2 2 0 0 1 2 2h3c0-1.1.9-2 2-2z"/></svg>
</a>
Khata App — Library Reference
</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--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<div class="md-nav__link md-nav__container">
<a href="../../../../domain/" class="md-nav__link ">
<span class="md-ellipsis">
Domain
</span>
</a>
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<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>
Domain
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../../../domain/enrichment/" class="md-nav__link">
<span class="md-ellipsis">
Enrichment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../../domain/fetch_pipeline/" class="md-nav__link">
<span class="md-ellipsis">
Fetch Pipeline
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../../domain/fetch_request/" class="md-nav__link">
<span class="md-ellipsis">
Fetch Request
</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" >
<div class="md-nav__link md-nav__container">
<a href="../../../../infra/" class="md-nav__link ">
<span class="md-ellipsis">
Infra
</span>
</a>
</div>
<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>
Infra
</label>
<ul class="md-nav__list" data-md-scrollfix>
</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" >
<div class="md-nav__link md-nav__container">
<a href="../../../../interfaces/" class="md-nav__link ">
<span class="md-ellipsis">
Interfaces
</span>
</a>
</div>
<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>
Interfaces
</label>
<ul class="md-nav__list" data-md-scrollfix>
</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" >
<div class="md-nav__link md-nav__container">
<a href="../../../" class="md-nav__link ">
<span class="md-ellipsis">
Pipelines
</span>
</a>
</div>
<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>
Pipelines
</label>
<ul class="md-nav__list" data-md-scrollfix>
</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="#pipelines.extraction.pdf.abc" class="md-nav__link">
<span class="md-ellipsis">
abc
</span>
</a>
<nav class="md-nav" aria-label="abc">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc--summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc-classes" class="md-nav__link">
<span class="md-ellipsis">
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.BucketFinderPort" class="md-nav__link">
<span class="md-ellipsis">
BucketFinderPort
</span>
</a>
<nav class="md-nav" aria-label="BucketFinderPort">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.BucketFinderPort-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.BucketFinderPort.get_opening_balance_buckets" class="md-nav__link">
<span class="md-ellipsis">
get_opening_balance_buckets
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.PDFExtractionPipeline" class="md-nav__link">
<span class="md-ellipsis">
PDFExtractionPipeline
</span>
</a>
<nav class="md-nav" aria-label="PDFExtractionPipeline">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.PDFExtractionPipeline-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.PDFExtractionPipeline.run" class="md-nav__link">
<span class="md-ellipsis">
run
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.RawLinesPort" class="md-nav__link">
<span class="md-ellipsis">
RawLinesPort
</span>
</a>
<nav class="md-nav" aria-label="RawLinesPort">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.RawLinesPort-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.RawLinesPort.extract" class="md-nav__link">
<span class="md-ellipsis">
extract
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.SplitterPort" class="md-nav__link">
<span class="md-ellipsis">
SplitterPort
</span>
</a>
<nav class="md-nav" aria-label="SplitterPort">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.SplitterPort-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.SplitterPort.split_blocks" class="md-nav__link">
<span class="md-ellipsis">
split_blocks
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TransactionParserPort" class="md-nav__link">
<span class="md-ellipsis">
TransactionParserPort
</span>
</a>
<nav class="md-nav" aria-label="TransactionParserPort">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TransactionParserPort-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TransactionParserPort.parse" class="md-nav__link">
<span class="md-ellipsis">
parse
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TxnBlocksPort" class="md-nav__link">
<span class="md-ellipsis">
TxnBlocksPort
</span>
</a>
<nav class="md-nav" aria-label="TxnBlocksPort">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TxnBlocksPort-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TxnBlocksPort.extract" class="md-nav__link">
<span class="md-ellipsis">
extract
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TxnDictsPort" class="md-nav__link">
<span class="md-ellipsis">
TxnDictsPort
</span>
</a>
<nav class="md-nav" aria-label="TxnDictsPort">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TxnDictsPort-functions" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
</a>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pipelines.extraction.pdf.abc.TxnDictsPort.extract" class="md-nav__link">
<span class="md-ellipsis">
extract
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="abc">Abc</h1>
<div class="doc doc-object doc-module">
<h2 id="pipelines.extraction.pdf.abc" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">pipelines.extraction.pdf.abc</span>
</h2>
<div class="doc doc-contents first">
<h3 id="pipelines.extraction.pdf.abc--summary">Summary</h3>
<p>Abstract contracts for the pdf (OCR text) extraction graph (no implementation).</p>
<hr />
<p>The pdf family is the classic heuristic text chain:</p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>ingest → raw_lines → txn_blocks → txn_dicts → raw_expense
</code></pre></div></td></tr></table></div>
<p>Non-PDF families (email / csv / xlsx) do NOT extend this root — they have their
own stage chains (see <code>email/abc.py</code> and <code>shared/tabular.py</code>).</p>
<p>The annotations on each class declare WHAT it needs. Concrete implementations
(re)declare the same port slots with CONCRETE types to inform which
implementation is used, and implement the @abstractmethod bodies.</p>
<div class="doc doc-children">
<h3 id="pipelines.extraction.pdf.abc-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.BucketFinderPort" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">BucketFinderPort</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>Divide raw_lines into account buckets at B/F markers.</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="pipelines.extraction.pdf.abc.BucketFinderPort.number">number</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.NumberPort" href="../../shared/ports/#pipelines.extraction.shared.ports.NumberPort">NumberPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Number extraction leaf.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.BucketFinderPort-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.BucketFinderPort.get_opening_balance_buckets" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">get_opening_balance_buckets</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
<span class="normal"><a href="#__codelineno-0-5">5</a></span>
<span class="normal"><a href="#__codelineno-0-6">6</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">get_opening_balance_buckets</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">lines</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="o">*</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">limit_first</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a> <span class="n">line_offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">tuple</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Divide raw lines into account buckets at B/F markers.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>lines</code></td>
<td>
<code><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Raw text lines.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>limit_first</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Keep only the first bucket. Defaults to False.</p>
</div>
</td>
<td>
<code>False</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>line_offset</code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Offset added to starting indices. Defaults to 0.</p>
</div>
</td>
<td>
<code>0</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><span title="typing.List">List</span>[tuple]</code>
</td>
<td>
<div class="doc-md-description">
<p>List[tuple]: <code>(start, end, opening_balance)</code> bucket triples.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.PDFExtractionPipeline" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">PDFExtractionPipeline</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>Root — wires ingest → raw_lines → txn_blocks → txn_dicts → raw_expenses.</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="pipelines.extraction.pdf.abc.PDFExtractionPipeline.source">source</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.ExtractionSource" href="../../shared/ports/#pipelines.extraction.shared.ports.ExtractionSource">ExtractionSource</a></code>
</td>
<td>
<div class="doc-md-description">
<p>The extraction source descriptor.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.pipeline">pipeline</span></code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Pipeline tag; defaults to "heuristic".</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.trust_fallback">trust_fallback</span></code></td>
<td>
</td>
<td>
<div class="doc-md-description">
<p>Fallback policy for amount/balance trust.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.ingest">ingest</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.IngestPort" href="../../shared/ports/#pipelines.extraction.shared.ports.IngestPort">IngestPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Ingest stage.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.raw_lines">raw_lines</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.pdf.abc.RawLinesPort" href="#pipelines.extraction.pdf.abc.RawLinesPort">RawLinesPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Raw-lines stage.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.txn_blocks">txn_blocks</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.pdf.abc.TxnBlocksPort" href="#pipelines.extraction.pdf.abc.TxnBlocksPort">TxnBlocksPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Txn-blocks stage.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.txn_dicts">txn_dicts</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.pdf.abc.TxnDictsPort" href="#pipelines.extraction.pdf.abc.TxnDictsPort">TxnDictsPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Txn-dicts stage.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.PDFExtractionPipeline.raw_expense">raw_expense</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.RawExpensePort" href="../../shared/ports/#pipelines.extraction.shared.ports.RawExpensePort">RawExpensePort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Terminal raw-expense stage.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.PDFExtractionPipeline-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.PDFExtractionPipeline.run" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">run</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">run</span><span class="p">(</span><span class="n">source</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Run the pdf extraction chain.</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>source</code></td>
<td>
</td>
<td>
<div class="doc-md-description">
<p>Raw extraction source.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typing.List">List</span>[<span title="typing.Any">Any</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>List[Any]: Raw expense records.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.RawLinesPort" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">RawLinesPort</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>content → list of raw text lines.</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="pipelines.extraction.pdf.abc.RawLinesPort.covert_to_image">covert_to_image</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether to binarize pages via image conversion.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.RawLinesPort-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.RawLinesPort.extract" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">extract</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">extract</span><span class="p">(</span><span class="n">content</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Extract raw OCR text lines from content.</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>content</code></td>
<td>
</td>
<td>
<div class="doc-md-description">
<p>Materialized content payload.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>List[str]: Raw text lines.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.SplitterPort" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">SplitterPort</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>Split bucket line-groups into transaction blocks.</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="pipelines.extraction.pdf.abc.SplitterPort.number">number</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.NumberPort" href="../../shared/ports/#pipelines.extraction.shared.ports.NumberPort">NumberPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Number extraction leaf.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.SplitterPort.date">date</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.DatePort" href="../../shared/ports/#pipelines.extraction.shared.ports.DatePort">DatePort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Date parsing leaf.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.SplitterPort-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.SplitterPort.split_blocks" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">split_blocks</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
<span class="normal"><a href="#__codelineno-0-5">5</a></span>
<span class="normal"><a href="#__codelineno-0-6">6</a></span>
<span class="normal"><a href="#__codelineno-0-7">7</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">split_blocks</span><span class="p">(</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a> <span class="n">lines</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a> <span class="o">*</span><span class="p">,</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a> <span class="n">has_header</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a> <span class="n">min_numbers</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">3</span><span class="p">,</span>
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6"></a> <span class="n">detect_date_ranges</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Split bucket line-groups into transaction blocks.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>lines</code></td>
<td>
<code><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Lines belonging to one account bucket.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>has_header</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether a header precedes the rows.</p>
</div>
</td>
<td>
<code>False</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>min_numbers</code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Minimum numbers for a split.</p>
</div>
</td>
<td>
<code>3</code>
</td>
</tr>
<tr class="doc-section-item">
<td><code>detect_date_ranges</code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Detect date-range lines.</p>
</div>
</td>
<td>
<code>False</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><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>List[str]: Transaction block texts.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.TransactionParserPort" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TransactionParserPort</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>Parse one transaction block into a structured dict.</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="pipelines.extraction.pdf.abc.TransactionParserPort.min_numbers">min_numbers</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Minimum numbers for a block.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TransactionParserPort.amount_index">amount_index</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Index of the amount in the number list.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TransactionParserPort.balance_index">balance_index</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Index of the balance in the number list.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TransactionParserPort.number">number</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.NumberPort" href="../../shared/ports/#pipelines.extraction.shared.ports.NumberPort">NumberPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Number extraction leaf.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TransactionParserPort.date">date</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.DatePort" href="../../shared/ports/#pipelines.extraction.shared.ports.DatePort">DatePort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Date parsing leaf.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TransactionParserPort.desc">desc</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.DescPort" href="../../shared/ports/#pipelines.extraction.shared.ports.DescPort">DescPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Description extraction leaf.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TransactionParserPort.amount_balance">amount_balance</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.shared.ports.AmountBalancePort" href="../../shared/ports/#pipelines.extraction.shared.ports.AmountBalancePort">AmountBalancePort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Amount/balance resolution leaf.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.TransactionParserPort-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.TransactionParserPort.parse" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">parse</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">parse</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_text</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">prev_date_str</span><span class="p">,</span> <span class="n">prev_balance</span><span class="p">:</span> <span class="nb">float</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Parse one transaction block into a structured dict.</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>txn_text</code></td>
<td>
<code>str</code>
</td>
<td>
<div class="doc-md-description">
<p>Transaction block text.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>prev_date_str</code></td>
<td>
</td>
<td>
<div class="doc-md-description">
<p>Previous transaction date string.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td><code>prev_balance</code></td>
<td>
<code>float</code>
</td>
<td>
<div class="doc-md-description">
<p>Running balance from the previous transaction.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>Dict[str, Any]: Parsed transaction dict.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.TxnBlocksPort" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TxnBlocksPort</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>raw_lines → txn_blocks (opening_balance → list[block strings]).</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="pipelines.extraction.pdf.abc.TxnBlocksPort.has_header">has_header</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Whether a header precedes the rows.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnBlocksPort.min_numbers">min_numbers</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Minimum numbers for block splitting.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnBlocksPort.detect_date_ranges">detect_date_ranges</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Detect date-range lines.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnBlocksPort.limit_first">limit_first</span></code></td>
<td>
<code>bool</code>
</td>
<td>
<div class="doc-md-description">
<p>Keep only the first bucket.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnBlocksPort.line_offset">line_offset</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Offset added to starting indices.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnBlocksPort.bucket_finder">bucket_finder</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.pdf.abc.BucketFinderPort" href="#pipelines.extraction.pdf.abc.BucketFinderPort">BucketFinderPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Bucket-finding stage.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnBlocksPort.splitter">splitter</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.pdf.abc.SplitterPort" href="#pipelines.extraction.pdf.abc.SplitterPort">SplitterPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Block-splitting stage.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.TxnBlocksPort-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.TxnBlocksPort.extract" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">extract</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">extract</span><span class="p">(</span><span class="n">raw_lines</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Extract txn blocks keyed by opening balance.</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>raw_lines</code></td>
<td>
<code><span title="typing.List">List</span>[str]</code>
</td>
<td>
<div class="doc-md-description">
<p>Raw OCR text lines.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typing.Dict">Dict</span>[float, <span title="typing.List">List</span>[str]]</code>
</td>
<td>
<div class="doc-md-description">
<p>Dict[float, List[str]]: Opening balance → block texts.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="doc doc-object doc-class">
<h4 id="pipelines.extraction.pdf.abc.TxnDictsPort" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">TxnDictsPort</span>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><span title="abc.ABC">ABC</span></code></p>
<p>txn_blocks → list of structured txn dicts.</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="pipelines.extraction.pdf.abc.TxnDictsPort.min_numbers">min_numbers</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Minimum numbers for a block.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnDictsPort.amount_index">amount_index</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Index of the amount in the number list.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnDictsPort.balance_index">balance_index</span></code></td>
<td>
<code>int</code>
</td>
<td>
<div class="doc-md-description">
<p>Index of the balance in the number list.</p>
</div>
</td>
</tr>
<tr class="doc-section-item">
<td><code><span title="pipelines.extraction.pdf.abc.TxnDictsPort.parser">parser</span></code></td>
<td>
<code><a class="autorefs autorefs-internal" title="pipelines.extraction.pdf.abc.TransactionParserPort" href="#pipelines.extraction.pdf.abc.TransactionParserPort">TransactionParserPort</a></code>
</td>
<td>
<div class="doc-md-description">
<p>Transaction parsing stage.</p>
</div>
</td>
</tr>
</tbody>
</table>
<div class="doc doc-children">
<h5 id="pipelines.extraction.pdf.abc.TxnDictsPort-functions">Functions</h5>
<div class="doc doc-object doc-function">
<h6 id="pipelines.extraction.pdf.abc.TxnDictsPort.extract" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">extract</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
</span>
</h6>
<div class="language-python doc-signature highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nf">extract</span><span class="p">(</span><span class="n">txn_blocks</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">float</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]])</span> <span class="o">-&gt;</span> <span class="n">Any</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Extract structured txn dicts from txn blocks.</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>txn_blocks</code></td>
<td>
<code><span title="typing.Dict">Dict</span>[float, <span title="typing.List">List</span>[str]]</code>
</td>
<td>
<div class="doc-md-description">
<p>Opening balance → block texts.</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>Any</code></td> <td>
<code><span title="typing.Any">Any</span></code>
</td>
<td>
<div class="doc-md-description">
<p>List of txn dicts.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</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>