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

{
  "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": {
      "BaseXlsxClient": {
        "name": "BaseXlsxClient",
        "kind": "class",
        "path": "omniread.xlsx.client.BaseXlsxClient",
        "signature": null,
        "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": "fetch(source: Any) -> bytes",
            "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": null,
        "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": "fetch(path: Path) -> bytes",
            "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."
          }
        }
      }
    }
  }
}