dataproduct-cli 0.0.1__py3-none-any.whl

dataproduct/model/exceptions.py

@@ -0,0 +1,23 @@
+from dataproduct.model.run import ResultEnum
+
+
+class DataProductException(Exception):
+    """A handled error surfaced as a check in the run result (no traceback)."""
+
+    def __init__(
+        self,
+        type: str,
+        name: str,
+        reason: str,
+        engine: str = "dataproduct",
+        result: ResultEnum = ResultEnum.error,
+    ):
+        self.type = type
+        self.name = name
+        self.reason = reason
+        self.engine = engine
+        self.result = result
+        super().__init__(reason)
+
+    def __str__(self) -> str:
+        return f"{self.name}: {self.reason}"

dataproduct/model/run.py

@@ -0,0 +1,69 @@
+"""Result model for a CLI run (lint, publish, …).
+
+Mirrors datacontract-cli's ``Run``/``Check`` shape closely so the two tools feel
+like siblings and share output tooling. The ``warning`` result level exists for
+parity and forward-compat; 0.1 emits only ``passed`` / ``error``.
+"""
+
+import logging
+from datetime import datetime, timezone
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+
+class ResultEnum(str, Enum):
+    passed = "passed"
+    warning = "warning"
+    error = "error"
+    failed = "failed"
+
+
+class Check(BaseModel):
+    type: str = "lint"
+    result: ResultEnum
+    name: str
+    reason: Optional[str] = None
+    engine: str = "dataproduct"
+    field: Optional[str] = None
+
+
+class Run(BaseModel):
+    result: ResultEnum = ResultEnum.passed
+    checks: List[Check] = Field(default_factory=list)
+    dataProductId: Optional[str] = None
+    dataProductVersion: Optional[str] = None
+    timestampStart: Optional[datetime] = None
+    timestampEnd: Optional[datetime] = None
+    logs: List[str] = Field(default_factory=list)
+
+    @classmethod
+    def create_run(cls) -> "Run":
+        return cls(timestampStart=datetime.now(timezone.utc))
+
+    def log_info(self, message: str) -> None:
+        logging.info(message)
+        self.logs.append(f"INFO {message}")
+
+    def log_warn(self, message: str) -> None:
+        logging.warning(message)
+        self.logs.append(f"WARN {message}")
+
+    def log_error(self, message: str) -> None:
+        logging.error(message)
+        self.logs.append(f"ERROR {message}")
+
+    def has_passed(self) -> bool:
+        return self.result == ResultEnum.passed
+
+    def finish(self) -> None:
+        """Compute the overall result and stamp the end time.
+
+        Any ``error`` check fails the run; ``warning`` checks do not.
+        """
+        self.timestampEnd = datetime.now(timezone.utc)
+        if any(c.result == ResultEnum.error for c in self.checks):
+            self.result = ResultEnum.failed
+        else:
+            self.result = ResultEnum.passed

dataproduct/output/output_format.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class OutputFormat(str, Enum):
+    json = "json"
+    junit = "junit"

dataproduct/output/result_writer.py

@@ -0,0 +1,77 @@
+"""Render a :class:`Run` to the console or a machine-readable file.
+
+Console output uses ``rich``; ``--output-format json|junit`` writes a file (or
+stdout). A failed run exits with code 1.
+"""
+
+from pathlib import Path
+from typing import Optional
+from xml.etree.ElementTree import Element, SubElement, tostring
+
+import typer
+
+from dataproduct.model.run import ResultEnum, Run
+from dataproduct.output.output_format import OutputFormat
+
+_ICON = {
+    ResultEnum.passed: "✅",
+    ResultEnum.warning: "⚠️ ",
+    ResultEnum.error: "❌",
+    ResultEnum.failed: "❌",
+}
+
+
+def write_result(run: Run, console, output_format: Optional[OutputFormat], output: Optional[Path]) -> None:
+    if output_format == OutputFormat.json:
+        _write_or_print(run.model_dump_json(indent=2), output, console)
+    elif output_format == OutputFormat.junit:
+        _write_or_print(_to_junit(run), output, console)
+    else:
+        _print_console(run, console)
+
+    if not run.has_passed():
+        raise typer.Exit(code=1)
+
+
+def _print_console(run: Run, console) -> None:
+    for check in run.checks:
+        icon = _ICON.get(check.result, "•")
+        line = f"{icon} {check.name}"
+        if check.reason:
+            line += f": {check.reason}"
+        console.print(line)
+    if run.has_passed():
+        console.print("[green]🟢 Data product is valid.[/green]")
+    else:
+        console.print("[red]🔴 Data product is invalid.[/red]")
+
+
+def _write_or_print(content: str, output: Optional[Path], console) -> None:
+    if output is not None:
+        Path(output).write_text(content)
+        console.print(f"📝 results written to {output}")
+    else:
+        print(content)
+
+
+def _to_junit(run: Run) -> str:
+    failures = sum(1 for c in run.checks if c.result in (ResultEnum.error, ResultEnum.failed))
+    testsuite = Element(
+        "testsuite",
+        {
+            "name": "dataproduct-lint",
+            "tests": str(len(run.checks)),
+            "failures": str(failures),
+            "errors": "0",
+        },
+    )
+    for check in run.checks:
+        testcase = SubElement(
+            testsuite,
+            "testcase",
+            {"classname": check.type, "name": check.name},
+        )
+        if check.result in (ResultEnum.error, ResultEnum.failed):
+            failure = SubElement(testcase, "failure", {"message": check.reason or check.name})
+            failure.text = check.reason or check.name
+    return '<?xml version="1.0" encoding="UTF-8"?>\n' + tostring(testsuite, encoding="unicode")

dataproduct/schemas/odps-1.0.0.init.yaml

@@ -0,0 +1,37 @@
+apiVersion: v1.0.0
+kind: DataProduct
+id: my-data-product-id
+name: My Data Product
+version: v1.0.0
+status: draft
+
+description:
+  purpose: Purpose of the data product.
+  usage: Intended usage of the data product.
+  limitations: Limitations of the data product.
+
+# tags: ['example']
+
+# inputPorts:
+#   - name: source-data
+#     version: 1.0.0
+#     contractId: 00000000-0000-0000-0000-000000000000
+
+outputPorts:
+  - name: my-output-port
+    description: The data this product exposes.
+    type: tables
+    version: 1.0.0
+    # contractId: 00000000-0000-0000-0000-000000000000
+
+# support:
+#   - channel: My Team Slack
+#     url: https://example.slack.com/archives/C0000000000
+#     tool: slack
+
+# team:
+#   name: My Team
+#   members:
+#     - username: jane.doe@example.com
+#       name: Jane Doe
+#       role: owner