Compare commits
15 Commits
0.0.1
...
a4d4874b39
| Author | SHA1 | Date | |
|---|---|---|---|
| a4d4874b39 | |||
| 22a0524823 | |||
| cd06de5435 | |||
| 14d89f5f91 | |||
| 7283a3eafd | |||
| 3ebfa34733 | |||
| 1e7e7c8a6c | |||
| f92d40ed7f | |||
| 04d8e069d4 | |||
| c3f3c9e57b | |||
| de7d04eb1a | |||
| 0fbf0ca0f0 | |||
| 5842e6a227 | |||
| a188e78283 | |||
| 67a3074ab4 |
22
.drone.yml
22
.drone.yml
@@ -32,6 +32,26 @@ steps:
|
||||
echo "🆕 New version detected: $PACKAGE_NAME==$VERSION"
|
||||
fi
|
||||
|
||||
- name: quality-gate
|
||||
image: python:3.13-slim
|
||||
environment:
|
||||
PIP_REPO_URL:
|
||||
from_secret: PIP_REPO_URL
|
||||
PIP_USERNAME:
|
||||
from_secret: PIP_USERNAME
|
||||
PIP_PASSWORD:
|
||||
from_secret: PIP_PASSWORD
|
||||
commands:
|
||||
- pip install --upgrade pip build
|
||||
- |
|
||||
AUTH_URL="https://${PIP_USERNAME}:${PIP_PASSWORD}@$(echo "${PIP_REPO_URL#*://}" | sed 's:/*$::')/simple"
|
||||
pip install --index-url "$AUTH_URL" --extra-index-url https://pypi.org/simple/ -U ".[dev]"
|
||||
- echo "🛡️ Running quality gate..."
|
||||
- python -m black --check .
|
||||
- python -m ruff check .
|
||||
- python -m mypy
|
||||
- python -m pytest
|
||||
|
||||
- name: build-package
|
||||
image: python:3.13-slim
|
||||
commands:
|
||||
@@ -126,4 +146,4 @@ steps:
|
||||
|
||||
trigger:
|
||||
event:
|
||||
- custom
|
||||
- custom
|
||||
7
.gitignore
vendored
7
.gitignore
vendored
@@ -25,10 +25,17 @@ env/
|
||||
htmlcov/
|
||||
coverage.xml
|
||||
|
||||
# Lint / type checking
|
||||
.mypy_cache/
|
||||
.ruff_cache/
|
||||
|
||||
# Environment variables
|
||||
.env
|
||||
.env.local
|
||||
|
||||
# Docs build artifacts
|
||||
site
|
||||
|
||||
# OS
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
|
||||
21
CHANGELOG.md
Normal file
21
CHANGELOG.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
- `py.typed` marker for PEP 561 type information.
|
||||
- `.drone.yml` CI with a quality-gate step (black, ruff, mypy, pytest).
|
||||
- Canonical `docforge.nav.yml`, generated `mkdocs.yml` and `mcp_docs/` via doc-forge.
|
||||
- MIT `LICENSE`.
|
||||
|
||||
### Changed
|
||||
- Standardized `pyproject.toml` (canonical packaging, lint tool config, extras).
|
||||
|
||||
### Fixed
|
||||
- `XLSX`/`CSV` members added to the `content` type surface.
|
||||
- Stub fixes for typed API surfaces.
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Aetoskia Platform
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
108
README.md
Normal file
108
README.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# omniread
|
||||
|
||||
# Summary
|
||||
|
||||
`OmniRead` — format-agnostic content acquisition and parsing framework.
|
||||
|
||||
`OmniRead` provides a **cleanly layered architecture** for fetching, parsing,
|
||||
and normalizing content from heterogeneous sources such as HTML documents
|
||||
and PDF files.
|
||||
|
||||
The library is structured around three core concepts:
|
||||
|
||||
1. **`Content`**: A canonical, format-agnostic container representing raw content
|
||||
bytes and minimal contextual metadata.
|
||||
2. **`Scrapers`**: Components responsible for *acquiring* raw content from a
|
||||
source (HTTP, filesystem, object storage, etc.). `Scrapers` never interpret
|
||||
content.
|
||||
3. **`Parsers`**: Components responsible for *interpreting* acquired content and
|
||||
converting it into structured, typed representations.
|
||||
|
||||
`OmniRead` deliberately separates these responsibilities to ensure:
|
||||
|
||||
- Clear boundaries between IO and interpretation.
|
||||
- Replaceable implementations per format.
|
||||
- Predictable, testable behavior.
|
||||
|
||||
# Installation
|
||||
|
||||
Install `OmniRead` using pip:
|
||||
|
||||
```bash
|
||||
pip install omniread
|
||||
```
|
||||
|
||||
Install OmniRead using Poetry:
|
||||
```bash
|
||||
poetry add omniread
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Quick start
|
||||
|
||||
Example:
|
||||
HTML example:
|
||||
```python
|
||||
from omniread import HTMLScraper, HTMLParser
|
||||
|
||||
scraper = HTMLScraper()
|
||||
content = scraper.fetch("https://example.com")
|
||||
|
||||
class TitleParser(HTMLParser[str]):
|
||||
def parse(self) -> str:
|
||||
return self._soup.title.string
|
||||
|
||||
parser = TitleParser(content)
|
||||
title = parser.parse()
|
||||
```
|
||||
|
||||
PDF example:
|
||||
```python
|
||||
from omniread import FileSystemPDFClient, PDFScraper, PDFParser
|
||||
from pathlib import Path
|
||||
|
||||
client = FileSystemPDFClient()
|
||||
scraper = PDFScraper(client=client)
|
||||
content = scraper.fetch(Path("document.pdf"))
|
||||
|
||||
class TextPDFParser(PDFParser[str]):
|
||||
def parse(self) -> str:
|
||||
# implement PDF text extraction
|
||||
...
|
||||
|
||||
parser = TextPDFParser(content)
|
||||
result = parser.parse()
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
This module re-exports the **recommended public entry points** of OmniRead.
|
||||
Consumers are encouraged to import from this namespace rather than from
|
||||
format-specific submodules directly, unless advanced customization is
|
||||
required.
|
||||
|
||||
- `Content`: Canonical content model.
|
||||
- `ContentType`: Supported media types.
|
||||
- `HTMLScraper`: HTTP-based HTML acquisition.
|
||||
- `HTMLParser`: Base parser for HTML DOM interpretation.
|
||||
- `FileSystemPDFClient`: Local filesystem PDF access.
|
||||
- `PDFScraper`: PDF-specific content acquisition.
|
||||
- `PDFParser`: Base parser for PDF binary interpretation.
|
||||
|
||||
---
|
||||
|
||||
# Core Philosophy
|
||||
|
||||
`OmniRead` is designed as a **decoupled content engine**:
|
||||
|
||||
1. **Separation of Concerns**: Scrapers *fetch*, Parsers *interpret*. Neither
|
||||
knows about the other.
|
||||
2. **Normalized Exchange**: All components communicate via the `Content` model,
|
||||
ensuring a consistent contract.
|
||||
3. **Format Agnosticism**: The core logic is independent of whether the input
|
||||
is HTML, PDF, or JSON.
|
||||
|
||||
---
|
||||
19
docforge.nav.yml
Normal file
19
docforge.nav.yml
Normal file
@@ -0,0 +1,19 @@
|
||||
home: lib/index.md
|
||||
groups:
|
||||
Core API:
|
||||
- lib/core/index.md
|
||||
- lib/core/content.md
|
||||
- lib/core/parser.md
|
||||
- lib/core/scraper.md
|
||||
HTML Handling:
|
||||
- lib/html/index.md
|
||||
- lib/html/parser.md
|
||||
- lib/html/scraper.md
|
||||
PDF Handling:
|
||||
- lib/pdf/index.md
|
||||
- lib/pdf/client.md
|
||||
- lib/pdf/parser.md
|
||||
- lib/pdf/scraper.md
|
||||
icon:
|
||||
logo: material/book-open-page-variant
|
||||
repo: fontawesome/brands/github
|
||||
@@ -1 +0,0 @@
|
||||
::: omniread
|
||||
@@ -1 +1,3 @@
|
||||
# Content
|
||||
|
||||
::: omniread.core.content
|
||||
@@ -1 +1,3 @@
|
||||
# Core
|
||||
|
||||
::: omniread.core
|
||||
@@ -1 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.core.parser
|
||||
@@ -1 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.core.scraper
|
||||
3
docs/lib/csv/client.md
Normal file
3
docs/lib/csv/client.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Client
|
||||
|
||||
::: omniread.csv.client
|
||||
3
docs/lib/csv/index.md
Normal file
3
docs/lib/csv/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Csv
|
||||
|
||||
::: omniread.csv
|
||||
3
docs/lib/csv/parser.md
Normal file
3
docs/lib/csv/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.csv.parser
|
||||
3
docs/lib/csv/parser_base.md
Normal file
3
docs/lib/csv/parser_base.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser Base
|
||||
|
||||
::: omniread.csv.parser_base
|
||||
3
docs/lib/csv/scraper.md
Normal file
3
docs/lib/csv/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.csv.scraper
|
||||
@@ -1 +1,3 @@
|
||||
# Html
|
||||
|
||||
::: omniread.html
|
||||
@@ -1 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.html.parser
|
||||
@@ -1 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.html.scraper
|
||||
4
docs/lib/index.md
Normal file
4
docs/lib/index.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# omniread
|
||||
|
||||
::: omniread
|
||||
- [Omniread](omniread/)
|
||||
3
docs/lib/omniread/core/content.md
Normal file
3
docs/lib/omniread/core/content.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Content
|
||||
|
||||
::: omniread.core.content
|
||||
6
docs/lib/omniread/core/index.md
Normal file
6
docs/lib/omniread/core/index.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# Core
|
||||
|
||||
::: omniread.core
|
||||
- [Content](content.md)
|
||||
- [Parser](parser.md)
|
||||
- [Scraper](scraper.md)
|
||||
3
docs/lib/omniread/core/parser.md
Normal file
3
docs/lib/omniread/core/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.core.parser
|
||||
3
docs/lib/omniread/core/scraper.md
Normal file
3
docs/lib/omniread/core/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.core.scraper
|
||||
3
docs/lib/omniread/csv/client.md
Normal file
3
docs/lib/omniread/csv/client.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Client
|
||||
|
||||
::: omniread.csv.client
|
||||
7
docs/lib/omniread/csv/index.md
Normal file
7
docs/lib/omniread/csv/index.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Csv
|
||||
|
||||
::: omniread.csv
|
||||
- [Client](client.md)
|
||||
- [Parser](parser.md)
|
||||
- [Parser Base](parser_base.md)
|
||||
- [Scraper](scraper.md)
|
||||
3
docs/lib/omniread/csv/parser.md
Normal file
3
docs/lib/omniread/csv/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.csv.parser
|
||||
3
docs/lib/omniread/csv/parser_base.md
Normal file
3
docs/lib/omniread/csv/parser_base.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser Base
|
||||
|
||||
::: omniread.csv.parser_base
|
||||
3
docs/lib/omniread/csv/scraper.md
Normal file
3
docs/lib/omniread/csv/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.csv.scraper
|
||||
5
docs/lib/omniread/html/index.md
Normal file
5
docs/lib/omniread/html/index.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Html
|
||||
|
||||
::: omniread.html
|
||||
- [Parser](parser.md)
|
||||
- [Scraper](scraper.md)
|
||||
3
docs/lib/omniread/html/parser.md
Normal file
3
docs/lib/omniread/html/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.html.parser
|
||||
3
docs/lib/omniread/html/scraper.md
Normal file
3
docs/lib/omniread/html/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.html.scraper
|
||||
8
docs/lib/omniread/index.md
Normal file
8
docs/lib/omniread/index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Omniread
|
||||
|
||||
::: omniread
|
||||
- [Core](core/)
|
||||
- [Csv](csv/)
|
||||
- [Html](html/)
|
||||
- [Pdf](pdf/)
|
||||
- [Xlsx](xlsx/)
|
||||
@@ -1 +1,3 @@
|
||||
# Client
|
||||
|
||||
::: omniread.pdf.client
|
||||
6
docs/lib/omniread/pdf/index.md
Normal file
6
docs/lib/omniread/pdf/index.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# Pdf
|
||||
|
||||
::: omniread.pdf
|
||||
- [Client](client.md)
|
||||
- [Parser](parser.md)
|
||||
- [Scraper](scraper.md)
|
||||
@@ -1 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.pdf.parser
|
||||
@@ -1 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.pdf.scraper
|
||||
3
docs/lib/omniread/xlsx/client.md
Normal file
3
docs/lib/omniread/xlsx/client.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Client
|
||||
|
||||
::: omniread.xlsx.client
|
||||
7
docs/lib/omniread/xlsx/index.md
Normal file
7
docs/lib/omniread/xlsx/index.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Xlsx
|
||||
|
||||
::: omniread.xlsx
|
||||
- [Client](client.md)
|
||||
- [Parser](parser.md)
|
||||
- [Parser Base](parser_base.md)
|
||||
- [Scraper](scraper.md)
|
||||
3
docs/lib/omniread/xlsx/parser.md
Normal file
3
docs/lib/omniread/xlsx/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.xlsx.parser
|
||||
3
docs/lib/omniread/xlsx/parser_base.md
Normal file
3
docs/lib/omniread/xlsx/parser_base.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser Base
|
||||
|
||||
::: omniread.xlsx.parser_base
|
||||
3
docs/lib/omniread/xlsx/scraper.md
Normal file
3
docs/lib/omniread/xlsx/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.xlsx.scraper
|
||||
3
docs/lib/pdf/client.md
Normal file
3
docs/lib/pdf/client.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Client
|
||||
|
||||
::: omniread.pdf.client
|
||||
@@ -1 +1,3 @@
|
||||
# Pdf
|
||||
|
||||
::: omniread.pdf
|
||||
3
docs/lib/pdf/parser.md
Normal file
3
docs/lib/pdf/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.pdf.parser
|
||||
3
docs/lib/pdf/scraper.md
Normal file
3
docs/lib/pdf/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.pdf.scraper
|
||||
3
docs/lib/xlsx/client.md
Normal file
3
docs/lib/xlsx/client.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Client
|
||||
|
||||
::: omniread.xlsx.client
|
||||
3
docs/lib/xlsx/index.md
Normal file
3
docs/lib/xlsx/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Xlsx
|
||||
|
||||
::: omniread.xlsx
|
||||
3
docs/lib/xlsx/parser.md
Normal file
3
docs/lib/xlsx/parser.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser
|
||||
|
||||
::: omniread.xlsx.parser
|
||||
3
docs/lib/xlsx/parser_base.md
Normal file
3
docs/lib/xlsx/parser_base.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parser Base
|
||||
|
||||
::: omniread.xlsx.parser_base
|
||||
3
docs/lib/xlsx/scraper.md
Normal file
3
docs/lib/xlsx/scraper.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Scraper
|
||||
|
||||
::: omniread.xlsx.scraper
|
||||
6
docs/mcp/index.json
Normal file
6
docs/mcp/index.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"project": "omniread",
|
||||
"type": "docforge-model",
|
||||
"modules_count": 22,
|
||||
"source": "docforge"
|
||||
}
|
||||
125
docs/mcp/modules/omniread.core.content.json
Normal file
125
docs/mcp/modules/omniread.core.content.json
Normal file
@@ -0,0 +1,125 @@
|
||||
{
|
||||
"module": "omniread.core.content",
|
||||
"content": {
|
||||
"path": "omniread.core.content",
|
||||
"docstring": "# Summary\n\nCanonical content models for OmniRead.\n\nThis module defines the **format-agnostic content representation** used across\nall parsers and scrapers in OmniRead.\n\nThe models defined here represent *what* was extracted, not *how* it was\nretrieved or parsed. Format-specific behavior and metadata must not alter\nthe semantic meaning of these models.",
|
||||
"objects": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"dataclass": {
|
||||
"name": "dataclass",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.dataclass",
|
||||
"signature": "<bound method Alias.signature of Alias('dataclass', 'dataclasses.dataclass')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Enum": {
|
||||
"name": "Enum",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.Enum",
|
||||
"signature": "<bound method Alias.signature of Alias('Enum', 'enum.Enum')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.content.ContentType",
|
||||
"signature": "<bound method Class.signature of Class('ContentType', 20, 49)>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.HTML",
|
||||
"signature": null,
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.PDF",
|
||||
"signature": null,
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.XLSX",
|
||||
"signature": null,
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.CSV",
|
||||
"signature": null,
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.JSON",
|
||||
"signature": null,
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.XML",
|
||||
"signature": null,
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.content.Content",
|
||||
"signature": "<bound method Class.signature of Class('Content', 52, 84)>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.raw",
|
||||
"signature": null,
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.source",
|
||||
"signature": null,
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.content_type",
|
||||
"signature": null,
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.metadata",
|
||||
"signature": null,
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
534
docs/mcp/modules/omniread.core.json
Normal file
534
docs/mcp/modules/omniread.core.json
Normal file
@@ -0,0 +1,534 @@
|
||||
{
|
||||
"module": "omniread.core",
|
||||
"content": {
|
||||
"path": "omniread.core",
|
||||
"docstring": "# Summary\n\nCore domain contracts for OmniRead.\n\nThis package defines the **format-agnostic domain layer** of OmniRead.\nIt exposes canonical content models and abstract interfaces that are\nimplemented by format-specific modules (HTML, PDF, etc.).\n\nPublic exports from this package are considered **stable contracts** and\nare safe for downstream consumers to depend on.\n\nSubmodules:\n\n- `content`: Canonical content models and enums.\n- `parser`: Abstract parsing contracts.\n- `scraper`: Abstract scraping contracts.\n\nFormat-specific behavior must not be introduced at this layer.\n\n---\n\n# Public API\n\n- `Content`\n- `ContentType`\n\n---",
|
||||
"objects": {
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.BaseScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseScraper', 'omniread.core.scraper.BaseScraper')>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.BaseScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.core.scraper.BaseScraper.fetch')>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "module",
|
||||
"path": "omniread.core.content",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nCanonical content models for OmniRead.\n\nThis module defines the **format-agnostic content representation** used across\nall parsers and scrapers in OmniRead.\n\nThe models defined here represent *what* was extracted, not *how* it was\nretrieved or parsed. Format-specific behavior and metadata must not alter\nthe semantic meaning of these models.",
|
||||
"members": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"dataclass": {
|
||||
"name": "dataclass",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.dataclass",
|
||||
"signature": "<bound method Alias.signature of Alias('dataclass', 'dataclasses.dataclass')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Enum": {
|
||||
"name": "Enum",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.Enum",
|
||||
"signature": "<bound method Alias.signature of Alias('Enum', 'enum.Enum')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.content.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.content.ContentType",
|
||||
"signature": "<bound method Class.signature of Class('ContentType', 20, 49)>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.HTML",
|
||||
"signature": null,
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.PDF",
|
||||
"signature": null,
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.XLSX",
|
||||
"signature": null,
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.CSV",
|
||||
"signature": null,
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.JSON",
|
||||
"signature": null,
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.ContentType.XML",
|
||||
"signature": null,
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.content.Content",
|
||||
"signature": "<bound method Class.signature of Class('Content', 52, 84)>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.raw",
|
||||
"signature": null,
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.source",
|
||||
"signature": null,
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.content_type",
|
||||
"signature": null,
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.content.Content.metadata",
|
||||
"signature": null,
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser": {
|
||||
"name": "parser",
|
||||
"kind": "module",
|
||||
"path": "omniread.core.parser",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nAbstract parsing contracts for OmniRead.\n\nThis module defines the **format-agnostic parser interface** used to transform\nraw content into structured, typed representations.\n\nParsers are responsible for:\n\n- Interpreting a single `Content` instance\n- Validating compatibility with the content type\n- Producing a structured output suitable for downstream consumers\n\nParsers are not responsible for:\n\n- Fetching or acquiring content\n- Performing retries or error recovery\n- Managing multiple content sources",
|
||||
"members": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.parser.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.parser.BaseParser",
|
||||
"signature": "<bound method Class.signature of Class('BaseParser', 30, 111)>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.BaseParser.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.BaseParser.content",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.parser.BaseParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 75, 94)>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.parser.BaseParser.supports",
|
||||
"signature": "<bound method Function.signature of Function('supports', 96, 111)>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scraper": {
|
||||
"name": "scraper",
|
||||
"kind": "module",
|
||||
"path": "omniread.core.scraper",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nAbstract scraping contracts for OmniRead.\n\nThis module defines the **format-agnostic scraper interface** responsible for\nacquiring raw content from external sources.\n\nScrapers are responsible for:\n\n- Locating and retrieving raw content bytes\n- Attaching minimal contextual metadata\n- Returning normalized `Content` objects\n\nScrapers are explicitly NOT responsible for:\n\n- Parsing or interpreting content\n- Inferring structure or semantics\n- Performing content-type specific processing\n\nAll interpretation must be delegated to parsers.",
|
||||
"members": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.scraper.BaseScraper",
|
||||
"signature": "<bound method Class.signature of Class('BaseScraper', 31, 83)>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.scraper.BaseScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 52, 83)>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
169
docs/mcp/modules/omniread.core.parser.json
Normal file
169
docs/mcp/modules/omniread.core.parser.json
Normal file
@@ -0,0 +1,169 @@
|
||||
{
|
||||
"module": "omniread.core.parser",
|
||||
"content": {
|
||||
"path": "omniread.core.parser",
|
||||
"docstring": "# Summary\n\nAbstract parsing contracts for OmniRead.\n\nThis module defines the **format-agnostic parser interface** used to transform\nraw content into structured, typed representations.\n\nParsers are responsible for:\n\n- Interpreting a single `Content` instance\n- Validating compatibility with the content type\n- Producing a structured output suitable for downstream consumers\n\nParsers are not responsible for:\n\n- Fetching or acquiring content\n- Performing retries or error recovery\n- Managing multiple content sources",
|
||||
"objects": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.parser.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.parser.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.parser.BaseParser",
|
||||
"signature": "<bound method Class.signature of Class('BaseParser', 30, 111)>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.BaseParser.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.parser.BaseParser.content",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.parser.BaseParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 75, 94)>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.parser.BaseParser.supports",
|
||||
"signature": "<bound method Function.signature of Function('supports', 96, 111)>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
90
docs/mcp/modules/omniread.core.scraper.json
Normal file
90
docs/mcp/modules/omniread.core.scraper.json
Normal file
@@ -0,0 +1,90 @@
|
||||
{
|
||||
"module": "omniread.core.scraper",
|
||||
"content": {
|
||||
"path": "omniread.core.scraper",
|
||||
"docstring": "# Summary\n\nAbstract scraping contracts for OmniRead.\n\nThis module defines the **format-agnostic scraper interface** responsible for\nacquiring raw content from external sources.\n\nScrapers are responsible for:\n\n- Locating and retrieving raw content bytes\n- Attaching minimal contextual metadata\n- Returning normalized `Content` objects\n\nScrapers are explicitly NOT responsible for:\n\n- Parsing or interpreting content\n- Inferring structure or semantics\n- Performing content-type specific processing\n\nAll interpretation must be delegated to parsers.",
|
||||
"objects": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.core.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.core.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.core.scraper.BaseScraper",
|
||||
"signature": "<bound method Class.signature of Class('BaseScraper', 31, 83)>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.core.scraper.BaseScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 52, 83)>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
69
docs/mcp/modules/omniread.csv.client.json
Normal file
69
docs/mcp/modules/omniread.csv.client.json
Normal file
@@ -0,0 +1,69 @@
|
||||
{
|
||||
"module": "omniread.csv.client",
|
||||
"content": {
|
||||
"path": "omniread.csv.client",
|
||||
"docstring": "# Summary\n\nCSV client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw\ncomma-separated-value document bytes from a concrete backing store.\n\nClients provide low-level access to csv binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
|
||||
"objects": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Path": {
|
||||
"name": "Path",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.Path",
|
||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BaseCsvClient": {
|
||||
"name": "BaseCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.client.BaseCsvClient",
|
||||
"signature": "<bound method Class.signature of Class('BaseCsvClient', 25, 58)>",
|
||||
"docstring": "Abstract client responsible for retrieving csv bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full csv binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.client.BaseCsvClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 40, 58)>",
|
||||
"docstring": "Fetch raw csv bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemCsvClient": {
|
||||
"name": "FileSystemCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.client.FileSystemCsvClient",
|
||||
"signature": "<bound method Class.signature of Class('FileSystemCsvClient', 61, 97)>",
|
||||
"docstring": "CSV client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads csv files directly from the disk and\n returns their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.client.FileSystemCsvClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 72, 97)>",
|
||||
"docstring": "Read a csv file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the csv file.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
576
docs/mcp/modules/omniread.csv.json
Normal file
576
docs/mcp/modules/omniread.csv.json
Normal file
@@ -0,0 +1,576 @@
|
||||
{
|
||||
"module": "omniread.csv",
|
||||
"content": {
|
||||
"path": "omniread.csv",
|
||||
"docstring": "# Summary\n\nCSV subpackage for OmniRead.\n\nProvides acquisition and parsing of comma-separated-value content:\n\n- `BaseCsvClient`: abstract backing-store client for csv bytes.\n- `FileSystemCsvClient`: local filesystem implementation.\n- `CsvScraper`: wraps fetched bytes into canonical `Content`.\n- `CsvParserBase`: content-type-enforcing parser contract.\n- `CsvParser`: generic string-row parser built on the standard csv module.",
|
||||
"objects": {
|
||||
"BaseCsvClient": {
|
||||
"name": "BaseCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.BaseCsvClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseCsvClient', 'omniread.csv.client.BaseCsvClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving csv bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full csv binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.BaseCsvClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.csv.client.BaseCsvClient.fetch')>",
|
||||
"docstring": "Fetch raw csv bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemCsvClient": {
|
||||
"name": "FileSystemCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.FileSystemCsvClient",
|
||||
"signature": "<bound method Alias.signature of Alias('FileSystemCsvClient', 'omniread.csv.client.FileSystemCsvClient')>",
|
||||
"docstring": "CSV client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads csv files directly from the disk and\n returns their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.FileSystemCsvClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.csv.client.FileSystemCsvClient.fetch')>",
|
||||
"docstring": "Read a csv file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the csv file.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvParser": {
|
||||
"name": "CsvParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.CsvParser",
|
||||
"signature": "<bound method Alias.signature of Alias('CsvParser', 'omniread.csv.parser.CsvParser')>",
|
||||
"docstring": "Generic csv parser producing string rows from the document.\n\nNotes:\n **Responsibilities:**\n\n - Decode the payload (UTF-8 with BOM support, Latin-1 fallback).\n - Detect the delimiter from a leading sample (`,` `;` tab `|`),\n defaulting to `,`.\n - Normalize cells into deterministic stripped string values.\n - Expose row extraction helpers mirroring `XlsxParser.rows`.\n\n **Constraints:**\n\n - All values are strings; consumers requiring typed values must\n convert on their side.\n - Quoted fields containing delimiters/newlines are handled by\n the standard ``csv`` module.",
|
||||
"members": {
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.CsvParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.csv.parser.CsvParser.parse')>",
|
||||
"docstring": "Parse the document into normalized string rows.\n\nReturns:\n list[list[str]]:\n Rows of the document."
|
||||
},
|
||||
"rows": {
|
||||
"name": "rows",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.CsvParser.rows",
|
||||
"signature": "<bound method Alias.signature of Alias('rows', 'omniread.csv.parser.CsvParser.rows')>",
|
||||
"docstring": "Extract normalized string rows from the document.\n\nArgs:\n skip_empty (bool):\n When True (default), rows whose cells are all blank are\n omitted.\n\nReturns:\n list[list[str]]:\n Normalized rows; trailing blank cells are trimmed per row."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvParserBase": {
|
||||
"name": "CsvParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.CsvParserBase",
|
||||
"signature": "<bound method Alias.signature of Alias('CsvParserBase', 'omniread.csv.parser_base.CsvParserBase')>",
|
||||
"docstring": "Base csv parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces csv content-type compatibility and provides\n the extension point for implementing concrete csv parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.CsvParserBase.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.csv.parser_base.CsvParserBase.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (CSV only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.CsvParserBase.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.csv.parser_base.CsvParserBase.parse')>",
|
||||
"docstring": "Parse csv content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvScraper": {
|
||||
"name": "CsvScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.CsvScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('CsvScraper', 'omniread.csv.scraper.CsvScraper')>",
|
||||
"docstring": "Scraper for csv documents.\n\nNotes:\n **Responsibilities:**\n\n - Fetch raw csv bytes via the configured client.\n - Wrap the payload in a canonical `Content` instance with the\n CSV content type and source identifier.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.CsvScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.csv.scraper.CsvScraper.fetch')>",
|
||||
"docstring": "Fetch a csv document from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv source as understood by the\n configured client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw csv bytes, source\n identifier, CSV content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the client."
|
||||
}
|
||||
}
|
||||
},
|
||||
"client": {
|
||||
"name": "client",
|
||||
"kind": "module",
|
||||
"path": "omniread.csv.client",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nCSV client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw\ncomma-separated-value document bytes from a concrete backing store.\n\nClients provide low-level access to csv binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
|
||||
"members": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Path": {
|
||||
"name": "Path",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.Path",
|
||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.client.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BaseCsvClient": {
|
||||
"name": "BaseCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.client.BaseCsvClient",
|
||||
"signature": "<bound method Class.signature of Class('BaseCsvClient', 25, 58)>",
|
||||
"docstring": "Abstract client responsible for retrieving csv bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full csv binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.client.BaseCsvClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 40, 58)>",
|
||||
"docstring": "Fetch raw csv bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemCsvClient": {
|
||||
"name": "FileSystemCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.client.FileSystemCsvClient",
|
||||
"signature": "<bound method Class.signature of Class('FileSystemCsvClient', 61, 97)>",
|
||||
"docstring": "CSV client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads csv files directly from the disk and\n returns their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.client.FileSystemCsvClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 72, 97)>",
|
||||
"docstring": "Read a csv file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the csv file.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser": {
|
||||
"name": "parser",
|
||||
"kind": "module",
|
||||
"path": "omniread.csv.parser",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nCSV parser implementations for OmniRead.\n\nThis module provides a concrete, generic parser for comma-separated-value\ndocuments. It exposes records as lists of string cells so downstream\nconsumers can interpret tabular content without depending on the ``csv``\nmodule directly.\n\nThe parser is intentionally statement-agnostic: it performs no header\ndetection or column interpretation beyond basic cell normalization and\ndelimiter detection.",
|
||||
"members": {
|
||||
"Sniffer": {
|
||||
"name": "Sniffer",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser.Sniffer",
|
||||
"signature": "<bound method Alias.signature of Alias('Sniffer', 'csv.Sniffer')>",
|
||||
"docstring": null
|
||||
},
|
||||
"reader": {
|
||||
"name": "reader",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser.reader",
|
||||
"signature": "<bound method Alias.signature of Alias('reader', 'csv.reader')>",
|
||||
"docstring": null
|
||||
},
|
||||
"StringIO": {
|
||||
"name": "StringIO",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser.StringIO",
|
||||
"signature": "<bound method Alias.signature of Alias('StringIO', 'io.StringIO')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvParserBase": {
|
||||
"name": "CsvParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser.CsvParserBase",
|
||||
"signature": "<bound method Alias.signature of Alias('CsvParserBase', 'omniread.csv.parser_base.CsvParserBase')>",
|
||||
"docstring": "Base csv parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces csv content-type compatibility and provides\n the extension point for implementing concrete csv parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.CsvParserBase.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.csv.parser_base.CsvParserBase.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (CSV only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser.CsvParserBase.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.csv.parser_base.CsvParserBase.parse')>",
|
||||
"docstring": "Parse csv content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvParser": {
|
||||
"name": "CsvParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser.CsvParser",
|
||||
"signature": "<bound method Class.signature of Class('CsvParser', 24, 102)>",
|
||||
"docstring": "Generic csv parser producing string rows from the document.\n\nNotes:\n **Responsibilities:**\n\n - Decode the payload (UTF-8 with BOM support, Latin-1 fallback).\n - Detect the delimiter from a leading sample (`,` `;` tab `|`),\n defaulting to `,`.\n - Normalize cells into deterministic stripped string values.\n - Expose row extraction helpers mirroring `XlsxParser.rows`.\n\n **Constraints:**\n\n - All values are strings; consumers requiring typed values must\n convert on their side.\n - Quoted fields containing delimiters/newlines are handled by\n the standard ``csv`` module.",
|
||||
"members": {
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser.CsvParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 57, 65)>",
|
||||
"docstring": "Parse the document into normalized string rows.\n\nReturns:\n list[list[str]]:\n Rows of the document."
|
||||
},
|
||||
"rows": {
|
||||
"name": "rows",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser.CsvParser.rows",
|
||||
"signature": "<bound method Function.signature of Function('rows', 67, 95)>",
|
||||
"docstring": "Extract normalized string rows from the document.\n\nArgs:\n skip_empty (bool):\n When True (default), rows whose cells are all blank are\n omitted.\n\nReturns:\n list[list[str]]:\n Normalized rows; trailing blank cells are trimmed per row."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser_base": {
|
||||
"name": "parser_base",
|
||||
"kind": "module",
|
||||
"path": "omniread.csv.parser_base",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nCSV parser base implementation for OmniRead.\n\nThis module defines the **CSV-specific parser contract**, extending the\nformat-agnostic `BaseParser` with constraints appropriate for\ncomma-separated-value documents.",
|
||||
"members": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser_base.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser_base.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser_base.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser_base.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser_base.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser_base.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser_base.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"CsvParserBase": {
|
||||
"name": "CsvParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser_base.CsvParserBase",
|
||||
"signature": "<bound method Class.signature of Class('CsvParserBase', 20, 55)>",
|
||||
"docstring": "Base csv parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces csv content-type compatibility and provides\n the extension point for implementing concrete csv parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.CsvParserBase.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (CSV only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser_base.CsvParserBase.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 42, 55)>",
|
||||
"docstring": "Parse csv content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scraper": {
|
||||
"name": "scraper",
|
||||
"kind": "module",
|
||||
"path": "omniread.csv.scraper",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nCSV scraper for OmniRead.\n\nThis module defines the scraper responsible for acquiring raw\ncomma-separated-value document content from a backing store via a\nconfigured client.\n\nThe scraper does not interpret or parse the acquired bytes; it wraps them in\nthe canonical `Content` model.",
|
||||
"members": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseCsvClient": {
|
||||
"name": "BaseCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.BaseCsvClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseCsvClient', 'omniread.csv.client.BaseCsvClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving csv bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full csv binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.scraper.BaseCsvClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.csv.client.BaseCsvClient.fetch')>",
|
||||
"docstring": "Fetch raw csv bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvScraper": {
|
||||
"name": "CsvScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.CsvScraper",
|
||||
"signature": "<bound method Class.signature of Class('CsvScraper', 22, 81)>",
|
||||
"docstring": "Scraper for csv documents.\n\nNotes:\n **Responsibilities:**\n\n - Fetch raw csv bytes via the configured client.\n - Wrap the payload in a canonical `Content` instance with the\n CSV content type and source identifier.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.scraper.CsvScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 49, 81)>",
|
||||
"docstring": "Fetch a csv document from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv source as understood by the\n configured client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw csv bytes, source\n identifier, CSV content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the client."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
113
docs/mcp/modules/omniread.csv.parser.json
Normal file
113
docs/mcp/modules/omniread.csv.parser.json
Normal file
@@ -0,0 +1,113 @@
|
||||
{
|
||||
"module": "omniread.csv.parser",
|
||||
"content": {
|
||||
"path": "omniread.csv.parser",
|
||||
"docstring": "# Summary\n\nCSV parser implementations for OmniRead.\n\nThis module provides a concrete, generic parser for comma-separated-value\ndocuments. It exposes records as lists of string cells so downstream\nconsumers can interpret tabular content without depending on the ``csv``\nmodule directly.\n\nThe parser is intentionally statement-agnostic: it performs no header\ndetection or column interpretation beyond basic cell normalization and\ndelimiter detection.",
|
||||
"objects": {
|
||||
"Sniffer": {
|
||||
"name": "Sniffer",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser.Sniffer",
|
||||
"signature": "<bound method Alias.signature of Alias('Sniffer', 'csv.Sniffer')>",
|
||||
"docstring": null
|
||||
},
|
||||
"reader": {
|
||||
"name": "reader",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser.reader",
|
||||
"signature": "<bound method Alias.signature of Alias('reader', 'csv.reader')>",
|
||||
"docstring": null
|
||||
},
|
||||
"StringIO": {
|
||||
"name": "StringIO",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser.StringIO",
|
||||
"signature": "<bound method Alias.signature of Alias('StringIO', 'io.StringIO')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvParserBase": {
|
||||
"name": "CsvParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser.CsvParserBase",
|
||||
"signature": "<bound method Alias.signature of Alias('CsvParserBase', 'omniread.csv.parser_base.CsvParserBase')>",
|
||||
"docstring": "Base csv parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces csv content-type compatibility and provides\n the extension point for implementing concrete csv parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser.CsvParserBase.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.csv.parser_base.CsvParserBase.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (CSV only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser.CsvParserBase.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.csv.parser_base.CsvParserBase.parse')>",
|
||||
"docstring": "Parse csv content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvParser": {
|
||||
"name": "CsvParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser.CsvParser",
|
||||
"signature": "<bound method Class.signature of Class('CsvParser', 24, 102)>",
|
||||
"docstring": "Generic csv parser producing string rows from the document.\n\nNotes:\n **Responsibilities:**\n\n - Decode the payload (UTF-8 with BOM support, Latin-1 fallback).\n - Detect the delimiter from a leading sample (`,` `;` tab `|`),\n defaulting to `,`.\n - Normalize cells into deterministic stripped string values.\n - Expose row extraction helpers mirroring `XlsxParser.rows`.\n\n **Constraints:**\n\n - All values are strings; consumers requiring typed values must\n convert on their side.\n - Quoted fields containing delimiters/newlines are handled by\n the standard ``csv`` module.",
|
||||
"members": {
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser.CsvParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 57, 65)>",
|
||||
"docstring": "Parse the document into normalized string rows.\n\nReturns:\n list[list[str]]:\n Rows of the document."
|
||||
},
|
||||
"rows": {
|
||||
"name": "rows",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser.CsvParser.rows",
|
||||
"signature": "<bound method Function.signature of Function('rows', 67, 95)>",
|
||||
"docstring": "Extract normalized string rows from the document.\n\nArgs:\n skip_empty (bool):\n When True (default), rows whose cells are all blank are\n omitted.\n\nReturns:\n list[list[str]]:\n Normalized rows; trailing blank cells are trimmed per row."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
148
docs/mcp/modules/omniread.csv.parser_base.json
Normal file
148
docs/mcp/modules/omniread.csv.parser_base.json
Normal file
@@ -0,0 +1,148 @@
|
||||
{
|
||||
"module": "omniread.csv.parser_base",
|
||||
"content": {
|
||||
"path": "omniread.csv.parser_base",
|
||||
"docstring": "# Summary\n\nCSV parser base implementation for OmniRead.\n\nThis module defines the **CSV-specific parser contract**, extending the\nformat-agnostic `BaseParser` with constraints appropriate for\ncomma-separated-value documents.",
|
||||
"objects": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser_base.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser_base.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.parser_base.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser_base.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser_base.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser_base.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser_base.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"CsvParserBase": {
|
||||
"name": "CsvParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.parser_base.CsvParserBase",
|
||||
"signature": "<bound method Class.signature of Class('CsvParserBase', 20, 55)>",
|
||||
"docstring": "Base csv parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces csv content-type compatibility and provides\n the extension point for implementing concrete csv parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.parser_base.CsvParserBase.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (CSV only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.parser_base.CsvParserBase.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 42, 55)>",
|
||||
"docstring": "Parse csv content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
143
docs/mcp/modules/omniread.csv.scraper.json
Normal file
143
docs/mcp/modules/omniread.csv.scraper.json
Normal file
@@ -0,0 +1,143 @@
|
||||
{
|
||||
"module": "omniread.csv.scraper",
|
||||
"content": {
|
||||
"path": "omniread.csv.scraper",
|
||||
"docstring": "# Summary\n\nCSV scraper for OmniRead.\n\nThis module defines the scraper responsible for acquiring raw\ncomma-separated-value document content from a backing store via a\nconfigured client.\n\nThe scraper does not interpret or parse the acquired bytes; it wraps them in\nthe canonical `Content` model.",
|
||||
"objects": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.csv.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.csv.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseCsvClient": {
|
||||
"name": "BaseCsvClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.BaseCsvClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseCsvClient', 'omniread.csv.client.BaseCsvClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving csv bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full csv binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.scraper.BaseCsvClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.csv.client.BaseCsvClient.fetch')>",
|
||||
"docstring": "Fetch raw csv bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw csv bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"CsvScraper": {
|
||||
"name": "CsvScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.csv.scraper.CsvScraper",
|
||||
"signature": "<bound method Class.signature of Class('CsvScraper', 22, 81)>",
|
||||
"docstring": "Scraper for csv documents.\n\nNotes:\n **Responsibilities:**\n\n - Fetch raw csv bytes via the configured client.\n - Wrap the payload in a canonical `Content` instance with the\n CSV content type and source identifier.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.csv.scraper.CsvScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 49, 81)>",
|
||||
"docstring": "Fetch a csv document from the given source.\n\nArgs:\n source (Any):\n Identifier of the csv source as understood by the\n configured client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw csv bytes, source\n identifier, CSV content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the client."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
488
docs/mcp/modules/omniread.html.json
Normal file
488
docs/mcp/modules/omniread.html.json
Normal file
@@ -0,0 +1,488 @@
|
||||
{
|
||||
"module": "omniread.html",
|
||||
"content": {
|
||||
"path": "omniread.html",
|
||||
"docstring": "# Summary\n\nHTML format implementation for OmniRead.\n\nThis package provides **HTML-specific implementations** of the core OmniRead\ncontracts defined in `omniread.core`.\n\nIt includes:\n\n- HTML parsers that interpret HTML content.\n- HTML scrapers that retrieve HTML documents.\n\nKey characteristics:\n\n- Implements, but does not redefine, core contracts.\n- May contain HTML-specific behavior and edge-case handling.\n- Produces canonical content models defined in `omniread.core.content`.\n\nConsumers should depend on `omniread.core` interfaces wherever possible and\nuse this package only when HTML-specific behavior is required.\n\n---\n\n# Public API\n\n- `HTMLScraper`\n- `HTMLParser`\n\n---",
|
||||
"objects": {
|
||||
"HTMLScraper": {
|
||||
"name": "HTMLScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.HTMLScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('HTMLScraper', 'omniread.html.scraper.HTMLScraper')>",
|
||||
"docstring": "Base HTML scraper using `httpx`.\n\nNotes:\n **Responsibilities:**\n\n - This scraper retrieves HTML documents over HTTP(S) and returns\n them as raw content wrapped in a `Content` object.\n - Fetches raw bytes and metadata only.\n - The scraper uses `httpx.Client` for HTTP requests, enforces an\n HTML content type, and preserves HTTP response metadata.\n\n **Constraints:**\n\n - The scraper does not: Parse HTML, perform retries or backoff,\n handle non-HTML responses.",
|
||||
"members": {
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.HTMLScraper.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.html.scraper.HTMLScraper.content_type')>",
|
||||
"docstring": null
|
||||
},
|
||||
"validate_content_type": {
|
||||
"name": "validate_content_type",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLScraper.validate_content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('validate_content_type', 'omniread.html.scraper.HTMLScraper.validate_content_type')>",
|
||||
"docstring": "Validate that the HTTP response contains HTML content.\n\nArgs:\n response (httpx.Response):\n HTTP response returned by `httpx`.\n\nRaises:\n ValueError:\n If the `Content-Type` header is missing or does not indicate HTML content."
|
||||
},
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.html.scraper.HTMLScraper.fetch')>",
|
||||
"docstring": "Fetch an HTML document from the given source.\n\nArgs:\n source (str):\n URL of the HTML document.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to be merged into the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw HTML bytes, source URL, HTML content type, and HTTP response metadata.\n\nRaises:\n httpx.HTTPError:\n If the HTTP request fails.\n ValueError:\n If the response is not valid HTML."
|
||||
}
|
||||
}
|
||||
},
|
||||
"HTMLParser": {
|
||||
"name": "HTMLParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.HTMLParser",
|
||||
"signature": "<bound method Alias.signature of Alias('HTMLParser', 'omniread.html.parser.HTMLParser')>",
|
||||
"docstring": "Base HTML parser.\n\nNotes:\n **Responsibilities:**\n\n - This class extends the core `BaseParser` with HTML-specific behavior,\n including DOM parsing via BeautifulSoup and reusable extraction helpers.\n - Provides reusable helpers for HTML extraction. Concrete parsers must\n explicitly define the return type.\n\n **Guarantees:**\n\n - Accepts only HTML content.\n - Owns a parsed BeautifulSoup DOM tree.\n - Provides pure helper utilities for common HTML structures.\n\n **Constraints:**\n\n - Concrete subclasses must define the output type `T` and implement\n the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.HTMLParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.html.parser.HTMLParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (HTML only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.html.parser.HTMLParser.parse')>",
|
||||
"docstring": "Fully parse the HTML content into structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully interpret the HTML DOM and return a\n deterministic, structured output."
|
||||
},
|
||||
"parse_div": {
|
||||
"name": "parse_div",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLParser.parse_div",
|
||||
"signature": "<bound method Alias.signature of Alias('parse_div', 'omniread.html.parser.HTMLParser.parse_div')>",
|
||||
"docstring": "Extract normalized text from a `<div>` element.\n\nArgs:\n div (Tag):\n BeautifulSoup tag representing a `<div>`.\n separator (str, optional):\n String used to separate text nodes.\n\nReturns:\n str:\n Flattened, whitespace-normalized text content."
|
||||
},
|
||||
"parse_link": {
|
||||
"name": "parse_link",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLParser.parse_link",
|
||||
"signature": "<bound method Alias.signature of Alias('parse_link', 'omniread.html.parser.HTMLParser.parse_link')>",
|
||||
"docstring": "Extract the hyperlink reference from an `<a>` element.\n\nArgs:\n a (Tag):\n BeautifulSoup tag representing an anchor.\n\nReturns:\n str | None:\n The value of the `href` attribute, or None if absent."
|
||||
},
|
||||
"parse_table": {
|
||||
"name": "parse_table",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLParser.parse_table",
|
||||
"signature": "<bound method Alias.signature of Alias('parse_table', 'omniread.html.parser.HTMLParser.parse_table')>",
|
||||
"docstring": "Parse an HTML table into a 2D list of strings.\n\nArgs:\n table (Tag):\n BeautifulSoup tag representing a `<table>`.\n\nReturns:\n list[list[str]]:\n A list of rows, where each row is a list of cell text values."
|
||||
},
|
||||
"parse_meta": {
|
||||
"name": "parse_meta",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.HTMLParser.parse_meta",
|
||||
"signature": "<bound method Alias.signature of Alias('parse_meta', 'omniread.html.parser.HTMLParser.parse_meta')>",
|
||||
"docstring": "Extract high-level metadata from the HTML document.\n\nReturns:\n dict[str, Any]:\n Dictionary containing extracted metadata.\n\nNotes:\n **Responsibilities:**\n\n - Extract high-level metadata from the HTML document.\n - This includes: Document title, `<meta>` tag name/property to\n content mappings."
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser": {
|
||||
"name": "parser",
|
||||
"kind": "module",
|
||||
"path": "omniread.html.parser",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nHTML parser base implementations for OmniRead.\n\nThis module provides reusable HTML parsing utilities built on top of\nthe abstract parser contracts defined in `omniread.core.parser`.\n\nIt supplies:\n\n- Content-type enforcement for HTML inputs\n- BeautifulSoup initialization and lifecycle management\n- Common helper methods for extracting structured data from HTML elements\n\nConcrete parsers must subclass `HTMLParser` and implement the `parse()` method\nto return a structured representation appropriate for their use case.",
|
||||
"members": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BeautifulSoup": {
|
||||
"name": "BeautifulSoup",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.BeautifulSoup",
|
||||
"signature": "<bound method Alias.signature of Alias('BeautifulSoup', 'bs4.BeautifulSoup')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Tag": {
|
||||
"name": "Tag",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.Tag",
|
||||
"signature": "<bound method Alias.signature of Alias('Tag', 'bs4.Tag')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"HTMLParser": {
|
||||
"name": "HTMLParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.HTMLParser",
|
||||
"signature": "<bound method Class.signature of Class('HTMLParser', 30, 202)>",
|
||||
"docstring": "Base HTML parser.\n\nNotes:\n **Responsibilities:**\n\n - This class extends the core `BaseParser` with HTML-specific behavior,\n including DOM parsing via BeautifulSoup and reusable extraction helpers.\n - Provides reusable helpers for HTML extraction. Concrete parsers must\n explicitly define the return type.\n\n **Guarantees:**\n\n - Accepts only HTML content.\n - Owns a parsed BeautifulSoup DOM tree.\n - Provides pure helper utilities for common HTML structures.\n\n **Constraints:**\n\n - Concrete subclasses must define the output type `T` and implement\n the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.HTMLParser.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (HTML only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 81, 96)>",
|
||||
"docstring": "Fully parse the HTML content into structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully interpret the HTML DOM and return a\n deterministic, structured output."
|
||||
},
|
||||
"parse_div": {
|
||||
"name": "parse_div",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_div",
|
||||
"signature": "<bound method Function.signature of Function('parse_div', 102, 117)>",
|
||||
"docstring": "Extract normalized text from a `<div>` element.\n\nArgs:\n div (Tag):\n BeautifulSoup tag representing a `<div>`.\n separator (str, optional):\n String used to separate text nodes.\n\nReturns:\n str:\n Flattened, whitespace-normalized text content."
|
||||
},
|
||||
"parse_link": {
|
||||
"name": "parse_link",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_link",
|
||||
"signature": "<bound method Function.signature of Function('parse_link', 119, 132)>",
|
||||
"docstring": "Extract the hyperlink reference from an `<a>` element.\n\nArgs:\n a (Tag):\n BeautifulSoup tag representing an anchor.\n\nReturns:\n str | None:\n The value of the `href` attribute, or None if absent."
|
||||
},
|
||||
"parse_table": {
|
||||
"name": "parse_table",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_table",
|
||||
"signature": "<bound method Function.signature of Function('parse_table', 134, 152)>",
|
||||
"docstring": "Parse an HTML table into a 2D list of strings.\n\nArgs:\n table (Tag):\n BeautifulSoup tag representing a `<table>`.\n\nReturns:\n list[list[str]]:\n A list of rows, where each row is a list of cell text values."
|
||||
},
|
||||
"parse_meta": {
|
||||
"name": "parse_meta",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_meta",
|
||||
"signature": "<bound method Function.signature of Function('parse_meta', 174, 202)>",
|
||||
"docstring": "Extract high-level metadata from the HTML document.\n\nReturns:\n dict[str, Any]:\n Dictionary containing extracted metadata.\n\nNotes:\n **Responsibilities:**\n\n - Extract high-level metadata from the HTML document.\n - This includes: Document title, `<meta>` tag name/property to\n content mappings."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scraper": {
|
||||
"name": "scraper",
|
||||
"kind": "module",
|
||||
"path": "omniread.html.scraper",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nHTML scraping implementation for OmniRead.\n\nThis module provides an HTTP-based scraper for retrieving HTML documents.\nIt implements the core `BaseScraper` contract using `httpx` as the transport\nlayer.\n\nThis scraper is responsible for:\n\n- Fetching raw HTML bytes over HTTP(S)\n- Validating response content type\n- Attaching HTTP metadata to the returned content\n\nThis scraper is not responsible for:\n\n- Parsing or interpreting HTML\n- Retrying failed requests\n- Managing crawl policies or rate limiting",
|
||||
"members": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"httpx": {
|
||||
"name": "httpx",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.scraper.httpx",
|
||||
"signature": "<bound method Alias.signature of Alias('httpx', 'httpx')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.BaseScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseScraper', 'omniread.core.scraper.BaseScraper')>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.scraper.BaseScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.core.scraper.BaseScraper.fetch')>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
},
|
||||
"HTMLScraper": {
|
||||
"name": "HTMLScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.HTMLScraper",
|
||||
"signature": "<bound method Class.signature of Class('HTMLScraper', 32, 143)>",
|
||||
"docstring": "Base HTML scraper using `httpx`.\n\nNotes:\n **Responsibilities:**\n\n - This scraper retrieves HTML documents over HTTP(S) and returns\n them as raw content wrapped in a `Content` object.\n - Fetches raw bytes and metadata only.\n - The scraper uses `httpx.Client` for HTTP requests, enforces an\n HTML content type, and preserves HTTP response metadata.\n\n **Constraints:**\n\n - The scraper does not: Parse HTML, perform retries or backoff,\n handle non-HTML responses.",
|
||||
"members": {
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.HTMLScraper.content_type",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"validate_content_type": {
|
||||
"name": "validate_content_type",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.scraper.HTMLScraper.validate_content_type",
|
||||
"signature": "<bound method Function.signature of Function('validate_content_type', 80, 102)>",
|
||||
"docstring": "Validate that the HTTP response contains HTML content.\n\nArgs:\n response (httpx.Response):\n HTTP response returned by `httpx`.\n\nRaises:\n ValueError:\n If the `Content-Type` header is missing or does not indicate HTML content."
|
||||
},
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.scraper.HTMLScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 104, 143)>",
|
||||
"docstring": "Fetch an HTML document from the given source.\n\nArgs:\n source (str):\n URL of the HTML document.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to be merged into the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw HTML bytes, source URL, HTML content type, and HTTP response metadata.\n\nRaises:\n httpx.HTTPError:\n If the HTTP request fails.\n ValueError:\n If the response is not valid HTML."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
234
docs/mcp/modules/omniread.html.parser.json
Normal file
234
docs/mcp/modules/omniread.html.parser.json
Normal file
@@ -0,0 +1,234 @@
|
||||
{
|
||||
"module": "omniread.html.parser",
|
||||
"content": {
|
||||
"path": "omniread.html.parser",
|
||||
"docstring": "# Summary\n\nHTML parser base implementations for OmniRead.\n\nThis module provides reusable HTML parsing utilities built on top of\nthe abstract parser contracts defined in `omniread.core.parser`.\n\nIt supplies:\n\n- Content-type enforcement for HTML inputs\n- BeautifulSoup initialization and lifecycle management\n- Common helper methods for extracting structured data from HTML elements\n\nConcrete parsers must subclass `HTMLParser` and implement the `parse()` method\nto return a structured representation appropriate for their use case.",
|
||||
"objects": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BeautifulSoup": {
|
||||
"name": "BeautifulSoup",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.BeautifulSoup",
|
||||
"signature": "<bound method Alias.signature of Alias('BeautifulSoup', 'bs4.BeautifulSoup')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Tag": {
|
||||
"name": "Tag",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.parser.Tag",
|
||||
"signature": "<bound method Alias.signature of Alias('Tag', 'bs4.Tag')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"HTMLParser": {
|
||||
"name": "HTMLParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.parser.HTMLParser",
|
||||
"signature": "<bound method Class.signature of Class('HTMLParser', 30, 202)>",
|
||||
"docstring": "Base HTML parser.\n\nNotes:\n **Responsibilities:**\n\n - This class extends the core `BaseParser` with HTML-specific behavior,\n including DOM parsing via BeautifulSoup and reusable extraction helpers.\n - Provides reusable helpers for HTML extraction. Concrete parsers must\n explicitly define the return type.\n\n **Guarantees:**\n\n - Accepts only HTML content.\n - Owns a parsed BeautifulSoup DOM tree.\n - Provides pure helper utilities for common HTML structures.\n\n **Constraints:**\n\n - Concrete subclasses must define the output type `T` and implement\n the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.parser.HTMLParser.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (HTML only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 81, 96)>",
|
||||
"docstring": "Fully parse the HTML content into structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully interpret the HTML DOM and return a\n deterministic, structured output."
|
||||
},
|
||||
"parse_div": {
|
||||
"name": "parse_div",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_div",
|
||||
"signature": "<bound method Function.signature of Function('parse_div', 102, 117)>",
|
||||
"docstring": "Extract normalized text from a `<div>` element.\n\nArgs:\n div (Tag):\n BeautifulSoup tag representing a `<div>`.\n separator (str, optional):\n String used to separate text nodes.\n\nReturns:\n str:\n Flattened, whitespace-normalized text content."
|
||||
},
|
||||
"parse_link": {
|
||||
"name": "parse_link",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_link",
|
||||
"signature": "<bound method Function.signature of Function('parse_link', 119, 132)>",
|
||||
"docstring": "Extract the hyperlink reference from an `<a>` element.\n\nArgs:\n a (Tag):\n BeautifulSoup tag representing an anchor.\n\nReturns:\n str | None:\n The value of the `href` attribute, or None if absent."
|
||||
},
|
||||
"parse_table": {
|
||||
"name": "parse_table",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_table",
|
||||
"signature": "<bound method Function.signature of Function('parse_table', 134, 152)>",
|
||||
"docstring": "Parse an HTML table into a 2D list of strings.\n\nArgs:\n table (Tag):\n BeautifulSoup tag representing a `<table>`.\n\nReturns:\n list[list[str]]:\n A list of rows, where each row is a list of cell text values."
|
||||
},
|
||||
"parse_meta": {
|
||||
"name": "parse_meta",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.parser.HTMLParser.parse_meta",
|
||||
"signature": "<bound method Function.signature of Function('parse_meta', 174, 202)>",
|
||||
"docstring": "Extract high-level metadata from the HTML document.\n\nReturns:\n dict[str, Any]:\n Dictionary containing extracted metadata.\n\nNotes:\n **Responsibilities:**\n\n - Extract high-level metadata from the HTML document.\n - This includes: Document title, `<meta>` tag name/property to\n content mappings."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
164
docs/mcp/modules/omniread.html.scraper.json
Normal file
164
docs/mcp/modules/omniread.html.scraper.json
Normal file
@@ -0,0 +1,164 @@
|
||||
{
|
||||
"module": "omniread.html.scraper",
|
||||
"content": {
|
||||
"path": "omniread.html.scraper",
|
||||
"docstring": "# Summary\n\nHTML scraping implementation for OmniRead.\n\nThis module provides an HTTP-based scraper for retrieving HTML documents.\nIt implements the core `BaseScraper` contract using `httpx` as the transport\nlayer.\n\nThis scraper is responsible for:\n\n- Fetching raw HTML bytes over HTTP(S)\n- Validating response content type\n- Attaching HTTP metadata to the returned content\n\nThis scraper is not responsible for:\n\n- Parsing or interpreting HTML\n- Retrying failed requests\n- Managing crawl policies or rate limiting",
|
||||
"objects": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"httpx": {
|
||||
"name": "httpx",
|
||||
"kind": "alias",
|
||||
"path": "omniread.html.scraper.httpx",
|
||||
"signature": "<bound method Alias.signature of Alias('httpx', 'httpx')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.BaseScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseScraper', 'omniread.core.scraper.BaseScraper')>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.scraper.BaseScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.core.scraper.BaseScraper.fetch')>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
},
|
||||
"HTMLScraper": {
|
||||
"name": "HTMLScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.html.scraper.HTMLScraper",
|
||||
"signature": "<bound method Class.signature of Class('HTMLScraper', 32, 143)>",
|
||||
"docstring": "Base HTML scraper using `httpx`.\n\nNotes:\n **Responsibilities:**\n\n - This scraper retrieves HTML documents over HTTP(S) and returns\n them as raw content wrapped in a `Content` object.\n - Fetches raw bytes and metadata only.\n - The scraper uses `httpx.Client` for HTTP requests, enforces an\n HTML content type, and preserves HTTP response metadata.\n\n **Constraints:**\n\n - The scraper does not: Parse HTML, perform retries or backoff,\n handle non-HTML responses.",
|
||||
"members": {
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.html.scraper.HTMLScraper.content_type",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"validate_content_type": {
|
||||
"name": "validate_content_type",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.scraper.HTMLScraper.validate_content_type",
|
||||
"signature": "<bound method Function.signature of Function('validate_content_type', 80, 102)>",
|
||||
"docstring": "Validate that the HTTP response contains HTML content.\n\nArgs:\n response (httpx.Response):\n HTTP response returned by `httpx`.\n\nRaises:\n ValueError:\n If the `Content-Type` header is missing or does not indicate HTML content."
|
||||
},
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.html.scraper.HTMLScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 104, 143)>",
|
||||
"docstring": "Fetch an HTML document from the given source.\n\nArgs:\n source (str):\n URL of the HTML document.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to be merged into the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw HTML bytes, source URL, HTML content type, and HTTP response metadata.\n\nRaises:\n httpx.HTTPError:\n If the HTTP request fails.\n ValueError:\n If the response is not valid HTML."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
3084
docs/mcp/modules/omniread.json
Normal file
3084
docs/mcp/modules/omniread.json
Normal file
File diff suppressed because it is too large
Load Diff
69
docs/mcp/modules/omniread.pdf.client.json
Normal file
69
docs/mcp/modules/omniread.pdf.client.json
Normal file
@@ -0,0 +1,69 @@
|
||||
{
|
||||
"module": "omniread.pdf.client",
|
||||
"content": {
|
||||
"path": "omniread.pdf.client",
|
||||
"docstring": "# Summary\n\nPDF client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw PDF\nbytes from a concrete backing store.\n\nClients provide low-level access to PDF binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
|
||||
"objects": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Path": {
|
||||
"name": "Path",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.Path",
|
||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BasePDFClient": {
|
||||
"name": "BasePDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.client.BasePDFClient",
|
||||
"signature": "<bound method Class.signature of Class('BasePDFClient', 25, 57)>",
|
||||
"docstring": "Abstract client responsible for retrieving PDF bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full PDF binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.client.BasePDFClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 40, 57)>",
|
||||
"docstring": "Fetch raw PDF bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF location, such as a file path, object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemPDFClient": {
|
||||
"name": "FileSystemPDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.client.FileSystemPDFClient",
|
||||
"signature": "<bound method Class.signature of Class('FileSystemPDFClient', 60, 96)>",
|
||||
"docstring": "PDF client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads PDF files directly from the disk and returns\n their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.client.FileSystemPDFClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 71, 96)>",
|
||||
"docstring": "Read a PDF file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the PDF file.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
440
docs/mcp/modules/omniread.pdf.json
Normal file
440
docs/mcp/modules/omniread.pdf.json
Normal file
@@ -0,0 +1,440 @@
|
||||
{
|
||||
"module": "omniread.pdf",
|
||||
"content": {
|
||||
"path": "omniread.pdf",
|
||||
"docstring": "# Summary\n\nPDF format implementation for OmniRead.\n\nThis package provides **PDF-specific implementations** of the core OmniRead\ncontracts defined in `omniread.core`.\n\nUnlike HTML, PDF handling requires an explicit client layer for document\naccess. This package therefore includes:\n\n- PDF clients for acquiring raw PDF data.\n- PDF scrapers that coordinate client access.\n- PDF parsers that extract structured content from PDF binaries.\n\nPublic exports from this package represent the supported PDF pipeline\nand are safe for consumers to import directly when working with PDFs.\n\n---\n\n# Public API\n\n- `FileSystemPDFClient`\n- `PDFScraper`\n- `PDFParser`\n\n---",
|
||||
"objects": {
|
||||
"FileSystemPDFClient": {
|
||||
"name": "FileSystemPDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.FileSystemPDFClient",
|
||||
"signature": "<bound method Alias.signature of Alias('FileSystemPDFClient', 'omniread.pdf.client.FileSystemPDFClient')>",
|
||||
"docstring": "PDF client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads PDF files directly from the disk and returns\n their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.FileSystemPDFClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.pdf.client.FileSystemPDFClient.fetch')>",
|
||||
"docstring": "Read a PDF file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the PDF file.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
},
|
||||
"PDFScraper": {
|
||||
"name": "PDFScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.PDFScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('PDFScraper', 'omniread.pdf.scraper.PDFScraper')>",
|
||||
"docstring": "Scraper for PDF sources.\n\nNotes:\n **Responsibilities:**\n\n - Delegates byte retrieval to a PDF client and normalizes output\n into `Content`.\n - Preserves caller-provided metadata.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.PDFScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.pdf.scraper.PDFScraper.fetch')>",
|
||||
"docstring": "Fetch a PDF document from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF source as understood by the configured PDF client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw PDF bytes, source identifier, PDF content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the PDF client."
|
||||
}
|
||||
}
|
||||
},
|
||||
"PDFParser": {
|
||||
"name": "PDFParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.PDFParser",
|
||||
"signature": "<bound method Alias.signature of Alias('PDFParser', 'omniread.pdf.parser.PDFParser')>",
|
||||
"docstring": "Base PDF parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces PDF content-type compatibility and provides\n the extension point for implementing concrete PDF parsing strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.PDFParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.pdf.parser.PDFParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (PDF only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.PDFParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.pdf.parser.PDFParser.parse')>",
|
||||
"docstring": "Parse PDF content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully interpret the PDF binary payload and\n return a deterministic, structured output."
|
||||
}
|
||||
}
|
||||
},
|
||||
"client": {
|
||||
"name": "client",
|
||||
"kind": "module",
|
||||
"path": "omniread.pdf.client",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nPDF client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw PDF\nbytes from a concrete backing store.\n\nClients provide low-level access to PDF binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
|
||||
"members": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Path": {
|
||||
"name": "Path",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.Path",
|
||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.client.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BasePDFClient": {
|
||||
"name": "BasePDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.client.BasePDFClient",
|
||||
"signature": "<bound method Class.signature of Class('BasePDFClient', 25, 57)>",
|
||||
"docstring": "Abstract client responsible for retrieving PDF bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full PDF binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.client.BasePDFClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 40, 57)>",
|
||||
"docstring": "Fetch raw PDF bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF location, such as a file path, object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemPDFClient": {
|
||||
"name": "FileSystemPDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.client.FileSystemPDFClient",
|
||||
"signature": "<bound method Class.signature of Class('FileSystemPDFClient', 60, 96)>",
|
||||
"docstring": "PDF client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads PDF files directly from the disk and returns\n their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.client.FileSystemPDFClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 71, 96)>",
|
||||
"docstring": "Read a PDF file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the PDF file.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser": {
|
||||
"name": "parser",
|
||||
"kind": "module",
|
||||
"path": "omniread.pdf.parser",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nPDF parser base implementations for OmniRead.\n\nThis module defines the **PDF-specific parser contract**, extending the\nformat-agnostic `BaseParser` with constraints appropriate for PDF content.\n\nPDF parsers are responsible for interpreting binary PDF data and producing\nstructured representations suitable for downstream consumption.",
|
||||
"members": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.parser.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.parser.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.parser.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.parser.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.parser.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.parser.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.parser.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"PDFParser": {
|
||||
"name": "PDFParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.parser.PDFParser",
|
||||
"signature": "<bound method Class.signature of Class('PDFParser', 22, 62)>",
|
||||
"docstring": "Base PDF parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces PDF content-type compatibility and provides\n the extension point for implementing concrete PDF parsing strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.PDFParser.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (PDF only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.parser.PDFParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 43, 62)>",
|
||||
"docstring": "Parse PDF content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully interpret the PDF binary payload and\n return a deterministic, structured output."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scraper": {
|
||||
"name": "scraper",
|
||||
"kind": "module",
|
||||
"path": "omniread.pdf.scraper",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nPDF scraping implementation for OmniRead.\n\nThis module provides a PDF-specific scraper that coordinates PDF byte\nretrieval via a client and normalizes the result into a `Content` object.\n\nThe scraper implements the core `BaseScraper` contract while delegating\nall storage and access concerns to a `BasePDFClient` implementation.",
|
||||
"members": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.BaseScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseScraper', 'omniread.core.scraper.BaseScraper')>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.scraper.BaseScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.core.scraper.BaseScraper.fetch')>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BasePDFClient": {
|
||||
"name": "BasePDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.BasePDFClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BasePDFClient', 'omniread.pdf.client.BasePDFClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving PDF bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full PDF binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.scraper.BasePDFClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.pdf.client.BasePDFClient.fetch')>",
|
||||
"docstring": "Fetch raw PDF bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF location, such as a file path, object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"PDFScraper": {
|
||||
"name": "PDFScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.PDFScraper",
|
||||
"signature": "<bound method Class.signature of Class('PDFScraper', 21, 78)>",
|
||||
"docstring": "Scraper for PDF sources.\n\nNotes:\n **Responsibilities:**\n\n - Delegates byte retrieval to a PDF client and normalizes output\n into `Content`.\n - Preserves caller-provided metadata.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.scraper.PDFScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 48, 78)>",
|
||||
"docstring": "Fetch a PDF document from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF source as understood by the configured PDF client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw PDF bytes, source identifier, PDF content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the PDF client."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
148
docs/mcp/modules/omniread.pdf.parser.json
Normal file
148
docs/mcp/modules/omniread.pdf.parser.json
Normal file
@@ -0,0 +1,148 @@
|
||||
{
|
||||
"module": "omniread.pdf.parser",
|
||||
"content": {
|
||||
"path": "omniread.pdf.parser",
|
||||
"docstring": "# Summary\n\nPDF parser base implementations for OmniRead.\n\nThis module defines the **PDF-specific parser contract**, extending the\nformat-agnostic `BaseParser` with constraints appropriate for PDF content.\n\nPDF parsers are responsible for interpreting binary PDF data and producing\nstructured representations suitable for downstream consumption.",
|
||||
"objects": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.parser.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.parser.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.parser.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.parser.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.parser.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.parser.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.parser.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"PDFParser": {
|
||||
"name": "PDFParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.parser.PDFParser",
|
||||
"signature": "<bound method Class.signature of Class('PDFParser', 22, 62)>",
|
||||
"docstring": "Base PDF parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces PDF content-type compatibility and provides\n the extension point for implementing concrete PDF parsing strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.parser.PDFParser.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (PDF only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.parser.PDFParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 43, 62)>",
|
||||
"docstring": "Parse PDF content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully interpret the PDF binary payload and\n return a deterministic, structured output."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
159
docs/mcp/modules/omniread.pdf.scraper.json
Normal file
159
docs/mcp/modules/omniread.pdf.scraper.json
Normal file
@@ -0,0 +1,159 @@
|
||||
{
|
||||
"module": "omniread.pdf.scraper",
|
||||
"content": {
|
||||
"path": "omniread.pdf.scraper",
|
||||
"docstring": "# Summary\n\nPDF scraping implementation for OmniRead.\n\nThis module provides a PDF-specific scraper that coordinates PDF byte\nretrieval via a client and normalizes the result into a `Content` object.\n\nThe scraper implements the core `BaseScraper` contract while delegating\nall storage and access concerns to a `BasePDFClient` implementation.",
|
||||
"objects": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.pdf.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.pdf.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseScraper": {
|
||||
"name": "BaseScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.BaseScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseScraper', 'omniread.core.scraper.BaseScraper')>",
|
||||
"docstring": "Base interface for all scrapers.\n\nNotes:\n **Responsibilities:**\n\n - A scraper is responsible ONLY for fetching raw content (bytes)\n from a source. It must not interpret or parse it.\n - A scraper is a stateless acquisition component that retrieves raw\n content from a source and returns it as a `Content` object.\n - Scrapers define how content is obtained, not what the content means.\n - Implementations may vary in transport mechanism, authentication\n strategy, retry and backoff behavior.\n\n **Constraints:**\n\n - Implementations must not parse content, modify content semantics,\n or couple scraping logic to a specific parser.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.scraper.BaseScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.core.scraper.BaseScraper.fetch')>",
|
||||
"docstring": "Fetch raw content from the given source.\n\nArgs:\n source (str):\n Location identifier (URL, file path, S3 URI, etc.).\n\n metadata (Mapping[str, Any] | None, optional):\n Optional hints for the scraper (headers, auth, etc.).\n\nReturns:\n Content:\n Content object containing raw bytes and metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must retrieve the content referenced by `source`\n and return it as raw bytes wrapped in a `Content` object."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BasePDFClient": {
|
||||
"name": "BasePDFClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.BasePDFClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BasePDFClient', 'omniread.pdf.client.BasePDFClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving PDF bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full PDF binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.scraper.BasePDFClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.pdf.client.BasePDFClient.fetch')>",
|
||||
"docstring": "Fetch raw PDF bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF location, such as a file path, object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw PDF bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"PDFScraper": {
|
||||
"name": "PDFScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.pdf.scraper.PDFScraper",
|
||||
"signature": "<bound method Class.signature of Class('PDFScraper', 21, 78)>",
|
||||
"docstring": "Scraper for PDF sources.\n\nNotes:\n **Responsibilities:**\n\n - Delegates byte retrieval to a PDF client and normalizes output\n into `Content`.\n - Preserves caller-provided metadata.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.pdf.scraper.PDFScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 48, 78)>",
|
||||
"docstring": "Fetch a PDF document from the given source.\n\nArgs:\n source (Any):\n Identifier of the PDF source as understood by the configured PDF client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw PDF bytes, source identifier, PDF content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the PDF client."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
69
docs/mcp/modules/omniread.xlsx.client.json
Normal file
69
docs/mcp/modules/omniread.xlsx.client.json
Normal file
@@ -0,0 +1,69 @@
|
||||
{
|
||||
"module": "omniread.xlsx.client",
|
||||
"content": {
|
||||
"path": "omniread.xlsx.client",
|
||||
"docstring": "# Summary\n\nXLSX client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw\nOffice Open XML spreadsheet bytes from a concrete backing store.\n\nClients provide low-level access to xlsx binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
|
||||
"objects": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Path": {
|
||||
"name": "Path",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.Path",
|
||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BaseXlsxClient": {
|
||||
"name": "BaseXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.client.BaseXlsxClient",
|
||||
"signature": "<bound method Class.signature of Class('BaseXlsxClient', 25, 58)>",
|
||||
"docstring": "Abstract client responsible for retrieving spreadsheet bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full xlsx binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.client.BaseXlsxClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 40, 58)>",
|
||||
"docstring": "Fetch raw xlsx bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemXlsxClient": {
|
||||
"name": "FileSystemXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.client.FileSystemXlsxClient",
|
||||
"signature": "<bound method Class.signature of Class('FileSystemXlsxClient', 61, 97)>",
|
||||
"docstring": "XLSX client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads spreadsheet files directly from the disk and\n returns their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.client.FileSystemXlsxClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 72, 97)>",
|
||||
"docstring": "Read an xlsx file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the spreadsheet file.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
611
docs/mcp/modules/omniread.xlsx.json
Normal file
611
docs/mcp/modules/omniread.xlsx.json
Normal file
@@ -0,0 +1,611 @@
|
||||
{
|
||||
"module": "omniread.xlsx",
|
||||
"content": {
|
||||
"path": "omniread.xlsx",
|
||||
"docstring": "# Summary\n\nXLSX subpackage for OmniRead.\n\nProvides acquisition and parsing of Office Open XML spreadsheet (xlsx)\ncontent:\n\n- `BaseXlsxClient`: abstract backing-store client for xlsx bytes.\n- `FileSystemXlsxClient`: local filesystem implementation.\n- `XlsxScraper`: wraps fetched bytes into canonical `Content`.\n- `XlsxParserBase`: content-type-enforcing parser contract.\n- `XlsxParser`: generic string-row parser built on openpyxl.",
|
||||
"objects": {
|
||||
"BaseXlsxClient": {
|
||||
"name": "BaseXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.BaseXlsxClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseXlsxClient', 'omniread.xlsx.client.BaseXlsxClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving spreadsheet bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full xlsx binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.BaseXlsxClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.xlsx.client.BaseXlsxClient.fetch')>",
|
||||
"docstring": "Fetch raw xlsx bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemXlsxClient": {
|
||||
"name": "FileSystemXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.FileSystemXlsxClient",
|
||||
"signature": "<bound method Alias.signature of Alias('FileSystemXlsxClient', 'omniread.xlsx.client.FileSystemXlsxClient')>",
|
||||
"docstring": "XLSX client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads spreadsheet files directly from the disk and\n returns their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.FileSystemXlsxClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.xlsx.client.FileSystemXlsxClient.fetch')>",
|
||||
"docstring": "Read an xlsx file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the spreadsheet file.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxParser": {
|
||||
"name": "XlsxParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.XlsxParser",
|
||||
"signature": "<bound method Alias.signature of Alias('XlsxParser', 'omniread.xlsx.parser.XlsxParser')>",
|
||||
"docstring": "Generic xlsx parser producing string rows from a worksheet.\n\nNotes:\n **Responsibilities:**\n\n - Lazily load the workbook owned by the parser's content.\n - Normalize cells (including dates and numeric values) into\n deterministic string representations.\n - Expose sheet discovery and row extraction helpers.\n\n **Constraints:**\n\n - Cells are rendered with ``str(value)`` after trimming; date and\n datetime values are rendered in ISO format. Consumers requiring\n locale-specific formatting must convert on their side.",
|
||||
"members": {
|
||||
"workbook": {
|
||||
"name": "workbook",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.XlsxParser.workbook",
|
||||
"signature": "<bound method Alias.signature of Alias('workbook', 'omniread.xlsx.parser.XlsxParser.workbook')>",
|
||||
"docstring": "The lazily loaded workbook backing this parser's content."
|
||||
},
|
||||
"sheet_names": {
|
||||
"name": "sheet_names",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.XlsxParser.sheet_names",
|
||||
"signature": "<bound method Alias.signature of Alias('sheet_names', 'omniread.xlsx.parser.XlsxParser.sheet_names')>",
|
||||
"docstring": "Names of all worksheets contained in the workbook."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.XlsxParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.xlsx.parser.XlsxParser.parse')>",
|
||||
"docstring": "Parse the first worksheet into normalized string rows.\n\nReturns:\n list[list[str]]:\n Rows of the default (first) worksheet."
|
||||
},
|
||||
"rows": {
|
||||
"name": "rows",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.XlsxParser.rows",
|
||||
"signature": "<bound method Alias.signature of Alias('rows', 'omniread.xlsx.parser.XlsxParser.rows')>",
|
||||
"docstring": "Extract normalized string rows from a worksheet.\n\nArgs:\n sheet (int | str | None):\n Worksheet index or title; defaults to the first worksheet.\n skip_empty (bool):\n When True (default), rows whose cells are all blank are omitted.\n\nReturns:\n list[list[str]]:\n Normalized rows; trailing blank cells are trimmed per row.\n\nRaises:\n ValueError:\n If the requested sheet does not exist."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxParserBase": {
|
||||
"name": "XlsxParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.XlsxParserBase",
|
||||
"signature": "<bound method Alias.signature of Alias('XlsxParserBase', 'omniread.xlsx.parser_base.XlsxParserBase')>",
|
||||
"docstring": "Base xlsx parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces xlsx content-type compatibility and provides\n the extension point for implementing concrete xlsx parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.XlsxParserBase.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.xlsx.parser_base.XlsxParserBase.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (XLSX only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.XlsxParserBase.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.xlsx.parser_base.XlsxParserBase.parse')>",
|
||||
"docstring": "Parse xlsx content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxScraper": {
|
||||
"name": "XlsxScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.XlsxScraper",
|
||||
"signature": "<bound method Alias.signature of Alias('XlsxScraper', 'omniread.xlsx.scraper.XlsxScraper')>",
|
||||
"docstring": "Scraper for xlsx spreadsheet documents.\n\nNotes:\n **Responsibilities:**\n\n - Fetch raw xlsx bytes via the configured client.\n - Wrap the payload in a canonical `Content` instance with the\n XLSX content type and source identifier.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.XlsxScraper.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.xlsx.scraper.XlsxScraper.fetch')>",
|
||||
"docstring": "Fetch an xlsx document from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet source as understood by the\n configured client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw xlsx bytes, source\n identifier, XLSX content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the client."
|
||||
}
|
||||
}
|
||||
},
|
||||
"client": {
|
||||
"name": "client",
|
||||
"kind": "module",
|
||||
"path": "omniread.xlsx.client",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nXLSX client abstractions for OmniRead.\n\nThis module defines the **client layer** responsible for retrieving raw\nOffice Open XML spreadsheet bytes from a concrete backing store.\n\nClients provide low-level access to xlsx binaries and are intentionally\ndecoupled from scraping and parsing logic. They do not perform validation,\ninterpretation, or content extraction.\n\nTypical backing stores include:\n\n- Local filesystems\n- Object storage (S3, GCS, etc.)\n- Network file systems",
|
||||
"members": {
|
||||
"ABC": {
|
||||
"name": "ABC",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.ABC",
|
||||
"signature": "<bound method Alias.signature of Alias('ABC', 'abc.ABC')>",
|
||||
"docstring": null
|
||||
},
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Path": {
|
||||
"name": "Path",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.Path",
|
||||
"signature": "<bound method Alias.signature of Alias('Path', 'pathlib.Path')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.client.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BaseXlsxClient": {
|
||||
"name": "BaseXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.client.BaseXlsxClient",
|
||||
"signature": "<bound method Class.signature of Class('BaseXlsxClient', 25, 58)>",
|
||||
"docstring": "Abstract client responsible for retrieving spreadsheet bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full xlsx binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.client.BaseXlsxClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 40, 58)>",
|
||||
"docstring": "Fetch raw xlsx bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"FileSystemXlsxClient": {
|
||||
"name": "FileSystemXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.client.FileSystemXlsxClient",
|
||||
"signature": "<bound method Class.signature of Class('FileSystemXlsxClient', 61, 97)>",
|
||||
"docstring": "XLSX client that reads from the local filesystem.\n\nNotes:\n **Guarantees:**\n\n - This client reads spreadsheet files directly from the disk and\n returns their raw binary contents.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.client.FileSystemXlsxClient.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 72, 97)>",
|
||||
"docstring": "Read an xlsx file from the local filesystem.\n\nArgs:\n path (Path):\n Filesystem path to the spreadsheet file.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n FileNotFoundError:\n If the path does not exist.\n ValueError:\n If the path exists but is not a file."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser": {
|
||||
"name": "parser",
|
||||
"kind": "module",
|
||||
"path": "omniread.xlsx.parser",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nXLSX parser implementations for OmniRead.\n\nThis module provides a concrete, generic parser for Office Open XML\nspreadsheets. It exposes workbook sheets as lists of string rows so\ndownstream consumers can interpret tabular content without depending on\nopenpyxl directly.\n\nThe parser is intentionally statement-agnostic: it performs no header\ndetection or column interpretation beyond basic cell normalization.",
|
||||
"members": {
|
||||
"datetime": {
|
||||
"name": "datetime",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.datetime",
|
||||
"signature": "<bound method Alias.signature of Alias('datetime', 'datetime')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BytesIO": {
|
||||
"name": "BytesIO",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.BytesIO",
|
||||
"signature": "<bound method Alias.signature of Alias('BytesIO', 'io.BytesIO')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"openpyxl": {
|
||||
"name": "openpyxl",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.openpyxl",
|
||||
"signature": "<bound method Alias.signature of Alias('openpyxl', 'openpyxl')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxParserBase": {
|
||||
"name": "XlsxParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser.XlsxParserBase",
|
||||
"signature": "<bound method Alias.signature of Alias('XlsxParserBase', 'omniread.xlsx.parser_base.XlsxParserBase')>",
|
||||
"docstring": "Base xlsx parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces xlsx content-type compatibility and provides\n the extension point for implementing concrete xlsx parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.XlsxParserBase.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.xlsx.parser_base.XlsxParserBase.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (XLSX only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser.XlsxParserBase.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.xlsx.parser_base.XlsxParserBase.parse')>",
|
||||
"docstring": "Parse xlsx content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxParser": {
|
||||
"name": "XlsxParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser.XlsxParser",
|
||||
"signature": "<bound method Class.signature of Class('XlsxParser', 26, 149)>",
|
||||
"docstring": "Generic xlsx parser producing string rows from a worksheet.\n\nNotes:\n **Responsibilities:**\n\n - Lazily load the workbook owned by the parser's content.\n - Normalize cells (including dates and numeric values) into\n deterministic string representations.\n - Expose sheet discovery and row extraction helpers.\n\n **Constraints:**\n\n - Cells are rendered with ``str(value)`` after trimming; date and\n datetime values are rendered in ISO format. Consumers requiring\n locale-specific formatting must convert on their side.",
|
||||
"members": {
|
||||
"workbook": {
|
||||
"name": "workbook",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.workbook",
|
||||
"signature": null,
|
||||
"docstring": "The lazily loaded workbook backing this parser's content."
|
||||
},
|
||||
"sheet_names": {
|
||||
"name": "sheet_names",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.sheet_names",
|
||||
"signature": null,
|
||||
"docstring": "Names of all worksheets contained in the workbook."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 85, 93)>",
|
||||
"docstring": "Parse the first worksheet into normalized string rows.\n\nReturns:\n list[list[str]]:\n Rows of the default (first) worksheet."
|
||||
},
|
||||
"rows": {
|
||||
"name": "rows",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.rows",
|
||||
"signature": "<bound method Function.signature of Function('rows', 95, 127)>",
|
||||
"docstring": "Extract normalized string rows from a worksheet.\n\nArgs:\n sheet (int | str | None):\n Worksheet index or title; defaults to the first worksheet.\n skip_empty (bool):\n When True (default), rows whose cells are all blank are omitted.\n\nReturns:\n list[list[str]]:\n Normalized rows; trailing blank cells are trimmed per row.\n\nRaises:\n ValueError:\n If the requested sheet does not exist."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"parser_base": {
|
||||
"name": "parser_base",
|
||||
"kind": "module",
|
||||
"path": "omniread.xlsx.parser_base",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nXLSX parser base implementation for OmniRead.\n\nThis module defines the **XLSX-specific parser contract**, extending the\nformat-agnostic `BaseParser` with constraints appropriate for Office Open\nXML spreadsheet content.",
|
||||
"members": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser_base.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser_base.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser_base.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser_base.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"XlsxParserBase": {
|
||||
"name": "XlsxParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser_base.XlsxParserBase",
|
||||
"signature": "<bound method Class.signature of Class('XlsxParserBase', 20, 55)>",
|
||||
"docstring": "Base xlsx parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces xlsx content-type compatibility and provides\n the extension point for implementing concrete xlsx parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.XlsxParserBase.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (XLSX only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser_base.XlsxParserBase.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 42, 55)>",
|
||||
"docstring": "Parse xlsx content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scraper": {
|
||||
"name": "scraper",
|
||||
"kind": "module",
|
||||
"path": "omniread.xlsx.scraper",
|
||||
"signature": null,
|
||||
"docstring": "# Summary\n\nXLSX scraper for OmniRead.\n\nThis module defines the scraper responsible for acquiring raw Office Open\nXML spreadsheet content from a backing store via a configured client.\n\nThe scraper does not interpret or parse the acquired bytes; it wraps them in\nthe canonical `Content` model.",
|
||||
"members": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseXlsxClient": {
|
||||
"name": "BaseXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.BaseXlsxClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseXlsxClient', 'omniread.xlsx.client.BaseXlsxClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving spreadsheet bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full xlsx binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.scraper.BaseXlsxClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.xlsx.client.BaseXlsxClient.fetch')>",
|
||||
"docstring": "Fetch raw xlsx bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxScraper": {
|
||||
"name": "XlsxScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.XlsxScraper",
|
||||
"signature": "<bound method Class.signature of Class('XlsxScraper', 21, 80)>",
|
||||
"docstring": "Scraper for xlsx spreadsheet documents.\n\nNotes:\n **Responsibilities:**\n\n - Fetch raw xlsx bytes via the configured client.\n - Wrap the payload in a canonical `Content` instance with the\n XLSX content type and source identifier.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.scraper.XlsxScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 48, 80)>",
|
||||
"docstring": "Fetch an xlsx document from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet source as understood by the\n configured client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw xlsx bytes, source\n identifier, XLSX content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the client."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
134
docs/mcp/modules/omniread.xlsx.parser.json
Normal file
134
docs/mcp/modules/omniread.xlsx.parser.json
Normal file
@@ -0,0 +1,134 @@
|
||||
{
|
||||
"module": "omniread.xlsx.parser",
|
||||
"content": {
|
||||
"path": "omniread.xlsx.parser",
|
||||
"docstring": "# Summary\n\nXLSX parser implementations for OmniRead.\n\nThis module provides a concrete, generic parser for Office Open XML\nspreadsheets. It exposes workbook sheets as lists of string rows so\ndownstream consumers can interpret tabular content without depending on\nopenpyxl directly.\n\nThe parser is intentionally statement-agnostic: it performs no header\ndetection or column interpretation beyond basic cell normalization.",
|
||||
"objects": {
|
||||
"datetime": {
|
||||
"name": "datetime",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.datetime",
|
||||
"signature": "<bound method Alias.signature of Alias('datetime', 'datetime')>",
|
||||
"docstring": null
|
||||
},
|
||||
"BytesIO": {
|
||||
"name": "BytesIO",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.BytesIO",
|
||||
"signature": "<bound method Alias.signature of Alias('BytesIO', 'io.BytesIO')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"openpyxl": {
|
||||
"name": "openpyxl",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser.openpyxl",
|
||||
"signature": "<bound method Alias.signature of Alias('openpyxl', 'openpyxl')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxParserBase": {
|
||||
"name": "XlsxParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser.XlsxParserBase",
|
||||
"signature": "<bound method Alias.signature of Alias('XlsxParserBase', 'omniread.xlsx.parser_base.XlsxParserBase')>",
|
||||
"docstring": "Base xlsx parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces xlsx content-type compatibility and provides\n the extension point for implementing concrete xlsx parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.XlsxParserBase.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.xlsx.parser_base.XlsxParserBase.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser (XLSX only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser.XlsxParserBase.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.xlsx.parser_base.XlsxParserBase.parse')>",
|
||||
"docstring": "Parse xlsx content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxParser": {
|
||||
"name": "XlsxParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser.XlsxParser",
|
||||
"signature": "<bound method Class.signature of Class('XlsxParser', 26, 149)>",
|
||||
"docstring": "Generic xlsx parser producing string rows from a worksheet.\n\nNotes:\n **Responsibilities:**\n\n - Lazily load the workbook owned by the parser's content.\n - Normalize cells (including dates and numeric values) into\n deterministic string representations.\n - Expose sheet discovery and row extraction helpers.\n\n **Constraints:**\n\n - Cells are rendered with ``str(value)`` after trimming; date and\n datetime values are rendered in ISO format. Consumers requiring\n locale-specific formatting must convert on their side.",
|
||||
"members": {
|
||||
"workbook": {
|
||||
"name": "workbook",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.workbook",
|
||||
"signature": null,
|
||||
"docstring": "The lazily loaded workbook backing this parser's content."
|
||||
},
|
||||
"sheet_names": {
|
||||
"name": "sheet_names",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.sheet_names",
|
||||
"signature": null,
|
||||
"docstring": "Names of all worksheets contained in the workbook."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 85, 93)>",
|
||||
"docstring": "Parse the first worksheet into normalized string rows.\n\nReturns:\n list[list[str]]:\n Rows of the default (first) worksheet."
|
||||
},
|
||||
"rows": {
|
||||
"name": "rows",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser.XlsxParser.rows",
|
||||
"signature": "<bound method Function.signature of Function('rows', 95, 127)>",
|
||||
"docstring": "Extract normalized string rows from a worksheet.\n\nArgs:\n sheet (int | str | None):\n Worksheet index or title; defaults to the first worksheet.\n skip_empty (bool):\n When True (default), rows whose cells are all blank are omitted.\n\nReturns:\n list[list[str]]:\n Normalized rows; trailing blank cells are trimmed per row.\n\nRaises:\n ValueError:\n If the requested sheet does not exist."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
148
docs/mcp/modules/omniread.xlsx.parser_base.json
Normal file
148
docs/mcp/modules/omniread.xlsx.parser_base.json
Normal file
@@ -0,0 +1,148 @@
|
||||
{
|
||||
"module": "omniread.xlsx.parser_base",
|
||||
"content": {
|
||||
"path": "omniread.xlsx.parser_base",
|
||||
"docstring": "# Summary\n\nXLSX parser base implementation for OmniRead.\n\nThis module defines the **XLSX-specific parser contract**, extending the\nformat-agnostic `BaseParser` with constraints appropriate for Office Open\nXML spreadsheet content.",
|
||||
"objects": {
|
||||
"abstractmethod": {
|
||||
"name": "abstractmethod",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser_base.abstractmethod",
|
||||
"signature": "<bound method Alias.signature of Alias('abstractmethod', 'abc.abstractmethod')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Generic": {
|
||||
"name": "Generic",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser_base.Generic",
|
||||
"signature": "<bound method Alias.signature of Alias('Generic', 'typing.Generic')>",
|
||||
"docstring": null
|
||||
},
|
||||
"TypeVar": {
|
||||
"name": "TypeVar",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.parser_base.TypeVar",
|
||||
"signature": "<bound method Alias.signature of Alias('TypeVar', 'typing.TypeVar')>",
|
||||
"docstring": null
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser_base.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseParser": {
|
||||
"name": "BaseParser",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseParser', 'omniread.core.parser.BaseParser')>",
|
||||
"docstring": "Base interface for all parsers.\n\nNotes:\n **Guarantees:**\n\n - A parser is a self-contained object that owns the `Content` it is\n responsible for interpreting.\n - Consumers may rely on early validation of content compatibility\n and type-stable return values from `parse()`.\n\n **Responsibilities:**\n\n - Implementations must declare supported content types via `supported_types`.\n - Implementations must raise parsing-specific exceptions from `parse()`.\n - Implementations must remain deterministic for a given input.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.supported_types",
|
||||
"signature": "<bound method Alias.signature of Alias('supported_types', 'omniread.core.parser.BaseParser.supported_types')>",
|
||||
"docstring": "Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic."
|
||||
},
|
||||
"content": {
|
||||
"name": "content",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.content",
|
||||
"signature": "<bound method Alias.signature of Alias('content', 'omniread.core.parser.BaseParser.content')>",
|
||||
"docstring": null
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.parse",
|
||||
"signature": "<bound method Alias.signature of Alias('parse', 'omniread.core.parser.BaseParser.parse')>",
|
||||
"docstring": "Parse the owned content into structured output.\n\nReturns:\n T:\n Parsed, structured representation.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation.\n\nNotes:\n **Responsibilities:**\n\n - Implementations must fully consume the provided content and\n return a deterministic, structured output."
|
||||
},
|
||||
"supports": {
|
||||
"name": "supports",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser_base.BaseParser.supports",
|
||||
"signature": "<bound method Alias.signature of Alias('supports', 'omniread.core.parser.BaseParser.supports')>",
|
||||
"docstring": "Check whether this parser supports the content's type.\n\nReturns:\n bool:\n True if the content type is supported; False otherwise."
|
||||
}
|
||||
}
|
||||
},
|
||||
"T": {
|
||||
"name": "T",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.T",
|
||||
"signature": null,
|
||||
"docstring": null
|
||||
},
|
||||
"XlsxParserBase": {
|
||||
"name": "XlsxParserBase",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.parser_base.XlsxParserBase",
|
||||
"signature": "<bound method Class.signature of Class('XlsxParserBase', 20, 55)>",
|
||||
"docstring": "Base xlsx parser.\n\nNotes:\n **Responsibilities:**\n\n - This class enforces xlsx content-type compatibility and provides\n the extension point for implementing concrete xlsx parsing\n strategies.\n\n **Constraints:**\n\n - Concrete implementations must define the output type `T` and\n implement the `parse()` method.",
|
||||
"members": {
|
||||
"supported_types": {
|
||||
"name": "supported_types",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.parser_base.XlsxParserBase.supported_types",
|
||||
"signature": null,
|
||||
"docstring": "Set of content types supported by this parser (XLSX only)."
|
||||
},
|
||||
"parse": {
|
||||
"name": "parse",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.parser_base.XlsxParserBase.parse",
|
||||
"signature": "<bound method Function.signature of Function('parse', 42, 55)>",
|
||||
"docstring": "Parse xlsx content into a structured output.\n\nReturns:\n T:\n Parsed representation of type `T`.\n\nRaises:\n Exception:\n Parsing-specific errors as defined by the implementation."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
143
docs/mcp/modules/omniread.xlsx.scraper.json
Normal file
143
docs/mcp/modules/omniread.xlsx.scraper.json
Normal file
@@ -0,0 +1,143 @@
|
||||
{
|
||||
"module": "omniread.xlsx.scraper",
|
||||
"content": {
|
||||
"path": "omniread.xlsx.scraper",
|
||||
"docstring": "# Summary\n\nXLSX scraper for OmniRead.\n\nThis module defines the scraper responsible for acquiring raw Office Open\nXML spreadsheet content from a backing store via a configured client.\n\nThe scraper does not interpret or parse the acquired bytes; it wraps them in\nthe canonical `Content` model.",
|
||||
"objects": {
|
||||
"Mapping": {
|
||||
"name": "Mapping",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.scraper.Mapping",
|
||||
"signature": "<bound method Alias.signature of Alias('Mapping', 'collections.abc.Mapping')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Any": {
|
||||
"name": "Any",
|
||||
"kind": "alias",
|
||||
"path": "omniread.xlsx.scraper.Any",
|
||||
"signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
|
||||
"docstring": null
|
||||
},
|
||||
"Content": {
|
||||
"name": "Content",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.Content",
|
||||
"signature": "<bound method Alias.signature of Alias('Content', 'omniread.core.content.Content')>",
|
||||
"docstring": "Normalized representation of extracted content.\n\nNotes:\n **Responsibilities:**\n\n - A `Content` instance represents a raw content payload along with\n minimal contextual metadata describing its origin and type.\n - This class is the primary exchange format between scrapers,\n parsers, and downstream consumers.",
|
||||
"members": {
|
||||
"raw": {
|
||||
"name": "raw",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.raw",
|
||||
"signature": "<bound method Alias.signature of Alias('raw', 'omniread.core.content.Content.raw')>",
|
||||
"docstring": "Raw content bytes as retrieved from the source."
|
||||
},
|
||||
"source": {
|
||||
"name": "source",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.source",
|
||||
"signature": "<bound method Alias.signature of Alias('source', 'omniread.core.content.Content.source')>",
|
||||
"docstring": "Identifier of the content origin (URL, file path, or logical name)."
|
||||
},
|
||||
"content_type": {
|
||||
"name": "content_type",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.content_type",
|
||||
"signature": "<bound method Alias.signature of Alias('content_type', 'omniread.core.content.Content.content_type')>",
|
||||
"docstring": "Optional MIME type of the content, if known."
|
||||
},
|
||||
"metadata": {
|
||||
"name": "metadata",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.Content.metadata",
|
||||
"signature": "<bound method Alias.signature of Alias('metadata', 'omniread.core.content.Content.metadata')>",
|
||||
"docstring": "Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes)."
|
||||
}
|
||||
}
|
||||
},
|
||||
"ContentType": {
|
||||
"name": "ContentType",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.ContentType",
|
||||
"signature": "<bound method Alias.signature of Alias('ContentType', 'omniread.core.content.ContentType')>",
|
||||
"docstring": "Supported MIME types for extracted content.\n\nNotes:\n **Guarantees:**\n\n - This enum represents the declared or inferred media type of the\n content source.\n - It is primarily used for routing content to the appropriate\n parser or downstream consumer.",
|
||||
"members": {
|
||||
"HTML": {
|
||||
"name": "HTML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.HTML",
|
||||
"signature": "<bound method Alias.signature of Alias('HTML', 'omniread.core.content.ContentType.HTML')>",
|
||||
"docstring": "HTML document content."
|
||||
},
|
||||
"PDF": {
|
||||
"name": "PDF",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.PDF",
|
||||
"signature": "<bound method Alias.signature of Alias('PDF', 'omniread.core.content.ContentType.PDF')>",
|
||||
"docstring": "PDF document content."
|
||||
},
|
||||
"XLSX": {
|
||||
"name": "XLSX",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.XLSX",
|
||||
"signature": "<bound method Alias.signature of Alias('XLSX', 'omniread.core.content.ContentType.XLSX')>",
|
||||
"docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
|
||||
},
|
||||
"CSV": {
|
||||
"name": "CSV",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.CSV",
|
||||
"signature": "<bound method Alias.signature of Alias('CSV', 'omniread.core.content.ContentType.CSV')>",
|
||||
"docstring": "Comma-separated-value document content."
|
||||
},
|
||||
"JSON": {
|
||||
"name": "JSON",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.JSON",
|
||||
"signature": "<bound method Alias.signature of Alias('JSON', 'omniread.core.content.ContentType.JSON')>",
|
||||
"docstring": "JSON document content."
|
||||
},
|
||||
"XML": {
|
||||
"name": "XML",
|
||||
"kind": "attribute",
|
||||
"path": "omniread.xlsx.scraper.ContentType.XML",
|
||||
"signature": "<bound method Alias.signature of Alias('XML', 'omniread.core.content.ContentType.XML')>",
|
||||
"docstring": "XML document content."
|
||||
}
|
||||
}
|
||||
},
|
||||
"BaseXlsxClient": {
|
||||
"name": "BaseXlsxClient",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.BaseXlsxClient",
|
||||
"signature": "<bound method Alias.signature of Alias('BaseXlsxClient', 'omniread.xlsx.client.BaseXlsxClient')>",
|
||||
"docstring": "Abstract client responsible for retrieving spreadsheet bytes.\n\nRetrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).\n\nNotes:\n **Responsibilities:**\n\n - Implementations must accept a source identifier appropriate to\n the backing store.\n - Return the full xlsx binary payload.\n - Raise retrieval-specific errors on failure.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.scraper.BaseXlsxClient.fetch",
|
||||
"signature": "<bound method Alias.signature of Alias('fetch', 'omniread.xlsx.client.BaseXlsxClient.fetch')>",
|
||||
"docstring": "Fetch raw xlsx bytes from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet location, such as a file path,\n object storage key, or remote reference.\n\nReturns:\n bytes:\n Raw xlsx bytes.\n\nRaises:\n Exception:\n Retrieval-specific errors defined by the implementation."
|
||||
}
|
||||
}
|
||||
},
|
||||
"XlsxScraper": {
|
||||
"name": "XlsxScraper",
|
||||
"kind": "class",
|
||||
"path": "omniread.xlsx.scraper.XlsxScraper",
|
||||
"signature": "<bound method Class.signature of Class('XlsxScraper', 21, 80)>",
|
||||
"docstring": "Scraper for xlsx spreadsheet documents.\n\nNotes:\n **Responsibilities:**\n\n - Fetch raw xlsx bytes via the configured client.\n - Wrap the payload in a canonical `Content` instance with the\n XLSX content type and source identifier.\n\n **Constraints:**\n\n - The scraper does not perform parsing or interpretation.\n - Does not assume a specific storage backend.",
|
||||
"members": {
|
||||
"fetch": {
|
||||
"name": "fetch",
|
||||
"kind": "function",
|
||||
"path": "omniread.xlsx.scraper.XlsxScraper.fetch",
|
||||
"signature": "<bound method Function.signature of Function('fetch', 48, 80)>",
|
||||
"docstring": "Fetch an xlsx document from the given source.\n\nArgs:\n source (Any):\n Identifier of the spreadsheet source as understood by the\n configured client.\n metadata (Mapping[str, Any] | None, optional):\n Optional metadata to attach to the returned content.\n\nReturns:\n Content:\n A `Content` instance containing raw xlsx bytes, source\n identifier, XLSX content type, and optional metadata.\n\nRaises:\n Exception:\n Retrieval-specific errors raised by the client."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
90
docs/mcp/nav.json
Normal file
90
docs/mcp/nav.json
Normal file
@@ -0,0 +1,90 @@
|
||||
[
|
||||
{
|
||||
"module": "omniread",
|
||||
"resource": "docs://modules/omniread"
|
||||
},
|
||||
{
|
||||
"module": "omniread.core",
|
||||
"resource": "docs://modules/omniread.core"
|
||||
},
|
||||
{
|
||||
"module": "omniread.core.content",
|
||||
"resource": "docs://modules/omniread.core.content"
|
||||
},
|
||||
{
|
||||
"module": "omniread.core.parser",
|
||||
"resource": "docs://modules/omniread.core.parser"
|
||||
},
|
||||
{
|
||||
"module": "omniread.core.scraper",
|
||||
"resource": "docs://modules/omniread.core.scraper"
|
||||
},
|
||||
{
|
||||
"module": "omniread.csv",
|
||||
"resource": "docs://modules/omniread.csv"
|
||||
},
|
||||
{
|
||||
"module": "omniread.csv.client",
|
||||
"resource": "docs://modules/omniread.csv.client"
|
||||
},
|
||||
{
|
||||
"module": "omniread.csv.parser",
|
||||
"resource": "docs://modules/omniread.csv.parser"
|
||||
},
|
||||
{
|
||||
"module": "omniread.csv.parser_base",
|
||||
"resource": "docs://modules/omniread.csv.parser_base"
|
||||
},
|
||||
{
|
||||
"module": "omniread.csv.scraper",
|
||||
"resource": "docs://modules/omniread.csv.scraper"
|
||||
},
|
||||
{
|
||||
"module": "omniread.html",
|
||||
"resource": "docs://modules/omniread.html"
|
||||
},
|
||||
{
|
||||
"module": "omniread.html.parser",
|
||||
"resource": "docs://modules/omniread.html.parser"
|
||||
},
|
||||
{
|
||||
"module": "omniread.html.scraper",
|
||||
"resource": "docs://modules/omniread.html.scraper"
|
||||
},
|
||||
{
|
||||
"module": "omniread.pdf",
|
||||
"resource": "docs://modules/omniread.pdf"
|
||||
},
|
||||
{
|
||||
"module": "omniread.pdf.client",
|
||||
"resource": "docs://modules/omniread.pdf.client"
|
||||
},
|
||||
{
|
||||
"module": "omniread.pdf.parser",
|
||||
"resource": "docs://modules/omniread.pdf.parser"
|
||||
},
|
||||
{
|
||||
"module": "omniread.pdf.scraper",
|
||||
"resource": "docs://modules/omniread.pdf.scraper"
|
||||
},
|
||||
{
|
||||
"module": "omniread.xlsx",
|
||||
"resource": "docs://modules/omniread.xlsx"
|
||||
},
|
||||
{
|
||||
"module": "omniread.xlsx.client",
|
||||
"resource": "docs://modules/omniread.xlsx.client"
|
||||
},
|
||||
{
|
||||
"module": "omniread.xlsx.parser",
|
||||
"resource": "docs://modules/omniread.xlsx.parser"
|
||||
},
|
||||
{
|
||||
"module": "omniread.xlsx.parser_base",
|
||||
"resource": "docs://modules/omniread.xlsx.parser_base"
|
||||
},
|
||||
{
|
||||
"module": "omniread.xlsx.scraper",
|
||||
"resource": "docs://modules/omniread.xlsx.scraper"
|
||||
}
|
||||
]
|
||||
87
docs/mkdocs.lib.yml
Normal file
87
docs/mkdocs.lib.yml
Normal file
@@ -0,0 +1,87 @@
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- scheme: slate
|
||||
primary: deep purple
|
||||
accent: cyan
|
||||
font:
|
||||
text: Inter
|
||||
code: JetBrains Mono
|
||||
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
|
||||
icon:
|
||||
logo: material/book-open-page-variant
|
||||
repo: fontawesome/brands/github
|
||||
markdown_extensions:
|
||||
- pymdownx.superfences
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.highlight:
|
||||
linenums: true
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- tables
|
||||
- footnotes
|
||||
- pymdownx.caret
|
||||
- pymdownx.tilde
|
||||
- pymdownx.mark
|
||||
extra_css:
|
||||
- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
paths:
|
||||
- ..
|
||||
options:
|
||||
docstring_style: google
|
||||
show_source: false
|
||||
show_signature_annotations: true
|
||||
separate_signature: true
|
||||
merge_init_into_class: true
|
||||
inherited_members: true
|
||||
annotations_path: brief
|
||||
show_root_heading: true
|
||||
group_by_category: true
|
||||
show_category_heading: true
|
||||
show_object_full_path: false
|
||||
show_symbol_type_heading: true
|
||||
site_name: omniread
|
||||
docs_dir: lib
|
||||
site_dir: ../site/lib
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Core API:
|
||||
- core/index.md
|
||||
- core/content.md
|
||||
- core/parser.md
|
||||
- core/scraper.md
|
||||
- HTML Handling:
|
||||
- html/index.md
|
||||
- html/parser.md
|
||||
- html/scraper.md
|
||||
- PDF Handling:
|
||||
- pdf/index.md
|
||||
- pdf/client.md
|
||||
- pdf/parser.md
|
||||
- pdf/scraper.md
|
||||
@@ -1,46 +0,0 @@
|
||||
"""
|
||||
Programmatic MkDocs build script for OmniRead.
|
||||
|
||||
This script builds (or serves) the documentation by invoking MkDocs
|
||||
*as a Python library*, not via shell commands.
|
||||
|
||||
Requirements:
|
||||
- mkdocs
|
||||
- mkdocs-material
|
||||
- mkdocstrings[python]
|
||||
|
||||
Usage:
|
||||
python generate_docs.py
|
||||
python generate_docs.py --serve
|
||||
"""
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from mkdocs.commands import build as mkdocs_build
|
||||
from mkdocs.commands import serve as mkdocs_serve
|
||||
from mkdocs.config import load_config
|
||||
|
||||
|
||||
PROJECT_ROOT = Path(__file__).resolve().parent
|
||||
MKDOCS_YML = PROJECT_ROOT / "mkdocs.yml"
|
||||
|
||||
|
||||
def main() -> None:
|
||||
if not MKDOCS_YML.exists():
|
||||
raise FileNotFoundError("mkdocs.yml not found at project root")
|
||||
|
||||
# Load MkDocs configuration programmatically
|
||||
config = load_config(str(MKDOCS_YML))
|
||||
|
||||
# Decide mode
|
||||
if "--serve" in sys.argv:
|
||||
# Live-reload development server
|
||||
mkdocs_serve.serve(config)
|
||||
else:
|
||||
# Static site build
|
||||
mkdocs_build.build(config)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
53
mkdocs.yml
53
mkdocs.yml
@@ -1,53 +0,0 @@
|
||||
site_name: Aetoskia OmniRead
|
||||
site_description: Format-agnostic document reading, parsing, and scraping framework
|
||||
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- scheme: slate
|
||||
primary: deep purple
|
||||
accent: cyan
|
||||
font:
|
||||
text: Inter
|
||||
code: JetBrains Mono
|
||||
features:
|
||||
- navigation.tabs
|
||||
- navigation.expand
|
||||
- navigation.top
|
||||
- navigation.instant
|
||||
- content.code.copy
|
||||
- content.code.annotate
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
paths: ["."]
|
||||
options:
|
||||
docstring_style: google
|
||||
show_source: false
|
||||
show_signature_annotations: true
|
||||
separate_signature: true
|
||||
merge_init_into_class: true
|
||||
inherited_members: true
|
||||
annotations_path: brief
|
||||
show_root_heading: true
|
||||
group_by_category: true
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
|
||||
- Core (Contracts):
|
||||
- Content Models: core/content.md
|
||||
- Parsers: core/parser.md
|
||||
- Scrapers: core/scraper.md
|
||||
|
||||
- HTML Implementation:
|
||||
- HTML Parser: html/parser.md
|
||||
- HTML Scraper: html/scraper.md
|
||||
|
||||
- PDF Implementation:
|
||||
- PDF Client: pdf/client.md
|
||||
- PDF Parser: pdf/parser.md
|
||||
- PDF Scraper: pdf/scraper.md
|
||||
@@ -1,116 +1,154 @@
|
||||
"""
|
||||
OmniRead — format-agnostic content acquisition and parsing framework.
|
||||
# Summary
|
||||
|
||||
OmniRead provides a **cleanly layered architecture** for fetching, parsing,
|
||||
`OmniRead` — format-agnostic content acquisition and parsing framework.
|
||||
|
||||
`OmniRead` provides a **cleanly layered architecture** for fetching, parsing,
|
||||
and normalizing content from heterogeneous sources such as HTML documents
|
||||
and PDF files.
|
||||
|
||||
The library is structured around three core concepts:
|
||||
|
||||
1. **Content**
|
||||
A canonical, format-agnostic container representing raw content bytes
|
||||
and minimal contextual metadata.
|
||||
1. **`Content`**: A canonical, format-agnostic container representing raw content
|
||||
bytes and minimal contextual metadata.
|
||||
2. **`Scrapers`**: Components responsible for *acquiring* raw content from a
|
||||
source (HTTP, filesystem, object storage, etc.). `Scrapers` never interpret
|
||||
content.
|
||||
3. **`Parsers`**: Components responsible for *interpreting* acquired content and
|
||||
converting it into structured, typed representations.
|
||||
|
||||
2. **Scrapers**
|
||||
Components responsible for *acquiring* raw content from a source
|
||||
(HTTP, filesystem, object storage, etc.). Scrapers never interpret
|
||||
content.
|
||||
`OmniRead` deliberately separates these responsibilities to ensure:
|
||||
|
||||
3. **Parsers**
|
||||
Components responsible for *interpreting* acquired content and
|
||||
converting it into structured, typed representations.
|
||||
- Clear boundaries between IO and interpretation.
|
||||
- Replaceable implementations per format.
|
||||
- Predictable, testable behavior.
|
||||
|
||||
OmniRead deliberately separates these responsibilities to ensure:
|
||||
- Clear boundaries between IO and interpretation
|
||||
- Replaceable implementations per format
|
||||
- Predictable, testable behavior
|
||||
# Installation
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Installation
|
||||
----------------------------------------------------------------------
|
||||
Install `OmniRead` using pip:
|
||||
|
||||
Install OmniRead using pip:
|
||||
```bash
|
||||
pip install omniread
|
||||
```
|
||||
|
||||
pip install omniread
|
||||
Install OmniRead using Poetry:
|
||||
```bash
|
||||
poetry add omniread
|
||||
```
|
||||
|
||||
Or with Poetry:
|
||||
---
|
||||
|
||||
poetry add omniread
|
||||
## Quick start
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Basic Usage
|
||||
----------------------------------------------------------------------
|
||||
Example:
|
||||
HTML example:
|
||||
```python
|
||||
from omniread import HTMLScraper, HTMLParser
|
||||
|
||||
HTML example:
|
||||
scraper = HTMLScraper()
|
||||
content = scraper.fetch("https://example.com")
|
||||
|
||||
from omniread import HTMLScraper, HTMLParser
|
||||
class TitleParser(HTMLParser[str]):
|
||||
def parse(self) -> str:
|
||||
return self._soup.title.string
|
||||
|
||||
scraper = HTMLScraper()
|
||||
content = scraper.fetch("https://example.com")
|
||||
parser = TitleParser(content)
|
||||
title = parser.parse()
|
||||
```
|
||||
|
||||
class TitleParser(HTMLParser[str]):
|
||||
def parse(self) -> str:
|
||||
return self._soup.title.string
|
||||
PDF example:
|
||||
```python
|
||||
from omniread import FileSystemPDFClient, PDFScraper, PDFParser
|
||||
from pathlib import Path
|
||||
|
||||
parser = TitleParser(content)
|
||||
title = parser.parse()
|
||||
client = FileSystemPDFClient()
|
||||
scraper = PDFScraper(client=client)
|
||||
content = scraper.fetch(Path("document.pdf"))
|
||||
|
||||
PDF example:
|
||||
class TextPDFParser(PDFParser[str]):
|
||||
def parse(self) -> str:
|
||||
# implement PDF text extraction
|
||||
...
|
||||
|
||||
from omniread import FileSystemPDFClient, PDFScraper, PDFParser
|
||||
from pathlib import Path
|
||||
parser = TextPDFParser(content)
|
||||
result = parser.parse()
|
||||
```
|
||||
|
||||
client = FileSystemPDFClient()
|
||||
scraper = PDFScraper(client=client)
|
||||
content = scraper.fetch(Path("document.pdf"))
|
||||
---
|
||||
|
||||
class TextPDFParser(PDFParser[str]):
|
||||
def parse(self) -> str:
|
||||
# implement PDF text extraction
|
||||
...
|
||||
|
||||
parser = TextPDFParser(content)
|
||||
result = parser.parse()
|
||||
|
||||
----------------------------------------------------------------------
|
||||
Public API Surface
|
||||
----------------------------------------------------------------------
|
||||
# Public API
|
||||
|
||||
This module re-exports the **recommended public entry points** of OmniRead.
|
||||
|
||||
Consumers are encouraged to import from this namespace rather than from
|
||||
format-specific submodules directly, unless advanced customization is
|
||||
required.
|
||||
|
||||
Core:
|
||||
- Content
|
||||
- ContentType
|
||||
- `Content`: Canonical content model.
|
||||
- `ContentType`: Supported media types.
|
||||
- `HTMLScraper`: HTTP-based HTML acquisition.
|
||||
- `HTMLParser`: Base parser for HTML DOM interpretation.
|
||||
- `FileSystemPDFClient`: Local filesystem PDF access.
|
||||
- `PDFScraper`: PDF-specific content acquisition.
|
||||
- `PDFParser`: Base parser for PDF binary interpretation.
|
||||
- `FileSystemXlsxClient`: Local filesystem spreadsheet access.
|
||||
- `XlsxScraper`: XLSX-specific content acquisition.
|
||||
- `XlsxParser`: Generic string-row parser for xlsx workbooks.
|
||||
|
||||
HTML:
|
||||
- HTMLScraper
|
||||
- HTMLParser
|
||||
---
|
||||
|
||||
PDF:
|
||||
- FileSystemPDFClient
|
||||
- PDFScraper
|
||||
- PDFParser
|
||||
# Core Philosophy
|
||||
|
||||
`OmniRead` is designed as a **decoupled content engine**:
|
||||
|
||||
1. **Separation of Concerns**: Scrapers *fetch*, Parsers *interpret*. Neither
|
||||
knows about the other.
|
||||
2. **Normalized Exchange**: All components communicate via the `Content` model,
|
||||
ensuring a consistent contract.
|
||||
3. **Format Agnosticism**: The core logic is independent of whether the input
|
||||
is HTML, PDF, or JSON.
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .core import Content, ContentType
|
||||
from .csv import (
|
||||
BaseCsvClient,
|
||||
CsvParser,
|
||||
CsvParserBase,
|
||||
CsvScraper,
|
||||
FileSystemCsvClient,
|
||||
)
|
||||
from .html import HTMLScraper, HTMLParser
|
||||
from .pdf import FileSystemPDFClient, PDFScraper, PDFParser
|
||||
from .xlsx import (
|
||||
BaseXlsxClient,
|
||||
FileSystemXlsxClient,
|
||||
XlsxParser,
|
||||
XlsxParserBase,
|
||||
XlsxScraper,
|
||||
)
|
||||
|
||||
__all__ = [
|
||||
# core
|
||||
"Content",
|
||||
"ContentType",
|
||||
|
||||
# html
|
||||
"HTMLScraper",
|
||||
"HTMLParser",
|
||||
|
||||
# pdf
|
||||
"FileSystemPDFClient",
|
||||
"PDFScraper",
|
||||
"PDFParser",
|
||||
# csv
|
||||
"BaseCsvClient",
|
||||
"FileSystemCsvClient",
|
||||
"CsvScraper",
|
||||
"CsvParser",
|
||||
"CsvParserBase",
|
||||
# xlsx
|
||||
"BaseXlsxClient",
|
||||
"FileSystemXlsxClient",
|
||||
"XlsxScraper",
|
||||
"XlsxParser",
|
||||
"XlsxParserBase",
|
||||
]
|
||||
|
||||
13
omniread/__init__.pyi
Normal file
13
omniread/__init__.pyi
Normal file
@@ -0,0 +1,13 @@
|
||||
from .core import Content, ContentType
|
||||
from .html import HTMLParser, HTMLScraper
|
||||
from .pdf import FileSystemPDFClient, PDFParser, PDFScraper
|
||||
|
||||
__all__ = [
|
||||
"Content",
|
||||
"ContentType",
|
||||
"HTMLScraper",
|
||||
"HTMLParser",
|
||||
"FileSystemPDFClient",
|
||||
"PDFScraper",
|
||||
"PDFParser",
|
||||
]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Core domain contracts for OmniRead.
|
||||
|
||||
This package defines the **format-agnostic domain layer** of OmniRead.
|
||||
@@ -9,11 +11,21 @@ Public exports from this package are considered **stable contracts** and
|
||||
are safe for downstream consumers to depend on.
|
||||
|
||||
Submodules:
|
||||
- content: Canonical content models and enums
|
||||
- parser: Abstract parsing contracts
|
||||
- scraper: Abstract scraping contracts
|
||||
|
||||
- `content`: Canonical content models and enums.
|
||||
- `parser`: Abstract parsing contracts.
|
||||
- `scraper`: Abstract scraping contracts.
|
||||
|
||||
Format-specific behavior must not be introduced at this layer.
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `Content`
|
||||
- `ContentType`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .content import Content, ContentType
|
||||
|
||||
10
omniread/core/__init__.pyi
Normal file
10
omniread/core/__init__.pyi
Normal file
@@ -0,0 +1,10 @@
|
||||
from .content import Content, ContentType
|
||||
from .parser import BaseParser
|
||||
from .scraper import BaseScraper
|
||||
|
||||
__all__ = [
|
||||
"Content",
|
||||
"ContentType",
|
||||
"BaseParser",
|
||||
"BaseScraper",
|
||||
]
|
||||
@@ -1,4 +1,6 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Canonical content models for OmniRead.
|
||||
|
||||
This module defines the **format-agnostic content representation** used across
|
||||
@@ -9,18 +11,23 @@ retrieved or parsed. Format-specific behavior and metadata must not alter
|
||||
the semantic meaning of these models.
|
||||
"""
|
||||
|
||||
from enum import Enum
|
||||
from collections.abc import Mapping
|
||||
from dataclasses import dataclass
|
||||
from typing import Any, Mapping, Optional
|
||||
from enum import Enum
|
||||
from typing import Any
|
||||
|
||||
|
||||
class ContentType(str, Enum):
|
||||
"""
|
||||
Supported MIME types for extracted content.
|
||||
|
||||
This enum represents the declared or inferred media type of the content
|
||||
source. It is primarily used for routing content to the appropriate
|
||||
parser or downstream consumer.
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- This enum represents the declared or inferred media type of the
|
||||
content source.
|
||||
- It is primarily used for routing content to the appropriate
|
||||
parser or downstream consumer.
|
||||
"""
|
||||
|
||||
HTML = "text/html"
|
||||
@@ -29,6 +36,12 @@ class ContentType(str, Enum):
|
||||
PDF = "application/pdf"
|
||||
"""PDF document content."""
|
||||
|
||||
XLSX = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
|
||||
"""Office Open XML spreadsheet (xlsx/xlsm) content."""
|
||||
|
||||
CSV = "text/csv"
|
||||
"""Comma-separated-value document content."""
|
||||
|
||||
JSON = "application/json"
|
||||
"""JSON document content."""
|
||||
|
||||
@@ -41,23 +54,31 @@ class Content:
|
||||
"""
|
||||
Normalized representation of extracted content.
|
||||
|
||||
A `Content` instance represents a raw content payload along with minimal
|
||||
contextual metadata describing its origin and type.
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
This class is the **primary exchange format** between:
|
||||
- Scrapers
|
||||
- Parsers
|
||||
- Downstream consumers
|
||||
|
||||
Attributes:
|
||||
raw: Raw content bytes as retrieved from the source.
|
||||
source: Identifier of the content origin (URL, file path, or logical name).
|
||||
content_type: Optional MIME type of the content, if known.
|
||||
metadata: Optional, implementation-defined metadata associated with
|
||||
the content (e.g., headers, encoding hints, extraction notes).
|
||||
- A `Content` instance represents a raw content payload along with
|
||||
minimal contextual metadata describing its origin and type.
|
||||
- This class is the primary exchange format between scrapers,
|
||||
parsers, and downstream consumers.
|
||||
"""
|
||||
|
||||
raw: bytes
|
||||
"""
|
||||
Raw content bytes as retrieved from the source.
|
||||
"""
|
||||
|
||||
source: str
|
||||
content_type: Optional[ContentType] = None
|
||||
metadata: Optional[Mapping[str, Any]] = None
|
||||
"""
|
||||
Identifier of the content origin (URL, file path, or logical name).
|
||||
"""
|
||||
|
||||
content_type: ContentType | None = None
|
||||
"""
|
||||
Optional MIME type of the content, if known.
|
||||
"""
|
||||
|
||||
metadata: Mapping[str, Any] | None = None
|
||||
"""
|
||||
Optional, implementation-defined metadata associated with the content (e.g., headers, encoding hints, extraction notes).
|
||||
"""
|
||||
|
||||
24
omniread/core/content.pyi
Normal file
24
omniread/core/content.pyi
Normal file
@@ -0,0 +1,24 @@
|
||||
from collections.abc import Mapping
|
||||
from enum import Enum
|
||||
from typing import Any
|
||||
|
||||
class ContentType(str, Enum):
|
||||
HTML = "text/html"
|
||||
PDF = "application/pdf"
|
||||
XLSX = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
|
||||
CSV = "text/csv"
|
||||
JSON = "application/json"
|
||||
XML = "application/xml"
|
||||
|
||||
class Content:
|
||||
raw: bytes
|
||||
source: str
|
||||
content_type: ContentType | None
|
||||
metadata: Mapping[str, Any] | None
|
||||
def __init__(
|
||||
self,
|
||||
raw: bytes,
|
||||
source: str,
|
||||
content_type: ContentType | None = ...,
|
||||
metadata: Mapping[str, Any] | None = ...,
|
||||
) -> None: ...
|
||||
@@ -1,22 +1,26 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Abstract parsing contracts for OmniRead.
|
||||
|
||||
This module defines the **format-agnostic parser interface** used to transform
|
||||
raw content into structured, typed representations.
|
||||
|
||||
Parsers are responsible for:
|
||||
|
||||
- Interpreting a single `Content` instance
|
||||
- Validating compatibility with the content type
|
||||
- Producing a structured output suitable for downstream consumers
|
||||
|
||||
Parsers are not responsible for:
|
||||
|
||||
- Fetching or acquiring content
|
||||
- Performing retries or error recovery
|
||||
- Managing multiple content sources
|
||||
"""
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Generic, TypeVar, Set
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
from .content import Content, ContentType
|
||||
|
||||
@@ -27,23 +31,24 @@ class BaseParser(ABC, Generic[T]):
|
||||
"""
|
||||
Base interface for all parsers.
|
||||
|
||||
A parser is a self-contained object that owns the Content
|
||||
it is responsible for interpreting.
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
Implementations must:
|
||||
- Declare supported content types via `supported_types`
|
||||
- Raise parsing-specific exceptions from `parse()`
|
||||
- Remain deterministic for a given input
|
||||
- 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()`.
|
||||
|
||||
Consumers may rely on:
|
||||
- Early validation of content compatibility
|
||||
- Type-stable return values from `parse()`
|
||||
**Responsibilities:**
|
||||
|
||||
- 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.
|
||||
"""
|
||||
|
||||
supported_types: Set[ContentType] = set()
|
||||
"""Set of content types supported by this parser.
|
||||
|
||||
An empty set indicates that the parser is content-type agnostic.
|
||||
supported_types: set[ContentType] = set()
|
||||
"""
|
||||
Set of content types supported by this parser. An empty set indicates that the parser is content-type agnostic.
|
||||
"""
|
||||
|
||||
def __init__(self, content: Content):
|
||||
@@ -51,10 +56,12 @@ class BaseParser(ABC, Generic[T]):
|
||||
Initialize the parser with content to be parsed.
|
||||
|
||||
Args:
|
||||
content: Content instance to be parsed.
|
||||
content (Content):
|
||||
Content instance to be parsed.
|
||||
|
||||
Raises:
|
||||
ValueError: If the content type is not supported by this parser.
|
||||
ValueError:
|
||||
If the content type is not supported by this parser.
|
||||
"""
|
||||
|
||||
self.content = content
|
||||
@@ -70,14 +77,19 @@ class BaseParser(ABC, Generic[T]):
|
||||
"""
|
||||
Parse the owned content into structured output.
|
||||
|
||||
Implementations must fully consume the provided content and
|
||||
return a deterministic, structured output.
|
||||
|
||||
Returns:
|
||||
Parsed, structured representation.
|
||||
T:
|
||||
Parsed, structured representation.
|
||||
|
||||
Raises:
|
||||
Exception: Parsing-specific errors as defined by the implementation.
|
||||
Exception:
|
||||
Parsing-specific errors as defined by the implementation.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Implementations must fully consume the provided content and
|
||||
return a deterministic, structured output.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
@@ -86,7 +98,8 @@ class BaseParser(ABC, Generic[T]):
|
||||
Check whether this parser supports the content's type.
|
||||
|
||||
Returns:
|
||||
True if the content type is supported; False otherwise.
|
||||
bool:
|
||||
True if the content type is supported; False otherwise.
|
||||
"""
|
||||
|
||||
if not self.supported_types:
|
||||
|
||||
14
omniread/core/parser.pyi
Normal file
14
omniread/core/parser.pyi
Normal file
@@ -0,0 +1,14 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
from .content import Content, ContentType
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
class BaseParser(ABC, Generic[T]):
|
||||
supported_types: set[ContentType]
|
||||
content: Content
|
||||
def __init__(self, content: Content) -> None: ...
|
||||
@abstractmethod
|
||||
def parse(self) -> T: ...
|
||||
def supports(self) -> bool: ...
|
||||
@@ -1,15 +1,19 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
Abstract scraping contracts for OmniRead.
|
||||
|
||||
This module defines the **format-agnostic scraper interface** responsible for
|
||||
acquiring raw content from external sources.
|
||||
|
||||
Scrapers are responsible for:
|
||||
|
||||
- Locating and retrieving raw content bytes
|
||||
- Attaching minimal contextual metadata
|
||||
- Returning normalized `Content` objects
|
||||
|
||||
Scrapers are explicitly NOT responsible for:
|
||||
|
||||
- Parsing or interpreting content
|
||||
- Inferring structure or semantics
|
||||
- Performing content-type specific processing
|
||||
@@ -18,7 +22,8 @@ All interpretation must be delegated to parsers.
|
||||
"""
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from typing import Any, Mapping, Optional
|
||||
from collections.abc import Mapping
|
||||
from typing import Any
|
||||
|
||||
from .content import Content
|
||||
|
||||
@@ -27,23 +32,21 @@ class BaseScraper(ABC):
|
||||
"""
|
||||
Base interface for all scrapers.
|
||||
|
||||
A scraper is responsible ONLY for fetching raw content
|
||||
(bytes) from a source. It must not interpret or parse it.
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
A scraper is a **stateless acquisition component** that retrieves raw
|
||||
content from a source and returns it as a `Content` object.
|
||||
- A scraper is responsible ONLY for fetching raw content (bytes)
|
||||
from a source. It must not interpret or parse it.
|
||||
- A scraper is a stateless acquisition component that retrieves raw
|
||||
content from a source and returns it as a `Content` object.
|
||||
- Scrapers define how content is obtained, not what the content means.
|
||||
- Implementations may vary in transport mechanism, authentication
|
||||
strategy, retry and backoff behavior.
|
||||
|
||||
Scrapers define *how content is obtained*, not *what the content means*.
|
||||
**Constraints:**
|
||||
|
||||
Implementations may vary in:
|
||||
- Transport mechanism (HTTP, filesystem, cloud storage)
|
||||
- Authentication strategy
|
||||
- Retry and backoff behavior
|
||||
|
||||
Implementations must not:
|
||||
- Parse content
|
||||
- Modify content semantics
|
||||
- Couple scraping logic to a specific parser
|
||||
- Implementations must not parse content, modify content semantics,
|
||||
or couple scraping logic to a specific parser.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
@@ -51,25 +54,30 @@ class BaseScraper(ABC):
|
||||
self,
|
||||
source: str,
|
||||
*,
|
||||
metadata: Optional[Mapping[str, Any]] = None,
|
||||
metadata: Mapping[str, Any] | None = None,
|
||||
) -> Content:
|
||||
"""
|
||||
Fetch raw content from the given source.
|
||||
|
||||
Implementations must retrieve the content referenced by `source`
|
||||
and return it as raw bytes wrapped in a `Content` object.
|
||||
|
||||
Args:
|
||||
source: Location identifier (URL, file path, S3 URI, etc.)
|
||||
metadata: Optional hints for the scraper (headers, auth, etc.)
|
||||
source (str):
|
||||
Location identifier (URL, file path, S3 URI, etc.).
|
||||
|
||||
metadata (Mapping[str, Any] | None, optional):
|
||||
Optional hints for the scraper (headers, auth, etc.).
|
||||
|
||||
Returns:
|
||||
Content object containing raw bytes and metadata.
|
||||
- Raw content bytes
|
||||
- Source identifier
|
||||
- Optional metadata
|
||||
Content:
|
||||
Content object containing raw bytes and metadata.
|
||||
|
||||
Raises:
|
||||
Exception: Retrieval-specific errors as defined by the implementation.
|
||||
Exception:
|
||||
Retrieval-specific errors as defined by the implementation.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Implementations must retrieve the content referenced by `source`
|
||||
and return it as raw bytes wrapped in a `Content` object.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
11
omniread/core/scraper.pyi
Normal file
11
omniread/core/scraper.pyi
Normal file
@@ -0,0 +1,11 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from collections.abc import Mapping
|
||||
from typing import Any
|
||||
|
||||
from .content import Content
|
||||
|
||||
class BaseScraper(ABC):
|
||||
@abstractmethod
|
||||
def fetch(
|
||||
self, source: str, *, metadata: Mapping[str, Any] | None = ...
|
||||
) -> Content: ...
|
||||
26
omniread/csv/__init__.py
Normal file
26
omniread/csv/__init__.py
Normal file
@@ -0,0 +1,26 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
CSV subpackage for OmniRead.
|
||||
|
||||
Provides acquisition and parsing of comma-separated-value content:
|
||||
|
||||
- `BaseCsvClient`: abstract backing-store client for csv bytes.
|
||||
- `FileSystemCsvClient`: local filesystem implementation.
|
||||
- `CsvScraper`: wraps fetched bytes into canonical `Content`.
|
||||
- `CsvParserBase`: content-type-enforcing parser contract.
|
||||
- `CsvParser`: generic string-row parser built on the standard csv module.
|
||||
"""
|
||||
|
||||
from .client import BaseCsvClient, FileSystemCsvClient
|
||||
from .parser import CsvParser
|
||||
from .parser_base import CsvParserBase
|
||||
from .scraper import CsvScraper
|
||||
|
||||
__all__ = [
|
||||
"BaseCsvClient",
|
||||
"FileSystemCsvClient",
|
||||
"CsvScraper",
|
||||
"CsvParser",
|
||||
"CsvParserBase",
|
||||
]
|
||||
12
omniread/csv/__init__.pyi
Normal file
12
omniread/csv/__init__.pyi
Normal file
@@ -0,0 +1,12 @@
|
||||
from .client import BaseCsvClient, FileSystemCsvClient
|
||||
from .parser import CsvParser
|
||||
from .parser_base import CsvParserBase
|
||||
from .scraper import CsvScraper
|
||||
|
||||
__all__ = [
|
||||
"BaseCsvClient",
|
||||
"FileSystemCsvClient",
|
||||
"CsvScraper",
|
||||
"CsvParser",
|
||||
"CsvParserBase",
|
||||
]
|
||||
97
omniread/csv/client.py
Normal file
97
omniread/csv/client.py
Normal file
@@ -0,0 +1,97 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
CSV client abstractions for OmniRead.
|
||||
|
||||
This module defines the **client layer** responsible for retrieving raw
|
||||
comma-separated-value document bytes from a concrete backing store.
|
||||
|
||||
Clients provide low-level access to csv binaries and are intentionally
|
||||
decoupled from scraping and parsing logic. They do not perform validation,
|
||||
interpretation, or content extraction.
|
||||
|
||||
Typical backing stores include:
|
||||
|
||||
- Local filesystems
|
||||
- Object storage (S3, GCS, etc.)
|
||||
- Network file systems
|
||||
"""
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
|
||||
class BaseCsvClient(ABC):
|
||||
"""
|
||||
Abstract client responsible for retrieving csv bytes.
|
||||
|
||||
Retrieves bytes from a specific backing store (filesystem, S3, FTP, etc.).
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Implementations must accept a source identifier appropriate to
|
||||
the backing store.
|
||||
- Return the full csv binary payload.
|
||||
- Raise retrieval-specific errors on failure.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def fetch(self, source: Any) -> bytes:
|
||||
"""
|
||||
Fetch raw csv bytes from the given source.
|
||||
|
||||
Args:
|
||||
source (Any):
|
||||
Identifier of the csv location, such as a file path,
|
||||
object storage key, or remote reference.
|
||||
|
||||
Returns:
|
||||
bytes:
|
||||
Raw csv bytes.
|
||||
|
||||
Raises:
|
||||
Exception:
|
||||
Retrieval-specific errors defined by the implementation.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
|
||||
|
||||
class FileSystemCsvClient(BaseCsvClient):
|
||||
"""
|
||||
CSV client that reads from the local filesystem.
|
||||
|
||||
Notes:
|
||||
**Guarantees:**
|
||||
|
||||
- This client reads csv files directly from the disk and
|
||||
returns their raw binary contents.
|
||||
"""
|
||||
|
||||
def fetch(self, path: Path) -> bytes:
|
||||
"""
|
||||
Read a csv file from the local filesystem.
|
||||
|
||||
Args:
|
||||
path (Path):
|
||||
Filesystem path to the csv file.
|
||||
|
||||
Returns:
|
||||
bytes:
|
||||
Raw csv bytes.
|
||||
|
||||
Raises:
|
||||
FileNotFoundError:
|
||||
If the path does not exist.
|
||||
ValueError:
|
||||
If the path exists but is not a file.
|
||||
"""
|
||||
|
||||
if not path.exists():
|
||||
raise FileNotFoundError(f"csv not found: {path}")
|
||||
|
||||
if not path.is_file():
|
||||
raise ValueError(f"Path is not a file: {path}")
|
||||
|
||||
return path.read_bytes()
|
||||
10
omniread/csv/client.pyi
Normal file
10
omniread/csv/client.pyi
Normal file
@@ -0,0 +1,10 @@
|
||||
from abc import ABC, abstractmethod
|
||||
from pathlib import Path
|
||||
from typing import Any
|
||||
|
||||
class BaseCsvClient(ABC):
|
||||
@abstractmethod
|
||||
def fetch(self, source: Any) -> bytes: ...
|
||||
|
||||
class FileSystemCsvClient(BaseCsvClient):
|
||||
def fetch(self, path: Path) -> bytes: ...
|
||||
102
omniread/csv/parser.py
Normal file
102
omniread/csv/parser.py
Normal file
@@ -0,0 +1,102 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
CSV parser implementations for OmniRead.
|
||||
|
||||
This module provides a concrete, generic parser for comma-separated-value
|
||||
documents. It exposes records as lists of string cells so downstream
|
||||
consumers can interpret tabular content without depending on the ``csv``
|
||||
module directly.
|
||||
|
||||
The parser is intentionally statement-agnostic: it performs no header
|
||||
detection or column interpretation beyond basic cell normalization and
|
||||
delimiter detection.
|
||||
"""
|
||||
|
||||
from csv import Sniffer, reader
|
||||
from io import StringIO
|
||||
|
||||
from omniread.core.content import Content
|
||||
|
||||
from .parser_base import CsvParserBase
|
||||
|
||||
|
||||
class CsvParser(CsvParserBase[list[list[str]]]):
|
||||
"""
|
||||
Generic csv parser producing string rows from the document.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Decode the payload (UTF-8 with BOM support, Latin-1 fallback).
|
||||
- Detect the delimiter from a leading sample (`,` `;` tab `|`),
|
||||
defaulting to `,`.
|
||||
- Normalize cells into deterministic stripped string values.
|
||||
- Expose row extraction helpers mirroring `XlsxParser.rows`.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- All values are strings; consumers requiring typed values must
|
||||
convert on their side.
|
||||
- Quoted fields containing delimiters/newlines are handled by
|
||||
the standard ``csv`` module.
|
||||
"""
|
||||
|
||||
_DELIMITERS = ",;\t|"
|
||||
|
||||
def __init__(self, content: Content):
|
||||
"""
|
||||
Initialize the parser.
|
||||
|
||||
Args:
|
||||
content (Content):
|
||||
CSV content to parse; its type must be supported.
|
||||
"""
|
||||
super().__init__(content)
|
||||
|
||||
def parse(self) -> list[list[str]]:
|
||||
"""
|
||||
Parse the document into normalized string rows.
|
||||
|
||||
Returns:
|
||||
list[list[str]]:
|
||||
Rows of the document.
|
||||
"""
|
||||
return self.rows()
|
||||
|
||||
def rows(self, *, skip_empty: bool = True) -> list[list[str]]:
|
||||
"""
|
||||
Extract normalized string rows from the document.
|
||||
|
||||
Args:
|
||||
skip_empty (bool):
|
||||
When True (default), rows whose cells are all blank are
|
||||
omitted.
|
||||
|
||||
Returns:
|
||||
list[list[str]]:
|
||||
Normalized rows; trailing blank cells are trimmed per row.
|
||||
"""
|
||||
text = self._decode(self.content.raw)
|
||||
dialect_sample = text[:4096]
|
||||
try:
|
||||
dialect = Sniffer().sniff(dialect_sample, delimiters=self._DELIMITERS)
|
||||
delimiter = dialect.delimiter
|
||||
except Exception:
|
||||
delimiter = ","
|
||||
out: list[list[str]] = []
|
||||
for row in reader(StringIO(text), delimiter=delimiter):
|
||||
cells = [c.strip() for c in row]
|
||||
while cells and not cells[-1]:
|
||||
cells.pop()
|
||||
if skip_empty and not any(cells):
|
||||
continue
|
||||
out.append(cells)
|
||||
return out
|
||||
|
||||
@staticmethod
|
||||
def _decode(raw: bytes) -> str:
|
||||
try:
|
||||
return raw.decode("utf-8-sig")
|
||||
except UnicodeDecodeError:
|
||||
return raw.decode("latin-1")
|
||||
8
omniread/csv/parser.pyi
Normal file
8
omniread/csv/parser.pyi
Normal file
@@ -0,0 +1,8 @@
|
||||
from omniread.core.content import Content
|
||||
|
||||
from .parser_base import CsvParserBase
|
||||
|
||||
class CsvParser(CsvParserBase[list[list[str]]]):
|
||||
def __init__(self, content: Content) -> None: ...
|
||||
def parse(self) -> list[list[str]]: ...
|
||||
def rows(self, *, skip_empty: bool = True) -> list[list[str]]: ...
|
||||
55
omniread/csv/parser_base.py
Normal file
55
omniread/csv/parser_base.py
Normal file
@@ -0,0 +1,55 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
CSV parser base implementation for OmniRead.
|
||||
|
||||
This module defines the **CSV-specific parser contract**, extending the
|
||||
format-agnostic `BaseParser` with constraints appropriate for
|
||||
comma-separated-value documents.
|
||||
"""
|
||||
|
||||
from abc import abstractmethod
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
from omniread.core.content import ContentType
|
||||
from omniread.core.parser import BaseParser
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
|
||||
class CsvParserBase(BaseParser[T], Generic[T]):
|
||||
"""
|
||||
Base csv parser.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- This class enforces csv content-type compatibility and provides
|
||||
the extension point for implementing concrete csv parsing
|
||||
strategies.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- Concrete implementations must define the output type `T` and
|
||||
implement the `parse()` method.
|
||||
"""
|
||||
|
||||
supported_types = {ContentType.CSV}
|
||||
"""
|
||||
Set of content types supported by this parser (CSV only).
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def parse(self) -> T:
|
||||
"""
|
||||
Parse csv content into a structured output.
|
||||
|
||||
Returns:
|
||||
T:
|
||||
Parsed representation of type `T`.
|
||||
|
||||
Raises:
|
||||
Exception:
|
||||
Parsing-specific errors as defined by the implementation.
|
||||
"""
|
||||
raise NotImplementedError
|
||||
13
omniread/csv/parser_base.pyi
Normal file
13
omniread/csv/parser_base.pyi
Normal file
@@ -0,0 +1,13 @@
|
||||
from abc import abstractmethod
|
||||
from typing import Generic, TypeVar
|
||||
|
||||
from omniread.core.content import ContentType
|
||||
from omniread.core.parser import BaseParser
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
class CsvParserBase(BaseParser[T], Generic[T]):
|
||||
supported_types: set[ContentType]
|
||||
|
||||
@abstractmethod
|
||||
def parse(self) -> T: ...
|
||||
81
omniread/csv/scraper.py
Normal file
81
omniread/csv/scraper.py
Normal file
@@ -0,0 +1,81 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
CSV scraper for OmniRead.
|
||||
|
||||
This module defines the scraper responsible for acquiring raw
|
||||
comma-separated-value document content from a backing store via a
|
||||
configured client.
|
||||
|
||||
The scraper does not interpret or parse the acquired bytes; it wraps them in
|
||||
the canonical `Content` model.
|
||||
"""
|
||||
|
||||
from collections.abc import Mapping
|
||||
from typing import Any
|
||||
|
||||
from omniread.core.content import Content, ContentType
|
||||
|
||||
from .client import BaseCsvClient
|
||||
|
||||
|
||||
class CsvScraper:
|
||||
"""
|
||||
Scraper for csv documents.
|
||||
|
||||
Notes:
|
||||
**Responsibilities:**
|
||||
|
||||
- Fetch raw csv bytes via the configured client.
|
||||
- Wrap the payload in a canonical `Content` instance with the
|
||||
CSV content type and source identifier.
|
||||
|
||||
**Constraints:**
|
||||
|
||||
- The scraper does not perform parsing or interpretation.
|
||||
- Does not assume a specific storage backend.
|
||||
"""
|
||||
|
||||
def __init__(self, *, client: BaseCsvClient):
|
||||
"""
|
||||
Initialize the CSV scraper.
|
||||
|
||||
Args:
|
||||
client (BaseCsvClient):
|
||||
Client responsible for retrieving raw csv bytes.
|
||||
"""
|
||||
self._client = client
|
||||
|
||||
def fetch(
|
||||
self,
|
||||
source: Any,
|
||||
*,
|
||||
metadata: Mapping[str, Any] | None = None,
|
||||
) -> Content:
|
||||
"""
|
||||
Fetch a csv document from the given source.
|
||||
|
||||
Args:
|
||||
source (Any):
|
||||
Identifier of the csv source as understood by the
|
||||
configured client.
|
||||
metadata (Mapping[str, Any] | None, optional):
|
||||
Optional metadata to attach to the returned content.
|
||||
|
||||
Returns:
|
||||
Content:
|
||||
A `Content` instance containing raw csv bytes, source
|
||||
identifier, CSV content type, and optional metadata.
|
||||
|
||||
Raises:
|
||||
Exception:
|
||||
Retrieval-specific errors raised by the client.
|
||||
"""
|
||||
raw = self._client.fetch(source)
|
||||
|
||||
return Content(
|
||||
raw=raw,
|
||||
source=source,
|
||||
content_type=ContentType.CSV,
|
||||
metadata=dict(metadata) if metadata else None,
|
||||
)
|
||||
12
omniread/csv/scraper.pyi
Normal file
12
omniread/csv/scraper.pyi
Normal file
@@ -0,0 +1,12 @@
|
||||
from collections.abc import Mapping
|
||||
from typing import Any
|
||||
|
||||
from omniread.core.content import Content
|
||||
|
||||
from .client import BaseCsvClient
|
||||
|
||||
class CsvScraper:
|
||||
def __init__(self, *, client: BaseCsvClient) -> None: ...
|
||||
def fetch(
|
||||
self, source: Any, *, metadata: Mapping[str, Any] | None = ...
|
||||
) -> Content: ...
|
||||
@@ -1,22 +1,34 @@
|
||||
"""
|
||||
# Summary
|
||||
|
||||
HTML format implementation for OmniRead.
|
||||
|
||||
This package provides **HTML-specific implementations** of the core OmniRead
|
||||
contracts defined in `omniread.core`.
|
||||
|
||||
It includes:
|
||||
- HTML parsers that interpret HTML content
|
||||
- HTML scrapers that retrieve HTML documents
|
||||
|
||||
This package:
|
||||
- Implements, but does not redefine, core contracts
|
||||
- May contain HTML-specific behavior and edge-case handling
|
||||
- Produces canonical content models defined in `omniread.core.content`
|
||||
- HTML parsers that interpret HTML content.
|
||||
- HTML scrapers that retrieve HTML documents.
|
||||
|
||||
Key characteristics:
|
||||
|
||||
- Implements, but does not redefine, core contracts.
|
||||
- May contain HTML-specific behavior and edge-case handling.
|
||||
- Produces canonical content models defined in `omniread.core.content`.
|
||||
|
||||
Consumers should depend on `omniread.core` interfaces wherever possible and
|
||||
use this package only when HTML-specific behavior is required.
|
||||
"""
|
||||
|
||||
---
|
||||
|
||||
# Public API
|
||||
|
||||
- `HTMLScraper`
|
||||
- `HTMLParser`
|
||||
|
||||
---
|
||||
"""
|
||||
|
||||
from .scraper import HTMLScraper
|
||||
from .parser import HTMLParser
|
||||
|
||||
4
omniread/html/__init__.pyi
Normal file
4
omniread/html/__init__.pyi
Normal file
@@ -0,0 +1,4 @@
|
||||
from .parser import HTMLParser
|
||||
from .scraper import HTMLScraper
|
||||
|
||||
__all__ = ["HTMLScraper", "HTMLParser"]
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user