This commit is contained in:
@@ -962,19 +962,22 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>Abstract parsing contracts for OmniRead.</p>
|
||||
<hr />
|
||||
<h4 id="omniread.core.parser--summary">Summary</h4>
|
||||
<h3 id="omniread.core.parser--summary">Summary</h3>
|
||||
<p>Abstract parsing contracts for OmniRead.</p>
|
||||
<p>This module defines the <strong>format-agnostic parser interface</strong> used to transform
|
||||
raw content into structured, typed representations.</p>
|
||||
<p>Parsers are responsible for:
|
||||
- Interpreting a single <code>Content</code> instance
|
||||
- Validating compatibility with the content type
|
||||
- Producing a structured output suitable for downstream consumers</p>
|
||||
<p>Parsers are not responsible for:
|
||||
- Fetching or acquiring content
|
||||
- Performing retries or error recovery
|
||||
- Managing multiple content sources</p>
|
||||
<p>Parsers are responsible for:</p>
|
||||
<ul>
|
||||
<li>Interpreting a single <code>Content</code> instance</li>
|
||||
<li>Validating compatibility with the content type</li>
|
||||
<li>Producing a structured output suitable for downstream consumers</li>
|
||||
</ul>
|
||||
<p>Parsers are not responsible for:</p>
|
||||
<ul>
|
||||
<li>Fetching or acquiring content</li>
|
||||
<li>Performing retries or error recovery</li>
|
||||
<li>Managing multiple content sources</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
@@ -1011,15 +1014,19 @@ raw content into structured, typed representations.</p>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Guarantees:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- A parser is a self-contained object that owns the Content it is responsible for interpreting
|
||||
- Consumers may rely on early validation of content compatibility and type-stable return values from `parse()`
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span>
|
||||
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- A parser is a self-contained object that owns the `Content` it is
|
||||
responsible for interpreting.
|
||||
- Consumers may rely on early validation of content compatibility
|
||||
and type-stable return values from `parse()`.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<p><strong>Responsibilities:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span>
|
||||
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Implementations must declare supported content types via `supported_types`
|
||||
- Implementations must raise parsing-specific exceptions from `parse()`
|
||||
- Implementations must remain deterministic for a given input
|
||||
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><code>- Implementations must declare supported content types via `supported_types`.
|
||||
- Implementations must raise parsing-specific exceptions from `parse()`.
|
||||
- Implementations must remain deterministic for a given input.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
<p>Initialize the parser with content to be parsed.</p>
|
||||
@@ -1039,7 +1046,7 @@ raw content into structured, typed representations.</p>
|
||||
<tr class="doc-section-item">
|
||||
<td><code>content</code></td>
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="omniread.core.content.Content" href="../../omniread/core/content/#omniread.core.content.Content">Content</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="omniread.core.content.Content" href="../content/#omniread.core.content.Content">Content</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1182,7 +1189,9 @@ raw content into structured, typed representations.</p>
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Responsibilities:</strong></p>
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- Implementations must fully consume the provided content and return a deterministic, structured output
|
||||
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
|
||||
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- Implementations must fully consume the provided content and
|
||||
return a deterministic, structured output.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user