omniread/docs/mcp/modules/omniread.csv.parser.json

{
  "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": {
      "Content": {
        "name": "Content",
        "kind": "class",
        "path": "omniread.csv.parser.Content",
        "signature": "Content(raw: bytes, source: str, content_type: ContentType | None = ..., metadata: Mapping[str, Any] | None = ...)",
        "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": null,
            "docstring": "Raw content bytes as retrieved from the source."
          },
          "source": {
            "name": "source",
            "kind": "attribute",
            "path": "omniread.csv.parser.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.csv.parser.Content.content_type",
            "signature": null,
            "docstring": "Optional MIME type of the content, if known."
          },
          "metadata": {
            "name": "metadata",
            "kind": "attribute",
            "path": "omniread.csv.parser.Content.metadata",
            "signature": null,
            "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": null,
        "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": null,
            "docstring": "Set of content types supported by this parser (CSV only)."
          },
          "parse": {
            "name": "parse",
            "kind": "function",
            "path": "omniread.csv.parser.CsvParserBase.parse",
            "signature": "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": "CsvParser(content: Content)",
        "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": "parse() -> list[list[str]]",
            "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": "rows(*, skip_empty: bool = True) -> list[list[str]]",
            "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."
          }
        }
      }
    }
  }
}