datamaker-py 0.11.1__tar.gz → 0.11.2__tar.gz

{datamaker_py-0.11.1/src/datamaker_py.egg-info → datamaker_py-0.11.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamaker-py
-Version: 0.11.1
+Version: 0.11.2
 Summary: The official Python library for the Automators DataMaker API.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{datamaker_py-0.11.1 → datamaker_py-0.11.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "datamaker-py"
-version = "0.11.1"
+version = "0.11.2"
 description = "The official Python library for the Automators DataMaker API."
 readme = "README.md"
 requires-python = ">=3.11"

{datamaker_py-0.11.1 → datamaker_py-0.11.2}/src/datamaker/generated/schema.py

@@ -2237,6 +2237,7 @@ class Subsets(TypedDict):
     created: list[str]
     existing: list[str]
     skipped: int
+    unaddressable: list[str]
 
 
 class ToscaDatasetPush(TypedDict):
@@ -2249,6 +2250,7 @@ class ToscaDatasetPush(TypedDict):
     rowsCount: int
     space: str
     subsets: Subsets
+    unaddressableColumns: list[str]
 
 
 class Parameter(TypedDict):

{datamaker_py-0.11.1 → datamaker_py-0.11.2}/src/datamaker/main.py

@@ -999,7 +999,10 @@ class DataMaker:
         Returns:
             A result with dataset_id, name, space, rows_count, outcome
             ("created", "overwritten", "recreated" or "copied"), columns,
-            added_columns, subsets and example.
+            added_columns, subsets, unaddressable_columns and example.
+            Names holding [ or ] cannot appear in {TDM[...]}: such columns are
+            listed in unaddressable_columns and such subset values in
+            subsets["unaddressable"].
 
         Raises:
             ReadOnlyConnectionError: The connection is read-only (403).

{datamaker_py-0.11.1 → datamaker_py-0.11.2}/src/datamaker/routes/tosca.py

@@ -43,8 +43,12 @@ class ToscaDatasetPushResult:
     columns: List[Dict[str, str]] = field(default_factory=list)
     # Columns an overwrite added to the existing data set
     added_columns: List[str] = field(default_factory=list)
-    # {"created": [names], "existing": [names], "skipped": count}
+    # {"created": [names], "existing": [names], "skipped": count,
+    #  "unaddressable": [values with [ or ], which {TDM[...]} cannot address]}
     subsets: Dict[str, Any] = field(default_factory=dict)
+    # Columns a test step cannot read by name because they hold [ or ]. Their
+    # data is in the data set; rename them to read it with {TDM[...]}.
+    unaddressable_columns: List[str] = field(default_factory=list)
     # The API's response as sent, for fields this class does not name yet.
     raw: ToscaDatasetPush = field(
         default_factory=lambda: cast(ToscaDatasetPush, {}), repr=False, compare=False
@@ -128,7 +132,11 @@ class ToscaClient(BaseClient):
         Returns:
             A ``ToscaDatasetPushResult`` with ``dataset_id``, ``name``,
             ``space``, ``rows_count``, ``outcome``, ``columns``,
-            ``added_columns``, ``subsets`` and ``example``.
+            ``added_columns``, ``subsets``, ``unaddressable_columns`` and
+            ``example``. Names holding ``[`` or ``]`` cannot appear in
+            ``{TDM[...]}``: such columns are listed in
+            ``unaddressable_columns`` and such subset values in
+            ``subsets["unaddressable"]``.
 
         Raises:
             DataMakerError: If the arguments do not describe exactly one source.
@@ -240,7 +248,11 @@ class ToscaClient(BaseClient):
                 for column in data["columns"]
             ],
             added_columns=data["addedColumns"],
-            subsets=dict(data["subsets"]),
+            # "unaddressable" is always present, so callers can index it even
+            # against an API from before datamaker#3683, which omits it.
+            subsets={"unaddressable": [], **dict(data["subsets"])},
+            # Read with .get: an API from before datamaker#3683 omits the key.
+            unaddressable_columns=list(data.get("unaddressableColumns") or []),
             raw=data,
         )
 

{datamaker_py-0.11.1 → datamaker_py-0.11.2/src/datamaker_py.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamaker-py
-Version: 0.11.1
+Version: 0.11.2
 Summary: The official Python library for the Automators DataMaker API.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{datamaker_py-0.11.1 → datamaker_py-0.11.2}/tests/test_tosca.py

@@ -78,7 +78,12 @@ class TestPushToscaDataset:
         assert result.outcome == "created"
         assert result.columns == [{"name": "Customer", "type": "String"}]
         assert result.added_columns == []
-        assert result.subsets == {"created": ["TC-1"], "existing": [], "skipped": 0}
+        assert result.subsets == {
+            "created": ["TC-1"],
+            "existing": [],
+            "skipped": 0,
+            "unaddressable": [],
+        }
         assert result.example == "{TDM[Orders][Customer]}"
         assert result.raw == PUSHED
 
@@ -135,6 +140,36 @@ class TestPushToscaDataset:
         assert result.outcome == "overwritten"
         assert result.added_columns == ["Region"]
 
+    @patch("requests.request")
+    def test_reports_names_tdm_cannot_address(self, mock_request, api_key):
+        mock_request.return_value = ok(
+            {
+                **PUSHED,
+                "subsets": {
+                    "created": ["Checkout"],
+                    "existing": [],
+                    "skipped": 0,
+                    "unaddressable": ["Checkout [smoke]"],
+                },
+                "unaddressableColumns": ["Price [EUR]"],
+            }
+        )
+
+        result = push(api_key, input_set_id="is-1")
+
+        assert result.unaddressable_columns == ["Price [EUR]"]
+        assert result.subsets["unaddressable"] == ["Checkout [smoke]"]
+
+    @patch("requests.request")
+    def test_api_without_unaddressable_fields_still_parses(self, mock_request, api_key):
+        # PUSHED is the response shape from before datamaker#3683.
+        mock_request.return_value = ok()
+
+        result = push(api_key, input_set_id="is-1")
+
+        assert result.unaddressable_columns == []
+        assert result.subsets["unaddressable"] == []
+
     @patch("requests.request")
     def test_subsets_can_be_turned_off(self, mock_request, api_key):
         mock_request.return_value = ok()