dyff-schema 0.7.0__py3-none-any.whl → 0.7.2__py3-none-any.whl

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/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/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.dist-info → dyff_schema-0.7.2.dist-info}/METADATA

@@ -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.dist-info → dyff_schema-0.7.2.dist-info}/RECORD

@@ -20,9 +20,9 @@ dyff/schema/io/vllm.py,sha256=2q05M_-lTzq9oywKXHPPpCFCSDVCSsRQqtmERzWTtio,123
 dyff/schema/v0/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/adapters.py,sha256=2t2oxsnGfSEDKKDIEYw4qqLXMH7qlFIwPVuLyUmbsHs,23552
-dyff/schema/v0/r1/base.py,sha256=g_wqh4OU_9ftMHovVxPtdeup4O5MZi422v3eZH99ZQI,17139
-dyff/schema/v0/r1/platform.py,sha256=2QcXlSxPZDLqbICoAvwebXcRf3ssvK_X6MJRqxx3AXI,60712
-dyff/schema/v0/r1/requests.py,sha256=OKOBk4fRFCEVEd4cID4DXAY9yQug7kC5da-GXW54U00,8860
+dyff/schema/v0/r1/base.py,sha256=X4QVwOzNw5xPCF_f14w2JhARj1CHmGMjUmTcNzb-X0c,17471
+dyff/schema/v0/r1/platform.py,sha256=ocEofM51a4bC0wlHB5zJO6jZUwJVUkYwv7RadTawhVA,61574
+dyff/schema/v0/r1/requests.py,sha256=bTLtQUK80_fFeEWRG6QUJoLwy1_PyXf8ua9Ei4av0ug,8913
 dyff/schema/v0/r1/test.py,sha256=X6dUyVd5svcPCI-PBMOAqEfK9jv3bRDvkQTJzwS96c0,10720
 dyff/schema/v0/r1/version.py,sha256=isKAGuGxsdru8vDaYmI4YiZdJOu_wNxXK7u6QzD6FE4,392
 dyff/schema/v0/r1/dataset/__init__.py,sha256=LbVlkO2asyGYBKk2z49xjJYTM-pu9y9e4eQDXgTDLnM,2553
@@ -33,9 +33,9 @@ dyff/schema/v0/r1/dataset/text.py,sha256=nLIn91Zlt0tNdXUklSgjJ-kEDxoPX32ISLkiv2D
 dyff/schema/v0/r1/dataset/vision.py,sha256=aIe0fbfM_g3DsrDTdg2K803YKLjZBpurM_VJcJFuZLc,369
 dyff/schema/v0/r1/io/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/io/vllm.py,sha256=CUE9y8KthtUI7sD49S875rDmPvKotSXVIRaBS79aBZs,5320
-dyff_schema-0.7.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.7.0.dist-info/METADATA,sha256=YmFc5JSsf50GgMl1jUv4Epb-idVIs26oj1_ZuXKzpow,3459
-dyff_schema-0.7.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.7.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-dyff_schema-0.7.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.7.0.dist-info/RECORD,,
+dyff_schema-0.7.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.7.2.dist-info/METADATA,sha256=zEELaVi3ZL67mNV3031i02KZH7DeuXqEwSkXR_C6LhI,3459
+dyff_schema-0.7.2.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.7.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+dyff_schema-0.7.2.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.7.2.dist-info/RECORD,,