datacontract-cli 0.10.20__py3-none-any.whl → 0.10.22__py3-none-any.whl

datacontract/model/data_contract_specification.py

@@ -1,5 +1,5 @@
 import os
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List
 
 import pydantic as pyd
 import yaml
@@ -32,9 +32,9 @@ DATACONTRACT_TYPES = [
 
 
 class Contact(pyd.BaseModel):
-    name: str = None
-    url: str = None
-    email: str = None
+    name: str | None = None
+    url: str | None = None
+    email: str | None = None
 
     model_config = pyd.ConfigDict(
         extra="allow",
@@ -42,37 +42,37 @@ class Contact(pyd.BaseModel):
 
 
 class ServerRole(pyd.BaseModel):
-    name: str = None
-    description: str = None
+    name: str | None = None
+    description: str | None = None
     model_config = pyd.ConfigDict(
         extra="allow",
     )
 
 
 class Server(pyd.BaseModel):
-    type: str = None
-    description: str = None
-    environment: str = None
-    format: str = None
-    project: str = None
-    dataset: str = None
-    path: str = None
-    delimiter: str = None
-    endpointUrl: str = None
-    location: str = None
-    account: str = None
-    database: str = None
-    schema_: str = pyd.Field(default=None, alias="schema")
-    host: str = None
-    port: int = None
-    catalog: str = None
-    topic: str = None
-    http_path: str = None  # Use ENV variable
-    token: str = None  # Use ENV variable
-    dataProductId: str = None
-    outputPortId: str = None
-    driver: str = None
-    storageAccount: str = None
+    type: str | None = None
+    description: str | None = None
+    environment: str | None = None
+    format: str | None = None
+    project: str | None = None
+    dataset: str | None = None
+    path: str | None = None
+    delimiter: str | None = None
+    endpointUrl: str | None = None
+    location: str | None = None
+    account: str | None = None
+    database: str | None = None
+    schema_: str | None = pyd.Field(default=None, alias="schema")
+    host: str | None = None
+    port: int | None = None
+    catalog: str | None = None
+    topic: str | None = None
+    http_path: str | None = None  # Use ENV variable
+    token: str | None = None  # Use ENV variable
+    dataProductId: str | None = None
+    outputPortId: str | None = None
+    driver: str | None = None
+    storageAccount: str | None = None
     roles: List[ServerRole] = None
 
     model_config = pyd.ConfigDict(
@@ -81,11 +81,11 @@ class Server(pyd.BaseModel):
 
 
 class Terms(pyd.BaseModel):
-    usage: str = None
-    limitations: str = None
-    billing: str = None
-    noticePeriod: str = None
-    description: str = None
+    usage: str | None = None
+    limitations: str | None = None
+    billing: str | None = None
+    noticePeriod: str | None = None
+    description: str | None = None
 
     model_config = pyd.ConfigDict(
         extra="allow",
@@ -93,26 +93,27 @@ class Terms(pyd.BaseModel):
 
 
 class Definition(pyd.BaseModel):
-    domain: str = None
-    name: str = None
-    title: str = None
-    description: str = None
-    type: str = None
+    domain: str | None = None
+    name: str | None = None
+    title: str | None = None
+    description: str | None = None
+    type: str | None = None
     enum: List[str] = []
-    format: str = None
-    minLength: int = None
-    maxLength: int = None
-    pattern: str = None
-    minimum: int = None
-    exclusiveMinimum: int = None
-    maximum: int = None
-    exclusiveMaximum: int = None
-    pii: bool = None
-    classification: str = None
+    format: str | None = None
+    minLength: int | None = None
+    maxLength: int | None = None
+    pattern: str | None = None
+    minimum: int | None = None
+    exclusiveMinimum: int | None = None
+    maximum: int | None = None
+    exclusiveMaximum: int | None = None
+    pii: bool | None = None
+    classification: str | None = None
     fields: Dict[str, "Field"] = {}
+    items: "Field" = None
     tags: List[str] = []
     links: Dict[str, str] = {}
-    example: str = None
+    example: str | None = None
     examples: List[Any] | None = None
 
     model_config = pyd.ConfigDict(
@@ -121,20 +122,20 @@ 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
+    type: str | None = None
+    description: str | None = None
+    query: str | None = None
+    dialect: str | None = None
+    mustBe: int | None = None
+    mustNotBe: int | None = None
+    mustBeGreaterThan: int | None = None
+    mustBeGreaterThanOrEqualTo: int | None = None
+    mustBeLessThan: int | None = None
+    mustBeLessThanOrEqualTo: int | None = None
     mustBeBetween: List[int] = None
     mustNotBeBetween: List[int] = None
-    engine: str = None
-    implementation: str | Dict[str, Any] = None
+    engine: str | None = None
+    implementation: str | Dict[str, Any] | None = None
 
     model_config = pyd.ConfigDict(
         extra="allow",
@@ -144,26 +145,26 @@ class Quality(pyd.BaseModel):
 class Field(pyd.BaseModel):
     ref: str = pyd.Field(default=None, alias="$ref")
     title: str | None = None
-    type: str = None
-    format: str = None
-    required: bool = None
+    type: str | None = None
+    format: str | None = None
+    required: bool | None = None
     primary: bool = pyd.Field(
         default=None,
         deprecated="Removed in Data Contract Specification v1.1.0. Use primaryKey instead.",
     )
     primaryKey: bool | None = None
     unique: bool | None = None
-    references: str = None
+    references: str | None = None
     description: str | None = None
     pii: bool | None = None
     classification: str | None = None
-    pattern: str = None
-    minLength: int = None
-    maxLength: int = None
-    minimum: int = None
-    exclusiveMinimum: int = None
-    maximum: int = None
-    exclusiveMaximum: int = None
+    pattern: str | None = None
+    minLength: int | None = None
+    maxLength: int | None = None
+    minimum: int | None = None
+    exclusiveMinimum: int | None = None
+    maximum: int | None = None
+    exclusiveMaximum: int | None = None
     enum: List[str] | None = []
     tags: List[str] | None = []
     links: Dict[str, str] = {}
@@ -171,11 +172,11 @@ class Field(pyd.BaseModel):
     items: "Field" = None
     keys: "Field" = None
     values: "Field" = None
-    precision: int = None
-    scale: int = None
-    example: str = pyd.Field(
+    precision: int | None = None
+    scale: int | None = None
+    example: Any | None = pyd.Field(
         default=None,
-        deprecated="Removed in Data Contract Specification v1.1.0. Use " "examples instead.",
+        deprecated="Removed in Data Contract Specification v1.1.0. Use examples instead.",
     )
     examples: List[Any] | None = None
     quality: List[Quality] | None = []
@@ -187,10 +188,10 @@ class Field(pyd.BaseModel):
 
 
 class Model(pyd.BaseModel):
-    description: Optional[str] = None
-    type: Optional[str] = None
-    namespace: Optional[str] = None
-    title: Optional[str] = None
+    description: str | None = None
+    type: str | None = None
+    namespace: str | None = None
+    title: str | None = None
     fields: Dict[str, Field] = {}
     quality: List[Quality] | None = []
     primaryKey: List[str] | None = []
@@ -204,12 +205,12 @@ class Model(pyd.BaseModel):
 
 
 class Info(pyd.BaseModel):
-    title: str = None
-    version: str = None
-    status: str = None
-    description: str = None
-    owner: str = None
-    contact: Contact = None
+    title: str | None = None
+    version: str | None = None
+    status: str | None = None
+    description: str | None = None
+    owner: str | None = None
+    contact: Contact | None = None
 
     model_config = pyd.ConfigDict(
         extra="allow",
@@ -217,91 +218,91 @@ class Info(pyd.BaseModel):
 
 
 class Example(pyd.BaseModel):
-    type: str = None
-    description: str = None
-    model: str = None
+    type: str | None = None
+    description: str | None = None
+    model: str | None = None
     data: str | object = None
 
 
 # Deprecated Quality class
 class DeprecatedQuality(pyd.BaseModel):
-    type: str = None
+    type: str | None = None
     specification: str | object = None
 
 
 class Availability(pyd.BaseModel):
-    description: Optional[str] = None
-    percentage: Optional[str] = None
+    description: str | None = None
+    percentage: str | None = None
 
 
 class Retention(pyd.BaseModel):
-    description: Optional[str] = None
-    period: Optional[str] = None
-    unlimited: Optional[bool] = None
-    timestampField: Optional[str] = None
+    description: str | None = None
+    period: str | None = None
+    unlimited: bool | None = None
+    timestampField: str | None = None
 
 
 class Latency(pyd.BaseModel):
-    description: Optional[str] = None
-    threshold: Optional[str] = None
-    sourceTimestampField: Optional[str] = None
-    processedTimestampField: Optional[str] = None
+    description: str | None = None
+    threshold: str | None = None
+    sourceTimestampField: str | None = None
+    processedTimestampField: str | None = None
 
 
 class Freshness(pyd.BaseModel):
-    description: Optional[str] = None
-    threshold: Optional[str] = None
-    timestampField: Optional[str] = None
+    description: str | None = None
+    threshold: str | None = None
+    timestampField: str | None = None
 
 
 class Frequency(pyd.BaseModel):
-    description: Optional[str] = None
-    type: Optional[str] = None
-    interval: Optional[str] = None
-    cron: Optional[str] = None
+    description: str | None = None
+    type: str | None = None
+    interval: str | None = None
+    cron: str | None = None
 
 
 class Support(pyd.BaseModel):
-    description: Optional[str] = None
-    time: Optional[str] = None
-    responseTime: Optional[str] = None
+    description: str | None = None
+    time: str | None = None
+    responseTime: str | None = None
 
 
 class Backup(pyd.BaseModel):
-    description: Optional[str] = None
-    interval: Optional[str] = None
-    cron: Optional[str] = None
-    recoveryTime: Optional[str] = None
-    recoveryPoint: Optional[str] = None
+    description: str | None = None
+    interval: str | None = None
+    cron: str | None = None
+    recoveryTime: str | None = None
+    recoveryPoint: str | None = None
 
 
 class ServiceLevel(pyd.BaseModel):
-    availability: Optional[Availability] = None
-    retention: Optional[Retention] = None
-    latency: Optional[Latency] = None
-    freshness: Optional[Freshness] = None
-    frequency: Optional[Frequency] = None
-    support: Optional[Support] = None
-    backup: Optional[Backup] = None
+    availability: Availability | None = None
+    retention: Retention | None = None
+    latency: Latency | None = None
+    freshness: Freshness | None = None
+    frequency: Frequency | None = None
+    support: Support | None = None
+    backup: Backup | None = None
 
 
 class DataContractSpecification(pyd.BaseModel):
-    dataContractSpecification: str = None
-    id: str = None
-    info: Info = None
+    dataContractSpecification: str | None = None
+    id: str | None = None
+    info: Info | None = None
     servers: Dict[str, Server] = {}
-    terms: Terms = None
+    terms: Terms | None = None
     models: Dict[str, Model] = {}
     definitions: Dict[str, Definition] = {}
     examples: List[Example] = pyd.Field(
         default_factory=list,
         deprecated="Removed in Data Contract Specification " "v1.1.0. Use models.examples instead.",
     )
-    quality: DeprecatedQuality = pyd.Field(
+    quality: DeprecatedQuality | None = 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
+    servicelevels: ServiceLevel | None = None
     links: Dict[str, str] = {}
     tags: List[str] = []
 

datacontract/model/exceptions.py

@@ -1,3 +1,6 @@
+from datacontract.model.run import ResultEnum
+
+
 class DataContractException(Exception):
     """Exception raised for errors in the execution of a run.
 
@@ -19,7 +22,7 @@ class DataContractException(Exception):
         engine="datacontract",
         model=None,
         original_exception=None,
-        result: str = "failed",
+        result: ResultEnum = ResultEnum.failed,
         message="Run operation failed",
     ):
         self.type = type

datacontract/model/run.py

@@ -1,7 +1,7 @@
 import logging
 from datetime import datetime, timezone
 from enum import Enum
-from typing import List, Optional
+from typing import List
 from uuid import UUID, uuid4
 
 from pydantic import BaseModel
@@ -17,15 +17,22 @@ class ResultEnum(str, Enum):
 
 
 class Check(BaseModel):
+    id: str | None = None
+    key: str | None = None
+    category: str | None = None
     type: str
-    name: Optional[str]
-    result: ResultEnum
-    engine: str
-    reason: Optional[str] = None
-    model: Optional[str] = None
-    field: Optional[str] = None
-    details: Optional[str] = None
-    diagnostics: Optional[dict] = None
+    name: str | None = None
+    model: str | None = None
+    field: str | None = None
+
+    engine: str | None = None
+    language: str | None = None
+    implementation: str | None = None
+
+    result: ResultEnum | None = None
+    reason: str | None = None
+    details: str | None = None
+    diagnostics: dict | None = None
 
 
 class Log(BaseModel):
@@ -36,16 +43,16 @@ class Log(BaseModel):
 
 class Run(BaseModel):
     runId: UUID
-    dataContractId: Optional[str] = None
-    dataContractVersion: Optional[str] = None
-    dataProductId: Optional[str] = None
-    outputPortId: Optional[str] = None
-    server: Optional[str] = None
-    timestampStart: datetime
-    timestampEnd: datetime
+    dataContractId: str | None = None
+    dataContractVersion: str | None = None
+    dataProductId: str | None = None
+    outputPortId: str | None = None
+    server: str | None = None
+    timestampStart: datetime | None
+    timestampEnd: datetime | None
     result: ResultEnum = ResultEnum.unknown
-    checks: List[Check]
-    logs: List[Log]
+    checks: List[Check] | None
+    logs: List[Log] | None
 
     def has_passed(self):
         self.calculate_result()

datacontract/templates/datacontract.html

@@ -146,14 +146,28 @@
                         {{ render_partial('partials/model_field.html', nested = False, field_name=field_name, field = field, level = 0) }}
                       {% endfor %}
                       </tbody>
-                      {% if model.primaryKey %}
-                      <tfoot class="bg-gray-50">
+                      {% if model.primaryKey or model.quality %}
+                      <tfoot class="divide-y divide-gray-200 bg-white">
+                      {% if model.quality %}
+                      {% for quality in model.quality %}
                       <tr>
+                        <th scope="colgroup" colspan="4"
+                            class="py-2 pl-4 pr-3 text-left text-sm font-normal sm:pl-6 bg-white">
+                          {{ render_partial('partials/quality.html', quality = quality)}}
+                        </th>
+                      </tr>
+                      {% endfor %}
+                      {% endif %}
+
+                      {% if model.primaryKey %}
+                      <tr class="bg-gray-50">
                         <th scope="colgroup" colspan="4"
                             class="py-2 pl-4 pr-3 text-left text-sm font-semibold text-gray-900 sm:pl-6">
                           <span>Primary Key: {{ model.primaryKey }}</span>
                         </th>
                       </tr>
+                      {% endif %}
+
                       </tfoot>
                       {% endif %}
                     </table>

datacontract/templates/partials/definition.html

@@ -3,112 +3,20 @@
     <div class="inline-block min-w-full py-2 align-middle sm:px-6 lg:px-8">
       <div class="overflow-hidden shadow ring-1 ring-black ring-opacity-5 sm:rounded-lg">
 
-        <table class="min-w-full divide-y divide-gray-300">
+        <table class="min-w-full divide-y divide-gray-300" id="/definitions/{{ definition_name }}">
           <thead class="bg-gray-50">
           <tr>
             <th scope="colgroup" colspan="3" class="py-2 pl-4 pr-3 text-left font-semibold text-gray-900 sm:pl-6">
               <span>{{ definition_name }}</span>
-              <span class="inline-flex items-center rounded-md bg-gray-50 px-2 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10">{{ definition.domain }}</span>
               <div class="text-sm font-medium text-gray-500">{{ definition.description }}</div>
             </th>
           </tr>
           </thead>
           <tbody class="divide-y divide-gray-200 bg-white">
-            <tr id="/definitions/{{ definition_name }}">
-              <td class="whitespace-nowrap py-2 pl-4 pr-2 text-sm font-medium text-gray-900 sm:pl-6 w-2/12">
-                <div class="py-2 text-sm">
-                  {% if definition.title %}
-                  <div>{{ definition.title }}</div>
-                  {% endif %}
-                  <div class="font-mono">{{ definition_name }}</div>
-                </div>
-              </td>
-              <td class="whitespace-nowrap px-1 py-2 text-sm text-gray-500 w-1/12">
-                <div class="py-2 text-sm">
-                  {{ definition.type }}
-                  {% if definition.format %}
-                    <span class="inline-flex items-center rounded-md bg-blue-50 px-1 py-1 text-xs font-medium text-blue-600 ring-1 ring-inset ring-blue-500/10 mr-1 mt-1">{{ definition.format }}</span>
-                  {% endif %}
-                </div>
-              </td>
-              <td class="px-3 py-2 text-sm text-gray-500 w-9/12">
-                {% if definition.example %}
-                <div class="mt-1 italic">
-                  <span class="text-gray-600">Example:</span> <span class="font-mono">{{ definition.example }}</span>
-                </div>
-                {% endif %}
 
-                {% if definition.examples %}
-                <div class="mt-1 italic">
-                  <span class="text-gray-600">Examples:</span>
-                  {% for example in definition.examples %}
-                  <span class="font-mono">{{ example }}</span>{% if not loop.last %}, {% endif %}
-                  {% endfor %}
-                </div>
-                {% endif %}
+          {{ render_partial('partials/model_field.html', nested = False, field_name=definition_name,
+          field = definition, level = 0) }}
 
-                {% if definition.tags %}
-                <div>
-                  <span class="text-gray-600 italic">Tags:</span>
-                  {% for tag in definition.tags %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">{{ tag }}</span>
-                  {% endfor %}
-                </div>
-                {% endif %}
-                {% if definition.enum %}
-                <div class="py-2 text-sm">
-                  <span class="text-gray-600 italic">Enum:</span>
-                  {% for value in definition.enum %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">{{ value }}</span>
-                  {% endfor %}
-                </div>
-                {% endif %}
-                <div>
-                  {% if definition.minLength %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">minLength:{{ definition.minLength }}</span>
-                  {% endif %}
-                  {% if definition.maxLength %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">maxLength:{{ definition.maxLength }}</span>
-                  {% endif %}
-                  {% if definition.pattern %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">pattern:{{ definition.pattern }}</span>
-                  {% endif %}
-                  {% if definition.precision %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">precision:{{ definition.precision }}</span>
-                  {% endif %}
-                  {% if definition.scale %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">scale:{{ definition.scale }}</span>
-                  {% endif %}
-                  {% if definition.minimum %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">minimum:{{ definition.minimum }}</span>
-                  {% endif %}
-                  {% if definition.exclusiveMinimum %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">exclusiveMinimum:{{ definition.exclusiveMinimum }}</span>
-                  {% endif %}
-                  {% if definition.maximum %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">maximum:{{ definition.maximum }}</span>
-                  {% endif %}
-                  {% if definition.exclusiveMaximum %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">exclusiveMaximum:{{ definition.exclusiveMaximum }}</span>
-                  {% endif %}
-                  {% if definition.classification %}
-                  <span class="inline-flex items-center rounded-md bg-blue-50 px-1 py-1 text-xs font-medium text-blue-600 ring-1 ring-inset ring-blue-500/10 mr-1 mt-1">{{ definition.classification }}</span>
-                  {% endif %}
-                  {% if definition.pii %}
-                  <span class="inline-flex items-center rounded-md bg-yellow-50 px-1 py-1 text-xs font-medium text-yellow-600 ring-1 ring-inset ring-yellow-500/10 mr-1 mt-1">PII</span>
-                  {% endif %}
-                  {% for key, value in definition.model_extra.items()  %}
-                  <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">{{ key }}:{{ value }}</span>
-                  {% endfor %}
-                  {% if definition.links %}
-                    {% for name,href in definition.links.items() %}
-                    <a href="{{ href }}" class="inline-flex items-center px-1 py-1 mr-1 mt-1 text-sky-500 hover:text-gray-700 text-xs font-semibold">{{ name }}</a>
-                    {% endfor %}
-                  {% endif %}
-                </div>
-              </td>
-
-            </tr>
           </tbody>
         </table>
       </div>

datacontract/templates/partials/model_field.html

@@ -48,6 +48,14 @@
     </div>
     {% endif %}
 
+    {% if field.enum %}
+    <div class="mt-1 italic">
+      Enum:
+      {% for enum_value in field.enum %}
+      <span class="font-mono">{{ enum_value }}</span>{% if not loop.last %}, {% endif %}
+      {% endfor %}
+    </div>
+    {% endif %}
     <div>
       {% if field.primaryKey or field.primary %}
       <span class="inline-flex items-center rounded-md bg-gray-50 px-1 py-1 text-xs font-medium text-gray-600 ring-1 ring-inset ring-gray-500/10 mr-1 mt-1">primary</span>
@@ -103,6 +111,11 @@
       {% endfor %}
       {% endif %}
     </div>
+    {% if field.quality %}
+    {% for quality in field.quality %}
+    {{ render_partial('partials/quality.html', quality = quality) }}
+    {% endfor %}
+    {% endif %}
   </td>
 </tr>