dyff-schema 0.8.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

dyff/schema/errors.py

@@ -0,0 +1,51 @@
+# SPDX-FileCopyrightText: 2024 UL Research Institutes
+# SPDX-License-Identifier: Apache-2.0
+
+
+from typing import NamedTuple, Optional
+
+
+class HTTPResponseStatus(NamedTuple):
+    status_code: int
+    description: str
+
+
+HTTP_400_BAD_REQUEST = HTTPResponseStatus(400, "Bad Request")
+HTTP_500_INTERNAL_SERVER_ERROR = HTTPResponseStatus(500, "Internal Server Error")
+
+
+class DyffError(Exception):
+    """Base class for Errors originating from the Dyff Platform."""
+
+    def __init__(self, message, *, http_status: Optional[HTTPResponseStatus] = None):
+        self.message = message
+        self.http_status = http_status
+
+
+class ClientError(DyffError):
+    """The error was caused by the client using an API incorrectly."""
+
+    def __init__(
+        self, message, *, http_status: HTTPResponseStatus = HTTP_400_BAD_REQUEST
+    ):
+        if not (400 <= http_status.status_code <= 499):
+            raise AssertionError(
+                f"ClientError should map to a 4xx HTTP status; got {http_status}"
+            )
+        super().__init__(message, http_status=http_status)
+
+
+class PlatformError(DyffError):
+    """The error was caused by an internal problem with the platform."""
+
+    def __init__(
+        self,
+        message,
+        *,
+        http_status: HTTPResponseStatus = HTTP_500_INTERNAL_SERVER_ERROR,
+    ):
+        if not (500 <= http_status.status_code <= 599):
+            raise AssertionError(
+                f"PlatformError should map to a 5xx HTTP status; got {http_status}"
+            )
+        super().__init__(message, http_status=http_status)

dyff/schema/v0/r1/platform.py

@@ -67,7 +67,7 @@ def _dns_domain_regex():
     Note that its maximum length is 253 characters, but we can't enforce this in the
     regex.
     """
-    return f"{_dns_label_regex()}(\.{_dns_label_regex()})*"
+    return rf"{_dns_label_regex()}(\.{_dns_label_regex()})*"
 
 
 def _k8s_domain_maxlen():
@@ -96,7 +96,7 @@ def _k8s_label_key_regex():
         * my-multi_segment.key
         * dyff.io/reserved-key
     """
-    return f"^({_dns_domain_regex()}/)?{_dns_label_regex()}$"
+    return rf"^({_dns_domain_regex()}/)?{_dns_label_regex()}$"
 
 
 def _k8s_label_key_maxlen():
@@ -126,7 +126,7 @@ def _k8s_label_value_regex():
 
     See: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
     """
-    return f"^({_k8s_label_regex()})?$"
+    return rf"^({_k8s_label_regex()})?$"
 
 
 def _k8s_label_value_maxlen():

dyff/schema/v0/r1/requests.py

@@ -12,9 +12,10 @@ resource will include the full dependency object as a sub-resource. The
 in response.
 """
 
+from __future__ import annotations
 
 from datetime import datetime
-from typing import Any, Optional, Union
+from typing import Optional, Union
 
 import pydantic
 
@@ -172,6 +173,14 @@ class LabelUpdateRequest(DyffRequestBase, Labeled):
 # will always be optional. There could be a problem if the semantics of a
 # name change, but let's just not do that!
 class DyffEntityQueryRequest(DyffRequestDefaultValidators):
+    query: Optional[str] = pydantic.Field(
+        default=None,
+        description="A JSON structure describing a query, encoded as a string."
+        " Valid keys are the same as the valid query keys for the corresponding"
+        " endpoint. Values can be scalars or lists. Lists are treated as"
+        " disjunctive queries (i.e., 'value $in list').",
+    )
+
     id: Optional[str] = pydantic.Field(default=None)
     account: Optional[str] = pydantic.Field(default=None)
     status: Optional[str] = pydantic.Field(default=None)
@@ -180,12 +189,6 @@ class DyffEntityQueryRequest(DyffRequestDefaultValidators):
         default=None, description="Labels dict represented as a JSON string."
     )
 
-    def dict(self, exclude_unset=True, **kwargs) -> dict[str, Any]:
-        return super().dict(exclude_unset=exclude_unset, **kwargs)
-
-    def json(self, exclude_unset=True, **kwargs) -> Any:
-        return super().json(exclude_unset=exclude_unset, **kwargs)
-
 
 class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
     method: Optional[str] = pydantic.Field(default=None)
@@ -194,7 +197,7 @@ class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
     evaluation: Optional[str] = pydantic.Field(default=None)
     inferenceService: Optional[str] = pydantic.Field(default=None)
     model: Optional[str] = pydantic.Field(default=None)
-    inputsAnyOf: Optional[str] = pydantic.Field(default=None)
+    inputs: Optional[str] = pydantic.Field(default=None)
 
 
 class AuditQueryRequest(DyffEntityQueryRequest):

{dyff_schema-0.8.0.dist-info → dyff_schema-0.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.8.0
+Version: 0.9.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.8.0.dist-info → dyff_schema-0.9.0.dist-info}/RECORD

@@ -2,6 +2,7 @@ dyff/schema/__init__.py,sha256=JcpxaRHNYgLjJWLjVayLlqacb2GX49Pazpwb8m-BctM,1031
 dyff/schema/adapters.py,sha256=YMTHv_2VlLGFp-Kqwa6H51hjffHmk8gXjZilHysIF5Q,123
 dyff/schema/base.py,sha256=jvaNtsSZyFfsdUZTcY_U-yfLY5_GyrMxSXhON2R9XR0,119
 dyff/schema/copydoc.py,sha256=B4ZRpQmbFxi-3l9LCHvaJiVKb9VxADgC5vey804Febc,1075
+dyff/schema/errors.py,sha256=4FwatI-0RUYYqVR0hHoifXPgANk89QgSq9PTS9FzfwU,1568
 dyff/schema/ids.py,sha256=Z3JQzlAJQC2Pam7ehxb4TXA4MIuFQN5SyzL5Ql0RukA,1422
 dyff/schema/platform.py,sha256=peHzGGSd5dQ-EFXrWDjBqMUtoOL3iCHxcV3XzW6Rjag,123
 dyff/schema/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -21,8 +22,8 @@ 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=QX1TfqX3jBafxpBnf2bUTcgP0sMyqZFFNJZQHhM48BI,19385
-dyff/schema/v0/r1/platform.py,sha256=yvIvYaXvKT2Sk1y9zzqwUpyguPZi08WFeU2AI6LhPPM,61413
-dyff/schema/v0/r1/requests.py,sha256=ADZ1FXn_lfgcI8hjNHnB6gfJK8fqrCm-oIADcDFWhpo,9728
+dyff/schema/v0/r1/platform.py,sha256=t7XKNBXByrkleLhcRZn1Et0Dtb36CtmghWeezThz_UI,61416
+dyff/schema/v0/r1/requests.py,sha256=I2K3thOsga0X9-6oRsAO1Hqgkr8qV_8haw-7ALIf_yc,9857
 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 +34,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.8.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.8.0.dist-info/METADATA,sha256=SAykB7teIygjExhNJabNE8zp2NVNAMwudB2VdtgbPx8,3459
-dyff_schema-0.8.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.8.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-dyff_schema-0.8.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.8.0.dist-info/RECORD,,
+dyff_schema-0.9.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.9.0.dist-info/METADATA,sha256=y8iwfPwD_j6hEaMZXg7wTYwt319cWdKjB2eDNRiyc14,3459
+dyff_schema-0.9.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.9.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+dyff_schema-0.9.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.9.0.dist-info/RECORD,,