dyff-schema 0.27.1__tar.gz → 0.27.2__tar.gz

{dyff_schema-0.27.1/dyff_schema.egg-info → dyff_schema-0.27.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dyff-schema
-Version: 0.27.1
+Version: 0.27.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.27.1 → dyff_schema-0.27.2}/dyff/schema/v0/r1/base.py

@@ -658,6 +658,29 @@ class DyffSchemaBaseModel(DyffBaseModel):
         return values
 
 
+class JsonMergePatchSemantics(DyffSchemaBaseModel):
+    """Explicit None values will be output as json 'null', and fields that are not set
+    explicitly are not output.
+
+    In JSON Merge Patch terms, None means "delete this field", and not setting a value
+    means "leave this field unchanged".
+    """
+
+    def dict(
+        self, *, by_alias: bool = True, exclude_unset=True, exclude_none=False, **kwargs
+    ) -> _ModelAsDict:
+        return super().dict(
+            by_alias=by_alias, exclude_unset=True, exclude_none=False, **kwargs
+        )
+
+    def json(
+        self, *, by_alias: bool = True, exclude_unset=True, exclude_none=False, **kwargs
+    ) -> str:
+        return super().json(
+            by_alias=by_alias, exclude_unset=True, exclude_none=False, **kwargs
+        )
+
+
 __all__ = [
     "DTYPE",
     "DType",
@@ -671,6 +694,7 @@ __all__ = [
     "Int16",
     "Int32",
     "Int64",
+    "JsonMergePatchSemantics",
     "Null",
     "UInt8",
     "UInt16",

{dyff_schema-0.27.1 → dyff_schema-0.27.2}/dyff/schema/v0/r1/commands.py

@@ -7,13 +7,14 @@ These are used internally by the platform and users typically won't encounter th
 
 from __future__ import annotations
 
-from typing import Any, Literal, Optional, Union
+from typing import Literal, Optional, Union
 
 import pydantic
 
-from .base import DyffSchemaBaseModel, Null
+from .base import DyffSchemaBaseModel, JsonMergePatchSemantics, Null
 from .platform import (
     DyffEntityType,
+    EntityIdentifier,
     EntityKindLiteral,
     FamilyMember,
     FamilyMembers,
@@ -29,33 +30,6 @@ from .platform import (
 # ----------------------------------------------------------------------------
 
 
-# mypy gets confused because 'dict' is the name of a method in DyffBaseModel
-_ModelAsDict = dict[str, Any]
-
-
-class _JsonMergePatchSemantics(DyffSchemaBaseModel):
-    """Explicit None values will be output as json 'null', and fields that are not set
-    explicitly are not output.
-
-    In JSON Merge Patch terms, None means "delete this field", and not setting a value
-    means "leave this field unchanged".
-    """
-
-    def dict(
-        self, *, by_alias: bool = True, exclude_unset=True, exclude_none=False, **kwargs
-    ) -> _ModelAsDict:
-        return super().dict(
-            by_alias=by_alias, exclude_unset=True, exclude_none=False, **kwargs
-        )
-
-    def json(
-        self, *, by_alias: bool = True, exclude_unset=True, exclude_none=False, **kwargs
-    ) -> str:
-        return super().json(
-            by_alias=by_alias, exclude_unset=True, exclude_none=False, **kwargs
-        )
-
-
 # class _NoneMeansUndefined(DyffSchemaBaseModel):
 #     """Fields with the value None will not be emitted in the JSON output."""
 
@@ -68,23 +42,6 @@ class _JsonMergePatchSemantics(DyffSchemaBaseModel):
 #         return super().json(exclude_none=True, **kwargs)
 
 
-class EntityIdentifier(DyffSchemaBaseModel):
-    """Identifies a single entity."""
-
-    @staticmethod
-    def of(entity: DyffEntityType) -> EntityIdentifier:
-        """Create an identifier that identifies the given entity."""
-        return EntityIdentifier(kind=entity.kind, id=entity.id)
-
-    id: str = pydantic.Field(description="The .id of the entity.")
-    kind: Optional[EntityKindLiteral] = pydantic.Field(
-        default=None,
-        description="The .kind of the entity. This is optional because"
-        " sometimes you need to send a command without knowing the kind,"
-        " but it should be set whenever possible.",
-    )
-
-
 class FamilyIdentifier(EntityIdentifier):
     """Identifies a single Family entity."""
 
@@ -123,7 +80,7 @@ class CreateEntity(Command):
 # ----------------------------------------------------------------------------
 
 
-class EditEntityDocumentationPatch(_JsonMergePatchSemantics):
+class EditEntityDocumentationPatch(JsonMergePatchSemantics):
     """Same properties as DocumentationBase, but assigning None to a field is
     interpreted as a command to delete that field.
 
@@ -186,7 +143,7 @@ class EditEntityDocumentation(Command):
 # ----------------------------------------------------------------------------
 
 
-class EditEntityLabelsAttributes(_JsonMergePatchSemantics):
+class EditEntityLabelsAttributes(JsonMergePatchSemantics):
     """Attributes for the EditEntityLabels command."""
 
     labels: dict[LabelKeyType, Optional[Union[LabelValueType, Null]]] = pydantic.Field(
@@ -220,7 +177,7 @@ class EditEntityLabels(Command):
 # ----------------------------------------------------------------------------
 
 
-class EditFamilyMembersAttributes(_JsonMergePatchSemantics):
+class EditFamilyMembersAttributes(JsonMergePatchSemantics):
     """Attributes for the EditFamilyMembers command."""
 
     members: dict[TagNameType, Optional[Union[FamilyMember, Null]]] = pydantic.Field(
@@ -262,7 +219,7 @@ class ForgetEntity(Command):
 # ----------------------------------------------------------------------------
 
 
-class UpdateEntityStatusAttributes(_JsonMergePatchSemantics):
+class UpdateEntityStatusAttributes(JsonMergePatchSemantics):
     """Attributes for the UpdateEntityStatus command."""
 
     status: str = pydantic.Field(

{dyff_schema-0.27.1 → dyff_schema-0.27.2}/dyff/schema/v0/r1/platform.py

@@ -291,6 +291,23 @@ class DyffModelWithID(DyffSchemaBaseModel):
     account: str = pydantic.Field(description="Account that owns the entity")
 
 
+class EntityIdentifier(DyffSchemaBaseModel):
+    """Identifies a single entity."""
+
+    @staticmethod
+    def of(entity: "DyffEntityType") -> "EntityIdentifier":
+        """Create an identifier that identifies the given entity."""
+        return EntityIdentifier(kind=entity.kind, id=entity.id)
+
+    id: str = pydantic.Field(description="The .id of the entity.")
+    kind: Optional[EntityKindLiteral] = pydantic.Field(
+        default=None,
+        description="The .kind of the entity. This is optional because"
+        " sometimes you need to send a command without knowing the kind,"
+        " but it should be set whenever possible.",
+    )
+
+
 def LabelKey() -> type[str]:
     return pydantic.constr(
         regex=_k8s_label_key_regex(), max_length=_k8s_label_key_maxlen()
@@ -682,24 +699,24 @@ class FamilyMemberKind(str, enum.Enum):
 
 
 class FamilyMemberBase(DyffSchemaBaseModel):
-    name: TagNameType = pydantic.Field(
-        description="An interpretable identifier for the member that is unique"
-        " in the context of the corresponding Family.",
-    )
-
-    resource: str = pydantic.Field(
+    entity: EntityIdentifier = pydantic.Field(
         description="ID of the resource this member references.",
     )
 
-    description: Optional[str] = pydantic.Field(
+    description: Optional[pydantic.constr(max_length=summary_maxlen())] = pydantic.Field(  # type: ignore
         default=None,
-        description="A short description of the member. Interpreted as Markdown."
-        " This should include information about how this version of the resource"
+        description="A short description of the member."
+        " This should describe how this version of the resource"
         " is different from other versions.",
     )
 
 
 class FamilyMember(FamilyMemberBase):
+    name: TagNameType = pydantic.Field(
+        description="An interpretable identifier for the member that is unique"
+        " in the context of the corresponding Family.",
+    )
+
     family: str = pydantic.Field(
         description="Identifier of the Family containing this tag."
     )
@@ -725,6 +742,12 @@ class FamilyBase(DyffSchemaBaseModel):
 class Family(DyffEntity, FamilyBase, FamilyMembers):
     kind: Literal["Family"] = "Family"
 
+    def dependencies(self) -> list[str]:
+        return []
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
 
 class RevisionMetadata(DyffSchemaBaseModel):
     previousRevision: Optional[str] = pydantic.Field(

{dyff_schema-0.27.1 → dyff_schema-0.27.2}/dyff/schema/v0/r1/requests.py

@@ -21,7 +21,7 @@ from typing import Any, Literal, Optional, Union
 import pydantic
 
 from . import commands
-from .base import DyffBaseModel
+from .base import DyffBaseModel, JsonMergePatchSemantics, Null
 from .platform import (
     AnalysisBase,
     AnalysisScope,
@@ -31,12 +31,14 @@ from .platform import (
     DocumentationBase,
     EvaluationBase,
     FamilyBase,
+    FamilyMemberBase,
     InferenceServiceBase,
     InferenceSessionBase,
     MethodBase,
     ModelSpec,
     ModuleBase,
     ReportBase,
+    TagNameType,
     summary_maxlen,
     title_maxlen,
 )
@@ -242,8 +244,12 @@ class DocumentationEditRequest(
     pass
 
 
-class FamilyMembersEditRequest(DyffRequestBase, commands.EditFamilyMembersAttributes):
-    pass
+class FamilyMembersEditRequest(DyffRequestBase, JsonMergePatchSemantics):
+    members: dict[TagNameType, Optional[Union[FamilyMemberBase, Null]]] = (
+        pydantic.Field(
+            description="Mapping of names to IDs of member resources.",
+        )
+    )
 
 
 class LabelsEditRequest(DyffRequestBase, commands.EditEntityLabelsAttributes):

{dyff_schema-0.27.1 → dyff_schema-0.27.2/dyff_schema.egg-info}/PKG-INFO

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