dyff-client 0.2.0__tar.gz → 0.2.2__tar.gz

{dyff-client-0.2.0 → dyff-client-0.2.2}/.gitlab-ci.yml

@@ -22,11 +22,11 @@ include:
     file:
       - detect-secrets.yml
   - project: buildgarden/pipelines/prettier
-    ref: 0.2.0
+    ref: 0.3.2
     file:
       - prettier.yml
   - project: buildgarden/pipelines/python
-    ref: 0.7.2
+    ref: 0.9.1
     file:
       - python-autoflake.yml
       - python-black.yml
@@ -36,6 +36,7 @@ include:
       - python-pyroma.yml
       - python-pytest.yml
       - python-twine-upload.yml
+      - python-docformatter.yml
   - project: buildgarden/pipelines/skywalking-eyes
     ref: 0.2.0
     file:
@@ -68,3 +69,7 @@ python-twine-upload-pypi:
     TWINE_USERNAME: __token__
     TWINE_PASSWORD: $PYPI_API_TOKEN
     TWINE_REPOSITORY_URL: https://upload.pypi.org/legacy/
+
+python-docformatter:
+  variables:
+    PYTHON_DOCFORMATTER_EXCLUDE: _generated

{dyff-client-0.2.0 → dyff-client-0.2.2}/.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/PyCQA/autoflake
-    rev: "v2.3.0"
+    rev: "v2.3.1"
     hooks:
       - id: autoflake
         args:
@@ -24,7 +24,7 @@ repos:
           - "--remove-all-unused-imports"
 
   - repo: https://github.com/psf/black
-    rev: 24.2.0
+    rev: 24.3.0
     hooks:
       - id: black
 
@@ -33,6 +33,13 @@ repos:
     hooks:
       - id: isort
 
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.5
+    hooks:
+      - id: docformatter
+        additional_dependencies: [tomli]
+        args: ["--in-place", "--black", "--config", "./pyproject.toml"]
+
   - repo: https://gitlab.com/buildgarden/pipelines/skywalking-eyes
     rev: "0.2.0"
     hooks:
@@ -44,12 +51,12 @@ repos:
       - id: prettier
 
   - repo: https://gitlab.com/buildgarden/tools/badgie
-    rev: "0.11.0"
+    rev: "0.11.2"
     hooks:
       - id: badgie
 
   - repo: https://gitlab.com/buildgarden/tools/cici-tools
-    rev: "0.6.0"
+    rev: "0.7.0"
     hooks:
       - id: cici-update
 

{dyff-client-0.2.0/dyff_client.egg-info → dyff-client-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-client
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python client for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{dyff-client-0.2.0 → dyff-client-0.2.2}/dyff/client/client.py

@@ -9,6 +9,7 @@ import pathlib
 import sys
 from io import BytesIO
 from typing import Any, BinaryIO, Callable, Optional, TypeVar
+from warnings import warn
 
 import httpx
 import pandas
@@ -120,10 +121,9 @@ def _require_id(x: DyffEntity | str) -> str:
 
 
 def _encode_labels(labels: Optional[dict[str, str]]) -> Optional[str]:
-    """The Python client accepts 'annotations' and 'labels' as dicts, but
-    they need to be json-encoded so that they can be forwarded as part of
-    the HTTP query parameters.
-    """
+    """The Python client accepts 'annotations' and 'labels' as dicts, but they need to
+    be json-encoded so that they can be forwarded as part of the HTTP query
+    parameters."""
     if labels is None:
         return None
     # validate
@@ -137,6 +137,15 @@ def _encode_labels(labels: Optional[dict[str, str]]) -> Optional[str]:
     return json.dumps(labels)
 
 
+def _check_deprecated_verify_ssl_certificates(
+    verify_ssl_certificates: bool, insecure: bool
+):
+    """Check if the deprecated parameter verify_ssl_certificates is set to insecure."""
+    # verify_ssl_certificates deprecated
+    # remove after 10/2024
+    return not verify_ssl_certificates or insecure
+
+
 def build_audits_upload_request(
     audit_id: str, *, file: BinaryIO, **kwargs: Any
 ) -> HttpRequest:
@@ -185,6 +194,8 @@ class InferenceSessionClient:
 
       Do not instantiate this class. Create an instance using
       :meth:`inferencesessions.client() <dyff.client.client.InferencesessionsOperations>`
+
+      `verify_ssl_certifcates` is deprecated, use `insecure` instead.
     """
 
     def __init__(
@@ -197,7 +208,14 @@ class InferenceSessionClient:
         input_adapter: Optional[Adapter] = None,
         output_adapter: Optional[Adapter] = None,
         verify_ssl_certificates: bool = True,
+        insecure: bool = False,
     ):
+        # verify_ssl_certificates deprecated
+        # remove after 10/2024
+        insecure = _check_deprecated_verify_ssl_certificates(
+            verify_ssl_certificates, insecure
+        )
+
         self._session_id = session_id
         self._token = token
         self._dyff_api_endpoint = dyff_api_endpoint
@@ -207,15 +225,15 @@ class InferenceSessionClient:
         self._output_adapter = output_adapter
 
         self._client = httpx.Client(
-            timeout=httpx.Timeout(5, read=None), verify=verify_ssl_certificates
+            timeout=httpx.Timeout(5, read=None), verify=not insecure
         )
 
     def infer(self, body: Any) -> Any:
         """Make an inference request.
 
-        The input and output are arbitrary JSON objects. The required format
-        depends on the endpoint and input/output adapters specified when
-        creating the inference client.
+        The input and output are arbitrary JSON objects. The required format depends on
+        the endpoint and input/output adapters specified when creating the inference
+        client.
 
         :param Any body: A JSON object containing the inference input.
         :returns: A JSON object containing the inference output.
@@ -287,8 +305,8 @@ class AuditsOperations:
         labels: Optional[dict[str, str]] = None,
         name: Optional[str] = None,
     ) -> list[Audit]:
-        """Get all Audits matching a query. The query is a set of equality
-        constraints specified as key-value pairs.
+        """Get all Audits matching a query. The query is a set of equality constraints
+        specified as key-value pairs.
 
         :keyword id:
         :paramtype id: str
@@ -319,8 +337,8 @@ class AuditsOperations:
         ]
 
     def label(self, audit_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified Audit with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified Audit with key-value pairs (stored in the ``.labels``
+        field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -427,6 +445,8 @@ class DatasetsOperations:
 
       Do not instantiate this class. Access it through the
       ``.datasets`` attribute of :class:`~dyff.client.Client`.
+
+      `verify_ssl_certifcates` is deprecated, use `insecure` instead.
     """
 
     def __init__(
@@ -434,9 +454,18 @@ class DatasetsOperations:
         _raw_ops: DatasetsOperationsGenerated,
         *,
         verify_ssl_certificates: bool = True,
+        insecure: bool = False,
     ):
         self._raw_ops = _raw_ops
-        self._verify_ssl_certificates = verify_ssl_certificates
+
+        # verify_ssl_certificates deprecated
+        # remove after 10/2024
+        insecure = _check_deprecated_verify_ssl_certificates(
+            verify_ssl_certificates, insecure
+        )
+
+        self._verify_ssl_certificates = not insecure
+        self._insecure = insecure
 
     def get(self, dataset_id: str) -> Dataset:
         """Get a Dataset by its key.
@@ -467,8 +496,8 @@ class DatasetsOperations:
         labels: Optional[dict[str, str]] = None,
         name: Optional[str] = None,
     ) -> list[Dataset]:
-        """Get all Datasets matching a query. The query is a set of equality
-        constraints specified as key-value pairs.
+        """Get all Datasets matching a query. The query is a set of equality constraints
+        specified as key-value pairs.
 
         :keyword id:
         :paramtype id: str
@@ -499,8 +528,8 @@ class DatasetsOperations:
         ]
 
     def label(self, dataset_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified Dataset with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified Dataset with key-value pairs (stored in the ``.labels``
+        field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -621,8 +650,8 @@ class DatasetsOperations:
         return self.create(request)
 
     def upload_arrow_dataset(self, dataset: Dataset, dataset_directory: str) -> None:
-        """Uploads the data files in an existing Arrow dataset for which a
-        Dataset resource has already been created.
+        """Uploads the data files in an existing Arrow dataset for which a Dataset
+        resource has already been created.
 
         Typical usage::
 
@@ -652,7 +681,7 @@ class DatasetsOperations:
                     put_url.url,
                     content=fin,
                     headers=headers,
-                    verify=self._verify_ssl_certificates,
+                    verify=not self._insecure,
                 )
                 response.raise_for_status()
         self._raw_ops.finalize(dataset.id)
@@ -747,8 +776,8 @@ class EvaluationsOperations:
         ]
 
     def label(self, evaluation_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified Evaluation with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified Evaluation with key-value pairs (stored in the
+        ``.labels`` field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -859,8 +888,8 @@ class InferenceservicesOperations:
         ]
 
     def label(self, service_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified InferenceService with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified InferenceService with key-value pairs (stored in the
+        ``.labels`` field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -901,6 +930,8 @@ class InferencesessionsOperations:
 
       Do not instantiate this class. Access it through the
       ``.inferencesessions`` attribute of :class:`~dyff.client.Client`.
+
+      `verify_ssl_certifcates` is deprecated, use `insecure` instead.
     """
 
     def __init__(
@@ -908,9 +939,18 @@ class InferencesessionsOperations:
         _raw_ops: InferencesessionsOperationsGenerated,
         *,
         verify_ssl_certificates: bool = True,
+        insecure: bool = False,
     ):
         self._raw_ops = _raw_ops
-        self._verify_ssl_certificates = verify_ssl_certificates
+
+        # verify_ssl_certificates deprecated
+        # remove after 10/2024
+        insecure = _check_deprecated_verify_ssl_certificates(
+            verify_ssl_certificates, insecure
+        )
+
+        self._verify_ssl_certificates = not insecure
+        self._insecure = insecure
 
     def get(self, session_id: str) -> InferenceSession:
         """Get an InferenceSession by its key.
@@ -985,8 +1025,8 @@ class InferencesessionsOperations:
         ]
 
     def label(self, session_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified InferenceSession with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified InferenceSession with key-value pairs (stored in the
+        ``.labels`` field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -1031,8 +1071,8 @@ class InferencesessionsOperations:
         input_adapter: Optional[Adapter] = None,
         output_adapter: Optional[Adapter] = None,
     ) -> InferenceSessionClient:
-        """Create an InferenceSessionClient that interacts with the given
-        inference session. The token should be one returned either from
+        """Create an InferenceSessionClient that interacts with the given inference
+        session. The token should be one returned either from
         ``Client.inferencesessions.create()`` or from
         ``Client.inferencesessions.token(session_id)``.
 
@@ -1083,7 +1123,7 @@ class InferencesessionsOperations:
             inference_endpoint=endpoint,
             input_adapter=input_adapter,
             output_adapter=output_adapter,
-            verify_ssl_certificates=self._verify_ssl_certificates,
+            insecure=self._insecure,
         )
 
     def ready(self, session_id: str) -> bool:
@@ -1171,8 +1211,8 @@ class ModelsOperations:
         labels: Optional[dict[str, str]] = None,
         name: Optional[str] = None,
     ) -> list[Model]:
-        """Get all Models matching a query. The query is a set of equality
-        constraints specified as key-value pairs.
+        """Get all Models matching a query. The query is a set of equality constraints
+        specified as key-value pairs.
 
         :keyword id:
         :paramtype id: str
@@ -1203,8 +1243,8 @@ class ModelsOperations:
         ]
 
     def label(self, model_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified Model with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified Model with key-value pairs (stored in the ``.labels``
+        field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -1241,6 +1281,8 @@ class ModulesOperations:
 
       Do not instantiate this class. Access it through the
       ``.modules`` attribute of :class:`~dyff.client.Client`.
+
+      `verify_ssl_certifcates` is deprecated, use `insecure` instead.
     """
 
     def __init__(
@@ -1248,9 +1290,18 @@ class ModulesOperations:
         _raw_ops: ModulesOperationsGenerated,
         *,
         verify_ssl_certificates: bool = True,
+        insecure: bool = False,
     ):
         self._raw_ops = _raw_ops
-        self._verify_ssl_certificates = verify_ssl_certificates
+
+        # verify_ssl_certificates deprecated
+        # remove after 10/2024
+        insecure = _check_deprecated_verify_ssl_certificates(
+            verify_ssl_certificates, insecure
+        )
+
+        self._verify_ssl_certificates = not insecure
+        self._insecure = insecure
 
     def get(self, module_id: str) -> Module:
         """Get a Module by its key.
@@ -1281,8 +1332,8 @@ class ModulesOperations:
         labels: Optional[dict[str, str]] = None,
         name: Optional[str] = None,
     ) -> list[Module]:
-        """Get all Modules matching a query. The query is a set of equality
-        constraints specified as key-value pairs.
+        """Get all Modules matching a query. The query is a set of equality constraints
+        specified as key-value pairs.
 
         :keyword id:
         :paramtype id: str
@@ -1313,8 +1364,8 @@ class ModulesOperations:
         ]
 
     def label(self, module_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified Module with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified Module with key-value pairs (stored in the ``.labels``
+        field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -1346,8 +1397,7 @@ class ModulesOperations:
     def create_package(
         self, package_directory: str, *, account: str, name: str
     ) -> Module:
-        """Create a Module resource describing a package structured as a
-        directory tree.
+        """Create a Module resource describing a package structured as a directory tree.
 
         Internally, constructs a ``ModuleCreateRequest`` using information
         obtained from the directory tree, then calls ``create()`` with the
@@ -1396,8 +1446,8 @@ class ModulesOperations:
         return self.create(request)
 
     def upload_package(self, module: Module, package_directory: str) -> None:
-        """Uploads the files in a package directory for which a Module resource
-        has already been created.
+        """Uploads the files in a package directory for which a Module resource has
+        already been created.
 
         Typical usage::
 
@@ -1427,7 +1477,7 @@ class ModulesOperations:
                     put_url.url,
                     content=fin,
                     headers=headers,
-                    verify=self._verify_ssl_certificates,
+                    verify=not self._insecure,
                 )
                 response.raise_for_status()
         self._raw_ops.finalize(module.id)
@@ -1478,8 +1528,8 @@ class ReportsOperations:
         inferenceService: Optional[str] = None,
         model: Optional[str] = None,
     ) -> list[Report]:
-        """Get all Reports matching a query. The query is a set of equality
-        constraints specified as key-value pairs.
+        """Get all Reports matching a query. The query is a set of equality constraints
+        specified as key-value pairs.
 
         :keyword id:
         :paramtype id: str
@@ -1522,8 +1572,8 @@ class ReportsOperations:
         ]
 
     def label(self, report_id: str, labels: dict[str, Optional[str]]) -> None:
-        """Label the specified Report with key-value pairs (stored in
-        the ``.labels`` field of the resource).
+        """Label the specified Report with key-value pairs (stored in the ``.labels``
+        field of the resource).
 
         Providing ``None`` for the value deletes the label.
 
@@ -1601,6 +1651,7 @@ class Client:
         api_key: str,
         endpoint: Optional[str] = None,
         verify_ssl_certificates: bool = True,
+        insecure: bool = False,
     ):
         """
         :param str api_key: An API token to use for authentication.
@@ -1609,10 +1660,23 @@ class Client:
         :param bool verify_ssl_certificates: You can disable certificate
             verification for testing; you should do this only if you have
             also changed ``endpoint`` to point to a trusted local server.
+
+            .. deprecated:: 0.2.2
+                Use insecure instead
+        :param bool insecure: Disable certificate verification for testing.
+            you should do this only if you have
+            also changed ``endpoint`` to point to a trusted local server.
         """
+        if not verify_ssl_certificates:
+            warn("verify_ssl_certificates is deprecated", DeprecationWarning)
+        # verify_ssl_certificates deprecated
+        # remove after 10/2024
+        insecure = _check_deprecated_verify_ssl_certificates(
+            verify_ssl_certificates, insecure
+        )
 
         if endpoint is None:
-            endpoint = "https://apis.alignmentlabs.ai/dyff/v0"
+            endpoint = "https://api.dyff.io/v0"
         credential = _APIKeyCredential(api_key=api_key)
         authentication_policy = BearerTokenCredentialPolicy(credential)
         self._raw = RawClient(
@@ -1642,26 +1706,24 @@ class Client:
         # >> print(self._pipeline._transport.connection_config.verify)
         # True
         self._raw._client._pipeline._transport.connection_config.verify = (  # type: ignore
-            verify_ssl_certificates
+            not insecure
         )
 
         self._audits = AuditsOperations(self._raw.audits)
         self._auditprocedures = AuditproceduresOperations(self._raw.auditprocedures)
-        self._datasets = DatasetsOperations(
-            self._raw.datasets, verify_ssl_certificates=verify_ssl_certificates
-        )
+        self._datasets = DatasetsOperations(self._raw.datasets, insecure=insecure)
         self._evaluations = EvaluationsOperations(self._raw.evaluations)
         self._inferenceservices = InferenceservicesOperations(
             self._raw.inferenceservices
         )
         self._inferencesessions = InferencesessionsOperations(
             self._raw.inferencesessions,
-            verify_ssl_certificates=verify_ssl_certificates,
+            insecure=insecure,
         )
         self._models = ModelsOperations(self._raw.models)
         self._modules = ModulesOperations(
             self._raw.modules,
-            verify_ssl_certificates=verify_ssl_certificates,
+            insecure=insecure,
         )
         self._reports = ReportsOperations(self._raw.reports)
 

{dyff-client-0.2.0 → dyff-client-0.2.2/dyff_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-client
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python client for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0