datacontract-cli 0.10.13__py3-none-any.whl → 0.10.15__py3-none-any.whl

datacontract/model/data_contract_specification.py

@@ -1,9 +1,35 @@
 import os
-from typing import List, Dict, Optional, Any
+from typing import Any, Dict, List, Optional
 
 import pydantic as pyd
 import yaml
 
+DATACONTRACT_TYPES = [
+    "string",
+    "text",
+    "varchar",
+    "number",
+    "decimal",
+    "numeric",
+    "int",
+    "integer",
+    "long",
+    "bigint",
+    "float",
+    "double",
+    "boolean",
+    "timestamp",
+    "timestamp_tz",
+    "timestamp_ntz",
+    "date",
+    "array",
+    "bytes",
+    "object",
+    "record",
+    "struct",
+    "null",
+]
+
 
 class Contact(pyd.BaseModel):
     name: str = None
@@ -15,6 +41,14 @@ class Contact(pyd.BaseModel):
     )
 
 
+class ServerRole(pyd.BaseModel):
+    name: str = None
+    description: str = None
+    model_config = pyd.ConfigDict(
+        extra="allow",
+    )
+
+
 class Server(pyd.BaseModel):
     type: str = None
     description: str = None
@@ -38,6 +72,7 @@ class Server(pyd.BaseModel):
     dataProductId: str = None
     outputPortId: str = None
     driver: str = None
+    roles: List[ServerRole] = None
 
     model_config = pyd.ConfigDict(
         extra="allow",
@@ -83,19 +118,41 @@ class Definition(pyd.BaseModel):
     )
 
 
+class Quality(pyd.BaseModel):
+    type: str = None
+    description: str = None
+    query: str = None
+    dialect: str = None
+    mustBe: int = None
+    mustNotBe: int = None
+    mustBeGreaterThan: int = None
+    mustBeGreaterThanOrEqualTo: int = None
+    mustBeLessThan: int = None
+    mustBeLessThanOrEqualTo: int = None
+    mustBeBetween: List[int] = None
+    mustNotBeBetween: List[int] = None
+    engine: str = None
+    implementation: str | Dict[str, Any] = None
+
+    model_config = pyd.ConfigDict(
+        extra="allow",
+    )
+
+
 class Field(pyd.BaseModel):
     ref: str = pyd.Field(default=None, alias="$ref")
     ref_obj: Definition = pyd.Field(default=None, exclude=True)
-    title: str = None
+    title: str | None = None
     type: str = None
     format: str = None
     required: bool = None
     primary: bool = None
-    unique: bool = None
+    primaryKey: bool = None
+    unique: bool | None = None
     references: str = None
-    description: str = None
-    pii: bool = None
-    classification: str = None
+    description: str | None = None
+    pii: bool | None = None
+    classification: str | None = None
     pattern: str = None
     minLength: int = None
     maxLength: int = None
@@ -103,8 +160,8 @@ class Field(pyd.BaseModel):
     exclusiveMinimum: int = None
     maximum: int = None
     exclusiveMaximum: int = None
-    enum: List[str] = []
-    tags: List[str] = []
+    enum: List[str] | None = []
+    tags: List[str] | None = []
     links: Dict[str, str] = {}
     fields: Dict[str, "Field"] = {}
     items: "Field" = None
@@ -113,7 +170,9 @@ class Field(pyd.BaseModel):
     precision: int = None
     scale: int = None
     example: str = None
-    config: Dict[str, Any] = None
+    examples: List[Any] | None = None
+    quality: List[Quality] | None = []
+    config: Dict[str, Any] | None = None
 
     model_config = pyd.ConfigDict(
         extra="allow",
@@ -126,7 +185,13 @@ class Model(pyd.BaseModel):
     namespace: Optional[str] = None
     title: Optional[str] = None
     fields: Dict[str, Field] = {}
+    quality: List[Quality] | None = []
     config: Dict[str, Any] = None
+    tags: List[str] | None = None
+
+    model_config = pyd.ConfigDict(
+        extra="allow",
+    )
 
 
 class Info(pyd.BaseModel):
@@ -218,9 +283,14 @@ class DataContractSpecification(pyd.BaseModel):
     terms: Terms = None
     models: Dict[str, Model] = {}
     definitions: Dict[str, Definition] = {}
-    # schema: Dict[str, str]
-    examples: List[Example] = []
-    quality: Quality = None
+    examples: List[Example] = pyd.Field(
+        default_factory=list,
+        deprecated="Removed in Data Contract Specification " "v1.1.0. Use models.examples instead.",
+    )
+    quality: Quality = pyd.Field(
+        default=None,
+        deprecated="Removed in Data Contract Specification v1.1.0. Use " "model-level and field-level quality instead.",
+    )
     servicelevels: Optional[ServiceLevel] = None
     links: Dict[str, str] = {}
     tags: List[str] = []
@@ -228,7 +298,7 @@ class DataContractSpecification(pyd.BaseModel):
     @classmethod
     def from_file(cls, file):
         if not os.path.exists(file):
-            raise (f"The file '{file}' does not exist.")
+            raise FileNotFoundError(f"The file '{file}' does not exist.")
         with open(file, "r") as file:
             file_content = file.read()
         return DataContractSpecification.from_string(file_content)

datacontract/model/odcs.py

@@ -0,0 +1,11 @@
+def is_open_data_contract_standard(odcs: dict) -> bool:
+    """
+    Check if the given dictionary is an OpenDataContractStandard.
+
+    Args:
+        odcs (dict): The dictionary to check.
+
+    Returns:
+        bool: True if the dictionary is an OpenDataContractStandard, False otherwise.
+    """
+    return odcs.get("kind") == "DataContract" and odcs.get("apiVersion", "").startswith("v3")

datacontract/model/run.py

@@ -1,15 +1,24 @@
 import logging
 from datetime import datetime, timezone
+from enum import Enum
 from typing import List, Optional
 from uuid import UUID, uuid4
 
 from pydantic import BaseModel
 
 
+class ResultEnum(str, Enum):
+    passed = "passed"
+    warning = "warning"
+    failed = "failed"
+    error = "error"
+    unknown = "unknown"
+
+
 class Check(BaseModel):
     type: str
     name: Optional[str]
-    result: str  # passed, failed, warning, unknown
+    result: ResultEnum
     engine: str
     reason: Optional[str] = None
     model: Optional[str] = None
@@ -33,29 +42,29 @@ class Run(BaseModel):
     server: Optional[str] = None
     timestampStart: datetime
     timestampEnd: datetime
-    result: str = "unknown"  # passed, warning, failed, error, unknown
+    result: ResultEnum = ResultEnum.unknown
     checks: List[Check]
     logs: List[Log]
 
     def has_passed(self):
         self.calculate_result()
-        return self.result == "passed"
+        return self.result == ResultEnum.passed
 
     def finish(self):
         self.timestampEnd = datetime.now(timezone.utc)
         self.calculate_result()
 
     def calculate_result(self):
-        if any(check.result == "error" for check in self.checks):
-            self.result = "error"
-        elif any(check.result == "failed" for check in self.checks):
-            self.result = "failed"
-        elif any(check.result == "warning" for check in self.checks):
-            self.result = "warning"
-        elif any(check.result == "passed" for check in self.checks):
-            self.result = "passed"
+        if any(check.result == ResultEnum.error for check in self.checks):
+            self.result = ResultEnum.error
+        elif any(check.result == ResultEnum.failed for check in self.checks):
+            self.result = ResultEnum.failed
+        elif any(check.result == ResultEnum.warning for check in self.checks):
+            self.result = ResultEnum.warning
+        elif any(check.result == ResultEnum.passed for check in self.checks):
+            self.result = ResultEnum.passed
         else:
-            self.result = "unknown"
+            self.result = ResultEnum.unknown
 
     def log_info(self, message: str):
         logging.info(message)

datacontract/templates/index.html

@@ -78,17 +78,17 @@
 
               <li class="col-span-1 rounded-lg bg-white shadow hover:bg-gray-50"
                   data-search="{{
-    contract.spec.info.title|lower }} {{
-    contract.spec.info.owner|lower if contract.spec.info.owner else '' }} {{
-    contract.spec.info.description|lower }} {%
+    contract.spec.info.title|lower|e }} {{
+    contract.spec.info.owner|lower|e if contract.spec.info.owner else '' }} {{
+    contract.spec.info.description|lower|e }} {%
     for model_name, model in contract.spec.models.items() %}
-      {{ model.description|lower }} {%
+      {{ model.description|lower|e }} {%
       for field_name, field in model.fields.items() %}
-        {{ field_name|lower }} {{ field.description|lower if field.description else '' }} {%
+        {{ field_name|lower|e }} {{ field.description|lower|e if field.description else '' }} {%
       endfor %}
     {% endfor %}
   ">
-                <a href="{{contract.html_link}}" >
+                <a href="{{contract.html_link|e}}" >
                   <div class="flex w-full justify-between space-x-1 p-6 pb-4">
                     <div class="flex-1 truncate">
                       <div class="flex items-center space-x-3">

datacontract/web.py

@@ -1,11 +1,10 @@
-from typing import Annotated, Union, Optional
+from typing import Annotated, Optional, Union
 
 import typer
 from fastapi import FastAPI, File
-from fastapi.responses import HTMLResponse
+from fastapi.responses import HTMLResponse, PlainTextResponse
 
 from datacontract.data_contract import DataContract, ExportFormat
-from fastapi.responses import PlainTextResponse
 
 app = FastAPI()