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

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
@@ -18,14 +18,14 @@ class ResultEnum(str, Enum):
 
 class Check(BaseModel):
     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
+    result: ResultEnum | None
+    engine: str | None
+    reason: str | None = None
+    model: str | None = None
+    field: str | None = None
+    details: str | None = None
+    diagnostics: dict | None = None
 
 
 class Log(BaseModel):
@@ -36,16 +36,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>
 

datacontract/templates/partials/quality.html

@@ -0,0 +1,49 @@
+<div class="mt-2">
+  <span class="italic">Quality | {{quality.type|upper}}:</span> {{ quality.description }}
+  {% if quality.type == 'sql' and quality.query %}
+  <div class="pl-4">
+    Query:
+    <div class="ring-1 ring-inset ring-gray-500/10 bg-gray-50 p-2 rounded-md"><pre><code>{{ quality.query }}</code></pre></div>
+    {% if quality.mustBe != None %}
+    <div>
+      Must Be: <span class="font-mono font-bold"> {{quality.mustBe}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustNotBe != None %}
+    <div>
+      Must Not Be: <span class="font-mono font-bold"> {{quality.mustNotBe}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustBeGreaterThan != None %}
+    <div>
+      Must Be Greater Than: <span class="font-mono font-bold"> {{quality.mustBeGreaterThan}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustBeGreaterThanOrEqualTo != None %}
+    <div>
+      Must Be Greater Than Or Equal To: <span class="font-mono font-bold"> {{quality.mustBeGreaterThanOrEqualTo}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustBeLessThan != None %}
+    <div>
+      Must Be Less Than: <span class="font-mono font-bold"> {{quality.mustBeLessThan}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustBeLessThanOrEqualTo != None %}
+    <div>
+      Must Be Less Than Or Equal To: <span class="font-mono font-bold"> {{quality.mustBeLessThanOrEqualTo}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustBeBetween %}
+    <div>
+      Must Be Between: <span class="font-mono font-bold"> {{quality.mustBeBetween|join(' and ')}}</span>
+    </div>
+    {% endif %}
+    {% if quality.mustNotBeBetween %}
+    <div>
+      Must Not Be Between: <span class="font-mono font-bold"> {{quality.mustNotBeBetween}}</span>
+    </div>
+    {% endif %}
+  </div>
+  {% endif %}
+</div>