gooddata-pandas 1.17.0__py3-none-any.whl → 1.18.0__py3-none-any.whl

gooddata_pandas/dataframe.py

@@ -269,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]:
         """
@@ -298,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:
@@ -322,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/result_convertor.py

@@ -306,6 +306,7 @@ def _create_header_mapper(
     dim: int,
     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
@@ -317,6 +318,7 @@ def _create_header_mapper(
         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.
@@ -334,7 +336,10 @@ def _create_header_mapper(
             pass
         elif "attributeHeader" in header:
             if "labelValue" in header["attributeHeader"]:
-                label = header["attributeHeader"]["labelValue"]
+                if use_primary_labels_in_attributes:
+                    label = header["attributeHeader"]["primaryLabelValue"]
+                else:
+                    label = header["attributeHeader"]["labelValue"]
                 # 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
@@ -376,6 +381,7 @@ def _headers_to_index(
     response: BareExecutionResponse,
     label_overrides: LabelOverrides,
     use_local_ids_in_headers: bool = False,
+    use_primary_labels_in_attributes: bool = False,
 ) -> Optional[pandas.Index]:
     """Converts headers to a pandas MultiIndex.
 
@@ -388,6 +394,8 @@ 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.
@@ -400,6 +408,7 @@ def _headers_to_index(
         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,
     )
 
     return pandas.MultiIndex.from_arrays(
@@ -467,6 +476,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]:
     """
@@ -480,6 +490,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:
@@ -503,6 +515,7 @@ def convert_execution_response_to_dataframe(
             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=_headers_to_index(
             dim_idx=1,
@@ -510,6 +523,7 @@ def convert_execution_response_to_dataframe(
             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,
         ),
     )
 

{gooddata_pandas-1.17.0.dist-info → gooddata_pandas-1.18.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-pandas
-Version: 1.17.0
+Version: 1.18.0
 Summary: GoodData Cloud to pandas
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.17.0
+Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.18.0
 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.17.0
+Requires-Dist: gooddata-sdk ~=1.18.0
 Requires-Dist: pandas <2.0.0,>=1.0.0
 
 # GoodData Pandas

{gooddata_pandas-1.17.0.dist-info → gooddata_pandas-1.18.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
 gooddata_pandas/__init__.py,sha256=Ta3qIIDq7kBRUsYSV3aC69AQBFvFvhtWDQucgP-l88w,297
 gooddata_pandas/_version.py,sha256=YxaAwfP9Yw10sit_vyhVfHJQBAzUUwtm5p0BItfBFx8,225
 gooddata_pandas/data_access.py,sha256=X8NKYtwWKFEfXvgrUbybuQmg1cub5pAhFtDCFMyzffY,18748
-gooddata_pandas/dataframe.py,sha256=w0l5pugt7pGxxVtLMJ-wNgA6mG6UxsCYc_Fyhay4P7U,13191
+gooddata_pandas/dataframe.py,sha256=ryKKhiZAY6vi-uuRB-Oar60X3ARo8EAow5P4Bq1ZcJk,13413
 gooddata_pandas/good_pandas.py,sha256=ePEm2Lmeiftz5td0BLC71q7my5Aj8aABn3xV0myRmqI,3444
 gooddata_pandas/py.typed,sha256=u_MS29sadlaIqGRPYFjWml5u0gQnoQfvbsf9pu3TZJU,94
-gooddata_pandas/result_convertor.py,sha256=oVQerbwDVLiXs9RcAGrNxklJPQ3VjPFrxFt9Cr5djQ4,23248
+gooddata_pandas/result_convertor.py,sha256=jAHPQWhh9iWz---oSPSsmXRwlhLplrZhpVWbiJRYSHU,24197
 gooddata_pandas/series.py,sha256=wTvJR_I0FUteyxo4RwHzP20eU7rei0dP8ZdqfrLbf5c,5759
 gooddata_pandas/utils.py,sha256=PpkB6oWacRxYY9S-RbEZm9Jdblo4bgAzrmHzV9MlMPQ,7223
-gooddata_pandas-1.17.0.dist-info/LICENSE.txt,sha256=CTs8U6T7MmKBKFFiQYARwgCfWgUzdosq01DI298WFiY,77209
-gooddata_pandas-1.17.0.dist-info/METADATA,sha256=pZ3d9C6stWOotNJDgrXY6-B9RVV5R-8kRxgqO89wPMk,2827
-gooddata_pandas-1.17.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-gooddata_pandas-1.17.0.dist-info/top_level.txt,sha256=B7K_WFxlxplJbEbv5Mf0YhX74dbOpTPgDX-W6I7CssI,16
-gooddata_pandas-1.17.0.dist-info/RECORD,,
+gooddata_pandas-1.18.0.dist-info/LICENSE.txt,sha256=CTs8U6T7MmKBKFFiQYARwgCfWgUzdosq01DI298WFiY,77209
+gooddata_pandas-1.18.0.dist-info/METADATA,sha256=Hjz8FO67_dqgQL-MJ9GwXwCuRjDsN04vZZK-YMPAEfE,2827
+gooddata_pandas-1.18.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+gooddata_pandas-1.18.0.dist-info/top_level.txt,sha256=B7K_WFxlxplJbEbv5Mf0YhX74dbOpTPgDX-W6I7CssI,16
+gooddata_pandas-1.18.0.dist-info/RECORD,,