roborean-documents-xlsx 0.1.2__py3-none-any.whl

roborean_documents_xlsx/driver.py

@@ -0,0 +1,161 @@
+"""XLSX document driver using openpyxl."""
+
+import io
+from dataclasses import dataclass, field
+from datetime import UTC, datetime
+from typing import Any, Mapping
+
+from openpyxl import Workbook, load_workbook
+from pydantic import TypeAdapter
+from roborean_documents_base.capabilities import assert_op_allowed
+from roborean_documents_base.resolve_values import public_literal_value
+from roborean_spec import (
+    DocumentDriverManifest,
+    DocumentOperation,
+    DocumentPreview,
+    TemplateManifest,
+    WorkspaceValue,
+)
+
+
+@dataclass
+class XlsxSession:
+    """Open workbook session."""
+
+    document_id: str
+    driver_id: str
+    workbook: Any
+    ops_applied: list[dict[str, Any]] = field(default_factory=list)
+
+
+class XlsxDocumentDriver:
+    """Spreadsheet driver with sheet.* operations."""
+
+    driver_id = "roborean.xlsx"
+    manifest = DocumentDriverManifest(
+        driverId="roborean.xlsx",
+        version="0.3.0",
+        irFamily="sheet",
+        capabilities=[
+            "set_metadata",
+            "replace_named_value",
+            "sheet.set_cell",
+            "sheet.set_formula",
+            "sheet.ensure_sheet",
+            "finalize",
+        ],
+        supportsPreview=True,
+        supportsBrowserExecution=False,
+        supportsDiff=True,
+        requiresBackend=True,
+        templateMediaTypes=[
+            "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+        ],
+    )
+
+    def __init__(self) -> None:
+        """Initialize empty template state."""
+        self._template: bytes | None = None
+        self._manifest: TemplateManifest | None = None
+
+    def load_template(self, template_ref, *, store, manifest) -> None:
+        """Load .xlsx template bytes."""
+        self._template = store.load_bytes(template_ref)
+        self._manifest = manifest
+
+    def begin_session(
+        self, workspace, metadata: Mapping[str, Any]
+    ) -> XlsxSession:
+        """Open a workbook from the template or a blank book."""
+        if self._template:
+            workbook = load_workbook(io.BytesIO(self._template))
+        else:
+            workbook = Workbook()
+        return XlsxSession(
+            document_id=str(metadata.get("documentId", "")),
+            driver_id=self.driver_id,
+            workbook=workbook,
+        )
+
+    def apply_operation(
+        self, session: XlsxSession, op: DocumentOperation
+    ) -> None:
+        """Apply one sheet operation."""
+        assert_op_allowed(self.manifest, op)
+        data = op.model_dump(mode="python", by_alias=True)
+        session.ops_applied.append(op.model_dump(mode="json", by_alias=True))
+        if op.op == "sheet.ensure_sheet":
+            name = str(data["name"])
+            if name not in session.workbook.sheetnames:
+                session.workbook.create_sheet(name)
+            return
+        if op.op == "sheet.set_cell":
+            sheet = session.workbook[str(data["sheet"])]
+            value = TypeAdapter(WorkspaceValue).validate_python(data["value"])
+            sheet[str(data["cell"])] = public_literal_value(value)
+            return
+        if op.op == "sheet.set_formula":
+            sheet = session.workbook[str(data["sheet"])]
+            formula = str(data["formula"])
+            if not formula.startswith("="):
+                formula = "=" + formula
+            sheet[str(data["cell"])] = formula
+
+    def finalize(self, session: XlsxSession) -> None:
+        """No-op finalize."""
+        return
+
+    def serialize(self, session: XlsxSession) -> bytes:
+        """Return .xlsx bytes."""
+        buffer = io.BytesIO()
+        session.workbook.save(buffer)
+        return buffer.getvalue()
+
+    def preview(self, session: XlsxSession) -> DocumentPreview:
+        """Build a simplified HTML table preview."""
+        max_rows = 50
+        parts = ['<div class="roborean-xlsx">']
+        for name in session.workbook.sheetnames:
+            sheet = session.workbook[name]
+            parts.append(f"<h3>{name}</h3><table>")
+            for index, row in enumerate(sheet.iter_rows(values_only=True)):
+                if index >= max_rows:
+                    break
+                cells = "".join(
+                    f"<td>{'' if c is None else c}</td>" for c in row
+                )
+                parts.append(f"<tr>{cells}</tr>")
+            parts.append("</table>")
+        parts.append("</div>")
+        return DocumentPreview(
+            documentId=session.document_id,
+            mode="html",
+            body="".join(parts),
+            warnings=[],
+            generatedAt=datetime.now(UTC).isoformat(),
+            renderer={
+                "package": "roborean-documents-xlsx",
+                "version": "0.3.0",
+            },
+        )
+
+
+def create_driver() -> XlsxDocumentDriver:
+    """Entry-point factory."""
+    return XlsxDocumentDriver()
+
+
+def xlsx_semantic_equal(a: bytes, b: bytes) -> bool:
+    """Compare sheet values/formulas; ignore workbook metadata."""
+    left = load_workbook(io.BytesIO(a), data_only=False)
+    right = load_workbook(io.BytesIO(b), data_only=False)
+    if left.sheetnames != right.sheetnames:
+        return False
+    for name in left.sheetnames:
+        lsheet = left[name]
+        rsheet = right[name]
+        lvals = [[cell.value for cell in row] for row in lsheet.iter_rows()]
+        rvals = [[cell.value for cell in row] for row in rsheet.iter_rows()]
+        if lvals != rvals:
+            return False
+    return True

roborean_documents_xlsx-0.1.2.dist-info/METADATA

@@ -0,0 +1,12 @@
+Metadata-Version: 2.4
+Name: roborean-documents-xlsx
+Version: 0.1.2
+Summary: XLSX document driver for Roborean
+Project-URL: Homepage, https://github.com/TNick/roborean
+Project-URL: Repository, https://github.com/TNick/roborean
+License-Expression: MIT
+Requires-Python: >=3.11
+Requires-Dist: defusedxml>=0.7
+Requires-Dist: openpyxl>=3.1
+Requires-Dist: roborean-documents-base>=0.1.1
+Requires-Dist: roborean-spec>=0.1.1

roborean_documents_xlsx-0.1.2.dist-info/RECORD

@@ -0,0 +1,5 @@
+roborean_documents_xlsx/driver.py,sha256=-J8xmKQXJIMwj828LiojHlFBR1nVHfhIKHfchJ80EHQ,5417
+roborean_documents_xlsx-0.1.2.dist-info/METADATA,sha256=GvWLMFP5xu8R6ytjzxdPUHQHgKctFway7b2K3zJJP7w,416
+roborean_documents_xlsx-0.1.2.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+roborean_documents_xlsx-0.1.2.dist-info/entry_points.txt,sha256=8JCbOouvoyHH4YNlPgBhpiPwyLan3o0c4aF1X8zIZ2A,89
+roborean_documents_xlsx-0.1.2.dist-info/RECORD,,

roborean_documents_xlsx-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any

roborean_documents_xlsx-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[roborean.document_drivers]
+roborean.xlsx = roborean_documents_xlsx.driver:create_driver