dyff-schema 0.26.1__tar.gz → 0.27.0__tar.gz

{dyff_schema-0.26.1/dyff_schema.egg-info → dyff_schema-0.27.0}/PKG-INFO

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

@@ -599,17 +599,20 @@ class DyffBaseModel(pydantic.BaseModel):
     # 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 dict(self, *, by_alias: bool = True, **kwargs) -> _ModelAsDict:
-        return super().dict(by_alias=by_alias, **kwargs)
+    def dict(
+        self, *, by_alias: bool = True, exclude_none: bool = True, **kwargs
+    ) -> _ModelAsDict:
+        return super().dict(by_alias=by_alias, exclude_none=exclude_none, **kwargs)
 
-    def json(self, *, by_alias: bool = True, **kwargs) -> str:
-        return super().json(by_alias=by_alias, **kwargs)
+    def json(
+        self, *, by_alias: bool = True, exclude_none: bool = True, **kwargs
+    ) -> str:
+        return super().json(by_alias=by_alias, exclude_none=exclude_none, **kwargs)
 
     def model_dump(
         self,
         *,
         mode: Literal["python", "json"] = "python",
-        by_alias: bool = True,
         **kwargs,
     ) -> _ModelAsDict:
         """Encode the object as a dict containing only JSON datatypes.
@@ -621,9 +624,9 @@ class DyffBaseModel(pydantic.BaseModel):
             we convert to Pydantic 2. See: DYFF-223
         """
         if mode == "python":
-            return self.dict(by_alias=by_alias, **kwargs)
+            return self.dict(**kwargs)
         else:
-            return json.loads(self.json(by_alias=by_alias, **kwargs))
+            return json.loads(self.json(**kwargs))
 
 
 # Note: I *really* wanted to require datetimes to have timezones, like in

{dyff_schema-0.26.1 → dyff_schema-0.27.0}/dyff/schema/v0/r1/commands.py

@@ -33,6 +33,37 @@ from .platform import (
 _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, **kwargs) -> _ModelAsDict:
+        return super().dict(
+            by_alias=by_alias, exclude_unset=True, exclude_none=False, **kwargs
+        )
+
+    def json(self, *, by_alias: bool = True, **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."""
+
+#     # TODO: (DYFF-223) This should perhaps be the default for all schema
+#     # objects.
+#     def dict(self, *, exclude_none=True, **kwargs) -> _ModelAsDict:
+#         return super().dict(exclude_none=True, **kwargs)
+
+#     def json(self, *, exclude_none=True, **kwargs) -> str:
+#         return super().json(exclude_none=True, **kwargs)
+
+
 class EntityIdentifier(DyffSchemaBaseModel):
     """Identifies a single entity."""
 
@@ -41,8 +72,13 @@ class EntityIdentifier(DyffSchemaBaseModel):
         """Create an identifier that identifies the given entity."""
         return EntityIdentifier(kind=entity.kind, id=entity.id)
 
-    kind: EntityKindLiteral = pydantic.Field(description="The .kind of the entity.")
     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):
@@ -66,17 +102,6 @@ class Command(SchemaVersion, DyffSchemaBaseModel):
         "UpdateEntityStatus",
     ]
 
-    # 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 dict(
-        self, *, by_alias: bool = True, exclude_unset=True, **kwargs
-    ) -> _ModelAsDict:
-        return super().dict(by_alias=by_alias, exclude_unset=exclude_unset, **kwargs)
-
-    def json(self, *, by_alias: bool = True, exclude_unset=True, **kwargs) -> str:
-        return super().json(by_alias=by_alias, exclude_unset=exclude_unset, **kwargs)
-
 
 # ----------------------------------------------------------------------------
 
@@ -94,7 +119,7 @@ class CreateEntity(Command):
 # ----------------------------------------------------------------------------
 
 
-class EditEntityDocumentationPatch(DyffSchemaBaseModel):
+class EditEntityDocumentationPatch(_JsonMergePatchSemantics):
     """Same properties as DocumentationBase, but assigning None to a field is
     interpreted as a command to delete that field.
 
@@ -157,7 +182,7 @@ class EditEntityDocumentation(Command):
 # ----------------------------------------------------------------------------
 
 
-class EditEntityLabelsAttributes(DyffSchemaBaseModel):
+class EditEntityLabelsAttributes(_JsonMergePatchSemantics):
     """Attributes for the EditEntityLabels command."""
 
     labels: dict[LabelKeyType, Optional[Union[LabelValueType, Null]]] = pydantic.Field(
@@ -191,7 +216,7 @@ class EditEntityLabels(Command):
 # ----------------------------------------------------------------------------
 
 
-class EditFamilyMembersAttributes(DyffSchemaBaseModel):
+class EditFamilyMembersAttributes(_JsonMergePatchSemantics):
     """Attributes for the EditFamilyMembers command."""
 
     members: dict[TagNameType, Optional[Union[FamilyMember, Null]]] = pydantic.Field(
@@ -233,7 +258,7 @@ class ForgetEntity(Command):
 # ----------------------------------------------------------------------------
 
 
-class UpdateEntityStatusAttributes(DyffSchemaBaseModel):
+class UpdateEntityStatusAttributes(_JsonMergePatchSemantics):
     """Attributes for the UpdateEntityStatus command."""
 
     status: str = pydantic.Field(

{dyff_schema-0.26.1 → dyff_schema-0.27.0}/dyff/schema/v0/r1/platform.py

@@ -305,7 +305,7 @@ def LabelValue() -> type[str]:
 
 def TagName() -> type[str]:
     return pydantic.constr(  # type: ignore
-        regex=_oci_image_tag_regex(), max_length=_k8s_label_key_maxlen()
+        regex=_oci_image_tag_regex(), max_length=_oci_image_tag_maxlen()
     )
 
 
@@ -449,7 +449,7 @@ class DyffEntityMetadata(DyffSchemaBaseModel):
         description="Unique identifier of the current revision of the entity.",
     )
 
-    documentation: Optional[DocumentationBase] = pydantic.Field(
+    documentation: DocumentationBase = pydantic.Field(
         default_factory=DocumentationBase,
         description="Documentation of the resource. The content is used to"
         " populate various views in the web UI.",
@@ -493,7 +493,7 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
     )
 
     creationTime: datetime = pydantic.Field(
-        default=None, description="Resource creation time (assigned by system)"
+        description="Resource creation time (assigned by system)"
     )
 
     lastTransitionTime: Optional[datetime] = pydantic.Field(
@@ -728,8 +728,9 @@ class Family(DyffEntity, FamilyBase, FamilyMembers):
 
 class RevisionMetadata(DyffSchemaBaseModel):
     previousRevision: Optional[str] = pydantic.Field(
+        default=None,
         description="The ID of the revision from which this revision was derived."
-        "If None, then this is the first revision of the entity."
+        "If None, then this is the first revision of the entity.",
     )
     creationTime: datetime = pydantic.Field(
         description="The time when the Revision was created"

{dyff_schema-0.26.1 → dyff_schema-0.27.0/dyff_schema.egg-info}/PKG-INFO

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