fix(gooddata-sdk): update type annotations for ty 0.0.27 and fix Arrow result reading

Author: Martozar

packages/gooddata-fdw/src/gooddata_fdw/executor.py

@@ -2,7 +2,7 @@
 from __future__ import annotations
 
 from collections.abc import Generator
-from typing import Any, NamedTuple
+from typing import Any, ClassVar, NamedTuple
 
 from gooddata_sdk import GoodDataSdk
 
@@ -43,7 +43,10 @@ def execute(
 
 
 class InsightExecutor(Executor):
-    _COLUMN_VALIDATORS = [col_val.LocalIdOptionValidator(), col_val.IdOptionValidator(mandatory=False)]
+    _COLUMN_VALIDATORS: ClassVar[list[col_val.ColumnValidator]] = [
+        col_val.LocalIdOptionValidator(),
+        col_val.IdOptionValidator(mandatory=False),
+    ]
 
     def __init__(self, inputs: InitData) -> None:
         super().__init__(inputs, self._COLUMN_VALIDATORS)

packages/gooddata-sdk/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)
 

packages/gooddata-sdk/src/gooddata_sdk/catalog/entity.py

@@ -256,7 +256,7 @@ def is_part_of_api(cls, entity: dict[str, Any]) -> bool:
         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 @@ def is_part_of_api(cls, entity: dict[str, Any]) -> bool:
         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 @@ def is_part_of_api(cls, entity: dict[str, Any]) -> bool:
         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],

packages/gooddata-sdk/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_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,31 @@ def read_result(
             )
         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]"
+            )
+        import io
+
+        response = self._actions_api.retrieve_result_binary(
+            workspace_id=self._workspace_id,
+            result_id=self.result_id,
+            _preload_content=False,
+            **({"x_gdc_cancel_token": self.cancel_token} if self.cancel_token else {}),
+        )
+        try:
+            buf = io.BytesIO(response.read())
+        finally:
+            response.release_conn()
+        return _ipc.open_file(buf).read_all()
+
     def cancel(self) -> None:
         """
         Cancels the execution backing this execution result.

packages/gooddata-sdk/src/gooddata_sdk/compute/model/filter.py

@@ -9,7 +9,7 @@
 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

packages/gooddata-sdk/src/gooddata_sdk/type_converter.py

@@ -27,7 +27,7 @@ def to_type(self, value: str) -> Any:
     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