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

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

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

@@ -51,7 +51,7 @@ class FamilyIdentifier(EntityIdentifier):
     kind: Literal["Family"] = "Family"
 
 
-class Command(SchemaVersion):
+class Command(SchemaVersion, DyffSchemaBaseModel):
     """Base class for Command messages.
 
     Commands define the API of the "command model" in our CQRS architecture.
@@ -95,17 +95,17 @@ class CreateEntity(Command):
 
 
 class EditEntityDocumentationPatch(DyffSchemaBaseModel):
-    """Same properties as DocumentationBase, but generates a JSON Schema that allows
-    fields to be set to JSON 'null'.
+    """Same properties as DocumentationBase, but assigning None to a field is
+    interpreted as a command to delete that field.
 
-    This is needed to get JSON Merge Patch semantics, where explicit 'null' means
-    "delete that field".
+    Fields that are assigned explicitly remain unchanged.
     """
 
     title: Optional[Union[pydantic.constr(max_length=title_maxlen()), Null]] = (  # type: ignore
         pydantic.Field(
             default=None,
-            description='A short plain string suitable as a title or "headline".',
+            description='A short plain string suitable as a title or "headline".'
+            " Providing an explicit None value deletes the current value.",
         )
     )
 
@@ -113,19 +113,22 @@ class EditEntityDocumentationPatch(DyffSchemaBaseModel):
         pydantic.Field(
             default=None,
             description="A brief summary, suitable for display in"
-            " small UI elements. Interpreted as Markdown. Excessively long"
-            " summaries may be truncated in the UI, especially on small displays.",
+            " small UI elements. Providing an explicit None value deletes the"
+            " current value.",
         )
     )
 
     fullPage: Optional[Union[str, Null]] = pydantic.Field(
         default=None,
         description="Long-form documentation. Interpreted as"
-        " Markdown. There are no length constraints, but be reasonable.",
+        " Markdown. There are no length constraints, but be reasonable."
+        " Providing an explicit None value deletes the current value.",
     )
 
 
 class EditEntityDocumentationAttributes(DyffSchemaBaseModel):
+    """Attributes for the EditEntityDocumentation command."""
+
     documentation: EditEntityDocumentationPatch = pydantic.Field(
         description="Edits to make to the documentation."
     )
@@ -155,18 +158,13 @@ class EditEntityDocumentation(Command):
 
 
 class EditEntityLabelsAttributes(DyffSchemaBaseModel):
+    """Attributes for the EditEntityLabels command."""
+
     labels: dict[LabelKeyType, Optional[Union[LabelValueType, Null]]] = pydantic.Field(
         default_factory=dict,
-        description="A set of key-value labels for the resource. Used to"
-        " specify identifying attributes of resources that are meaningful to"
-        " users but do not imply semantics in the dyff system.\n\n"
-        "The keys are DNS labels with an optional DNS domain prefix."
-        " For example: 'my-key', 'your.com/key_0'. Keys prefixed with"
-        " 'dyff.io/', 'subdomain.dyff.io/', etc. are reserved.\n\n"
-        "The label values are alphanumeric characters separated by"
-        " '.', '-', or '_'.\n\n"
-        "We follow the kubernetes label conventions closely."
-        " See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels",
+        description="A set of key-value labels for the resource."
+        " Existing label keys that are not provided in the edit remain unchanged."
+        " Providing an explicit None value deletes the corresponding key.",
     )
 
 
@@ -194,7 +192,7 @@ class EditEntityLabels(Command):
 
 
 class EditFamilyMembersAttributes(DyffSchemaBaseModel):
-    """Payload data for the EditFamilyMembers command."""
+    """Attributes for the EditFamilyMembers command."""
 
     members: dict[TagNameType, Optional[Union[FamilyMember, Null]]] = pydantic.Field(
         description="Mapping of names to IDs of member resources.",
@@ -236,11 +234,13 @@ class ForgetEntity(Command):
 
 
 class UpdateEntityStatusAttributes(DyffSchemaBaseModel):
+    """Attributes for the UpdateEntityStatus command."""
+
     status: str = pydantic.Field(
         description=Status.__fields__["status"].field_info.description
     )
 
-    reason: Union[str, Null] = pydantic.Field(
+    reason: Optional[Union[str, Null]] = pydantic.Field(
         description=Status.__fields__["reason"].field_info.description
     )
 

{dyff_schema-0.26.0 → dyff_schema-0.26.1}/dyff/schema/v0/r1/requests.py

@@ -16,11 +16,12 @@ from __future__ import annotations
 
 import re
 from datetime import datetime
-from typing import Literal, Optional, Union
+from typing import Any, Literal, Optional, Union
 
 import pydantic
 
-from .base import DyffBaseModel, DyffSchemaBaseModel
+from . import commands
+from .base import DyffBaseModel
 from .platform import (
     AnalysisBase,
     AnalysisScope,
@@ -30,10 +31,8 @@ from .platform import (
     DocumentationBase,
     EvaluationBase,
     FamilyBase,
-    FamilyMembers,
     InferenceServiceBase,
     InferenceSessionBase,
-    Labeled,
     MethodBase,
     ModelSpec,
     ModuleBase,
@@ -43,6 +42,9 @@ from .platform import (
 )
 from .version import SchemaVersion
 
+# mypy gets confused because 'dict' is the name of a method in DyffBaseModel
+_ModelAsDict = dict[str, Any]
+
 
 class DyffRequestDefaultValidators(DyffBaseModel):
     """This must be the base class for *all* request models in the Dyff schema.
@@ -62,7 +64,19 @@ class DyffRequestDefaultValidators(DyffBaseModel):
 
 
 class DyffRequestBase(SchemaVersion, DyffRequestDefaultValidators):
-    pass
+    # 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)
+
+
+# ----------------------------------------------------------------------------
 
 
 class DyffEntityCreateRequest(DyffRequestBase):
@@ -124,26 +138,6 @@ class DatasetCreateRequest(DyffEntityCreateRequest, DatasetBase):
     pass
 
 
-class DocumentationEditRequest(DyffRequestBase, DocumentationBase):
-    @pydantic.validator("title", check_fields=False)
-    def _validate_title(cls, title: Optional[str]) -> Optional[str]:
-        # TODO: This has to be a validator function because we can't apply the
-        # contraint to DocumentationBase, since there are already entities
-        # that violate the constraints in the data store. Fix in Schema v1.
-        if title is not None and len(title) > title_maxlen():
-            raise ValueError(f".title must have length < {title_maxlen()}")
-        return title
-
-    @pydantic.validator("summary", check_fields=False)
-    def _validate_summary(cls, summary: Optional[str]) -> Optional[str]:
-        # TODO: This has to be a validator function because we can't apply the
-        # contraint to DocumentationBase, since there are already entities
-        # that violate the constraints in the data store. Fix in Schema v1.
-        if summary is not None and len(summary) > summary_maxlen():
-            raise ValueError(f".summary must have length < {summary_maxlen()}")
-        return summary
-
-
 class InferenceServiceCreateRequest(DyffEntityCreateRequest, InferenceServiceBase):
     model: Optional[str] = pydantic.Field(
         default=None, description="ID of Model backing the service, if applicable"
@@ -239,14 +233,35 @@ class ReportCreateRequest(DyffEntityCreateRequest, ReportBase):
     )
 
 
-class FamilyMembersEditRequest(DyffRequestBase, FamilyMembers):
+# ----------------------------------------------------------------------------
+
+
+class DocumentationEditRequest(
+    DyffRequestBase, commands.EditEntityDocumentationAttributes
+):
     pass
 
 
-class LabelUpdateRequest(DyffRequestBase, Labeled):
+class FamilyMembersEditRequest(DyffRequestBase, commands.EditFamilyMembersAttributes):
     pass
 
 
+class LabelsEditRequest(DyffRequestBase, commands.EditEntityLabelsAttributes):
+    pass
+
+
+class LabelUpdateRequest(LabelsEditRequest):
+    """Deprecated alias for LabelsEditRequest.
+
+    .. deprecated:: 0.26.0
+
+        Use LabelsEditRequest
+    """
+
+
+# ----------------------------------------------------------------------------
+
+
 # Note: Query requests, as they currently exist, don't work with Versioned
 # because fastapi will assign None to every field that the client doesn't
 # specify. I think it's not that important, because all of the query parameters
@@ -418,6 +433,7 @@ __all__ = [
     "InferenceSessionQueryRequest",
     "InferenceSessionTokenCreateRequest",
     "LabelUpdateRequest",
+    "LabelsEditRequest",
     "MeasurementQueryRequest",
     "MethodCreateRequest",
     "MethodQueryRequest",

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

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