gooddata-pandas 1.44.0__py3-none-any.whl → 1.44.1.dev2__py3-none-any.whl

gooddata_pandas/data_access.py

@@ -33,7 +33,7 @@ from gooddata_pandas.utils import (
 class ExecutionDefinitionBuilder:
     _DEFAULT_INDEX_NAME: str = "0"
 
-    def __init__(self, columns: ColumnsDef, index_by: Optional[IndexDef] = None) -> None:
+    def __init__(self, columns: ColumnsDef, index_by: Optional[IndexDef] = None, is_cancellable: bool = False) -> None:
         """
         Initializes the ExecutionDefinitionBuilder instance with columns and an
         optional index_by definition. Processes the given columns and index_by
@@ -42,6 +42,8 @@ class ExecutionDefinitionBuilder:
         Args:
             columns (ColumnsDef): Input columns to process and build internal mappings.
             index_by (Optional[IndexDef], optional): Index definition to process. Defaults to None.
+            is_cancellable (Optional[bool]): Whether the execution of this definition should be cancelled when
+                the connection is interrupted.
 
         """
         self._attributes: list[Attribute] = []
@@ -49,6 +51,7 @@ class ExecutionDefinitionBuilder:
         self._col_to_attr_idx: dict[str, int] = dict()
         self._index_to_attr_idx: dict[str, int] = dict()
         self._col_to_metric_idx: dict[str, int] = dict()
+        self._is_cancellable = is_cancellable
 
         self._process_columns(columns)
         self._process_index(index_by)
@@ -248,6 +251,7 @@ class ExecutionDefinitionBuilder:
             metrics=self._metrics,
             filters=filters,
             dimensions=dimensions,
+            is_cancellable=self._is_cancellable,
         )
 
 
@@ -257,6 +261,7 @@ def _compute(
     columns: ColumnsDef,
     index_by: Optional[IndexDef] = None,
     filter_by: Optional[Union[Filter, list[Filter]]] = None,
+    is_cancellable: bool = False,
 ) -> tuple[Execution, dict[str, int], dict[str, int], dict[str, int]]:
     """
     Internal function that computes an execution-by-convention to retrieve data for a data frame with the provided
@@ -268,6 +273,8 @@ def _compute(
         columns (ColumnsDef): The columns definition.
         index_by (Optional[IndexDef]): The index definition, if any.
         filter_by (Optional[Union[Filter, list[Filter]]]): A filter or a list of filters, if any.
+        is_cancellable (bool, optional): Whether the execution of this definition should be cancelled when
+            the connection is interrupted.
 
     Returns:
         tuple: A tuple containing the following elements:
@@ -277,7 +284,7 @@ def _compute(
         - dict[str, int]: A mapping of pandas index names to attribute dimension indices.
     """
 
-    builder = ExecutionDefinitionBuilder(columns, index_by)
+    builder = ExecutionDefinitionBuilder(columns, index_by, is_cancellable=is_cancellable)
     exec_def = builder.build_execution_definition(filter_by)
 
     return (
@@ -413,6 +420,7 @@ def compute_and_extract(
     index_by: Optional[IndexDef] = None,
     filter_by: Optional[Union[Filter, list[Filter]]] = None,
     on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+    is_cancellable: bool = False,
 ) -> tuple[dict, dict]:
     """
     Convenience function that computes and extracts data from the execution response.
@@ -425,6 +433,8 @@ def compute_and_extract(
         filter_by (Optional[Union[Filter, list[Filter]]]): A filter or a list of filters, if any.
         on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
             submitted to the backend.
+        is_cancellable (bool, optional): Whether the execution of this definition should be cancelled when
+            the connection is interrupted.
 
     Returns:
         tuple: A tuple containing the following dictionaries:
@@ -440,6 +450,7 @@ def compute_and_extract(
         index_by=index_by,
         columns=columns,
         filter_by=filter_by,
+        is_cancellable=is_cancellable,
     )
 
     execution, col_to_attr_idx, col_to_metric_idx, index_to_attr_idx = result

gooddata_pandas/dataframe.py

@@ -74,6 +74,7 @@ class DataFrameFactory:
         columns: ColumnsDef,
         filter_by: Optional[Union[Filter, list[Filter]]] = None,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> pandas.DataFrame:
         """
         Creates a data frame indexed by values of the label. The data frame columns will be created from either
@@ -88,6 +89,7 @@ class DataFrameFactory:
                 Optional filters to apply during computation on the server.
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
 
         Returns:
             pandas.DataFrame: A DataFrame instance.
@@ -99,6 +101,7 @@ class DataFrameFactory:
             index_by=index_by,
             filter_by=filter_by,
             on_execution_submitted=on_execution_submitted,
+            is_cancellable=is_cancellable,
         )
 
         _idx = make_pandas_index(index)
@@ -110,6 +113,7 @@ class DataFrameFactory:
         columns: ColumnsDef,
         filter_by: Optional[Union[Filter, list[Filter]]] = None,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> pandas.DataFrame:
         """
         Creates a data frame with columns created from metrics and or labels.
@@ -120,6 +124,7 @@ class DataFrameFactory:
                 computation on the server.
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
 
         Returns:
             pandas.DataFrame: A DataFrame instance.
@@ -131,6 +136,7 @@ class DataFrameFactory:
             columns=columns,
             filter_by=filter_by,
             on_execution_submitted=on_execution_submitted,
+            is_cancellable=is_cancellable,
         )
 
         return pandas.DataFrame(data=data)
@@ -141,6 +147,7 @@ class DataFrameFactory:
         filter_by: Optional[Union[Filter, list[Filter]]] = None,
         auto_index: bool = True,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> pandas.DataFrame:
         """
         Creates a data frame for named items. This is a convenience method that will create DataFrame with or
@@ -154,6 +161,7 @@ class DataFrameFactory:
                 of the items.
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
 
         Returns:
             pandas.DataFrame: A DataFrame instance.
@@ -183,6 +191,7 @@ class DataFrameFactory:
             columns=resolved_measure_cols,
             filter_by=filter_by,
             on_execution_submitted=on_execution_submitted,
+            is_cancellable=is_cancellable,
         )
 
     def for_visualization(
@@ -190,6 +199,7 @@ class DataFrameFactory:
         visualization_id: str,
         auto_index: bool = True,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> pandas.DataFrame:
         """
         Creates a data frame with columns based on the content of the visualization with the provided identifier.
@@ -200,6 +210,7 @@ class DataFrameFactory:
                 of the visualization.
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
 
         Returns:
             pandas.DataFrame: A DataFrame instance.
@@ -215,13 +226,18 @@ class DataFrameFactory:
         }
 
         return self.for_items(
-            columns, filter_by=filter_by, auto_index=auto_index, on_execution_submitted=on_execution_submitted
+            columns,
+            filter_by=filter_by,
+            auto_index=auto_index,
+            on_execution_submitted=on_execution_submitted,
+            is_cancellable=is_cancellable,
         )
 
     def for_created_visualization(
         self,
         created_visualizations_response: dict,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> tuple[pandas.DataFrame, DataFrameMetadata]:
         """
         Creates a data frame using a created visualization.
@@ -230,11 +246,14 @@ class DataFrameFactory:
             created_visualizations_response (dict): Created visualization response.
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
 
         Returns:
             pandas.DataFrame: A DataFrame instance.
         """
-        execution_definition = self._sdk.compute.build_exec_def_from_chat_result(created_visualizations_response)
+        execution_definition = self._sdk.compute.build_exec_def_from_chat_result(
+            created_visualizations_response, is_cancellable=is_cancellable
+        )
         return self.for_exec_def(
             exec_def=execution_definition,
             on_execution_submitted=on_execution_submitted,

gooddata_pandas/series.py

@@ -29,6 +29,7 @@ class SeriesFactory:
         data_by: Union[SimpleMetric, str, ObjId, Attribute],
         filter_by: Optional[Union[Filter, list[Filter]]] = None,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> pandas.Series:
         """Creates pandas Series from data points calculated from a single `data_by`.
 
@@ -65,6 +66,8 @@ class SeriesFactory:
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
 
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
+
         Returns:
             pandas.Series: pandas series instance
         """
@@ -76,6 +79,7 @@ class SeriesFactory:
             columns={"_series": data_by},
             filter_by=filter_by,
             on_execution_submitted=on_execution_submitted,
+            is_cancellable=is_cancellable,
         )
 
         _idx = make_pandas_index(index)
@@ -88,6 +92,7 @@ class SeriesFactory:
         granularity: Optional[Union[list[LabelItemDef], IndexDef]] = None,
         filter_by: Optional[Union[Filter, list[Filter]]] = None,
         on_execution_submitted: Optional[Callable[[Execution], None]] = None,
+        is_cancellable: bool = False,
     ) -> pandas.Series:
         """
         Creates a pandas.Series from data points calculated from a single `data_by` without constructing an index.
@@ -116,6 +121,7 @@ class SeriesFactory:
                 Defaults to None.
             on_execution_submitted (Optional[Callable[[Execution], None]]): Callback to call when the execution was
                 submitted to the backend.
+            is_cancellable (bool, optional): Whether the execution should be cancelled when the connection is interrupted.
 
         Returns:
             pandas.Series: The resulting pandas Series instance.
@@ -133,6 +139,7 @@ class SeriesFactory:
             columns={"_series": data_by},
             filter_by=filter_by,
             on_execution_submitted=on_execution_submitted,
+            is_cancellable=is_cancellable,
         )
 
         return pandas.Series(data=data["_series"])

{gooddata_pandas-1.44.0.dist-info → gooddata_pandas-1.44.1.dev2.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: gooddata-pandas
-Version: 1.44.0
+Version: 1.44.1.dev2
 Summary: GoodData Cloud to pandas
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.44.0
+Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.44.1.dev2
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Keywords: gooddata,pandas,series,data,frame,data_frame,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-sdk~=1.44.0
+Requires-Dist: gooddata-sdk~=1.44.1.dev2
 Requires-Dist: pandas<3.0.0,>=2.0.0
 Dynamic: author
 Dynamic: author-email

gooddata_pandas-1.44.1.dev2.dist-info/RECORD

@@ -0,0 +1,14 @@
+gooddata_pandas/__init__.py,sha256=Ta3qIIDq7kBRUsYSV3aC69AQBFvFvhtWDQucgP-l88w,297
+gooddata_pandas/_version.py,sha256=960vTs6l7xsN2BOXWCxOc4PSKdzzKhnNEPTMnmMTCQs,119
+gooddata_pandas/data_access.py,sha256=VPFjlOVH4dsQvbspEkT6UG_g3yA9sE5g8OLSrqKaeH4,20129
+gooddata_pandas/dataframe.py,sha256=EsOgO8O42JBg1as0RZVwbeVOlGlENpkEsvlL-Xi5Jsg,16679
+gooddata_pandas/good_pandas.py,sha256=ePEm2Lmeiftz5td0BLC71q7my5Aj8aABn3xV0myRmqI,3444
+gooddata_pandas/py.typed,sha256=u_MS29sadlaIqGRPYFjWml5u0gQnoQfvbsf9pu3TZJU,94
+gooddata_pandas/result_convertor.py,sha256=r7uFrjeM6cxMy08YcS3LywF1iUPSyEyG3BAddh0DkIQ,25807
+gooddata_pandas/series.py,sha256=ELBSg1jKy-AYrtXErpNhsmQ0Zd6mP1M6FNS6bGgNPyI,6780
+gooddata_pandas/utils.py,sha256=JhWs0WYqg-9o3aWRP21ERFAxCKoT5oNKQ5mKlJh4uT4,8091
+gooddata_pandas-1.44.1.dev2.dist-info/licenses/LICENSE.txt,sha256=3RjzQk8y9HG1_LgqvbEqWZKJnTQGOO1cpzYzBc13Myk,149825
+gooddata_pandas-1.44.1.dev2.dist-info/METADATA,sha256=P1p0lbtujH7kvNeHpEjgdbNPzTQv5K0b_9BrjMFrZ40,3148
+gooddata_pandas-1.44.1.dev2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gooddata_pandas-1.44.1.dev2.dist-info/top_level.txt,sha256=B7K_WFxlxplJbEbv5Mf0YhX74dbOpTPgDX-W6I7CssI,16
+gooddata_pandas-1.44.1.dev2.dist-info/RECORD,,

gooddata_pandas-1.44.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-gooddata_pandas/__init__.py,sha256=Ta3qIIDq7kBRUsYSV3aC69AQBFvFvhtWDQucgP-l88w,297
-gooddata_pandas/_version.py,sha256=960vTs6l7xsN2BOXWCxOc4PSKdzzKhnNEPTMnmMTCQs,119
-gooddata_pandas/data_access.py,sha256=cGvg7Uk_G0DdLdqIzoZows-viQ8DE9Z3uKof31xCuKY,19408
-gooddata_pandas/dataframe.py,sha256=E45gvV7C1Lv_6mfav2P-DJJcZsr1nbWC57VCDPdhumY,15612
-gooddata_pandas/good_pandas.py,sha256=ePEm2Lmeiftz5td0BLC71q7my5Aj8aABn3xV0myRmqI,3444
-gooddata_pandas/py.typed,sha256=u_MS29sadlaIqGRPYFjWml5u0gQnoQfvbsf9pu3TZJU,94
-gooddata_pandas/result_convertor.py,sha256=r7uFrjeM6cxMy08YcS3LywF1iUPSyEyG3BAddh0DkIQ,25807
-gooddata_pandas/series.py,sha256=S4h_GuapUTwpnbIEXnBH1Z_f1LpxsU9DR0amq2vB9Ww,6371
-gooddata_pandas/utils.py,sha256=JhWs0WYqg-9o3aWRP21ERFAxCKoT5oNKQ5mKlJh4uT4,8091
-gooddata_pandas-1.44.0.dist-info/licenses/LICENSE.txt,sha256=3RjzQk8y9HG1_LgqvbEqWZKJnTQGOO1cpzYzBc13Myk,149825
-gooddata_pandas-1.44.0.dist-info/METADATA,sha256=YAWAGHjpZ9Z3yYQcvZ3UiNWX3OxHJvzsXpiWpvkLMbs,3133
-gooddata_pandas-1.44.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gooddata_pandas-1.44.0.dist-info/top_level.txt,sha256=B7K_WFxlxplJbEbv5Mf0YhX74dbOpTPgDX-W6I7CssI,16
-gooddata_pandas-1.44.0.dist-info/RECORD,,