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

{dyff-client-0.2.1/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.1
+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.1 → 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
@@ -136,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:
@@ -184,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__(
@@ -196,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
@@ -206,7 +225,7 @@ 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:
@@ -426,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__(
@@ -433,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.
@@ -651,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)
@@ -900,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__(
@@ -907,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.
@@ -1082,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:
@@ -1240,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__(
@@ -1247,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.
@@ -1425,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)
@@ -1599,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.
@@ -1607,7 +1660,20 @@ 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://api.dyff.io/v0"
@@ -1640,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.1 → 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.1
+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