cave-utils 3.4.2__tar.gz → 3.4.4__tar.gz

{cave_utils-3.4.2/cave_utils.egg-info → cave_utils-3.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cave_utils
-Version: 3.4.2
+Version: 3.4.4
 Summary: Python wrapper for api use in the cave_app
 Author-email: Connor Makowski <conmak@mit.edu>
 Project-URL: Homepage, https://github.com/mit-cave/cave_utils

{cave_utils-3.4.2 → cave_utils-3.4.4}/cave_utils/api/pages.py

@@ -173,6 +173,7 @@ class pages_data_star_charts(ApiValidator):
         distributionVariant: str | None = None,
         xAxisOrder: str | None = None,
         showNA: bool = False,
+        filters: list[dict] | None = None,
         **kwargs,
     ):
         """
@@ -259,6 +260,7 @@ class pages_data_star_charts(ApiValidator):
                 * `"alpha_descending"`: Orders the x-axis in reverse alphabetical order.
             * **Note**: If left unspecified (i.e., `None`), it will default to `"default"`.
         * **`showNA`**: `[bool]` = `False` → Whether to display missing or filtered values in both the chart tooltip and the axis.
+        * **`filters`**: `[dict]` = `None` → A list of filter dictionaries to apply to the chart data.
 
         [area chart]: https://en.wikipedia.org/wiki/Area_chart
         [bar chart]: https://en.wikipedia.org/wiki/Bar_chart
@@ -277,6 +279,7 @@ class pages_data_star_charts(ApiValidator):
         [waterfall chart]: https://en.wikipedia.org/wiki/Waterfall_chart
         [distribution chart]: https://en.wikipedia.org/wiki/Probability_distribution
         """
+        # TODO: Document and validate filters
         if type == "globalOutput":
             chartType_options = ["bar", "line", "table", "overview"]
         elif type == "groupedOutput":

{cave_utils-3.4.2 → cave_utils-3.4.4}/cave_utils/builders/groups.py

@@ -209,6 +209,8 @@ class DateGroupsBuilder(GroupsUtils):
         include_month_week: bool = False,
         include_month_day: bool = False,
         include_week_day: bool = True,
+        month_as_name: bool = False,
+        week_day_as_name: bool = False,
     ) -> None:
         """
         Initialize a date group builder.
@@ -228,6 +230,8 @@ class DateGroupsBuilder(GroupsUtils):
         * **`include_month_week`**: `[bool]` = `False` → Whether or not to include the month and week in the group.
         * **`include_month_day`**: `[bool]` = `False` → Whether or not to include the month and day in the group.
         * **`include_week_day`**: `[bool]` = `True` → Whether or not to include the week day in the group.
+        * **`month_as_name`**: `[bool]` = `False` → Whether or not to use the month name instead of the month number.
+        * **`week_day_as_name`**: `[bool]` = `False` → Whether or not to use the week day name instead of the week day number.
 
         Returns:
 
@@ -245,6 +249,8 @@ class DateGroupsBuilder(GroupsUtils):
         self.include_month_week = include_month_week
         self.include_month_day = include_month_day
         self.include_week_day = include_week_day
+        self.month_as_name = month_as_name
+        self.week_day_as_name = week_day_as_name
         self.date_objects = self.__get_date_objects__(date_data=date_data)
         self.__gen_structures__()
 
@@ -323,11 +329,23 @@ class DateGroupsBuilder(GroupsUtils):
             self.data_structure["year_day"] = [i.strftime("%Y-%j") for i in self.date_objects]
             self.group_keys.append("year_day")
         if self.include_month:
-            self.levels_structure["month"] = {
-                "name": "Month",
-                "ordering": sorted(list(set([i.strftime("%m") for i in self.date_objects]))),
-            }
-            self.data_structure["month"] = [i.strftime("%m") for i in self.date_objects]
+            if self.month_as_name:
+                self.levels_structure["month"] = {
+                    "name": "Month",
+                    "ordering": [
+                        i[1]
+                        for i in sorted(
+                            list(set([(i.month, i.strftime("%B")) for i in self.date_objects]))
+                        )
+                    ],
+                }
+                self.data_structure["month"] = [i.strftime("%B") for i in self.date_objects]
+            else:
+                self.levels_structure["month"] = {
+                    "name": "Month",
+                    "ordering": sorted(list(set([i.strftime("%m") for i in self.date_objects]))),
+                }
+                self.data_structure["month"] = [i.strftime("%m") for i in self.date_objects]
             self.group_keys.append("month")
         if self.include_month_week:
             self.levels_structure["month_week"] = {
@@ -344,11 +362,30 @@ class DateGroupsBuilder(GroupsUtils):
             self.data_structure["month_day"] = [i.strftime("%m-%d") for i in self.date_objects]
             self.group_keys.append("month_day")
         if self.include_week_day:
-            self.levels_structure["week_day"] = {
-                "name": "Week Day",
-                "ordering": sorted(list(set([i.strftime("%w") for i in self.date_objects]))),
-            }
-            self.data_structure["week_day"] = [i.strftime("%w") for i in self.date_objects]
+            if self.week_day_as_name:
+                self.levels_structure["week_day"] = {
+                    "name": "Week Day",
+                    "ordering": [
+                        i[1]
+                        for i in sorted(
+                            list(
+                                set(
+                                    [
+                                        (int(i.strftime("%w")), i.strftime("%A"))
+                                        for i in self.date_objects
+                                    ]
+                                )
+                            )
+                        )
+                    ],
+                }
+                self.data_structure["week_day"] = [i.strftime("%A") for i in self.date_objects]
+            else:
+                self.levels_structure["week_day"] = {
+                    "name": "Week Day",
+                    "ordering": sorted(list(set([i.strftime("%w") for i in self.date_objects]))),
+                }
+                self.data_structure["week_day"] = [i.strftime("%w") for i in self.date_objects]
             self.group_keys.append("week_day")
 
     def get_id(self, *args, **kwargs):

{cave_utils-3.4.2 → cave_utils-3.4.4/cave_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cave_utils
-Version: 3.4.2
+Version: 3.4.4
 Summary: Python wrapper for api use in the cave_app
 Author-email: Connor Makowski <conmak@mit.edu>
 Project-URL: Homepage, https://github.com/mit-cave/cave_utils

{cave_utils-3.4.2 → cave_utils-3.4.4}/cave_utils.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ cave_utils/api_utils/validator_utils.py
 cave_utils/builders/__init__.py
 cave_utils/builders/groups.py
 test/test_arguments.py
+test/test_builders_date_groups.py
 test/test_builders_groups.py
 test/test_custom_coordinates.py
 test/test_geo_utils.py

{cave_utils-3.4.2 → cave_utils-3.4.4}/pyproject.toml

@@ -12,7 +12,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cave_utils"
-version = "3.4.2"
+version = "3.4.4"
 description = "Python wrapper for api use in the cave_app"
 authors = [
     {name="Connor Makowski", email="conmak@mit.edu"}

{cave_utils-3.4.2 → cave_utils-3.4.4}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = cave_utils
-version = 3.4.2
+version = 3.4.4
 description_file = README.md
 
 [options]

cave_utils-3.4.4/test/test_builders_date_groups.py

@@ -0,0 +1,85 @@
+from cave_utils.builders.groups import DateGroupsBuilder
+
+date_data = ["2023-01-01", "2023-02-01"]
+
+# Test 1: Basic
+builder = DateGroupsBuilder(
+    group_name="Dates",
+    date_data=date_data,
+    include_month=True,
+    include_week_day=True,
+)
+serialized = builder.serialize()
+
+# Check month is numbers
+# We have dates from 2023-01-01 to 2023-02-01.
+# Months: 01, 02
+assert "01" in serialized["data"]["month"]
+assert "02" in serialized["data"]["month"]
+assert serialized["levels"]["month"]["ordering"] == ["01", "02"]
+
+# Check week day is numbers
+# We have all days of week in that range.
+assert serialized["levels"]["week_day"]["ordering"] == ["0", "1", "2", "3", "4", "5", "6"]
+
+# Test 2: Names
+builder_names = DateGroupsBuilder(
+    group_name="Dates",
+    date_data=date_data,
+    include_month=True,
+    include_week_day=True,
+    month_as_name=True,
+    week_day_as_name=True,
+)
+serialized_names = builder_names.serialize()
+
+# Check month is names
+assert "January" in serialized_names["data"]["month"]
+assert "February" in serialized_names["data"]["month"]
+assert serialized_names["levels"]["month"]["ordering"] == ["January", "February"]
+
+# Check week day is names
+assert "Sunday" in serialized_names["data"]["week_day"]
+assert "Monday" in serialized_names["data"]["week_day"]
+# Ordering should be Sunday, Monday, Tuesday...
+expected_ordering = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
+assert serialized_names["levels"]["week_day"]["ordering"] == expected_ordering
+
+# Test 3: All Features
+builder_all = DateGroupsBuilder(
+    group_name="Dates",
+    date_data=date_data,
+    include_year=True,
+    include_year_month=True,
+    include_year_month_day=True,
+    include_year_week=True,
+    include_year_day=True,
+    include_month=True,
+    include_month_week=True,
+    include_month_day=True,
+    include_week_day=True,
+)
+serialized_all = builder_all.serialize()
+
+# Check keys exist
+expected_keys = [
+    "year",
+    "year_month",
+    "year_month_day",
+    "year_week",
+    "year_day",
+    "month",
+    "month_week",
+    "month_day",
+    "week_day",
+]
+for key in expected_keys:
+    assert key in serialized_all["data"]
+    assert key in serialized_all["levels"]
+
+# Check some values
+assert 2023 in serialized_all["data"]["year"]
+assert "2023-01" in serialized_all["data"]["year_month"]
+assert "2023-01-01" in serialized_all["data"]["year_month_day"]
+
+print("DateGroupsBuilder Tests: Passed!")