gooddata-sdk 1.63.1.dev2__tar.gz → 1.63.1.dev4__tar.gz

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: gooddata-sdk
-Version: 1.63.1.dev2
+Version: 1.63.1.dev4
 Summary: GoodData Cloud Python SDK
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.63.1.dev2
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.63.1.dev4
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Author-email: GoodData <support@gooddata.com>
 License-Expression: MIT
@@ -23,12 +23,14 @@ Requires-Python: <4.0,>=3.10
 Requires-Dist: attrs<=24.2.0,>=21.4.0
 Requires-Dist: brotli==1.2.0
 Requires-Dist: cattrs<=24.1.1,>=22.1.0
-Requires-Dist: gooddata-api-client~=1.63.1.dev2
+Requires-Dist: gooddata-api-client~=1.63.1.dev4
 Requires-Dist: gooddata-code-convertors
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: python-dotenv<2.0.0,>=1.0.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: requests~=2.32.0
+Provides-Extra: arrow
+Requires-Dist: pyarrow>=23.0.1; extra == 'arrow'
 Description-Content-Type: text/markdown
 
 # GoodData Python SDK
@@ -47,7 +49,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.63.1.dev2) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.63.1.dev4) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/README.md

@@ -14,7 +14,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.63.1.dev2) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.63.1.dev4) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/pyproject.toml

@@ -1,7 +1,7 @@
 # (C) 2025 GoodData Corporation
 [project]
 name = "gooddata-sdk"
-version = "1.63.1.dev2"
+version = "1.63.1.dev4"
 description = "GoodData Cloud Python SDK"
 readme = "README.md"
 license = "MIT"
@@ -26,7 +26,7 @@ keywords = [
 ]
 requires-python = ">=3.10,<4.0"
 dependencies = [
-    "gooddata-api-client~=1.63.1.dev2",
+    "gooddata-api-client~=1.63.1.dev4",
     "python-dateutil>=2.5.3",
     "pyyaml>=6.0",
     "attrs>=21.4.0,<=24.2.0",
@@ -50,8 +50,11 @@ classifiers = [
     "Typing :: Typed",
 ]
 
+[project.optional-dependencies]
+arrow = ["pyarrow>=23.0.1"]
+
 [project.urls]
-Documentation = "https://www.gooddata.com/docs/python-sdk/1.63.1.dev2"
+Documentation = "https://www.gooddata.com/docs/python-sdk/1.63.1.dev4"
 Source = "https://github.com/gooddata/gooddata-python-sdk"
 
 [project.scripts]
@@ -69,6 +72,7 @@ test = [
     "python-dotenv~=1.0.0",
     "deepdiff~=8.5.0",
     "tests_support",
+    "pyarrow>=23.0.1",
 ]
 
 [tool.ty.analysis]

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/src/gooddata_sdk/catalog/data_source/entity_model/data_source.py

@@ -62,7 +62,7 @@ class CatalogDataSourceBase(Base):
     credentials: Credentials = field(repr=False)
     alternative_data_source_id: str | None = None
 
-    @type.validator  # type: ignore[attr-defined]
+    @type.validator  # type: ignore
     def _check_allowed_values(self, attribute: Attribute, value: str) -> None:
         value_in_allowed(self.__class__, attribute, value, JsonApiDataSourceInAttributes)
 

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/src/gooddata_sdk/catalog/entity.py

@@ -256,7 +256,7 @@ class BasicCredentials(Credentials):
         return cls.USER_KEY in entity
 
     @classmethod
-    def from_api(cls, attributes: dict[str, Any]) -> BasicCredentials:  # type: ignore[override]
+    def from_api(cls, attributes: dict[str, Any]) -> BasicCredentials:  # type: ignore
         # Credentials are not returned from security reasons
         return cls(
             username=attributes[cls.USER_KEY],
@@ -277,7 +277,7 @@ class KeyPairCredentials(Credentials):
         return cls.USER_KEY in entity and cls.PRIVATE_KEY in entity
 
     @classmethod
-    def from_api(cls, attributes: dict[str, Any]) -> KeyPairCredentials:  # type: ignore[override]
+    def from_api(cls, attributes: dict[str, Any]) -> KeyPairCredentials:  # type: ignore
         # Credentials are not returned for security reasons
         return cls(
             username=attributes[cls.USER_KEY],
@@ -297,7 +297,7 @@ class ClientSecretCredentials(Credentials):
         return cls.CLIENT_ID in entity and cls.CLIENT_SECRET in entity
 
     @classmethod
-    def from_api(cls, attributes: dict[str, Any]) -> ClientSecretCredentials:  # type: ignore[override]
+    def from_api(cls, attributes: dict[str, Any]) -> ClientSecretCredentials:  # type: ignore
         # Credentials are not returned for security reasons
         return cls(
             client_id=attributes[cls.CLIENT_ID],

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/src/gooddata_sdk/catalog/export/service.py

@@ -329,6 +329,41 @@ class ExportService(CatalogServiceBase):
             max_retry=max_retry,
         )
 
+    def get_raw_export_bytes(
+        self,
+        workspace_id: str,
+        export_id: str,
+        timeout: float = 60.0,
+        retry: float = 0.2,
+        max_retry: float = 5.0,
+    ) -> bytes:
+        """
+        Poll the raw export endpoint for an already-submitted export and return its bytes.
+
+        Low-level building block: the caller is responsible for submitting the export request
+        (via ``actions_api.create_raw_export``) and passing the resulting ``export_id`` here.
+        The returned bytes reflect whatever format was requested at creation time
+        (``ARROW_FILE``, ``ARROW_STREAM``, or ``CSV``).
+
+        Args:
+            workspace_id (str): The ID of the target workspace.
+            export_id (str): Export ID returned by ``create_raw_export``.
+            timeout (float): Total seconds to wait for the export to complete. Defaults to 60.0.
+            retry (float): Initial wait between retries in seconds. Defaults to 0.2.
+            max_retry (float): Maximum wait between retries in seconds. Defaults to 5.0.
+
+        Returns:
+            bytes: Raw export bytes in the format requested at submission time.
+        """
+        return self._get_exported_content(
+            workspace_id=workspace_id,
+            export_id=export_id,
+            get_func=self._actions_api.get_raw_export,
+            timeout=timeout,
+            retry=retry,
+            max_retry=max_retry,
+        )
+
     def export_slides(
         self,
         workspace_id: str,

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/src/gooddata_sdk/compute/model/execution.py

@@ -2,7 +2,10 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Union
+from typing import TYPE_CHECKING, Any, Union
+
+if TYPE_CHECKING:
+    import pyarrow
 
 from attrs import define, field
 from attrs.setters import frozen as frozen_attr
@@ -11,6 +14,13 @@ from gooddata_api_client.model.afm import AFM
 from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens
 from gooddata_api_client.model.result_spec import ResultSpec
 
+try:
+    import pyarrow as _pyarrow
+    from pyarrow import ipc as _ipc
+except ImportError:
+    _pyarrow = None  # type: ignore
+    _ipc = None  # type: ignore
+
 from gooddata_sdk.client import GoodDataApiClient
 from gooddata_sdk.compute.model.attribute import Attribute
 from gooddata_sdk.compute.model.filter import Filter
@@ -372,6 +382,36 @@ class BareExecutionResponse:
             )
         return ExecutionResult(execution_result)
 
+    def read_result_arrow(self) -> pyarrow.Table:
+        """
+        Reads the full execution result as a pyarrow Table.
+
+        The binary endpoint returns the complete result in one shot (no paging).
+        Requires pyarrow to be installed (pip install gooddata-sdk[arrow]).
+        """
+        if _ipc is None:
+            raise ImportError(
+                "pyarrow is required to use read_result_arrow(). Install it with: pip install gooddata-sdk[arrow]"
+            )
+
+        header_params: dict = {"Accept": "application/vnd.apache.arrow.stream"}
+        if self.cancel_token:
+            header_params["X-GDC-CANCEL-TOKEN"] = self.cancel_token
+
+        response = self._actions_api.api_client.call_api(
+            resource_path="/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary",
+            method="GET",
+            path_params={"workspaceId": self._workspace_id, "resultId": self.result_id},
+            header_params=header_params,
+            response_type=None,
+            _preload_content=False,
+            _return_http_data_only=True,
+        )
+        try:
+            return _ipc.open_stream(response).read_all()
+        finally:
+            response.release_conn()
+
     def cancel(self) -> None:
         """
         Cancels the execution backing this execution result.

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/src/gooddata_sdk/compute/model/filter.py

@@ -9,7 +9,7 @@ from attrs import define
 from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline
 
 if find_spec("icu") is not None:
-    from icu import Locale, SimpleDateFormat  # type: ignore[import-not-found]
+    from icu import Locale, SimpleDateFormat  # type: ignore
 
 import gooddata_api_client.models as afm_models
 from gooddata_api_client.model_utils import OpenApiModel

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/src/gooddata_sdk/type_converter.py

@@ -27,7 +27,7 @@ class Converter:
     def to_external_type(self, value: str) -> Any:
         typed_value = self.to_type(value)
         if self._EXTERNAL_CONVERSION_FNC:
-            return self._EXTERNAL_CONVERSION_FNC(typed_value)
+            return self._EXTERNAL_CONVERSION_FNC(typed_value)  # type: ignore
         else:
             return typed_value
 

gooddata_sdk-1.63.1.dev4/tests/compute/test_bare_execution_response.py

@@ -0,0 +1,110 @@
+# (C) 2026 GoodData Corporation
+from __future__ import annotations
+
+import io
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+pyarrow = pytest.importorskip("pyarrow")
+
+
+def _make_ipc_stream_bytes() -> bytes:
+    """Return minimal Arrow IPC stream bytes for a one-row table."""
+    import pyarrow as pa
+    from pyarrow import ipc
+
+    table = pa.table({"x": pa.array([1.0])})
+    buf = io.BytesIO()
+    with ipc.new_stream(buf, table.schema) as writer:
+        writer.write_table(table)
+    return buf.getvalue()
+
+
+class _FakeResponse(io.RawIOBase):
+    """Minimal file-like with release_conn to simulate a urllib3 HTTPResponse."""
+
+    def __init__(self, data: bytes) -> None:
+        super().__init__()
+        self._buf = io.BytesIO(data)
+        self.release_conn = MagicMock()
+
+    def read(self, n: int = -1) -> bytes:
+        return self._buf.read(n)
+
+    def readable(self) -> bool:
+        return True
+
+    def readinto(self, b: bytearray) -> int:
+        data = self._buf.read(len(b))
+        n = len(data)
+        b[:n] = data
+        return n
+
+
+def _make_bare(ipc_bytes: bytes):
+    """Return a BareExecutionResponse backed by a mock API client."""
+    from gooddata_sdk.compute.model.execution import BareExecutionResponse
+
+    mock_api_client = MagicMock()
+    mock_response = _FakeResponse(ipc_bytes)
+    mock_api_client.actions_api.api_client.call_api.return_value = mock_response
+
+    afm_exec_response = {
+        "execution_response": {
+            "links": {"executionResult": "result-id-123"},
+            "dimensions": [],
+        }
+    }
+    bare = BareExecutionResponse(
+        api_client=mock_api_client,
+        workspace_id="ws-id",
+        execution_response=afm_exec_response,
+    )
+    return bare, mock_response
+
+
+def test_read_result_arrow_returns_table() -> None:
+    """read_result_arrow reads the stream from the binary endpoint and returns a pa.Table."""
+    import pyarrow as pa
+
+    ipc_bytes = _make_ipc_stream_bytes()
+    bare, mock_response = _make_bare(ipc_bytes)
+
+    result = bare.read_result_arrow()
+
+    assert isinstance(result, pa.Table)
+    mock_response.release_conn.assert_called_once()
+
+
+def test_read_result_arrow_requests_stream_format() -> None:
+    """read_result_arrow sets Accept: application/vnd.apache.arrow.stream explicitly."""
+    ipc_bytes = _make_ipc_stream_bytes()
+    bare, _ = _make_bare(ipc_bytes)
+
+    bare.read_result_arrow()
+
+    call_kwargs = bare._actions_api.api_client.call_api.call_args.kwargs
+    assert call_kwargs["header_params"]["Accept"] == "application/vnd.apache.arrow.stream"
+
+
+def test_read_result_arrow_without_cancel_token() -> None:
+    """Without a cancel_token the call omits the cancel header."""
+    ipc_bytes = _make_ipc_stream_bytes()
+    bare, _ = _make_bare(ipc_bytes)
+
+    bare.read_result_arrow()
+
+    call_kwargs = bare._actions_api.api_client.call_api.call_args.kwargs
+    assert "X-GDC-CANCEL-TOKEN" not in call_kwargs["header_params"]
+
+
+def test_read_result_arrow_no_pyarrow_raises() -> None:
+    """When pyarrow is not installed, read_result_arrow raises ImportError."""
+    from gooddata_sdk.compute.model import execution as _exec_mod
+
+    ipc_bytes = _make_ipc_stream_bytes()
+    bare, _ = _make_bare(ipc_bytes)
+
+    with patch.object(_exec_mod, "_ipc", None), pytest.raises(ImportError, match="pyarrow is required"):
+        bare.read_result_arrow()

{gooddata_sdk-1.63.1.dev2 → gooddata_sdk-1.63.1.dev4}/tests/export/test_export_service.py

@@ -5,6 +5,7 @@
 # (./packages/gooddata-sdk/tests/export -> /tmp/exports). Fix with: chmod -R 777 tests/export/exports/
 import os
 from pathlib import Path
+from unittest.mock import MagicMock, patch
 
 import pytest
 from gooddata_sdk import (
@@ -20,6 +21,7 @@ from gooddata_sdk import (
     SimpleMetric,
     TableDimension,
 )
+from gooddata_sdk.catalog.export.service import ExportService
 from tests_support.vcrpy_utils import get_vcr
 
 gd_vcr = get_vcr()
@@ -107,6 +109,27 @@ def test_export_settings_grand_totals_position_defaults_to_none():
     assert settings.grand_totals_position is None
 
 
+def test_get_raw_export_bytes_delegates_to_get_exported_content() -> None:
+    """get_raw_export_bytes delegates to _get_exported_content with the raw export func."""
+
+    mock_api_client = MagicMock()
+    svc = ExportService(mock_api_client)
+    fake_bytes = b"arrow_ipc"
+
+    with patch.object(ExportService, "_get_exported_content", return_value=fake_bytes) as mock_get:
+        result = svc.get_raw_export_bytes("ws-id", "export-id-123")
+
+    mock_get.assert_called_once_with(
+        workspace_id="ws-id",
+        export_id="export-id-123",
+        get_func=mock_api_client.actions_api.get_raw_export,
+        timeout=60.0,
+        retry=0.2,
+        max_retry=5.0,
+    )
+    assert result == fake_bytes
+
+
 @gd_vcr.use_cassette(str(_fixtures_dir / "test_export_csv.yaml"))
 def test_export_csv(test_config):
     _tabular_export_base(test_config, "CSV")