refactor: doc strings and test file

Author: ShriramS-Emerson

nisystemlink/clients/product/utilities/_dataframe_utilities.py

@@ -9,16 +9,14 @@ def convert_products_to_dataframe(products: List[Product]) -> DataFrame:
     """Converts a list of products into a normalized dataframe.
 
     Args:
-        products (List[Product]): A list of product responses retrieved from the API.
+        products (List[Product]): A list of products
 
     Returns:
         DataFrame:
-            - A Pandas DataFrame containing the normalized product data. The DataFrame would consist
-            of all the fields received from the product response.
-
-            - Further, the properties field alone would get normalized. In the sense, there
-            would be separate columns for each of the properties in the list of all products. The
-            normalized column headers would be in the format `properties.property_name`.
+            - A Pandas DataFrame containing the product data. The DataFrame would consist of all the
+            fields in the input products.
+            - A new column would be created for unique properties across all products. The property
+            columns would be named in the format `properties.property_name`.
     """
     products_dict_representation = [product.dict() for product in products]
     normalized_products_dataframe = pd.json_normalize(

tests/unit/product/test_product_dataframe_utilities.py

@@ -40,9 +40,28 @@ def mock_products_data() -> List[Product]:
 @pytest.fixture
 def expected_products_dataframe(mock_products_data: List[Product]) -> DataFrame:
     """Fixture to return the expected DataFrame based on the mock product data."""
-    return pd.json_normalize(
-        [mock_product.dict() for mock_product in mock_products_data]
-    )
+    restructured_mock_products = []
+
+    for product in mock_products_data:
+        properties = (
+            {f"properties.{key}": value for key, value in product.properties.items()}
+            if product.properties
+            else {}
+        )
+        restructured_product = {
+            "id": product.id,
+            "part_number": product.part_number,
+            "name": product.name,
+            "family": product.family,
+            "updated_at": product.updated_at,
+            "file_ids": product.file_ids,
+            "keywords": product.keywords,
+            "workspace": product.workspace,
+            **properties,
+        }
+        restructured_mock_products.append(restructured_product)
+
+    return pd.json_normalize(restructured_mock_products)
 
 
 @pytest.fixture