gooddata-pandas 1.12.1.dev3__tar.gz → 1.18.2.dev1__tar.gz

{gooddata-pandas-1.12.1.dev3/gooddata_pandas.egg-info → gooddata_pandas-1.18.2.dev1}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-pandas
-Version: 1.12.1.dev3
+Version: 1.18.2.dev1
 Summary: GoodData Cloud to pandas
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.12.1.dev3
+Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.18.2.dev1
 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
@@ -22,7 +22,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-sdk~=1.12.1.dev3
+Requires-Dist: gooddata-sdk~=1.18.2.dev1
 Requires-Dist: pandas<2.0.0,>=1.0.0
 
 # GoodData Pandas

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/gooddata_pandas/data_access.py

@@ -3,15 +3,6 @@ from __future__ import annotations
 
 from typing import Any, Optional, Union
 
-from gooddata_pandas.utils import (
-    ColumnsDef,
-    IndexDef,
-    LabelItemDef,
-    _str_to_obj_id,
-    _to_attribute,
-    _to_item,
-    _typed_attribute_value,
-)
 from gooddata_sdk import (
     Attribute,
     AttributeFilter,
@@ -23,6 +14,17 @@ from gooddata_sdk import (
     Metric,
     MetricValueFilter,
     ObjId,
+    TableDimension,
+)
+
+from gooddata_pandas.utils import (
+    ColumnsDef,
+    IndexDef,
+    LabelItemDef,
+    _str_to_obj_id,
+    _to_attribute,
+    _to_item,
+    _typed_attribute_value,
 )
 
 
@@ -229,8 +231,12 @@ class ExecutionDefinitionBuilder:
             and dimensions.
         """
         dimensions = [
-            ["measureGroup"] if len(self._metrics) else None,
-            [a.local_id for a in self._attributes] if len(self._attributes) else None,
+            TableDimension(
+                item_ids=["measureGroup"] if self._metrics else None,
+            ),
+            TableDimension(
+                item_ids=[a.local_id for a in self._attributes] if self._attributes else None,
+            ),
         ]
 
         filters = self._update_filter_ids(filter_by)

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/gooddata_pandas/dataframe.py

@@ -2,10 +2,20 @@
 from __future__ import annotations
 
 from typing import Optional, Tuple, Union
+from warnings import warn
 
 import pandas
-
 from gooddata_api_client import models
+from gooddata_sdk import (
+    Attribute,
+    BareExecutionResponse,
+    ExecutionDefinition,
+    Filter,
+    GoodDataSdk,
+    ResultCacheMetadata,
+    ResultSizeDimensions,
+)
+
 from gooddata_pandas.data_access import compute_and_extract
 from gooddata_pandas.result_convertor import (
     _DEFAULT_PAGE_SIZE,
@@ -15,21 +25,12 @@ from gooddata_pandas.result_convertor import (
 )
 from gooddata_pandas.utils import (
     ColumnsDef,
-    DefaultInsightColumnNaming,
+    DefaultVisualizationColumnNaming,
     IndexDef,
     LabelItemDef,
     _to_item,
     make_pandas_index,
 )
-from gooddata_sdk import (
-    Attribute,
-    BareExecutionResponse,
-    ExecutionDefinition,
-    Filter,
-    GoodDataSdk,
-    ResultCacheMetadata,
-    ResultSizeDimensions,
-)
 
 
 class DataFrameFactory:
@@ -43,7 +44,7 @@ class DataFrameFactory:
             -> pandas.DataFrame:
         - for_items(self, items: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]] = None,
             auto_index: bool = True) -> pandas.DataFrame:
-        - for_insight(self, insight_id: str, auto_index: bool = True)
+        - for_visualization(self, visualization_id: str, auto_index: bool = True)
             -> pandas.DataFrame:
         - result_cache_metadata_for_exec_result_id(self, result_id: str)
             -> ResultCacheMetadata:
@@ -159,28 +160,39 @@ class DataFrameFactory:
             filter_by=filter_by,
         )
 
-    def for_insight(self, insight_id: str, auto_index: bool = True) -> pandas.DataFrame:
+    def for_visualization(self, visualization_id: str, auto_index: bool = True) -> pandas.DataFrame:
         """
-        Creates a data frame with columns based on the content of the insight with the provided identifier.
+        Creates a data frame with columns based on the content of the visualization with the provided identifier.
 
         Args:
-            insight_id (str): Insight identifier.
+            visualization_id (str): Visualization identifier.
             auto_index (bool): Default True. Enables creation of DataFrame with index depending on the contents
-                of the insight.
+                of the visualization.
 
         Returns:
             pandas.DataFrame: A DataFrame instance.
         """
-        naming = DefaultInsightColumnNaming()
-        insight = self._sdk.insights.get_insight(workspace_id=self._workspace_id, insight_id=insight_id)
-        filter_by = [f.as_computable() for f in insight.filters]
+        naming = DefaultVisualizationColumnNaming()
+        visualization = self._sdk.visualizations.get_visualization(
+            workspace_id=self._workspace_id, visualization_id=visualization_id
+        )
+        filter_by = [f.as_computable() for f in visualization.filters]
         columns: ColumnsDef = {
-            **{naming.col_name_for_attribute(a): a.as_computable() for a in insight.attributes},
-            **{naming.col_name_for_metric(m): m.as_computable() for m in insight.metrics},
+            **{naming.col_name_for_attribute(a): a.as_computable() for a in visualization.attributes},
+            **{naming.col_name_for_metric(m): m.as_computable() for m in visualization.metrics},
         }
 
         return self.for_items(columns, filter_by=filter_by, auto_index=auto_index)
 
+    def for_insight(self, insight_id: str, auto_index: bool = True) -> pandas.DataFrame:
+        warn(
+            "This method is deprecated and it will be removed in v1.20.0 release. "
+            "Please use 'for_visualization' method instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.for_visualization(insight_id, auto_index)
+
     def result_cache_metadata_for_exec_result_id(self, result_id: str) -> ResultCacheMetadata:
         """
         Retrieves result cache metadata for given :result_id:
@@ -257,6 +269,7 @@ class DataFrameFactory:
         result_size_dimensions_limits: ResultSizeDimensions = (),
         result_size_bytes_limit: Optional[int] = None,
         use_local_ids_in_headers: bool = False,
+        use_primary_labels_in_attributes: bool = False,
         page_size: int = _DEFAULT_PAGE_SIZE,
     ) -> Tuple[pandas.DataFrame, DataFrameMetadata]:
         """
@@ -286,6 +299,7 @@ class DataFrameFactory:
             result_size_dimensions_limits (ResultSizeDimensions): A tuple containing maximum size of result dimensions.
             result_size_bytes_limit (Optional[int]): Maximum size of result in bytes.
             use_local_ids_in_headers (bool): Use local identifier in headers.
+            use_primary_labels_in_attributes (bool): Use primary labels in attributes.
             page_size (int): Number of records per page.
 
         Returns:
@@ -310,5 +324,6 @@ class DataFrameFactory:
             result_size_dimensions_limits=result_size_dimensions_limits,
             result_size_bytes_limit=result_size_bytes_limit,
             use_local_ids_in_headers=use_local_ids_in_headers,
+            use_primary_labels_in_attributes=use_primary_labels_in_attributes,
             page_size=page_size,
         )

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/gooddata_pandas/good_pandas.py

@@ -4,11 +4,12 @@ from __future__ import annotations
 from pathlib import Path
 from typing import Optional
 
+from gooddata_sdk import GoodDataSdk
+from gooddata_sdk.utils import PROFILES_FILE_PATH, good_pandas_profile_content
+
 from gooddata_pandas import __version__
 from gooddata_pandas.dataframe import DataFrameFactory
 from gooddata_pandas.series import SeriesFactory
-from gooddata_sdk import GoodDataSdk
-from gooddata_sdk.utils import PROFILES_FILE_PATH, good_pandas_profile_content
 
 USER_AGENT = f"gooddata-pandas/{__version__}"
 """Extra segment of the User-Agent header that will be appended to standard gooddata-sdk user agent."""

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/gooddata_pandas/result_convertor.py

@@ -3,7 +3,6 @@ from typing import Any, Callable, Dict, List, Optional, Tuple, Union, cast
 
 import pandas
 from attrs import define, field, frozen
-
 from gooddata_sdk import BareExecutionResponse, ExecutionResult, ResultCacheMetadata, ResultSizeDimensions
 
 _DEFAULT_PAGE_SIZE = 100
@@ -201,12 +200,16 @@ class DataFrameMetadata:
 
     row_totals_indexes: List[List[int]]
     execution_response: BareExecutionResponse
+    primary_labels_from_index: Dict[int, Dict[str, str]]
+    primary_labels_from_columns: Dict[int, Dict[str, str]]
 
     @classmethod
     def from_data(
         cls,
         headers: Tuple[_DataHeaders, Optional[_DataHeaders]],
         execution_response: BareExecutionResponse,
+        primary_labels_from_index: Dict[int, Dict[str, str]],
+        primary_labels_from_columns: Dict[int, Dict[str, str]],
     ) -> "DataFrameMetadata":
         """This method constructs a DataFrameMetadata object from data headers and an execution response.
 
@@ -220,6 +223,8 @@ class DataFrameMetadata:
         return cls(
             row_totals_indexes=row_totals_indexes,
             execution_response=execution_response,
+            primary_labels_from_index=primary_labels_from_index,
+            primary_labels_from_columns=primary_labels_from_columns,
         )
 
 
@@ -305,8 +310,10 @@ def _read_complete_execution_result(
 def _create_header_mapper(
     response: BareExecutionResponse,
     dim: int,
+    primary_attribute_labels_mapping: Dict[int, Dict[str, str]],
     label_overrides: Optional[LabelOverrides] = None,
     use_local_ids_in_headers: bool = False,
+    use_primary_labels_in_attributes: bool = False,
 ) -> Callable[[Any, Optional[int]], Optional[str]]:
     """
     Prepares a header mapper function which translates header structures into appropriate labels used
@@ -315,9 +322,12 @@ def _create_header_mapper(
     Args:
         response (BareExecutionResponse): Response structure to gather dimension header details.
         dim (int): Dimension id.
+        primary_attribute_labels_mapping (Dict[int, Dict[str, str]]): Dict to be filled by mapping of primary labels to
+            custom labels per level identified by integer.
         label_overrides (Optional[LabelOverrides]): Label overrides. Defaults to None.
         use_local_ids_in_headers (bool): Use local identifiers of header attributes and metrics. Optional.
             Defaults to False.
+        use_primary_labels_in_attributes (bool): Use primary labels in attributes. Optional. Defaults to False.
 
     Returns:
         Callable[[Any, Optional[int]], Optional[str]]: Mapper function.
@@ -335,7 +345,17 @@ def _create_header_mapper(
             pass
         elif "attributeHeader" in header:
             if "labelValue" in header["attributeHeader"]:
-                label = header["attributeHeader"]["labelValue"]
+                label_value = header["attributeHeader"]["labelValue"]
+                primary_label_value = header["attributeHeader"]["primaryLabelValue"]
+                if use_primary_labels_in_attributes:
+                    label = primary_label_value
+                else:
+                    label = label_value
+                if header_idx is not None:
+                    if header_idx in primary_attribute_labels_mapping:
+                        primary_attribute_labels_mapping[header_idx][primary_label_value] = label_value
+                    else:
+                        primary_attribute_labels_mapping[header_idx] = {primary_label_value: label_value}
                 # explicitly handle '(empty value)' if it's None otherwise it's not recognizable in final MultiIndex
                 # backend represents ^^^ by "" (datasource value is "") or None (datasource value is NULL) therefore
                 # if both representation are used it's necessary to set label to unique header label (space) to avoid
@@ -377,7 +397,8 @@ def _headers_to_index(
     response: BareExecutionResponse,
     label_overrides: LabelOverrides,
     use_local_ids_in_headers: bool = False,
-) -> Optional[pandas.Index]:
+    use_primary_labels_in_attributes: bool = False,
+) -> Tuple[Optional[pandas.Index], Dict[int, Dict[str, str]]]:
     """Converts headers to a pandas MultiIndex.
 
     This function converts the headers present in the response to a pandas MultiIndex (can be used in pandas dataframes)
@@ -389,18 +410,26 @@ def _headers_to_index(
         response (BareExecutionResponse): The execution response object with all data.
         label_overrides (LabelOverrides): A dictionary containing label overrides for the headers.
         use_local_ids_in_headers (bool, optional): If True, uses local Ids in headers, otherwise not. Defaults to False.
+        use_primary_labels_in_attributes (bool, optional): If True, uses primary labels in attributes, otherwise not.
+            Defaults to False.
 
     Returns:
-        Optional[pandas.Index]: A pandas MultiIndex object created from the headers, or None if the headers are empty.
+        Tuple[Optional[pandas.Index], Dict[int, Dict[str, str]]: A pandas MultiIndex object created from the headers
+        with primary attribute labels mapping as Dict, or None with empty Dict if the headers are empty.
     """
+    # dict of primary labels and it's custom labels for attributes per level as key
+    primary_attribute_labels_mapping: Dict[int, Dict[str, str]] = {}
+
     if len(response.dimensions) <= dim_idx or not len(response.dimensions[dim_idx]["headers"]):
-        return None
+        return None, primary_attribute_labels_mapping
 
     mapper = _create_header_mapper(
         response=response,
         dim=dim_idx,
         label_overrides=label_overrides,
         use_local_ids_in_headers=use_local_ids_in_headers,
+        use_primary_labels_in_attributes=use_primary_labels_in_attributes,
+        primary_attribute_labels_mapping=primary_attribute_labels_mapping,
     )
 
     return pandas.MultiIndex.from_arrays(
@@ -409,7 +438,7 @@ def _headers_to_index(
             for header_idx, header_group in enumerate(cast(_DataHeaders, headers[dim_idx]))
         ],
         names=[mapper(dim_header, None) for dim_header in (response.dimensions[dim_idx]["headers"])],
-    )
+    ), primary_attribute_labels_mapping
 
 
 def _merge_grand_totals_into_data(extract: _DataWithHeaders) -> Union[_DataArray, List[_DataArray]]:
@@ -468,6 +497,7 @@ def convert_execution_response_to_dataframe(
     result_size_dimensions_limits: ResultSizeDimensions,
     result_size_bytes_limit: Optional[int] = None,
     use_local_ids_in_headers: bool = False,
+    use_primary_labels_in_attributes: bool = False,
     page_size: int = _DEFAULT_PAGE_SIZE,
 ) -> Tuple[pandas.DataFrame, DataFrameMetadata]:
     """
@@ -481,6 +511,8 @@ def convert_execution_response_to_dataframe(
         result_size_dimensions_limits (ResultSizeDimensions): Dimension limits for the dataframe.
         result_size_bytes_limit (Optional[int], default=None): Size limit in bytes for the dataframe.
         use_local_ids_in_headers (bool, default=False): Use local ids in headers if True, else use default settings.
+        use_primary_labels_in_attributes (bool, default=False): Use primary labels in attributes if True, else use
+            default settings.
         page_size (int, default=_DEFAULT_PAGE_SIZE): Size of the page.
 
     Returns:
@@ -496,22 +528,33 @@ def convert_execution_response_to_dataframe(
     full_data = _merge_grand_totals_into_data(extract)
     full_headers = _merge_grand_total_headers_into_headers(extract)
 
+    index, primary_labels_from_index = _headers_to_index(
+        dim_idx=0,
+        headers=full_headers,
+        response=execution_response,
+        label_overrides=label_overrides,
+        use_local_ids_in_headers=use_local_ids_in_headers,
+        use_primary_labels_in_attributes=use_primary_labels_in_attributes,
+    )
+
+    columns, primary_labels_from_columns = _headers_to_index(
+        dim_idx=1,
+        headers=full_headers,
+        response=execution_response,
+        label_overrides=label_overrides,
+        use_local_ids_in_headers=use_local_ids_in_headers,
+        use_primary_labels_in_attributes=use_primary_labels_in_attributes,
+    )
+
     df = pandas.DataFrame(
         data=full_data,
-        index=_headers_to_index(
-            dim_idx=0,
-            headers=full_headers,
-            response=execution_response,
-            label_overrides=label_overrides,
-            use_local_ids_in_headers=use_local_ids_in_headers,
-        ),
-        columns=_headers_to_index(
-            dim_idx=1,
-            headers=full_headers,
-            response=execution_response,
-            label_overrides=label_overrides,
-            use_local_ids_in_headers=use_local_ids_in_headers,
-        ),
+        index=index,
+        columns=columns,
     )
 
-    return df, DataFrameMetadata.from_data(headers=full_headers, execution_response=execution_response)
+    return df, DataFrameMetadata.from_data(
+        headers=full_headers,
+        execution_response=execution_response,
+        primary_labels_from_index=primary_labels_from_index,
+        primary_labels_from_columns=primary_labels_from_columns,
+    )

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/gooddata_pandas/utils.py

@@ -6,17 +6,23 @@ import uuid
 from typing import Any, Dict, Optional, Union
 
 import pandas
-from pandas import Index, MultiIndex
-
-from gooddata_sdk import Attribute, CatalogAttribute, InsightAttribute, InsightMetric, Metric, ObjId, SimpleMetric
+from gooddata_sdk import (
+    Attribute,
+    CatalogAttribute,
+    Metric,
+    ObjId,
+    SimpleMetric,
+    VisualizationAttribute,
+    VisualizationMetric,
+)
 from gooddata_sdk.type_converter import AttributeConverterStore, DateConverter, DatetimeConverter, IntegerConverter
+from pandas import Index, MultiIndex
 
 LabelItemDef = Union[Attribute, ObjId, str]
 DataItemDef = Union[Attribute, Metric, ObjId, str]
 IndexDef = Union[LabelItemDef, Dict[str, LabelItemDef]]
 ColumnsDef = Dict[str, DataItemDef]
 
-
 # register external pandas types to converters
 IntegerConverter.set_external_fnc(lambda self, value: pandas.to_numeric(value))
 DateConverter.set_external_fnc(lambda self, value: pandas.to_datetime(value))
@@ -162,10 +168,10 @@ def make_pandas_index(index: dict) -> Optional[Union[Index, MultiIndex]]:
     return _idx
 
 
-class DefaultInsightColumnNaming:
+class DefaultVisualizationColumnNaming:
     def __init__(self) -> None:
         """
-        Initialize a DefaultInsightColumnNaming instance with an empty dictionary for unique names.
+        Initialize a DefaultVisualizationColumnNaming instance with an empty dictionary for unique names.
         """
         self._uniques: dict[str, int] = dict()
 
@@ -206,24 +212,24 @@ class DefaultInsightColumnNaming:
         self._uniques[unique_candidate] = 1
         return unique_candidate
 
-    def col_name_for_attribute(self, attr: InsightAttribute) -> str:
+    def col_name_for_attribute(self, attr: VisualizationAttribute) -> str:
         """
         Generate a unique column name for the given attribute.
 
         Args:
-            attr (InsightAttribute): The attribute.
+            attr (VisualizationAttribute): The attribute.
 
         Returns:
             str: The unique column name.
         """
         return self._ensure_unique(attr.label_id)
 
-    def col_name_for_metric(self, measure: InsightMetric) -> str:
+    def col_name_for_metric(self, measure: VisualizationMetric) -> str:
         """
         Generate a unique column name for the given metric.
 
         Args:
-          measure (InsightMetric): The metric.
+          measure (VisualizationMetric): The metric.
 
         Returns:
             str: The unique column name.

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1/gooddata_pandas.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-pandas
-Version: 1.12.1.dev3
+Version: 1.18.2.dev1
 Summary: GoodData Cloud to pandas
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.12.1.dev3
+Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.18.2.dev1
 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
@@ -22,7 +22,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-sdk~=1.12.1.dev3
+Requires-Dist: gooddata-sdk~=1.18.2.dev1
 Requires-Dist: pandas<2.0.0,>=1.0.0
 
 # GoodData Pandas

gooddata_pandas-1.18.2.dev1/gooddata_pandas.egg-info/requires.txt

@@ -0,0 +1,2 @@
+gooddata-sdk~=1.18.2.dev1
+pandas<2.0.0,>=1.0.0

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/setup.py

@@ -7,7 +7,7 @@ this_directory = Path(__file__).parent
 long_description = (this_directory / "README.md").read_text(encoding="utf-8")
 
 REQUIRES = [
-    "gooddata-sdk~=1.12.1.dev3",
+    "gooddata-sdk~=1.18.2.dev1",
     "pandas>=1.0.0,<2.0.0",
 ]
 
@@ -16,7 +16,7 @@ setup(
     description="GoodData Cloud to pandas",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="1.12.1.dev3",
+    version="1.18.2.dev1",
     author="GoodData",
     author_email="support@gooddata.com",
     license="MIT",
@@ -26,7 +26,7 @@ setup(
     packages=find_packages(exclude=["tests*"]),
     python_requires=">=3.8.0",
     project_urls={
-        "Documentation": "https://gooddata-pandas.readthedocs.io/en/v1.12.1.dev3",
+        "Documentation": "https://gooddata-pandas.readthedocs.io/en/v1.18.2.dev1",
         "Source": "https://github.com/gooddata/gooddata-python-sdk",
     },
     classifiers=[

gooddata-pandas-1.12.1.dev3/gooddata_pandas.egg-info/requires.txt

@@ -1,2 +0,0 @@
-gooddata-sdk~=1.12.1.dev3
-pandas<2.0.0,>=1.0.0

{gooddata-pandas-1.12.1.dev3 → gooddata_pandas-1.18.2.dev1}/gooddata_pandas/series.py

@@ -4,10 +4,10 @@ from __future__ import annotations
 from typing import Optional, Union
 
 import pandas
+from gooddata_sdk import Attribute, Filter, GoodDataSdk, ObjId, SimpleMetric
 
 from gooddata_pandas.data_access import compute_and_extract
 from gooddata_pandas.utils import IndexDef, LabelItemDef, make_pandas_index
-from gooddata_sdk import Attribute, Filter, GoodDataSdk, ObjId, SimpleMetric
 
 
 class SeriesFactory: