gooddata-sdk 1.40.1.dev4__tar.gz → 1.40.1.dev6__tar.gz

{gooddata_sdk-1.40.1.dev4/gooddata_sdk.egg-info → gooddata_sdk-1.40.1.dev6}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: gooddata-sdk
-Version: 1.40.1.dev4
+Version: 1.40.1.dev6
 Summary: GoodData Cloud Python SDK
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.40.1.dev4
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.40.1.dev6
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Keywords: gooddata,sdk,api,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
 Classifier: Development Status :: 5 - Production/Stable
@@ -23,7 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-api-client~=1.40.1.dev4
+Requires-Dist: gooddata-api-client~=1.40.1.dev6
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: attrs<=24.2.0,>=21.4.0
@@ -59,7 +59,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev4) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev6) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6}/README.md

@@ -13,7 +13,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev4) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev6) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6}/gooddata_sdk/client.py

@@ -24,6 +24,7 @@ class GoodDataApiClient:
         token: str,
         custom_headers: Optional[dict[str, str]] = None,
         extra_user_agent: Optional[str] = None,
+        executions_cancellable: bool = False,
     ) -> None:
         """Take url, token for connecting to GoodData.CN.
 
@@ -32,6 +33,11 @@ class GoodDataApiClient:
 
         `extra_user_agent` is optional string to be added to default http User-Agent
         header. This takes precedence over custom_headers setting.
+
+        `executions_cancellable` is a flag that sets all executions computed through this client as cancellable.
+        In case a request for a result is interrupted, the GD server will try to free resources like killing sql queries
+        related to the given execution.
+        *This feature does not work yet, it will be rolled out soon.*
         """
         self._hostname = host
         self._token = token
@@ -57,6 +63,7 @@ class GoodDataApiClient:
         self._layout_api = apis.LayoutApi(self._api_client)
         self._actions_api = apis.ActionsApi(self._api_client)
         self._user_management_api = apis.UserManagementApi(self._api_client)
+        self._executions_cancellable = executions_cancellable
 
     def _do_post_request(
         self,
@@ -138,3 +145,7 @@ class GoodDataApiClient:
     @property
     def user_management_api(self) -> apis.UserManagementApi:
         return self._user_management_api
+
+    @property
+    def executions_cancellable(self) -> bool:
+        return self._executions_cancellable

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6}/gooddata_sdk/compute/model/execution.py

@@ -60,12 +60,14 @@ class ExecutionDefinition:
         filters: Optional[list[Filter]],
         dimensions: list[TableDimension],
         totals: Optional[list[TotalDefinition]] = None,
+        is_cancellable: bool = False,
     ) -> None:
         self._attributes = attributes or []
         self._metrics = metrics or []
         self._filters = filters or []
         self._dimensions = [dim for dim in dimensions if dim.item_ids is not None]
         self._totals = totals
+        self._is_cancellable = is_cancellable
 
     @property
     def attributes(self) -> list[Attribute]:
@@ -98,6 +100,10 @@ class ExecutionDefinition:
     def is_two_dim(self) -> bool:
         return len(self.dimensions) == 2
 
+    @property
+    def is_cancellable(self) -> bool:
+        return self._is_cancellable
+
     def _create_value_sort_key(self, sort_key: dict) -> models.SortKey:
         sort_key_value = sort_key["value"]
         return models.SortKey(
@@ -296,6 +302,7 @@ class BareExecutionResponse:
         api_client: GoodDataApiClient,
         workspace_id: str,
         execution_response: models.AfmExecutionResponse,
+        cancel_token: Optional[str] = None,
     ):
         self._api_client = api_client
         self._actions_api = self._api_client.actions_api
@@ -303,6 +310,7 @@ class BareExecutionResponse:
 
         self._exec_response: models.ExecutionResponse = execution_response["execution_response"]
         self._afm_exec_response = execution_response
+        self._cancel_token = cancel_token
 
     @property
     def workspace_id(self) -> str:
@@ -316,6 +324,10 @@ class BareExecutionResponse:
     def dimensions(self) -> Any:
         return self._exec_response["dimensions"]
 
+    @property
+    def cancel_token(self) -> Optional[str]:
+        return self._cancel_token
+
     def read_result(self, limit: Union[int, list[int]], offset: Union[None, int, list[int]] = None) -> ExecutionResult:
         """
         Reads from the execution result.
@@ -335,6 +347,7 @@ class BareExecutionResponse:
             limit=_limit,
             _check_return_type=False,
             _return_http_data_only=False,
+            **({"x_gdc_cancel_token": self.cancel_token} if self.cancel_token else {}),
         )
         custom_headers = self._api_client.custom_headers
         if "X-GDC-TRACE-ID" in custom_headers and "X-GDC-TRACE-ID" in http_headers:
@@ -351,7 +364,7 @@ class BareExecutionResponse:
         return self.__repr__()
 
     def __repr__(self) -> str:
-        return f"BareExecutionResponse(workspace_id={self.workspace_id}, result_id={self.result_id})"
+        return f"BareExecutionResponse(workspace_id={self.workspace_id}, result_id={self.result_id}, cancel_token={self.cancel_token})"
 
 
 class Execution:
@@ -367,12 +380,11 @@ class Execution:
         workspace_id: str,
         exec_def: ExecutionDefinition,
         response: models.AfmExecutionResponse,
+        cancel_token: Optional[str] = None,
     ):
         self._exec_def = exec_def
         self._bare_exec_response = BareExecutionResponse(
-            api_client=api_client,
-            workspace_id=workspace_id,
-            execution_response=response,
+            api_client=api_client, workspace_id=workspace_id, execution_response=response, cancel_token=cancel_token
         )
 
     @property
@@ -395,6 +407,10 @@ class Execution:
     def dimensions(self) -> Any:
         return self.bare_exec_response._exec_response["dimensions"]
 
+    @property
+    def cancel_token(self) -> Optional[str]:
+        return self.bare_exec_response.cancel_token
+
     def get_labels_and_formats(self) -> tuple[dict[str, str], dict[str, str]]:
         """
         Extracts labels and custom measure formats from the execution response.
@@ -425,7 +441,9 @@ class Execution:
         return self.__repr__()
 
     def __repr__(self) -> str:
-        return f"Execution(workspace_id={self.workspace_id}, result_id={self.bare_exec_response.result_id})"
+        return (
+            f"Execution(workspace_id={self.workspace_id}, result_id={self.result_id}, cancel_token={self.cancel_token})"
+        )
 
 
 # Originally ExecutionResponse contained also ExecutionDefinition which was not correct, therefore Execution class was

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6}/gooddata_sdk/compute/service.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 
 import logging
 
+from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens
 from gooddata_api_client.model.chat_history_request import ChatHistoryRequest
 from gooddata_api_client.model.chat_history_result import ChatHistoryResult
 from gooddata_api_client.model.chat_request import ChatRequest
@@ -41,6 +42,9 @@ class ComputeService:
             workspace_id=workspace_id,
             exec_def=exec_def,
             response=response,
+            cancel_token=response.headers.get("X-GDC-CANCEL-TOKEN")
+            if exec_def.is_cancellable or self._api_client.executions_cancellable
+            else None,
         )
 
     def retrieve_result_cache_metadata(self, workspace_id: str, result_id: str) -> ResultCacheMetadata:
@@ -107,3 +111,24 @@ class ComputeService:
         """
         chat_history_request = ChatHistoryRequest(reset=True)
         self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False)
+
+    def cancel_executions(self, executions: list[Execution]) -> None:
+        """
+        Try to cancel given executions using the cancel api endpoint.
+
+        *Note that this is currently a noop, we will be enabling this functionality soon.*
+
+        Args:
+            executions: list of executions to send for cancellation
+        """
+        workspace_to_tokens: dict[str, set[str]] = {}
+
+        for execution in executions:
+            if not workspace_to_tokens[execution.workspace_id]:
+                workspace_to_tokens[execution.workspace_id] = set()
+
+            if execution.cancel_token:
+                workspace_to_tokens[execution.workspace_id].add(execution.cancel_token)
+
+        for workspace_id, token_ids in workspace_to_tokens.items():
+            self._actions_api.cancel_executions(workspace_id, AfmCancelTokens(list(token_ids)))

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6/gooddata_sdk.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: gooddata-sdk
-Version: 1.40.1.dev4
+Version: 1.40.1.dev6
 Summary: GoodData Cloud Python SDK
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.40.1.dev4
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.40.1.dev6
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Keywords: gooddata,sdk,api,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
 Classifier: Development Status :: 5 - Production/Stable
@@ -23,7 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-api-client~=1.40.1.dev4
+Requires-Dist: gooddata-api-client~=1.40.1.dev6
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: attrs<=24.2.0,>=21.4.0
@@ -59,7 +59,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev4) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev6) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6}/gooddata_sdk.egg-info/requires.txt

@@ -1,4 +1,4 @@
-gooddata-api-client~=1.40.1.dev4
+gooddata-api-client~=1.40.1.dev6
 python-dateutil>=2.5.3
 pyyaml>=6.0
 attrs<=24.2.0,>=21.4.0

{gooddata_sdk-1.40.1.dev4 → gooddata_sdk-1.40.1.dev6}/setup.py

@@ -7,7 +7,7 @@ this_directory = Path(__file__).parent
 long_description = (this_directory / "README.md").read_text(encoding="utf-8")
 
 REQUIRES = [
-    "gooddata-api-client~=1.40.1.dev4",
+    "gooddata-api-client~=1.40.1.dev6",
     "python-dateutil>=2.5.3",
     "pyyaml>=6.0",
     "attrs>=21.4.0,<=24.2.0",
@@ -22,7 +22,7 @@ setup(
     description="GoodData Cloud Python SDK",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="1.40.1.dev4",
+    version="1.40.1.dev6",
     author="GoodData",
     author_email="support@gooddata.com",
     license="MIT",
@@ -36,7 +36,7 @@ setup(
         "bin/gdc",
     ],
     project_urls={
-        "Documentation": "https://www.gooddata.com/docs/python-sdk/1.40.1.dev4",
+        "Documentation": "https://www.gooddata.com/docs/python-sdk/1.40.1.dev6",
         "Source": "https://github.com/gooddata/gooddata-python-sdk",
     },
     classifiers=[