dyff-schema 0.7.0__tar.gz → 0.7.2__tar.gz

{dyff_schema-0.7.0/dyff_schema.egg-info → dyff_schema-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.7.0
+Version: 0.7.2
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{dyff_schema-0.7.0 → dyff_schema-0.7.2}/dyff/schema/v0/r1/base.py

@@ -1,6 +1,7 @@
 # SPDX-FileCopyrightText: 2024 UL Research Institutes
 # SPDX-License-Identifier: Apache-2.0
 
+from datetime import datetime
 from typing import Any, Generic, NamedTuple, Optional, Type, TypeVar
 
 import pydantic
@@ -563,6 +564,14 @@ class DyffSchemaBaseModel(pydantic.BaseModel):
     Python reserved words like 'bytes' as field names.
     """
 
+    @pydantic.root_validator
+    def _require_datetime_timezone_aware(cls, values):
+        for k, v in values.items():
+            if isinstance(v, datetime):
+                if v.tzinfo is None:
+                    raise ValueError(f"{cls.__qualname__}.{k}: timezone not set")
+        return values
+
     def dict(self, *, by_alias: bool = True, **kwargs) -> dict[str, Any]:
         return super().dict(by_alias=by_alias, **kwargs)
 

{dyff_schema-0.7.0 → dyff_schema-0.7.2}/dyff/schema/v0/r1/platform.py

@@ -18,7 +18,7 @@ We use the following naming convention:
 # mypy: disable-error-code="import-untyped"
 import abc
 import enum
-from datetime import datetime
+from datetime import datetime, timezone
 from enum import Enum
 from typing import Any, Literal, NamedTuple, Optional, Type, Union
 
@@ -298,7 +298,7 @@ class Status(DyffSchemaBaseModel):
     )
 
 
-class Documentation(DyffSchemaBaseModel):
+class DocumentationBase(DyffSchemaBaseModel):
     title: Optional[str] = pydantic.Field(
         default=None,
         description='A short plain string suitable as a title or "headline".',
@@ -318,9 +318,13 @@ class Documentation(DyffSchemaBaseModel):
     )
 
 
+class Documentation(SchemaVersion, DocumentationBase):
+    pass
+
+
 class Documented(DyffSchemaBaseModel):
-    documentation: Documentation = pydantic.Field(
-        default_factory=Documentation,
+    documentation: DocumentationBase = pydantic.Field(
+        default_factory=DocumentationBase,
         description="Documentation of the resource. The content is used to"
         " populate various views in the web UI.",
     )
@@ -380,8 +384,8 @@ class Family(Labeled, SchemaVersion, DyffModelWithID):
         description="Tags mapping interpretable names to resource IDs.",
     )
 
-    documentation: Documentation = pydantic.Field(
-        default_factory=Documentation,
+    documentation: DocumentationBase = pydantic.Field(
+        default_factory=DocumentationBase,
         description="Documentation of the resource family. The content is used"
         " to populate various views in the web UI.",
     )
@@ -528,7 +532,10 @@ class AccessGrant(DyffSchemaBaseModel):
     )
 
 
-class APIKey(DyffSchemaBaseModel):
+# FIXME: We can't derive from DyffSchemaBaseModel right now because existing
+# APIKeys don't have a timezone set for their datetime members.
+# See: DYFF-406
+class APIKey(pydantic.BaseModel):
     """A description of a set of permissions granted to a single subject (either an
     account or a workload).
 
@@ -557,6 +564,22 @@ class APIKey(DyffSchemaBaseModel):
         default_factory=list, description="AccessGrants associated with the APIKey"
     )
 
+    @pydantic.root_validator
+    def _ensure_datetime_timezone_aware(cls, values):
+        update = {}
+        for k, v in values.items():
+            if isinstance(v, datetime):
+                if v.tzinfo is None:
+                    update[k] = v.replace(tzinfo=timezone.utc)
+        values.update(update)
+        return values
+
+    def dict(self, *, by_alias: bool = True, **kwargs) -> dict[str, Any]:
+        return super().dict(by_alias=by_alias, **kwargs)
+
+    def json(self, *, by_alias: bool = True, **kwargs) -> str:
+        return super().json(by_alias=by_alias, **kwargs)
+
 
 # ----------------------------------------------------------------------------
 
@@ -1861,6 +1884,7 @@ __all__ = [
     "DataView",
     "Digest",
     "Documentation",
+    "DocumentationBase",
     "DyffDataSchema",
     "DyffEntity",
     "DyffModelWithID",

{dyff_schema-0.7.0 → dyff_schema-0.7.2}/dyff/schema/v0/r1/requests.py

@@ -23,7 +23,7 @@ from .platform import (
     AnalysisBase,
     DatasetBase,
     DataView,
-    Documentation,
+    DocumentationBase,
     EvaluationBase,
     InferenceServiceBase,
     InferenceSessionBase,
@@ -52,7 +52,7 @@ class DatasetCreateRequest(DyffEntityCreateRequest, DatasetBase):
     pass
 
 
-class DocumentationEditRequest(Documentation):
+class DocumentationEditRequest(SchemaVersion, DocumentationBase):
     pass
 
 
@@ -137,11 +137,11 @@ class ReportCreateRequest(DyffEntityCreateRequest, ReportBase):
     )
 
 
-class TagCreateRequest(TagBase):
+class TagCreateRequest(SchemaVersion, TagBase):
     pass
 
 
-class LabelUpdateRequest(Labeled):
+class LabelUpdateRequest(SchemaVersion, Labeled):
     pass
 
 

{dyff_schema-0.7.0 → dyff_schema-0.7.2/dyff_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.7.0
+Version: 0.7.2
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0