gooddata-sdk 1.40.1.dev3__tar.gz → 1.40.1.dev5__tar.gz

{gooddata_sdk-1.40.1.dev3/gooddata_sdk.egg-info → gooddata_sdk-1.40.1.dev5}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: gooddata-sdk
-Version: 1.40.1.dev3
+Version: 1.40.1.dev5
 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.dev3
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.40.1.dev5
 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.dev3
+Requires-Dist: gooddata-api-client~=1.40.1.dev5
 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.dev3) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev5) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/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.dev3) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev5) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/gooddata_sdk/__init__.py

@@ -66,6 +66,7 @@ from gooddata_sdk.catalog.export.request import (
     ExportCustomOverride,
     ExportRequest,
     ExportSettings,
+    SlidesExportRequest,
     VisualExportRequest,
 )
 from gooddata_sdk.catalog.filter_by import CatalogFilterBy
@@ -78,7 +79,20 @@ from gooddata_sdk.catalog.identifier import (
     CatalogUserIdentifier,
     CatalogWorkspaceIdentifier,
 )
+from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate
+from gooddata_sdk.catalog.organization.common.running_section import CatalogRunningSection
+from gooddata_sdk.catalog.organization.common.slide_template import (
+    CatalogContentSlideTemplate,
+    CatalogCoverSlideTemplate,
+    CatalogIntroSlideTemplate,
+    CatalogSectionSlideTemplate,
+)
+from gooddata_sdk.catalog.organization.common.widget_slides_template import CatalogWidgetSlidesTemplate
 from gooddata_sdk.catalog.organization.entity_model.directive import CatalogCspDirective
+from gooddata_sdk.catalog.organization.entity_model.export_template import (
+    CatalogExportTemplate,
+    CatalogExportTemplateAttributes,
+)
 from gooddata_sdk.catalog.organization.entity_model.jwk import (
     CatalogJwk,
     CatalogJwkAttributes,
@@ -87,6 +101,9 @@ from gooddata_sdk.catalog.organization.entity_model.jwk import (
 )
 from gooddata_sdk.catalog.organization.entity_model.organization import CatalogOrganization
 from gooddata_sdk.catalog.organization.entity_model.setting import CatalogOrganizationSetting
+from gooddata_sdk.catalog.organization.layout.export_template import (
+    CatalogDeclarativeExportTemplate,
+)
 from gooddata_sdk.catalog.organization.layout.notification_channel import (
     CatalogDeclarativeNotificationChannel,
     CatalogWebhook,

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/gooddata_sdk/catalog/export/request.py

@@ -1,11 +1,12 @@
 # (C) 2023 GoodData Corporation
-from typing import Optional
+from typing import Literal, Optional
 
 from attrs import define
 from gooddata_api_client.model.custom_label import CustomLabel as ApiCustomLabel
 from gooddata_api_client.model.custom_metric import CustomMetric as ApiCustomMetric
 from gooddata_api_client.model.custom_override import CustomOverride as ApiCustomOverride
 from gooddata_api_client.model.settings import Settings as ApiSettings
+from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi
 from gooddata_api_client.model.tabular_export_request import TabularExportRequest
 from gooddata_api_client.model.visual_export_request import VisualExportRequest as VisualExportRequestApi
 
@@ -121,3 +122,31 @@ class VisualExportRequest(Base):
             type[TabularExportRequest]: VisualExportRequest class
         """
         return VisualExportRequestApi
+
+
+@define(auto_attribs=True, kw_only=True)
+class SlidesExportRequest(Base):
+    """
+    SlidesExportRequest class is used to create a slide export request in the desired format, filename, and settings.
+    Attributes:
+        dashboard_id (str): Dashboard identifier.
+        file_name (str): File name to be used for retrieving the PDF document.
+        metadata (Optional[Dict[str, bool]]): Optional dictionary containing settings for the export request.
+    """
+
+    file_name: str
+    format: Literal["PDF", "PPTX"]
+    dashboard_id: Optional[str] = None
+    widget_ids: Optional[list[str]] = None
+    visualization_ids: Optional[list[str]] = None
+    metadata: Optional[dict] = None
+    templateId: Optional[str] = None
+
+    @staticmethod
+    def client_class() -> type[SlidesExportRequestApi]:
+        """
+        Returns the appropriate client class for the visual export request.
+        Returns:
+            type[SlidesExportRequestApi]: SlidesExportRequestApi class
+        """
+        return SlidesExportRequestApi

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/gooddata_sdk/catalog/export/service.py

@@ -4,6 +4,7 @@ from pathlib import Path
 from typing import Any, Callable, Optional, Union
 
 from gooddata_api_client.exceptions import NotFoundException
+from gooddata_api_client.model.slides_export_request import SlidesExportRequest as SlidesExportRequestApi
 from gooddata_api_client.model.tabular_export_request import TabularExportRequest
 from gooddata_api_client.model.visual_export_request import VisualExportRequest
 
@@ -11,6 +12,7 @@ from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
 from gooddata_sdk.catalog.export.request import (
     ExportRequest,
     ExportSettings,
+    SlidesExportRequest,
 )
 from gooddata_sdk.client import GoodDataApiClient
 from gooddata_sdk.visualization import VisualizationService
@@ -140,7 +142,7 @@ class ExportService(CatalogServiceBase):
     def _export_common(
         self,
         workspace_id: str,
-        request: Union[VisualExportRequest, TabularExportRequest],
+        request: Union[VisualExportRequest, TabularExportRequest, SlidesExportRequestApi],
         file_path: Path,
         create_func: Callable,
         get_func: Callable,
@@ -314,3 +316,33 @@ class ExportService(CatalogServiceBase):
             retry=retry,
             max_retry=max_retry,
         )
+
+    def export_slides(
+        self,
+        workspace_id: str,
+        request: SlidesExportRequest,
+        store_path: Union[str, Path] = Path.cwd(),
+        timeout: float = 60.0,
+        retry: float = 0.2,
+        max_retry: float = 5.0,
+    ) -> None:
+        """
+        Exports slides based on slide export request.
+
+        Args:
+            workspace_id (str): The workspace id from which the visualization is to be exported.
+            request (SlidesExportRequest): The request object containing the export parameters.
+            store_path (Union[str, Path], optional): The path to store the exported file. Default to Path.cwd().
+            timeout (float, optional): The maximum time to wait for the export to finish. Defaults to 60.0.
+            retry (float, optional):
+                Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2.
+            max_retry (float, optional): The maximum retry wait time (in seconds). Defaults to 5.0.
+
+        Returns:
+            None
+        """
+        store_path = store_path if isinstance(store_path, Path) else Path(store_path)
+        file_path = store_path / f"{request.file_name}.{request.format.lower()}"
+        create_func = self._actions_api.create_slides_export
+        get_func = self._actions_api.get_slides_export
+        self._export_common(workspace_id, request.to_api(), file_path, create_func, get_func, timeout, retry, max_retry)

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/common/__init__.py

@@ -0,0 +1 @@
+# (C) 2025 GoodData Corporation

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/common/dashboard_slides_template.py

@@ -0,0 +1,20 @@
+# (C) 2025 GoodData Corporation
+from typing import Literal, Optional
+
+from attrs import define
+
+from gooddata_sdk.catalog.organization.common.slide_template import (
+    CatalogContentSlideTemplate,
+    CatalogCoverSlideTemplate,
+    CatalogIntroSlideTemplate,
+    CatalogSectionSlideTemplate,
+)
+
+
+@define
+class CatalogDashboardSlidesTemplate:
+    applied_on: list[Literal["PDF", "PPTX"]]
+    cover_slide: Optional[CatalogCoverSlideTemplate] = None
+    intro_slide: Optional[CatalogIntroSlideTemplate] = None
+    section_slide: Optional[CatalogSectionSlideTemplate] = None
+    content_slide: Optional[CatalogContentSlideTemplate] = None

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/common/running_section.py

@@ -0,0 +1,10 @@
+# (C) 2025 GoodData Corporation
+from typing import Optional
+
+from attrs import define
+
+
+@define
+class CatalogRunningSection:
+    left: Optional[str] = None
+    right: Optional[str] = None

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/common/slide_template.py

@@ -0,0 +1,38 @@
+# (C) 2025 GoodData Corporation
+from typing import Optional
+
+from attrs import define
+
+from gooddata_sdk.catalog.base import Base
+from gooddata_sdk.catalog.organization.common.running_section import CatalogRunningSection
+
+
+@define
+class CatalogCoverSlideTemplate(Base):
+    background_image: bool
+    description_field: Optional[str] = None
+    header: Optional[CatalogRunningSection] = None
+    footer: Optional[CatalogRunningSection] = None
+
+
+@define
+class CatalogIntroSlideTemplate(Base):
+    background_image: bool
+    title_field: Optional[str] = None
+    description_field: Optional[str] = None
+    header: Optional[CatalogRunningSection] = None
+    footer: Optional[CatalogRunningSection] = None
+
+
+@define
+class CatalogSectionSlideTemplate(Base):
+    background_image: bool
+    header: Optional[CatalogRunningSection] = None
+    footer: Optional[CatalogRunningSection] = None
+
+
+@define
+class CatalogContentSlideTemplate(Base):
+    description_field: Optional[str] = None
+    header: Optional[CatalogRunningSection] = None
+    footer: Optional[CatalogRunningSection] = None

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/common/widget_slides_template.py

@@ -0,0 +1,12 @@
+# (C) 2025 GoodData Corporation
+from typing import Literal, Optional
+
+from attrs import define
+
+from gooddata_sdk.catalog.organization.common.slide_template import CatalogContentSlideTemplate
+
+
+@define
+class CatalogWidgetSlidesTemplate:
+    applied_on: list[Literal["PDF", "PPTX"]]
+    content_slide: Optional[CatalogContentSlideTemplate] = None

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/entity_model/export_template.py

@@ -0,0 +1,34 @@
+# (C) 2025 GoodData Corporation
+from __future__ import annotations
+
+import builtins
+from typing import Optional
+
+from attrs import define
+from gooddata_api_client.model.json_api_export_template_in_attributes import JsonApiExportTemplateInAttributes
+from gooddata_api_client.model.json_api_export_template_post_optional_id import JsonApiExportTemplatePostOptionalId
+
+from gooddata_sdk.catalog.base import Base
+from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate
+from gooddata_sdk.catalog.organization.common.widget_slides_template import CatalogWidgetSlidesTemplate
+
+
+@define(auto_attribs=True, kw_only=True)
+class CatalogExportTemplate(Base):
+    id: str
+    attributes: Optional[CatalogExportTemplateAttributes] = None
+
+    @staticmethod
+    def client_class() -> builtins.type[JsonApiExportTemplatePostOptionalId]:
+        return JsonApiExportTemplatePostOptionalId
+
+
+@define(auto_attribs=True, kw_only=True)
+class CatalogExportTemplateAttributes(Base):
+    name: str
+    dashboard_slides_template: Optional[CatalogDashboardSlidesTemplate] = None
+    widget_slides_template: Optional[CatalogWidgetSlidesTemplate] = None
+
+    @staticmethod
+    def client_class() -> builtins.type[JsonApiExportTemplateInAttributes]:
+        return JsonApiExportTemplateInAttributes

gooddata_sdk-1.40.1.dev5/gooddata_sdk/catalog/organization/layout/export_template.py

@@ -0,0 +1,22 @@
+# (C) 2025 GoodData Corporation
+import builtins
+from typing import Optional
+
+from attrs import define
+from gooddata_api_client.model.declarative_export_template import DeclarativeExportTemplate
+
+from gooddata_sdk.catalog.base import Base
+from gooddata_sdk.catalog.organization.common.dashboard_slides_template import CatalogDashboardSlidesTemplate
+from gooddata_sdk.catalog.organization.common.widget_slides_template import CatalogWidgetSlidesTemplate
+
+
+@define
+class CatalogDeclarativeExportTemplate(Base):
+    id: str
+    name: str
+    dashboard_slides_template: Optional[CatalogDashboardSlidesTemplate] = None
+    widget_slides_template: Optional[CatalogWidgetSlidesTemplate] = None
+
+    @staticmethod
+    def client_class() -> builtins.type[DeclarativeExportTemplate]:
+        return DeclarativeExportTemplate

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/gooddata_sdk/catalog/organization/service.py

@@ -5,11 +5,17 @@ import functools
 from typing import Optional
 
 from gooddata_api_client.exceptions import NotFoundException
+from gooddata_api_client.model.declarative_export_templates import DeclarativeExportTemplates
 from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels
 from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument
+from gooddata_api_client.model.json_api_export_template_in_document import JsonApiExportTemplateInDocument
+from gooddata_api_client.model.json_api_export_template_post_optional_id_document import (
+    JsonApiExportTemplatePostOptionalIdDocument,
+)
 from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument
 from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument
 
+from gooddata_sdk import CatalogDeclarativeExportTemplate, CatalogExportTemplate
 from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
 from gooddata_sdk.catalog.organization.entity_model.directive import CatalogCspDirective
 from gooddata_sdk.catalog.organization.entity_model.identity_provider import CatalogIdentityProvider
@@ -424,6 +430,86 @@ class CatalogOrganizationService(CatalogServiceBase):
             identity_provider_id, CatalogIdentityProvider.to_api_patch(identity_provider_id, attributes)
         )
 
+    def create_or_update_export_template(self, export_template: CatalogExportTemplate) -> None:
+        """Create a new export template or overwrite an existing export template with the same id.
+
+        Args:
+            export_template (CatalogExportTemplate):
+                Catalog export template object to be created or updated.
+
+        Returns:
+            None
+
+        Raises:
+            ValueError: Export template cannot be updated.
+        """
+        try:
+            self.get_export_template(export_template.id)
+            self._entities_api.update_entity_export_templates(
+                id=export_template.id,
+                json_api_export_template_in_document=JsonApiExportTemplateInDocument.from_dict(
+                    {"data": export_template.to_dict()}
+                ),
+            )
+        except NotFoundException:
+            self._entities_api.create_entity_export_templates(
+                json_api_export_template_post_optional_id_document=JsonApiExportTemplatePostOptionalIdDocument(
+                    data=export_template.to_api()
+                )
+            )
+
+    def get_export_template(self, export_template_id: str) -> CatalogExportTemplate:
+        """Get an individual export template.
+
+        Args:
+            export_template_id (str):
+                Export template identification string e.g. "demo"
+
+        Returns:
+            CatalogJwk:
+                Catalog export template object containing the structure of the export template.
+        """
+        export_template_api = self._entities_api.get_entity_export_templates(id=export_template_id).data
+        return CatalogExportTemplate.from_api(export_template_api)
+
+    def delete_export_template(self, export_template_id: str) -> None:
+        """Delete an export template.
+
+        Args:
+            export_template_id (str):
+                Export template identification string e.g. "demo"
+
+        Returns:
+            None
+
+        Raises:
+            ValueError:
+                Export template does not exist.
+        """
+        try:
+            self._entities_api.delete_entity_export_templates(export_template_id)
+        except NotFoundException:
+            raise ValueError(
+                f"Can not delete {export_template_id} export template. This export template does not exist."
+            )
+
+    def list_export_templates(self) -> list[CatalogExportTemplate]:
+        """Returns a list of all export templates in the current organization.
+
+        Returns:
+            list[CatalogExportTemplate]:
+                List of export templates in the current organization.
+        """
+        get_export_templates = functools.partial(
+            self._entities_api.get_all_entities_export_templates,
+            _check_return_type=False,
+        )
+        export_templates = load_all_entities_dict(get_export_templates, camel_case=False)
+        return [
+            CatalogExportTemplate.from_dict(export_template, camel_case=False)
+            for export_template in export_templates["data"]
+        ]
+
     # Layout APIs
 
     def get_declarative_notification_channels(self) -> list[CatalogDeclarativeNotificationChannel]:
@@ -480,3 +566,36 @@ class CatalogOrganizationService(CatalogServiceBase):
         """
         api_idps = [idp.to_api() for idp in identity_providers]
         self._layout_api.set_identity_providers(declarative_identity_provider=api_idps)
+
+    def get_declarative_export_templates(self) -> list[CatalogDeclarativeExportTemplate]:
+        """
+        Get all declarative export templates in the current organization.
+
+        Returns:
+            list[CatalogDeclarativeExportTemplate]:
+                List of declarative export templates.
+        """
+        export_templates_api = self._layout_api.get_export_templates_layout()
+        if hasattr(export_templates_api, "export_templates"):
+            return [
+                CatalogDeclarativeExportTemplate.from_api(template)
+                for template in export_templates_api.export_templates
+            ]
+        else:
+            return []
+
+    def put_declarative_export_templates(self, export_templates: list[CatalogDeclarativeExportTemplate]) -> None:
+        """
+        Put declarative export templates in the current organization.
+
+        Args:
+            export_templates (list[CatalogDeclarativeExportTemplate]):
+                List of declarative export templates.
+
+        Returns:
+            None
+        """
+        api_export_templates = [export_template.to_api() for export_template in export_templates]
+        self._layout_api.set_export_templates(
+            declarative_export_templates=DeclarativeExportTemplates(export_templates=api_export_templates)
+        )

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/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.dev3 → gooddata_sdk-1.40.1.dev5}/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,7 @@ 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 else None,
         )
 
     def retrieve_result_cache_metadata(self, workspace_id: str, result_id: str) -> ResultCacheMetadata:
@@ -107,3 +109,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.dev3 → gooddata_sdk-1.40.1.dev5/gooddata_sdk.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: gooddata-sdk
-Version: 1.40.1.dev3
+Version: 1.40.1.dev5
 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.dev3
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.40.1.dev5
 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.dev3
+Requires-Dist: gooddata-api-client~=1.40.1.dev5
 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.dev3) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.40.1.dev5) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.40.1.dev3 → gooddata_sdk-1.40.1.dev5}/gooddata_sdk.egg-info/SOURCES.txt

@@ -57,13 +57,20 @@ gooddata_sdk/catalog/export/request.py
 gooddata_sdk/catalog/export/service.py
 gooddata_sdk/catalog/organization/__init__.py
 gooddata_sdk/catalog/organization/service.py
+gooddata_sdk/catalog/organization/common/__init__.py
+gooddata_sdk/catalog/organization/common/dashboard_slides_template.py
+gooddata_sdk/catalog/organization/common/running_section.py
+gooddata_sdk/catalog/organization/common/slide_template.py
+gooddata_sdk/catalog/organization/common/widget_slides_template.py
 gooddata_sdk/catalog/organization/entity_model/__init__.py
 gooddata_sdk/catalog/organization/entity_model/directive.py
+gooddata_sdk/catalog/organization/entity_model/export_template.py
 gooddata_sdk/catalog/organization/entity_model/identity_provider.py
 gooddata_sdk/catalog/organization/entity_model/jwk.py
 gooddata_sdk/catalog/organization/entity_model/organization.py
 gooddata_sdk/catalog/organization/entity_model/setting.py
 gooddata_sdk/catalog/organization/layout/__init__.py
+gooddata_sdk/catalog/organization/layout/export_template.py
 gooddata_sdk/catalog/organization/layout/identity_provider.py
 gooddata_sdk/catalog/organization/layout/notification_channel.py
 gooddata_sdk/catalog/permission/__init__.py