omniread/docs/mcp/modules/omniread.xlsx.parser_base.json

{
  "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": {
      "ContentType": {
        "name": "ContentType",
        "kind": "class",
        "path": "omniread.xlsx.parser_base.ContentType",
        "signature": null,
        "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": null,
            "docstring": "HTML document content."
          },
          "PDF": {
            "name": "PDF",
            "kind": "attribute",
            "path": "omniread.xlsx.parser_base.ContentType.PDF",
            "signature": null,
            "docstring": "PDF document content."
          },
          "XLSX": {
            "name": "XLSX",
            "kind": "attribute",
            "path": "omniread.xlsx.parser_base.ContentType.XLSX",
            "signature": null,
            "docstring": "Office Open XML spreadsheet (xlsx/xlsm) content."
          },
          "CSV": {
            "name": "CSV",
            "kind": "attribute",
            "path": "omniread.xlsx.parser_base.ContentType.CSV",
            "signature": null,
            "docstring": "Comma-separated-value document content."
          },
          "JSON": {
            "name": "JSON",
            "kind": "attribute",
            "path": "omniread.xlsx.parser_base.ContentType.JSON",
            "signature": null,
            "docstring": "JSON document content."
          },
          "XML": {
            "name": "XML",
            "kind": "attribute",
            "path": "omniread.xlsx.parser_base.ContentType.XML",
            "signature": null,
            "docstring": "XML document content."
          }
        }
      },
      "BaseParser": {
        "name": "BaseParser",
        "kind": "class",
        "path": "omniread.xlsx.parser_base.BaseParser",
        "signature": "BaseParser(content: Content)",
        "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": 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.xlsx.parser_base.BaseParser.content",
            "signature": null,
            "docstring": null
          },
          "parse": {
            "name": "parse",
            "kind": "function",
            "path": "omniread.xlsx.parser_base.BaseParser.parse",
            "signature": "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": "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": null,
        "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": "parse() -> T",
            "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."
          }
        }
      }
    }
  }
}