datamasque-python 1.1.4__tar.gz → 1.1.6__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/HISTORY.rst +15 -0
  2. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/PKG-INFO +6 -1
  3. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/README.rst +5 -0
  4. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/__init__.py +3 -0
  5. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/base.py +3 -0
  6. datamasque_python-1.1.6/datamasque/client/discovery_config_libraries.py +172 -0
  7. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/dmclient.py +2 -0
  8. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/exceptions.py +16 -0
  9. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/connection.py +9 -4
  10. datamasque_python-1.1.6/datamasque/client/models/discovery_config_library.py +33 -0
  11. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/dm_instance.py +13 -0
  12. datamasque_python-1.1.6/datamasque/client/spcs.py +179 -0
  13. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/client.rst +8 -0
  14. datamasque_python-1.1.6/docs/usage.rst +49 -0
  15. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/pyproject.toml +1 -1
  16. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/setup.cfg +1 -1
  17. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_connections.py +30 -0
  18. datamasque_python-1.1.6/tests/test_discovery_config_libraries.py +625 -0
  19. datamasque_python-1.1.6/tests/test_spcs.py +157 -0
  20. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/uv.lock +90 -90
  21. datamasque_python-1.1.4/docs/usage.rst +0 -21
  22. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/.editorconfig +0 -0
  23. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/.github/workflows/ci.yml +0 -0
  24. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/.github/workflows/release-testpypi.yml +0 -0
  25. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/.github/workflows/release.yml +0 -0
  26. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/.gitignore +0 -0
  27. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/.readthedocs.yaml +0 -0
  28. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/CONTRIBUTING.rst +0 -0
  29. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/LICENSE +0 -0
  30. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/MANIFEST.in +0 -0
  31. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/Makefile +0 -0
  32. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/NOTICE +0 -0
  33. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/connections.py +0 -0
  34. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/discovery.py +0 -0
  35. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/discovery_configs.py +0 -0
  36. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/files.py +0 -0
  37. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/ifm.py +0 -0
  38. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/license.py +0 -0
  39. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/__init__.py +0 -0
  40. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/data_selection.py +0 -0
  41. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/discovery.py +0 -0
  42. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/discovery_config.py +0 -0
  43. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/files.py +0 -0
  44. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/git.py +0 -0
  45. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/ifm.py +0 -0
  46. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/license.py +0 -0
  47. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/pagination.py +0 -0
  48. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/ruleset.py +0 -0
  49. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/ruleset_library.py +0 -0
  50. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/runs.py +0 -0
  51. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/status.py +0 -0
  52. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/models/user.py +0 -0
  53. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/py.typed +0 -0
  54. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/ruleset_libraries.py +0 -0
  55. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/rulesets.py +0 -0
  56. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/runs.py +0 -0
  57. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/settings.py +0 -0
  58. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/datamasque/client/users.py +0 -0
  59. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/Makefile +0 -0
  60. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/client.models.rst +0 -0
  61. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/conf.py +0 -0
  62. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/contributing.rst +0 -0
  63. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/history.rst +0 -0
  64. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/index.rst +0 -0
  65. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/installation.rst +0 -0
  66. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/make.bat +0 -0
  67. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/modules.rst +0 -0
  68. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/docs/readme.rst +0 -0
  69. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/__init__.py +0 -0
  70. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/conftest.py +0 -0
  71. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/helpers.py +0 -0
  72. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_base.py +0 -0
  73. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_discovery.py +0 -0
  74. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_discovery_configs.py +0 -0
  75. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_files.py +0 -0
  76. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_ifm.py +0 -0
  77. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_license.py +0 -0
  78. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_pagination.py +0 -0
  79. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_ruleset_library.py +0 -0
  80. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_rulesets.py +0 -0
  81. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_runs.py +0 -0
  82. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_settings.py +0 -0
  83. {datamasque_python-1.1.4 → datamasque_python-1.1.6}/tests/test_users.py +0 -0
@@ -2,6 +2,21 @@
2
2
  History
3
3
  =======
4
4
 
5
+ 1.1.6 (2026-07-13)
6
+ ------------------
7
+
8
+ * Added discovery-config-library management APIs (``list_discovery_config_libraries``, ``create_discovery_config_library``, and friends).
9
+
10
+ 1.1.5 (2026-06-29)
11
+ ------------------
12
+
13
+ * Added support for DataMasque deployments on Snowpark Container Services (SPCS):
14
+
15
+ * Added ``spcs_pat`` to ``DataMasqueInstanceConfig`` for authenticating through the SPCS app gateway.
16
+ * Added ``SpcsGatewayAuthError``, raised when the gateway rejects the PAT.
17
+ * Added the ``spcs`` option to ``SnowflakeStageLocation``.
18
+ * Made several ``SnowflakeConnectionConfig`` fields optional, since SPCS-staged connections leave them unset.
19
+
5
20
  1.1.4 (2026-06-29)
6
21
  ------------------
7
22
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: datamasque-python
3
- Version: 1.1.4
3
+ Version: 1.1.6
4
4
  Summary: Official Python client for the DataMasque data-masking API.
5
5
  Project-URL: Homepage, https://datamasque.com/
6
6
  Project-URL: Documentation, https://datamasque-python.readthedocs.io/
@@ -74,6 +74,11 @@ Authentication is performed on the first request if ``authenticate()`` is not ca
74
74
  and is automatically retried once on a 401 response.
75
75
  ``client.healthcheck()`` is available as a lightweight readiness probe that does not consume credentials.
76
76
 
77
+ For a DataMasque instance hosted on Snowpark Container Services (SPCS)
78
+ (a ``*.snowflakecomputing.app`` ``base_url``),
79
+ pass a Snowflake Programmatic Access Token as ``spcs_pat`` on ``DataMasqueInstanceConfig``.
80
+ See the `usage docs <https://datamasque-python.readthedocs.io/en/latest/usage.html>`_ for details.
81
+
77
82
  Error handling
78
83
  ==============
79
84
 
@@ -42,6 +42,11 @@ Authentication is performed on the first request if ``authenticate()`` is not ca
42
42
  and is automatically retried once on a 401 response.
43
43
  ``client.healthcheck()`` is available as a lightweight readiness probe that does not consume credentials.
44
44
 
45
+ For a DataMasque instance hosted on Snowpark Container Services (SPCS)
46
+ (a ``*.snowflakecomputing.app`` ``base_url``),
47
+ pass a Snowflake Programmatic Access Token as ``spcs_pat`` on ``DataMasqueInstanceConfig``.
48
+ See the `usage docs <https://datamasque-python.readthedocs.io/en/latest/usage.html>`_ for details.
49
+
45
50
  Error handling
46
51
  ==============
47
52
 
@@ -80,6 +80,7 @@ from datamasque.client.models.discovery import (
80
80
  TableConstraints,
81
81
  )
82
82
  from datamasque.client.models.discovery_config import DiscoveryConfig, DiscoveryConfigId, DiscoveryConfigType
83
+ from datamasque.client.models.discovery_config_library import DiscoveryConfigLibrary, DiscoveryConfigLibraryId
83
84
  from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
84
85
  from datamasque.client.models.files import (
85
86
  DataMasqueFile,
@@ -148,6 +149,8 @@ __all__ = [
148
149
  "DatabricksConnectionConfig",
149
150
  "DiscoveryConfig",
150
151
  "DiscoveryConfigId",
152
+ "DiscoveryConfigLibrary",
153
+ "DiscoveryConfigLibraryId",
151
154
  "DiscoveryConfigNotFoundError",
152
155
  "DiscoveryConfigType",
153
156
  "DiscoveryMatch",
@@ -21,6 +21,7 @@ from datamasque.client.exceptions import (
21
21
  DataMasqueTransportError,
22
22
  )
23
23
  from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
24
+ from datamasque.client.spcs import install_spcs_gateway_auth
24
25
 
25
26
  logger = logging.getLogger(__name__)
26
27
 
@@ -137,6 +138,8 @@ class BaseClient:
137
138
  self.verify_ssl = connection_config.verify_ssl
138
139
  self.token_source = connection_config.token_source
139
140
  self._session = _build_session(self.verify_ssl)
141
+ if connection_config.spcs_pat:
142
+ install_spcs_gateway_auth(self._session, connection_config.spcs_pat)
140
143
 
141
144
  @contextmanager
142
145
  def _maybe_suppress_insecure_warning(self) -> Iterator[None]:
@@ -0,0 +1,172 @@
1
+ import logging
2
+ from typing import Optional
3
+
4
+ from datamasque.client.base import BaseClient
5
+ from datamasque.client.exceptions import DataMasqueApiError
6
+ from datamasque.client.models.discovery_config import DiscoveryConfigType
7
+ from datamasque.client.models.discovery_config_library import DiscoveryConfigLibrary, DiscoveryConfigLibraryId
8
+
9
+ logger = logging.getLogger(__name__)
10
+
11
+
12
+ class DiscoveryConfigLibraryClient(BaseClient):
13
+ """Discovery config library CRUD API methods. Mixed into `DataMasqueClient`."""
14
+
15
+ def list_discovery_config_libraries(self) -> list[DiscoveryConfigLibrary]:
16
+ """
17
+ Lists all discovery config libraries.
18
+
19
+ Unlike most list endpoints, this one is not paginated;
20
+ the server returns every library in a single response.
21
+ Note: the YAML content is not included in the list response for performance.
22
+ Use `get_discovery_config_library` to retrieve the full library with its YAML body.
23
+ """
24
+
25
+ response = self.make_request("GET", "/api/discovery/config-libraries/")
26
+ return [DiscoveryConfigLibrary.model_validate(item) for item in response.json()]
27
+
28
+ def get_discovery_config_library(self, library_id: DiscoveryConfigLibraryId) -> DiscoveryConfigLibrary:
29
+ """Retrieves a single discovery config library by ID, including its YAML content."""
30
+
31
+ response = self.make_request("GET", f"/api/discovery/config-libraries/{library_id}/")
32
+ return DiscoveryConfigLibrary.model_validate(response.json())
33
+
34
+ def _get_discovery_config_library_id_by_name(
35
+ self, name: str, config_type: DiscoveryConfigType, namespace: str
36
+ ) -> Optional[DiscoveryConfigLibraryId]:
37
+ """
38
+ Returns the ID of the library with the given name, type, and namespace, or `None` if there is none.
39
+
40
+ The listing is filtered by name to keep the response small;
41
+ type and namespace are matched client-side,
42
+ since the API's namespace filter cannot select the default (empty) namespace.
43
+ """
44
+
45
+ response = self.make_request(
46
+ "GET",
47
+ "/api/discovery/config-libraries/",
48
+ params={"name_exact": name},
49
+ )
50
+ entries = [DiscoveryConfigLibrary.model_validate(item) for item in response.json()]
51
+ matches = [
52
+ entry
53
+ for entry in entries
54
+ if entry.name == name and entry.namespace == namespace and entry.config_type is config_type
55
+ ]
56
+ if not matches:
57
+ return None
58
+
59
+ if matches[0].id is None:
60
+ raise DataMasqueApiError(
61
+ "Server returned a discovery config library list entry without an `id`.",
62
+ response=response,
63
+ )
64
+
65
+ return matches[0].id
66
+
67
+ def get_discovery_config_library_by_name(
68
+ self, name: str, config_type: DiscoveryConfigType, namespace: str = ""
69
+ ) -> Optional[DiscoveryConfigLibrary]:
70
+ """
71
+ Looks for a discovery config library matching the given name, type, and namespace (case-sensitive, exact match).
72
+
73
+ Library names are unique per type within a namespace,
74
+ so a type is required to identify a single library.
75
+ Returns it (with full YAML content) if found, otherwise `None`.
76
+ """
77
+
78
+ library_id = self._get_discovery_config_library_id_by_name(name, config_type, namespace)
79
+ if library_id is None:
80
+ return None
81
+
82
+ return self.get_discovery_config_library(library_id)
83
+
84
+ def create_discovery_config_library(self, library: DiscoveryConfigLibrary) -> DiscoveryConfigLibrary:
85
+ """
86
+ Creates a new discovery config library on the server.
87
+
88
+ Sets the library's server-assigned fields
89
+ (`id`, `is_valid`, `validation_error`, `created`, `modified`) and returns the library.
90
+ """
91
+
92
+ data = library.model_dump(exclude_none=True, by_alias=True, mode="json")
93
+ response = self.make_request("POST", "/api/discovery/config-libraries/", data=data)
94
+ created = DiscoveryConfigLibrary.model_validate(response.json())
95
+ library.id = created.id
96
+ library.is_valid = created.is_valid
97
+ library.validation_error = created.validation_error
98
+ library.created = created.created
99
+ library.modified = created.modified
100
+ logger.info('Creation of discovery config library "%s" successful', library.name)
101
+ return library
102
+
103
+ def update_discovery_config_library(self, library: DiscoveryConfigLibrary) -> DiscoveryConfigLibrary:
104
+ """
105
+ Performs a full update of the discovery config library.
106
+
107
+ The library must have its `id` set (i.e., it must have been previously created or retrieved from the server)
108
+ and its `yaml` content present.
109
+ A library's `config_type` is fixed at creation and cannot be changed by an update.
110
+ """
111
+
112
+ if library.id is None:
113
+ raise ValueError("Cannot update a discovery config library that has not been created yet (id is None)")
114
+
115
+ if library.yaml is None:
116
+ raise ValueError(
117
+ "Cannot update a discovery config library without YAML content (yaml is None); "
118
+ "list results omit YAML, so fetch the full library with `get_discovery_config_library` first"
119
+ )
120
+
121
+ data = library.model_dump(exclude_none=True, by_alias=True, mode="json")
122
+ response = self.make_request("PUT", f"/api/discovery/config-libraries/{library.id}/", data=data)
123
+ updated = DiscoveryConfigLibrary.model_validate(response.json())
124
+ library.is_valid = updated.is_valid
125
+ library.validation_error = updated.validation_error
126
+ library.modified = updated.modified
127
+ logger.debug('Update of discovery config library "%s" successful', library.name)
128
+ return library
129
+
130
+ def create_or_update_discovery_config_library(self, library: DiscoveryConfigLibrary) -> DiscoveryConfigLibrary:
131
+ """
132
+ Creates the library, or updates the existing one with the same name, namespace, and config type.
133
+
134
+ Sets the library's `id` property.
135
+ """
136
+
137
+ library_id = self._get_discovery_config_library_id_by_name(library.name, library.config_type, library.namespace)
138
+ if library_id is not None:
139
+ library.id = library_id
140
+ return self.update_discovery_config_library(library)
141
+
142
+ return self.create_discovery_config_library(library)
143
+
144
+ def delete_discovery_config_library_by_id_if_exists(
145
+ self, library_id: DiscoveryConfigLibraryId, *, force: bool = False
146
+ ) -> None:
147
+ """
148
+ Deletes the discovery config library with the given ID.
149
+
150
+ No-op if the library does not exist.
151
+
152
+ If the library is imported by any discovery configs,
153
+ the server will return 409 Conflict unless `force=True` is passed.
154
+ """
155
+
156
+ params = {"force": "true"} if force else None
157
+ self._delete_if_exists(f"/api/discovery/config-libraries/{library_id}/", params=params)
158
+
159
+ def delete_discovery_config_library_by_name_if_exists(
160
+ self, name: str, config_type: DiscoveryConfigType, namespace: str = "", *, force: bool = False
161
+ ) -> None:
162
+ """
163
+ Deletes the discovery config library with the given name, type, and namespace.
164
+
165
+ Library names are unique per type within a namespace,
166
+ so a type is required to identify a single library.
167
+ No-op if no such library exists.
168
+ """
169
+
170
+ library_id = self._get_discovery_config_library_id_by_name(name, config_type, namespace)
171
+ if library_id is not None:
172
+ self.delete_discovery_config_library_by_id_if_exists(library_id, force=force)
@@ -1,6 +1,7 @@
1
1
  from datamasque.client.base import FileOrContent, UploadFile
2
2
  from datamasque.client.connections import ConnectionClient
3
3
  from datamasque.client.discovery import DiscoveryClient
4
+ from datamasque.client.discovery_config_libraries import DiscoveryConfigLibraryClient
4
5
  from datamasque.client.discovery_configs import DiscoveryConfigClient
5
6
  from datamasque.client.files import FileClient
6
7
  from datamasque.client.license import LicenseClient
@@ -22,6 +23,7 @@ class DataMasqueClient(
22
23
  RunClient,
23
24
  DiscoveryClient,
24
25
  DiscoveryConfigClient,
26
+ DiscoveryConfigLibraryClient,
25
27
  UserClient,
26
28
  SettingsClient,
27
29
  ):
@@ -84,6 +84,22 @@ class IfmAuthError(DataMasqueIfmError):
84
84
  """Raised when the IFM client cannot obtain or refresh a JWT (e.g. invalid credentials, missing scope)."""
85
85
 
86
86
 
87
+ class SpcsGatewayAuthError(DataMasqueException):
88
+ """
89
+ Raised when a Snowflake SPCS app gateway rejects the configured `spcs_pat`.
90
+
91
+ The message includes the Snowflake-provided detail, request id,
92
+ and a hint at the likely cause
93
+ (for example an expired token, or a network policy that excludes your IP).
94
+
95
+ Deliberately a direct subclass of `DataMasqueException` rather than
96
+ `DataMasqueApiError`:
97
+ the client's 401 re-authenticate-and-retry path keys off `DataMasqueApiError`,
98
+ so keeping this outside that subtree
99
+ ensures a gateway rejection aborts immediately instead of looping.
100
+ """
101
+
102
+
87
103
  class RunNotCancellableError(DataMasqueUserError):
88
104
  """
89
105
  Raised when `cancel_run` is called against a run that is no longer eligible for cancellation.
@@ -57,6 +57,7 @@ class SnowflakeStageLocation(str, Enum):
57
57
  local = "local" # Not supported for production use
58
58
  aws_s3 = "aws_s3"
59
59
  azure_blob_storage = "azure_blob_storage"
60
+ spcs = "spcs" # DataMasque running inside Snowflake SPCS; staged on the container's own storage
60
61
 
61
62
 
62
63
  class SseSelection(Enum):
@@ -234,10 +235,14 @@ class SnowflakeConnectionConfig(ConnectionConfig):
234
235
  """
235
236
 
236
237
  database: str
237
- user: str
238
- snowflake_account_id: str
239
- snowflake_warehouse: str
240
- snowflake_storage_integration_name: str
238
+ # Optional because DataMasque-in-SPCS connections leave these unset: the agent uses the
239
+ # container's OAuth token + SNOWFLAKE_HOST/SNOWFLAKE_ACCOUNT env and the app-owned QUERY_WAREHOUSE,
240
+ # so user/account/storage-integration/warehouse are null for stage_location=spcs. Mirrors the app's
241
+ # canonical model (agent .../schemas/connection/connection.py), which types these `| None = None`.
242
+ user: Optional[str] = None
243
+ snowflake_account_id: Optional[str] = None
244
+ snowflake_warehouse: Optional[str] = None
245
+ snowflake_storage_integration_name: Optional[str] = None
241
246
  host: str = ""
242
247
  port: Optional[int] = None
243
248
  db_schema: Optional[str] = Field(default=None, alias="schema")
@@ -0,0 +1,33 @@
1
+ from datetime import datetime
2
+ from typing import NewType, Optional
3
+
4
+ from pydantic import BaseModel, ConfigDict, Field
5
+
6
+ from datamasque.client.models.discovery_config import DiscoveryConfigType
7
+ from datamasque.client.models.status import ValidationStatus
8
+
9
+ DiscoveryConfigLibraryId = NewType("DiscoveryConfigLibraryId", str)
10
+
11
+
12
+ class DiscoveryConfigLibrary(BaseModel):
13
+ """
14
+ Represents a named, namespaced, persisted YAML discovery config library.
15
+
16
+ Library names are unique per config type within a namespace,
17
+ so a database and a file library may share a name.
18
+ """
19
+
20
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
21
+
22
+ name: str
23
+ config_type: DiscoveryConfigType
24
+ namespace: str = ""
25
+ yaml: Optional[str] = Field(default=None, alias="config_yaml")
26
+ # Server-populated read-only fields, excluded from request bodies.
27
+ id: Optional[DiscoveryConfigLibraryId] = Field(default=None, exclude=True)
28
+ is_valid: Optional[ValidationStatus] = Field(default=None, exclude=True)
29
+ """Validation status; libraries are validated synchronously on create/update."""
30
+ validation_error: Optional[str] = Field(default=None, exclude=True)
31
+ """Human-readable validation error, or `None` when valid."""
32
+ created: Optional[datetime] = Field(default=None, exclude=True)
33
+ modified: Optional[datetime] = Field(default=None, exclude=True)
@@ -20,6 +20,11 @@ class DataMasqueInstanceConfig(BaseModel):
20
20
  the client prepends it with `Token ` when sending the `Authorization` header.
21
21
  The client calls `token_source` on each authentication attempt,
22
22
  so the callable is free to fetch and refresh tokens out-of-band (e.g. from a secrets manager).
23
+
24
+ `spcs_pat` is an optional Snowflake Programmatic Access Token
25
+ for reaching a DataMasque instance hosted on Snowpark Container Services (SPCS).
26
+ It layers underneath whichever DataMasque auth method
27
+ (`password` or `token_source`) you choose.
23
28
  """
24
29
 
25
30
  model_config = ConfigDict(arbitrary_types_allowed=True)
@@ -29,6 +34,14 @@ class DataMasqueInstanceConfig(BaseModel):
29
34
  password: Optional[str] = None
30
35
  verify_ssl: bool = True
31
36
  token_source: Optional[Callable[[], str]] = None
37
+ spcs_pat: Optional[str] = None
38
+ """Snowflake Programmatic Access Token
39
+ for a DataMasque instance hosted on Snowpark Container Services (SPCS),
40
+ where `base_url` ends in `.snowflakecomputing.app`.
41
+
42
+ Create the token in Snowsight (User profile → Programmatic access tokens)
43
+ for an account that can reach the SPCS app.
44
+ Leave unset for instances that are not hosted on SPCS."""
32
45
 
33
46
  @model_validator(mode="after")
34
47
  def _validate_auth_source(self) -> "DataMasqueInstanceConfig":
@@ -0,0 +1,179 @@
1
+ """
2
+ Snowflake SPCS app gateway authentication for `DataMasqueClient`.
3
+
4
+ When a DataMasque instance is hosted on Snowpark Container Services (SPCS),
5
+ its app ingress (`*.snowflakecomputing.app`) fronts every request
6
+ with a Snowflake gateway that must be cleared first.
7
+ We authenticate to the gateway with a Programmatic Access Token (PAT),
8
+ sent on `X-SF-SPCS-Authorization: Snowflake Token="<PAT>"`.
9
+ The gateway accepts the PAT on this alternate header
10
+ and strips it before forwarding to the container,
11
+ so DataMasque's own `Authorization: Token <key>` flow rides through untouched.
12
+
13
+ `install_spcs_gateway_auth` attaches this behaviour to a client's `requests.Session`:
14
+ it sets the header on the session
15
+ (so it is sent on every request, including the unauthenticated login)
16
+ and registers a response hook
17
+ that turns a gateway-originated rejection into a clear `SpcsGatewayAuthError`.
18
+ """
19
+
20
+ import re
21
+ from typing import Any, Optional
22
+
23
+ import requests
24
+
25
+ from datamasque.client.exceptions import SpcsGatewayAuthError
26
+
27
+ SPCS_GATEWAY_AUTH_HEADER = "X-SF-SPCS-Authorization"
28
+
29
+ # Body-shape discriminators for SPCS gateway error responses.
30
+ # The gateway emits JSON with `responseType` (ERROR_<UPPER_SNAKE>), `requestId`
31
+ # (canonical UUID), and `detail` (free text). All three must be present and
32
+ # match these patterns for the body to count as gateway-originated.
33
+ _GATEWAY_RESPONSE_TYPE_RE = re.compile(r"^ERROR_[A-Z][A-Z0-9_]+$")
34
+ _UUID_RE = re.compile(
35
+ r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
36
+ re.IGNORECASE,
37
+ )
38
+
39
+ # Header-shape discriminators for "this response transited a Snowflake SPCS
40
+ # gateway". The Server header and the `sfc-ss-` cookie name prefix both appear
41
+ # on every gateway-handled response (success and error alike) and aren't
42
+ # plausible to spoof by accident.
43
+ _SPCS_GATEWAY_SERVER_VALUE = "_"
44
+ _SPCS_COOKIE_PREFIX = "sfc-ss-"
45
+
46
+
47
+ def _has_spcs_gateway_header_signature(response: requests.Response) -> bool:
48
+ """
49
+ True if at least one header-level Snowflake gateway marker is present.
50
+
51
+ Looks for either `Server: _` (the gateway's literal Server header value)
52
+ or any `Set-Cookie` carrying the `sfc-ss-` cookie name prefix.
53
+ Either is sufficient — both indicate the response was emitted by,
54
+ or transited, Snowflake's SPCS ingress.
55
+ """
56
+ if response.headers.get("server", "").strip() == _SPCS_GATEWAY_SERVER_VALUE:
57
+ return True
58
+ # `Set-Cookie` may appear multiple times; `requests` flattens duplicates
59
+ # via a comma-separated value in `.headers`, but our prefix substring
60
+ # check is order- and count-insensitive.
61
+ return _SPCS_COOKIE_PREFIX in response.headers.get("set-cookie", "")
62
+
63
+
64
+ def _is_spcs_gateway_error_body(response: requests.Response) -> Optional[dict]:
65
+ """
66
+ Return the parsed body iff it is a structurally-valid gateway error.
67
+
68
+ All four conditions must hold:
69
+ 1. The body parses as JSON and is a dict.
70
+ 2. Keys `responseType`, `requestId`, `detail` are all present and string-typed.
71
+ 3. `responseType` matches `^ERROR_<UPPER_SNAKE>$`.
72
+ 4. `requestId` is a canonical 8-4-4-4-12 UUID.
73
+
74
+ Returns the parsed dict (truthy) on match, `None` on miss.
75
+ """
76
+ try:
77
+ data = response.json()
78
+ except ValueError:
79
+ return None
80
+ if not isinstance(data, dict):
81
+ return None
82
+ response_type = data.get("responseType")
83
+ request_id = data.get("requestId")
84
+ detail = data.get("detail")
85
+ if not (isinstance(response_type, str) and isinstance(request_id, str) and isinstance(detail, str)):
86
+ return None
87
+ if _GATEWAY_RESPONSE_TYPE_RE.match(response_type) and _UUID_RE.match(request_id):
88
+ return data
89
+ return None
90
+
91
+
92
+ def _hint_for_gateway_detail(detail: str) -> str:
93
+ """Map common Snowflake gateway `detail` strings to a one-line cause hint."""
94
+ d = (detail or "").lower()
95
+ if "network policy" in d:
96
+ return (
97
+ "PAT requires a network policy attached to the user (or account) "
98
+ "that permits your current public IP. Run `CREATE NETWORK POLICY "
99
+ "... ALLOWED_IP_LIST = ('<your.ip>/32')` and `ALTER USER <pat-user> "
100
+ "SET NETWORK_POLICY = <policy>`."
101
+ )
102
+ if "invalid" in d and "token" in d:
103
+ return (
104
+ "PAT is malformed, expired, or revoked. Create a new PAT in Snowsight "
105
+ "(User profile -> Programmatic access tokens) and update `spcs_pat`."
106
+ )
107
+ if "expired" in d:
108
+ return "PAT has expired. Create a fresh one in Snowsight and update `spcs_pat`."
109
+ if "authentication" in d or "unauthorized" in d:
110
+ return (
111
+ "Generic auth rejection. Verify the PAT was created by a user that "
112
+ "has access to this SPCS app, and that any account-level network "
113
+ "policy includes your current public IP."
114
+ )
115
+ return "Unknown gateway rejection — see the Snowflake `detail` string above and the Snowflake PAT docs."
116
+
117
+
118
+ def _check_spcs_gateway_response(response: requests.Response) -> None:
119
+ """
120
+ Raise `SpcsGatewayAuthError` iff `response` is a gateway-originated rejection.
121
+
122
+ Two-layer discriminator — both must hold:
123
+ * **Body originated at the gateway**:
124
+ strict shape match on the JSON body
125
+ (multiple fields, typed, with format constraints)
126
+ via `_is_spcs_gateway_error_body`.
127
+ * **Response transited an SPCS gateway**:
128
+ header signature confirms via `_has_spcs_gateway_header_signature`.
129
+
130
+ Either layer alone could in principle false-positive on an unrelated upstream
131
+ that happened to emit one of those signals;
132
+ the conjunction is what makes the check robust.
133
+ Legitimate DataMasque 401s (DRF `{"detail": "..."}`)
134
+ have the gateway header signature but fail the body shape —
135
+ so they correctly flow through
136
+ to the client's normal re-auth-and-retry path untouched.
137
+ """
138
+ if response.status_code not in (401, 403):
139
+ return
140
+ if not _has_spcs_gateway_header_signature(response):
141
+ return
142
+ data = _is_spcs_gateway_error_body(response)
143
+ if data is None:
144
+ return
145
+
146
+ response_type = data["responseType"]
147
+ request_id = data["requestId"]
148
+ detail = data["detail"]
149
+ hint = _hint_for_gateway_detail(detail)
150
+ raise SpcsGatewayAuthError(
151
+ f"SPCS gateway rejected the PAT (HTTP {response.status_code}, "
152
+ f"{response_type}). The request never reached DataMasque.\n"
153
+ f' Snowflake said: "{detail}"\n'
154
+ f" Snowflake reqId: {request_id}\n"
155
+ f" Likely cause: {hint}\n"
156
+ f" Fix in Snowsight on the account hosting this SPCS app, then retry."
157
+ )
158
+
159
+
160
+ def _spcs_gateway_response_hook(response: requests.Response, *args: Any, **kwargs: Any) -> None:
161
+ """`requests` response hook: raise on a gateway-originated auth rejection."""
162
+ _check_spcs_gateway_response(response)
163
+
164
+
165
+ def install_spcs_gateway_auth(session: requests.Session, pat: str) -> None:
166
+ """
167
+ Configure `session` to authenticate to a Snowflake SPCS app gateway.
168
+
169
+ Sets the `X-SF-SPCS-Authorization` header on the session
170
+ (so it rides on every request, including the unauthenticated login)
171
+ and registers a response hook
172
+ that raises `SpcsGatewayAuthError` on a gateway rejection.
173
+
174
+ Scoping is automatic:
175
+ the client's session only ever talks to its own `base_url`,
176
+ so there is no need to match per-request hosts.
177
+ """
178
+ session.headers[SPCS_GATEWAY_AUTH_HEADER] = f'Snowflake Token="{pat}"'
179
+ session.hooks["response"].append(_spcs_gateway_response_hook)
@@ -60,6 +60,14 @@ datamasque.client.files module
60
60
  :undoc-members:
61
61
  :show-inheritance:
62
62
 
63
+ datamasque.client.spcs module
64
+ -----------------------------
65
+
66
+ .. automodule:: datamasque.client.spcs
67
+ :members:
68
+ :undoc-members:
69
+ :show-inheritance:
70
+
63
71
  datamasque.client.ifm module
64
72
  ----------------------------
65
73
 
@@ -0,0 +1,49 @@
1
+ =====
2
+ Usage
3
+ =====
4
+
5
+ To use DataMasque Python in a project:
6
+
7
+ .. code-block:: python
8
+
9
+ from datamasque.client import DataMasqueClient
10
+ from datamasque.client.models.dm_instance import DataMasqueInstanceConfig
11
+
12
+ config = DataMasqueInstanceConfig(
13
+ base_url="https://datamasque.example.com",
14
+ username="api_user",
15
+ password="api_password",
16
+ )
17
+ client = DataMasqueClient(config)
18
+ client.authenticate()
19
+
20
+ for connection in client.list_connections():
21
+ print(connection.name)
22
+
23
+ Connecting to an SPCS-hosted instance
24
+ =====================================
25
+
26
+ When DataMasque is hosted on Snowpark Container Services (SPCS),
27
+ its `base_url` ends in `.snowflakecomputing.app`
28
+ and requests must first clear the Snowflake gateway.
29
+ Pass a Snowflake Programmatic Access Token (PAT) as `spcs_pat`
30
+ and the client clears the gateway for you,
31
+ independently of your DataMasque `username`/`password` (or `token_source`) auth.
32
+
33
+ .. code-block:: python
34
+
35
+ config = DataMasqueInstanceConfig(
36
+ base_url="https://my-app.snowflakecomputing.app",
37
+ username="api_user",
38
+ password="api_password",
39
+ spcs_pat="<snowflake-programmatic-access-token>",
40
+ )
41
+ client = DataMasqueClient(config)
42
+ client.authenticate()
43
+
44
+ Create the PAT in Snowsight (User profile → Programmatic access tokens)
45
+ for an account that can reach the SPCS app.
46
+ If the gateway rejects the PAT
47
+ (for example it has expired, or a network policy excludes your IP),
48
+ the client raises `SpcsGatewayAuthError`
49
+ with the Snowflake-provided detail and a hint at the likely cause.
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "datamasque-python"
3
- version = "1.1.4"
3
+ version = "1.1.6"
4
4
  description = "Official Python client for the DataMasque data-masking API."
5
5
  authors = [
6
6
  { name = "DataMasque Ltd" },
@@ -1,5 +1,5 @@
1
1
  [bumpversion]
2
- current_version = 1.1.3
2
+ current_version = 1.1.6
3
3
  commit = True
4
4
  tag = True
5
5