datamasque-python 1.5.0__tar.gz → 1.5.1__tar.gz

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/HISTORY.rst

@@ -2,6 +2,14 @@
 History
 =======
 
+1.5.1 (2026-11-05)
+------------------
+
+* Every request now has a connect and a read timeout,
+  so a server that stops answering raises ``DataMasqueTransportError`` instead of hanging the caller.
+  Set them with ``connect_timeout_seconds`` (default 10) and ``read_timeout_seconds`` (default 300)
+  on the instance config models.
+
 1.5.0 (2026-10-07)
 ------------------
 

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: datamasque-python
-Version: 1.5.0
+Version: 1.5.1
 Summary: Official Python client for the DataMasque data-masking API.
 Project-URL: Homepage, https://datamasque.com/
 Project-URL: Documentation, https://datamasque-python.readthedocs.io/

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/datamasque/client/base.py

@@ -138,6 +138,7 @@ class BaseClient:
         self.verify_ssl = connection_config.verify_ssl
         self.token_source = connection_config.token_source
         self._session = _build_session(self.verify_ssl)
+        self._timeout = (connection_config.connect_timeout_seconds, connection_config.read_timeout_seconds)
         if connection_config.spcs_pat:
             install_spcs_gateway_auth(self._session, connection_config.spcs_pat)
 
@@ -252,8 +253,11 @@ class BaseClient:
                             params=params,
                             headers=headers,
                             files=files_payload,
+                            timeout=self._timeout,
                         )
-                    return self._session.request(method, url, json=data, params=params, headers=headers)
+                    return self._session.request(
+                        method, url, json=data, params=params, headers=headers, timeout=self._timeout
+                    )
             except requests.RequestException as e:
                 raise DataMasqueTransportError(f"Failed to reach DataMasque server at {url}: {e}") from e
 

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/datamasque/client/ifm.py

@@ -85,6 +85,7 @@ class DataMasqueIfmClient:
         # One session for both admin-server (JWT login/refresh) and IFM (data plane)
         # traffic -- different hosts, but a single session handles per-host pooling.
         self._session = _build_session(self.verify_ssl)
+        self._timeout = (connection_config.connect_timeout_seconds, connection_config.read_timeout_seconds)
 
     def authenticate(self) -> None:
         """Obtain an access (and refresh) token from the admin server, or via `token_source`."""
@@ -101,6 +102,7 @@ class DataMasqueIfmClient:
                 response = self._session.post(
                     login_url,
                     json={"username": self.username, "password": self.password},
+                    timeout=self._timeout,
                 )
         except requests.RequestException as e:
             raise DataMasqueTransportError(f"Failed to reach admin server at {login_url}: {e}") from e
@@ -127,6 +129,7 @@ class DataMasqueIfmClient:
                 response = self._session.post(
                     refresh_url,
                     json={"refresh": self.refresh_token},
+                    timeout=self._timeout,
                 )
         except requests.RequestException as e:
             raise DataMasqueTransportError(f"Failed to reach admin server at {refresh_url}: {e}") from e
@@ -194,6 +197,7 @@ class DataMasqueIfmClient:
                         json=json_body,
                         params=params,
                         headers={"Authorization": f"Bearer {self.access_token}"},
+                        timeout=self._timeout,
                     )
             except requests.RequestException as e:
                 raise DataMasqueTransportError(f"Failed to reach IFM server at {url}: {e}") from e

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/datamasque/client/models/dm_instance.py

@@ -4,6 +4,9 @@ from pydantic import BaseModel, ConfigDict, model_validator
 
 from datamasque.client.exceptions import DataMasqueUserError
 
+DEFAULT_CONNECT_TIMEOUT_SECONDS = 10.0
+DEFAULT_READ_TIMEOUT_SECONDS = 300.0
+
 
 class DataMasqueInstanceConfig(BaseModel):
     """
@@ -42,6 +45,10 @@ class DataMasqueInstanceConfig(BaseModel):
     Create the token in Snowsight (User profile → Programmatic access tokens)
     for an account that can reach the SPCS app.
     Leave unset for instances that are not hosted on SPCS."""
+    connect_timeout_seconds: float = DEFAULT_CONNECT_TIMEOUT_SECONDS
+    """How long a request may take to connect, including the TLS handshake."""
+    read_timeout_seconds: float = DEFAULT_READ_TIMEOUT_SECONDS
+    """How long a request may wait for the server between bytes of its response."""
 
     @model_validator(mode="after")
     def _validate_auth_source(self) -> "DataMasqueInstanceConfig":

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/datamasque/client/models/ifm.py

@@ -6,6 +6,7 @@ from typing import Any, Callable, Optional
 from pydantic import BaseModel, ConfigDict, model_validator
 
 from datamasque.client.exceptions import DataMasqueUserError
+from datamasque.client.models.dm_instance import DEFAULT_CONNECT_TIMEOUT_SECONDS, DEFAULT_READ_TIMEOUT_SECONDS
 
 
 class RulesetPlanOptions(BaseModel):
@@ -167,6 +168,10 @@ class DataMasqueIfmInstanceConfig(BaseModel):
     password: Optional[str] = None
     verify_ssl: bool = True
     token_source: Optional[Callable[[], str]] = None
+    connect_timeout_seconds: float = DEFAULT_CONNECT_TIMEOUT_SECONDS
+    """How long a request may take to connect, including the TLS handshake."""
+    read_timeout_seconds: float = DEFAULT_READ_TIMEOUT_SECONDS
+    """How long a request may wait for the server between bytes of its response."""
 
     @model_validator(mode="after")
     def _validate_auth_source(self) -> "DataMasqueIfmInstanceConfig":

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "datamasque-python"
-version = "1.5.0"
+version = "1.5.1"
 description = "Official Python client for the DataMasque data-masking API."
 authors = [
     { name = "DataMasque Ltd" },

datamasque_python-1.5.1/tests/test_timeouts.py

@@ -0,0 +1,58 @@
+"""Every request the clients send has a connect and a read timeout."""
+
+import requests_mock
+
+from datamasque.client import DataMasqueClient, DataMasqueIfmClient, DataMasqueIfmInstanceConfig
+from datamasque.client.models.dm_instance import DEFAULT_CONNECT_TIMEOUT_SECONDS, DEFAULT_READ_TIMEOUT_SECONDS
+
+ADMIN = "http://admin.test"
+IFM = "http://ifm.test"
+
+
+def test_a_request_gets_the_default_timeouts(client):
+    with requests_mock.Mocker() as m:
+        m.get("http://test-server/api/healthcheck/", status_code=200)
+        client.healthcheck()
+
+    assert m.request_history[0].timeout == (DEFAULT_CONNECT_TIMEOUT_SECONDS, DEFAULT_READ_TIMEOUT_SECONDS)
+
+
+def test_the_timeouts_come_from_the_config(config):
+    client = DataMasqueClient(config.model_copy(update={"connect_timeout_seconds": 3, "read_timeout_seconds": 900}))
+
+    with requests_mock.Mocker() as m:
+        m.post("http://test-server/api/auth/token/login/", json={"key": "test_token"}, status_code=200)
+        client.authenticate()
+
+    assert m.request_history[0].timeout == (3, 900)
+
+
+def test_every_ifm_request_gets_the_config_timeouts():
+    client = DataMasqueIfmClient(
+        DataMasqueIfmInstanceConfig(
+            admin_server_base_url=ADMIN,
+            ifm_base_url=IFM,
+            username="ifm_user",
+            password="ifm_password",
+            read_timeout_seconds=60,
+        )
+    )
+    client.access_token = "access-1"
+    client.refresh_token = "refresh-1"
+
+    with requests_mock.Mocker() as m:
+        m.get(
+            f"{IFM}/ruleset-plans/",
+            [{"status_code": 401}, {"json": {"items": [], "total": 0, "limit": 100, "offset": 0}, "status_code": 200}],
+        )
+        m.post(f"{ADMIN}/api/auth/jwt/refresh/", status_code=401)
+        m.post(f"{ADMIN}/api/auth/jwt/login/", json={"access_token": "ACC", "refresh_token": "REF"}, status_code=200)
+        client.list_ruleset_plans()
+
+    assert [request.path for request in m.request_history] == [
+        "/ruleset-plans/",
+        "/api/auth/jwt/refresh/",
+        "/api/auth/jwt/login/",
+        "/ruleset-plans/",
+    ]
+    assert {request.timeout for request in m.request_history} == {(DEFAULT_CONNECT_TIMEOUT_SECONDS, 60)}

{datamasque_python-1.5.0 → datamasque_python-1.5.1}/uv.lock

@@ -419,7 +419,7 @@ toml = [
 
 [[package]]
 name = "datamasque-python"
-version = "1.5.0"
+version = "1.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },