Rename argument -> multi_index (#479)

Author: delucchi-cmu

src/hats/catalog/dataset/dataset.py

@@ -70,7 +70,7 @@ def per_pixel_statistics(
         exclude_columns: list[str] = None,
         include_columns: list[str] = None,
         include_stats: list[str] = None,
-        multiindex=False,
+        multi_index=False,
     ):
         """Read footer statistics in parquet metadata, and report on statistics about
         each pixel partition.
@@ -83,7 +83,7 @@ def per_pixel_statistics(
                 names provided. Defaults to None, and returns all non-hats columns.
             include_stats (List[str]): if specified, only return the kinds of values from list
                 (min_value, max_value, null_count, row_count). Defaults to None, and returns all values.
-            multiindex (bool): should the returned frame be created with a multi-index, first on
+            multi_index (bool): should the returned frame be created with a multi-index, first on
                 pixel, then on column name? Default is False, and instead indexes on pixel, with
             separate columns per-data-column and stat value combination.
         """
@@ -96,5 +96,5 @@ def per_pixel_statistics(
             exclude_columns=exclude_columns,
             include_columns=include_columns,
             include_stats=include_stats,
-            multiindex=multiindex,
+            multi_index=multi_index,
         )

src/hats/catalog/healpix_dataset/healpix_dataset.py

@@ -295,7 +295,7 @@ def per_pixel_statistics(
         exclude_columns: list[str] | None = None,
         include_columns: list[str] | None = None,
         include_stats: list[str] | None = None,
-        multiindex=False,
+        multi_index=False,
         include_pixels: list[HealpixPixel] | None = None,
     ):
         """Read footer statistics in parquet metadata, and report on statistics about
@@ -311,7 +311,7 @@ def per_pixel_statistics(
                 for the pixels indicated. Defaults to none, and returns all pixels.
             include_stats (List[str]): if specified, only return the kinds of values from list
                 (min_value, max_value, null_count, row_count). Defaults to None, and returns all values.
-            multiindex (bool): should the returned frame be created with a multi-index, first on
+            multi_index (bool): should the returned frame be created with a multi-index, first on
                 pixel, then on column name?
         """
         if not self.on_disk:
@@ -326,6 +326,6 @@ def per_pixel_statistics(
             exclude_columns=exclude_columns,
             include_columns=include_columns,
             include_stats=include_stats,
-            multiindex=multiindex,
+            multi_index=multi_index,
             include_pixels=include_pixels,
         )

src/hats/io/parquet_metadata.py

@@ -251,7 +251,7 @@ def per_pixel_statistics(
     exclude_columns: list[str] = None,
     include_columns: list[str] = None,
     include_stats: list[str] = None,
-    multiindex=False,
+    multi_index=False,
     include_pixels: list[HealpixPixel] = None,
 ):
     """Read footer statistics in parquet metadata, and report on statistics about
@@ -268,7 +268,7 @@ def per_pixel_statistics(
             for the pixels indicated. Defaults to none, and returns all pixels.
         include_stats (List[str]): if specified, only return the kinds of values from list
             (min_value, max_value, null_count, row_count). Defaults to None, and returns all values.
-        multiindex (bool): should the returned frame be created with a multi-index, first on
+        multi_index (bool): should the returned frame be created with a multi-index, first on
             pixel, then on column name? Default is False, and instead indexes on pixel, with
             separate columns per-data-column and stat value combination.
     Returns:
@@ -325,7 +325,7 @@ def per_pixel_statistics(
     stats_lists = np.array(leaf_stats)
     original_shape = stats_lists.shape
 
-    if multiindex:
+    if multi_index:
         stats_lists = stats_lists.reshape((original_shape[0] * original_shape[1], original_shape[2]))
         frame = pd.DataFrame(
             stats_lists,

tests/hats/io/test_parquet_metadata.py

@@ -253,14 +253,14 @@ def test_per_pixel_statistics(small_sky_order1_dir):
     assert len(result_frame) == 0
 
 
-def test_per_pixel_statistics_multiindex(small_sky_order1_dir):
+def test_per_pixel_statistics_multi_index(small_sky_order1_dir):
     partition_info_file = paths.get_parquet_metadata_pointer(small_sky_order1_dir)
 
-    result_frame = per_pixel_statistics(partition_info_file, multiindex=True)
+    result_frame = per_pixel_statistics(partition_info_file, multi_index=True)
     # 20 = 5 columns * 4 pixels
     assert result_frame.shape == (20, 4)
 
-    result_frame = per_pixel_statistics(partition_info_file, exclude_hats_columns=False, multiindex=True)
+    result_frame = per_pixel_statistics(partition_info_file, exclude_hats_columns=False, multi_index=True)
     # 36 = 9 columns * 4 stats per-column
     assert result_frame.shape == (36, 4)
 
@@ -279,7 +279,7 @@ def test_per_pixel_statistics_include_stats(small_sky_order1_dir):
     assert result_frame.shape == (4, 1)
 
     result_frame = per_pixel_statistics(
-        partition_info_file, include_stats=["row_count"], include_columns=["id"], multiindex=True
+        partition_info_file, include_stats=["row_count"], include_columns=["id"], multi_index=True
     )
     # 1 = 1 columns * 1 stat per column
     assert result_frame.shape == (4, 1)