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

{datamaker_py-0.10.0 → datamaker_py-0.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datamaker-py
-Version: 0.10.0
+Version: 0.11.1
 Summary: The official Python library for the Automators DataMaker API.
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -62,6 +62,35 @@ if __name__ == "__main__":
 
 ```
 
+## Push a set into Tosca Cloud
+
+`push_tosca_dataset` creates or replaces a native Tosca Cloud data set from a saved
+set, an input set version, a dataset or inline rows. A Tosca test step reads it with
+`{TDM[<data set>][<subset>][<column>]}`.
+
+```python
+from datamaker import DataMaker, ToscaDatasetSchemaChangedError
+
+dm = DataMaker()
+
+try:
+    result = dm.push_tosca_dataset(
+        integration_id,
+        name="Orders",
+        input_set_id="is_123",        # or set_id=..., dataset_id=..., rows=[...]
+        on_existing="overwrite",      # "fail" (default) | "overwrite" | "new"
+    )
+    print(result.dataset_id, result.rows_count, result.outcome, result.example)
+except ToscaDatasetSchemaChangedError as e:
+    # The rows dropped a column the data set has. Pass on_schema_change="recreate"
+    # to delete and recreate it instead.
+    print("removed:", e.removed_columns, "added:", e.added_columns)
+```
+
+An input set gets one Tosca subset per test case by default; `subsets_by` picks another
+column or turns it off with `False`. `get_tosca_datasets(integration_id)` lists what a
+space already holds.
+
 ## Autocomplete Types
 
 This SDK automatically generates TypeScript autocomplete definitions for use in the [datamaker application](https://github.com/automators/datamaker). 
@@ -108,7 +137,8 @@ python scripts/generate_schema.py
 CI runs `python scripts/generate_schema.py --check` and fails if the committed
 types drift from the spec.
 
-Three schemas cannot currently be generated (`SetDetail`, `PackInstallListItem`,
-`SchemaGraphNavigation`): they are composed with `allOf`, which the generator
-merges away rather than emitting as a named class. Methods returning those keep
+Five schemas cannot currently be generated (`SetDetail`, `DatasetDetail`,
+`InputSetDetail`, `PackInstallListItem`, `SchemaGraphNavigation`): they are composed
+with `allOf`, or only appear inside a union, so the generator does not emit them as a
+named class. Methods returning those keep
 `Dict`. The generator script lists them explicitly and fails if the set grows.

{datamaker_py-0.10.0 → datamaker_py-0.11.1}/README.md

@@ -51,6 +51,35 @@ if __name__ == "__main__":
 
 ```
 
+## Push a set into Tosca Cloud
+
+`push_tosca_dataset` creates or replaces a native Tosca Cloud data set from a saved
+set, an input set version, a dataset or inline rows. A Tosca test step reads it with
+`{TDM[<data set>][<subset>][<column>]}`.
+
+```python
+from datamaker import DataMaker, ToscaDatasetSchemaChangedError
+
+dm = DataMaker()
+
+try:
+    result = dm.push_tosca_dataset(
+        integration_id,
+        name="Orders",
+        input_set_id="is_123",        # or set_id=..., dataset_id=..., rows=[...]
+        on_existing="overwrite",      # "fail" (default) | "overwrite" | "new"
+    )
+    print(result.dataset_id, result.rows_count, result.outcome, result.example)
+except ToscaDatasetSchemaChangedError as e:
+    # The rows dropped a column the data set has. Pass on_schema_change="recreate"
+    # to delete and recreate it instead.
+    print("removed:", e.removed_columns, "added:", e.added_columns)
+```
+
+An input set gets one Tosca subset per test case by default; `subsets_by` picks another
+column or turns it off with `False`. `get_tosca_datasets(integration_id)` lists what a
+space already holds.
+
 ## Autocomplete Types
 
 This SDK automatically generates TypeScript autocomplete definitions for use in the [datamaker application](https://github.com/automators/datamaker). 
@@ -97,7 +126,8 @@ python scripts/generate_schema.py
 CI runs `python scripts/generate_schema.py --check` and fails if the committed
 types drift from the spec.
 
-Three schemas cannot currently be generated (`SetDetail`, `PackInstallListItem`,
-`SchemaGraphNavigation`): they are composed with `allOf`, which the generator
-merges away rather than emitting as a named class. Methods returning those keep
+Five schemas cannot currently be generated (`SetDetail`, `DatasetDetail`,
+`InputSetDetail`, `PackInstallListItem`, `SchemaGraphNavigation`): they are composed
+with `allOf`, or only appear inside a union, so the generator does not emit them as a
+named class. Methods returning those keep
 `Dict`. The generator script lists them explicitly and fails if the set grows.

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

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

datamaker_py-0.11.1/src/datamaker/__init__.py

@@ -0,0 +1,12 @@
+from .main import DataMaker  # noqa
+from .template import Template  # noqa
+from .error import (  # noqa
+    DataMakerError,
+    DataMakerAPIError,
+    ReadOnlyConnectionError,
+    ToscaDatasetExistsError,
+    ToscaDatasetLockedError,
+    ToscaDatasetSchemaChangedError,
+    ToscaDatasetTooLargeError,
+)
+from .routes.tosca import ToscaDatasetPushResult  # noqa

datamaker_py-0.11.1/src/datamaker/error.py

@@ -0,0 +1,94 @@
+from typing import Any, List, Optional
+
+
+class DataMakerError(Exception):
+    pass
+
+
+class DataMakerAPIError(DataMakerError):
+    """The API answered with a non-2xx status.
+
+    Subclasses ``DataMakerError`` and keeps its message, so existing
+    ``except DataMakerError`` handlers are unaffected. Adds the status code and
+    the decoded JSON body (``None`` when the body was not JSON).
+    """
+
+    def __init__(self, message: str, status_code: int, body: Any = None):
+        super().__init__(message)
+        self.status_code = status_code
+        self.body = body
+
+    def _detail(self, key: str) -> Any:
+        return self.body.get(key) if isinstance(self.body, dict) else None
+
+
+class ReadOnlyConnectionError(DataMakerAPIError):
+    """403: the connection is read-only, so DataMaker refused the write."""
+
+
+class ToscaDatasetExistsError(DataMakerAPIError):
+    """409: a Tosca data set of that name exists and ``on_existing`` is "fail"."""
+
+    @property
+    def dataset_id(self) -> Optional[str]:
+        """The id of the data set that is already there."""
+        return self._detail("datasetId")
+
+
+class ToscaDatasetLockedError(DataMakerAPIError):
+    """409: the data set is locked in Tosca Cloud, so it cannot be overwritten.
+
+    A test run or a "Test data - Expert" step holds it. Retry once it is
+    unlocked.
+    """
+
+    @property
+    def dataset_id(self) -> Optional[str]:
+        return self._detail("datasetId")
+
+
+class ToscaDatasetSchemaChangedError(DataMakerAPIError):
+    """409: an overwrite would drop columns the Tosca data set has.
+
+    Tosca only overwrites in place when the columns match. Added columns are
+    handled by the API; a removed column is refused unless the push asks for
+    ``on_schema_change="recreate"``.
+    """
+
+    @property
+    def dataset_id(self) -> Optional[str]:
+        return self._detail("datasetId")
+
+    @property
+    def added_columns(self) -> List[str]:
+        return self._detail("added") or []
+
+    @property
+    def removed_columns(self) -> List[str]:
+        return self._detail("removed") or []
+
+
+class ToscaDatasetTooLargeError(DataMakerAPIError):
+    """413: more rows or bytes than one push may write.
+
+    The row pair (``max_rows``, ``rows``) or the byte pair (``max_bytes``,
+    ``bytes``) is set, depending on which cap was hit. A set, input set or
+    dataset refused before its rows are loaded carries neither; the message
+    names the cap.
+    """
+
+    @property
+    def max_rows(self) -> Optional[int]:
+        return self._detail("maxRows")
+
+    @property
+    def rows(self) -> Optional[int]:
+        return self._detail("rows")
+
+    @property
+    def max_bytes(self) -> Optional[int]:
+        return self._detail("maxBytes")
+
+    @property
+    def bytes(self) -> Optional[int]:
+        return self._detail("bytes")