dyff-schema 0.32.0__tar.gz → 0.33.1__tar.gz

{dyff_schema-0.32.0 → dyff_schema-0.33.1}/.gitlab-ci.yml

@@ -8,7 +8,7 @@ stages:
 
 include:
   - project: saferatday0/library/gitlab
-    ref: 0.17.2
+    ref: 0.18.3
     file:
       - gitlab-release.yml
   - project: saferatday0/library/detect-secrets
@@ -20,7 +20,7 @@ include:
     file:
       - prettier.yml
   - project: saferatday0/library/python
-    ref: 0.21.2
+    ref: 0.22.0
     file:
       - python-autoflake.yml
       - python-black.yml

{dyff_schema-0.32.0/dyff_schema.egg-info → dyff_schema-0.33.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.32.0
+Version: 0.33.1
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0
@@ -20,6 +20,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
+Requires-Dist: canonicaljson==2.0.0
 Requires-Dist: hypothesis
 Requires-Dist: hypothesis-jsonschema
 Requires-Dist: jsonpath-ng

dyff_schema-0.33.1/dyff/schema/_version.py

@@ -0,0 +1,2 @@
+__version__ = version = "0.33.1"
+__version_tuple__ = version_tuple = (0, 33, 1)

dyff_schema-0.33.1/dyff/schema/v0/r1/oci.py

@@ -0,0 +1,183 @@
+# SPDX-FileCopyrightText: 2024 UL Research Institutes
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+import enum
+import hashlib
+from datetime import datetime, timezone
+from typing import Any, Literal, Optional
+
+import canonicaljson
+import pydantic
+
+from .base import int64
+
+
+class KnownMediaTypes(str, enum.Enum):
+    oci_image_manifest = "application/vnd.oci.image.manifest.v1+json"
+    oci_image_config = "application/vnd.oci.image.config.v1+json"
+    oci_image_layer_tar = "application/vnd.oci.image.layer.v1.tar"
+    oci_image_layer_tar_gzip = "application/vnd.oci.image.layer.v1.tar+gzip"
+
+
+# mypy gets confused because 'dict' is the name of a method in DyffBaseModel
+_ModelAsDict = dict[str, Any]
+
+
+class _OCISchemaBaseModel(pydantic.BaseModel):
+    def model_dump(  # type: ignore [override]
+        self, *, by_alias: bool = True, exclude_none: bool = True, **kwargs
+    ) -> _ModelAsDict:
+        return super().model_dump(
+            by_alias=by_alias, exclude_none=exclude_none, **kwargs
+        )
+
+    def model_dump_json(  # type: ignore [override]
+        self, *, by_alias: bool = True, exclude_none: bool = True, **kwargs
+    ) -> str:
+        return super().model_dump_json(
+            by_alias=by_alias, exclude_none=exclude_none, **kwargs
+        )
+
+    def dict(
+        self, *, by_alias: bool = True, exclude_none: bool = True, **kwargs
+    ) -> _ModelAsDict:
+        return self.model_dump(by_alias=by_alias, exclude_none=exclude_none, **kwargs)
+
+    def json(
+        self, *, by_alias: bool = True, exclude_none: bool = True, **kwargs
+    ) -> str:
+        return self.model_dump_json(
+            by_alias=by_alias, exclude_none=exclude_none, **kwargs
+        )
+
+    @pydantic.model_validator(mode="after")
+    def _ensure_datetime_timezone_utc(cls, values):
+        for field_name, field_value in values.__dict__.items():
+            if isinstance(field_value, datetime):
+                if field_value.tzinfo is None:
+                    # Set UTC timezone for naive datetime
+                    setattr(
+                        values, field_name, field_value.replace(tzinfo=timezone.utc)
+                    )
+                elif field_value.tzinfo != timezone.utc:
+                    # Convert to UTC timezone
+                    setattr(values, field_name, field_value.astimezone(timezone.utc))
+        return values
+
+
+class _DigestMixin(pydantic.BaseModel):
+    def digest(self) -> str:
+        obj = self.model_dump(mode="json")
+        h = hashlib.sha256(usedforsecurity=False)
+        for chunk in canonicaljson.iterencode_canonical_json(obj):
+            h.update(chunk)
+        return "sha256:{}".format(h.hexdigest())
+
+
+class Platform(_OCISchemaBaseModel):
+    architecture: str
+    os: str
+    os_version: Optional[str] = pydantic.Field(alias="os.version", default=None)
+    os_features: Optional[list[str]] = pydantic.Field(alias="os.features", default=None)
+    variant: Optional[str] = pydantic.Field(default=None)
+
+
+class Descriptor(_OCISchemaBaseModel):
+    """
+    https://github.com/opencontainers/image-spec/blob/v1.1.1/descriptor.md
+    """
+
+    mediaType: str = pydantic.Field()
+    digest: str = pydantic.Field()
+    size: int64() = pydantic.Field(  # type: ignore
+        description="This REQUIRED property specifies the size, in bytes,"
+        " of the raw content. This property exists so that a client"
+        " will have an expected size for the content before processing."
+        " If the length of the retrieved content does not match"
+        " the specified length, the content SHOULD NOT be trusted."
+    )
+    urls: Optional[list[str]] = pydantic.Field(default=None)
+    annotations: Optional[dict[str, str]] = pydantic.Field(default=None)
+    data: Optional[str] = pydantic.Field(default=None)
+    artifactType: Optional[str] = pydantic.Field(default=None)
+
+    @staticmethod
+    def empty() -> Descriptor:
+        """
+        https://github.com/opencontainers/image-spec/blob/v1.1.1/manifest.md#guidance-for-an-empty-descriptor
+        """
+        return Descriptor.model_validate(
+            {
+                "mediaType": "application/vnd.oci.empty.v1+json",
+                "digest": "sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
+                "size": 2,
+                "data": "e30=",
+            }
+        )
+
+
+class ImageDescriptor(Descriptor):
+    platform: Platform
+
+
+class ExecutionParameters(_OCISchemaBaseModel):
+    # TODO
+    pass
+
+
+class RootFS(_OCISchemaBaseModel):
+    type_: Literal["layers"] = pydantic.Field(alias="type", default="layers")
+    diff_ids: list[str] = pydantic.Field()
+
+
+class HistoryEntry(_OCISchemaBaseModel):
+    created: Optional[str] = pydantic.Field(default=None)
+    author: Optional[str] = pydantic.Field(default=None)
+    created_by: Optional[str] = pydantic.Field(default=None)
+    comment: Optional[str] = pydantic.Field(default=None)
+    empty_layer: Optional[bool] = pydantic.Field(default=None)
+
+
+class ImageConfig(Platform, _DigestMixin):
+    """
+    https://github.com/opencontainers/image-spec/blob/v1.1.1/config.md
+    """
+
+    created: Optional[str] = pydantic.Field(default=None)
+    author: Optional[str] = pydantic.Field(default=None)
+    config: Optional[ExecutionParameters] = pydantic.Field(default=None)
+    rootfs: RootFS
+    history: Optional[list[HistoryEntry]] = pydantic.Field(default=None)
+
+
+class ImageManifest(_OCISchemaBaseModel):
+    schemaVersion: Literal["2"] = "2"
+    mediaType: Literal["application/vnd.oci.image.manifest.v1+json"] = (
+        "application/vnd.oci.image.manifest.v1+json"
+    )
+    artifactType: Optional[str] = pydantic.Field(default=None)
+    config: Descriptor = pydantic.Field(default_factory=Descriptor.empty)
+    layers: list[Descriptor] = pydantic.Field(
+        default_factory=lambda: [Descriptor.empty()]
+    )
+    subject: Optional[Descriptor] = pydantic.Field(default=None)
+    annotations: Optional[dict[str, str]] = pydantic.Field(default=None)
+
+    def is_image_manifest(self) -> bool:
+        return self.artifactType is None
+
+    def is_artifact_manifest(self) -> bool:
+        return self.artifactType is not None
+
+    @pydantic.model_validator(mode="after")
+    def validate_types(self):
+        if self.artifactType is None:
+            if self.config.mediaType != KnownMediaTypes.oci_image_config.value:
+                raise ValueError(
+                    ".config.mediaType must be"
+                    f"{KnownMediaTypes.oci_image_config.value}"
+                    " if .artifactType is unspecified"
+                )
+        return self

{dyff_schema-0.32.0 → dyff_schema-0.33.1}/dyff/schema/v0/r1/platform.py

@@ -33,6 +33,7 @@ from typing_extensions import Annotated, TypeAlias
 
 from ... import named_data_schema, product_schema
 from ...version import SomeSchemaVersion
+from . import oci
 from .base import DyffSchemaBaseModel
 from .dataset import arrow, make_item_type, make_response_type
 from .version import SCHEMA_VERSION, SchemaVersion
@@ -193,6 +194,8 @@ class Entities(str, enum.Enum):
 
     Account = "Account"
     Analysis = "Analysis"
+    # FIXME: (schema v1) Rename to Artifact
+    Artifact = "OCIArtifact"
     Audit = "Audit"
     AuditProcedure = "AuditProcedure"
     Concern = "Concern"
@@ -220,6 +223,7 @@ class Resources(str, enum.Enum):
     """The resource names corresponding to entities that have API endpoints."""
 
     Analysis = "analyses"
+    Artifact = "artifacts"
     Audit = "audits"
     AuditProcedure = "auditprocedures"
     Concern = "concerns"
@@ -259,6 +263,9 @@ class Resources(str, enum.Enum):
     @staticmethod
     def for_kind(kind: Entities) -> "Resources":
         try:
+            # FIXME: (schema v1) Special case for legacy OCIArtifact name
+            if kind == Entities.Artifact:
+                return Resources.Artifact
             return Resources[kind.value]
         except KeyError:
             raise ValueError(f"No Resources for Entity kind: {kind}")
@@ -280,6 +287,8 @@ EntityKindLiteral = Literal[
     "Method",
     "Model",
     "Module",
+    # FIXME: (schema v1) Rename to Artifact
+    "OCIArtifact",
     "Report",
     "Revision",
     "SafetyCase",
@@ -502,6 +511,8 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
         "Method",
         "Model",
         "Module",
+        # FIXME: (schema v1) Rename to Artifact
+        "OCIArtifact",
         "Report",
         "Revision",
         "SafetyCase",
@@ -829,8 +840,10 @@ class Digest(DyffSchemaBaseModel):
     )
 
 
+# TODO: (schema-v1) Rename this to "File" or something -- reserve Artifact
+# for OCI artifacts.
 class Artifact(DyffSchemaBaseModel):
-    # TODO: In v1, rename this to 'contentType' or something and commit to making it the MIME type
+    # TODO: (schema-v1) Rename this to 'contentType' or something and commit to making it the MIME type
     kind: Optional[str] = pydantic.Field(
         default=None, description="The kind of artifact"
     )
@@ -1122,6 +1135,10 @@ class ModelSource(DyffSchemaBaseModel):
     )
 
 
+class ContainerImage(DyffSchemaBaseModel):
+    pass
+
+
 class AcceleratorGPU(DyffSchemaBaseModel):
     hardwareTypes: list[str] = pydantic.Field(
         min_length=1,
@@ -2130,6 +2147,25 @@ class Score(ScoreData):
     id: str = pydantic.Field(description="Unique identifier of the entity")
 
 
+# ---------------------------------------------------------------------------
+# OCI artifacts
+
+
+# TODO: (schema-v1) Rename this to Artifact
+class OCIArtifact(DyffEntity):
+    kind: Literal["OCIArtifact"] = Entities.Artifact.value
+
+    manifest: oci.ImageManifest = pydantic.Field(
+        description="The OCI image manifest of the artifact"
+    )
+
+    def dependencies(self) -> list[str]:
+        return []
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
+
 # ---------------------------------------------------------------------------
 # Status enumerations
 
@@ -2372,6 +2408,7 @@ def is_status_success(status: str) -> bool:
 
 _ENTITY_CLASS = {
     Entities.Analysis: Analysis,
+    Entities.Artifact: OCIArtifact,
     Entities.Audit: Audit,
     Entities.AuditProcedure: AuditProcedure,
     Entities.Dataset: Dataset,
@@ -2406,6 +2443,7 @@ _DyffEntityTypeRevisable = Union[
     Method,
     Model,
     Module,
+    OCIArtifact,
     Report,
     SafetyCase,
     UseCase,
@@ -2579,6 +2617,7 @@ __all__ = [
     "ModelStorage",
     "Module",
     "ModuleBase",
+    "OCIArtifact",
     "QueryableDyffEntity",
     "Report",
     "ReportBase",

{dyff_schema-0.32.0 → dyff_schema-0.33.1}/dyff/schema/v0/r1/requests.py

@@ -21,7 +21,7 @@ from typing import Any, Literal, Optional, Union
 import pydantic
 
 from ... import upcast
-from . import commands
+from . import commands, oci
 from .base import DyffBaseModel, JsonMergePatchSemantics
 from .platform import (
     AnalysisBase,
@@ -72,6 +72,20 @@ class DyffRequestBase(SchemaVersion, DyffRequestDefaultValidators):
     # TODO: (DYFF-223) I think that exclude_unset=True should be the default
     # for all schema objects, but I'm unsure of the consequences of making
     # this change and we'll defer it until v1.
+    def model_dump(  # type: ignore [override]
+        self, *, by_alias: bool = True, exclude_unset=True, **kwargs
+    ) -> _ModelAsDict:
+        return super().model_dump(
+            by_alias=by_alias, exclude_unset=exclude_unset, **kwargs
+        )
+
+    def model_dump_json(  # type: ignore [override]
+        self, *, by_alias: bool = True, exclude_unset=True, **kwargs
+    ) -> str:
+        return super().model_dump_json(
+            by_alias=by_alias, exclude_unset=exclude_unset, **kwargs
+        )
+
     def dict(
         self, *, by_alias: bool = True, exclude_unset=True, **kwargs
     ) -> _ModelAsDict:
@@ -118,6 +132,10 @@ class AnalysisCreateRequest(DyffEntityCreateRequest, AnalysisBase):
         return scope
 
 
+class ArtifactCreateRequest(DyffEntityCreateRequest):
+    manifest: oci.ImageManifest
+
+
 class ConcernCreateRequest(DyffEntityCreateRequest, ConcernBase):
     @pydantic.field_validator("documentation", check_fields=False)
     def _validate_documentation(
@@ -357,6 +375,10 @@ class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
     inputs: Optional[str] = pydantic.Field(default=None)
 
 
+class ArtifactQueryRequest(DyffEntityQueryRequest):
+    name: Optional[str] = pydantic.Field(default=None)
+
+
 class AuditQueryRequest(DyffEntityQueryRequest):
     name: Optional[str] = pydantic.Field(default=None)
 
@@ -446,6 +468,8 @@ class UseCaseQueryRequest(DyffEntityQueryRequest):
 
 __all__ = [
     "AnalysisCreateRequest",
+    "ArtifactCreateRequest",
+    "ArtifactQueryRequest",
     "AuditQueryRequest",
     "ConcernCreateRequest",
     "DyffEntityCreateRequest",

{dyff_schema-0.32.0 → dyff_schema-0.33.1/dyff_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.32.0
+Version: 0.33.1
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0
@@ -20,6 +20,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
+Requires-Dist: canonicaljson==2.0.0
 Requires-Dist: hypothesis
 Requires-Dist: hypothesis-jsonschema
 Requires-Dist: jsonpath-ng

{dyff_schema-0.32.0 → dyff_schema-0.33.1}/dyff_schema.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ dyff/schema/v0/r1/__init__.py
 dyff/schema/v0/r1/adapters.py
 dyff/schema/v0/r1/base.py
 dyff/schema/v0/r1/commands.py
+dyff/schema/v0/r1/oci.py
 dyff/schema/v0/r1/platform.py
 dyff/schema/v0/r1/requests.py
 dyff/schema/v0/r1/responses.py

{dyff_schema-0.32.0 → dyff_schema-0.33.1}/dyff_schema.egg-info/requires.txt

@@ -1,3 +1,4 @@
+canonicaljson==2.0.0
 hypothesis
 hypothesis-jsonschema
 jsonpath-ng

{dyff_schema-0.32.0 → dyff_schema-0.33.1}/pyproject.toml

@@ -30,6 +30,7 @@ classifiers=[
 ]
 
 dependencies = [
+    "canonicaljson==2.0.0",
     "hypothesis",
     "hypothesis-jsonschema",
     "jsonpath-ng",

dyff_schema-0.32.0/dyff/schema/_version.py

@@ -1,2 +0,0 @@
-__version__ = version = "0.32.0"
-__version_tuple__ = version_tuple = (0, 32, 0)