cave-utils 2.1.2__tar.gz → 2.2.0__tar.gz

{cave_utils-2.1.2/cave_utils.egg-info → cave_utils-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cave_utils
-Version: 2.1.2
+Version: 2.2.0
 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
@@ -11,8 +11,8 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE.md
-Requires-Dist: pamda>=2.3.0
-Requires-Dist: type_enforced>=1.2.0
+Requires-Dist: pamda>=2.5.0
+Requires-Dist: type_enforced>=1.4.0
 
 Cave Utilities for the Cave App
 ==========
@@ -58,9 +58,9 @@ pip install cave_utils
 
 # cave_utils development
 
-## Using Live Validation
+## Using Local Hotloading
 
-1. In your cave_app, update the following file:
+1. In your `cave_app`, update the following file:
 
     `utils/run_server.sh`
     ```
@@ -80,12 +80,12 @@ pip install cave_utils
 
 2. Remove `cave_utils` from the root `requirements.txt` file
 
-3. In your cave_app, set `LIVE_API_VALIDATION_PRINT=True` in the `.env` file
+3. In your `cave_app`, set `LIVE_API_VALIDATION_PRINT=True` in the `.env` file
     - This will validate your data every time an API command is called for each session
 
-4. Use the following command to run your cave_app:
+4. Use the following command to run your `cave_app`:
     `cave run --docker-args "--volume {local_path_to_cave_utils}/cave_utils:/cave_utils"`
-    - As you edit cave_utils, the logs will be updated live
+    - As you edit `cave_utils`, any changes will be hotloaded into your running `cave_app`
 
 ## Using interactive mode and running tests
 

{cave_utils-2.1.2 → cave_utils-2.2.0}/README.md

@@ -42,9 +42,9 @@ pip install cave_utils
 
 # cave_utils development
 
-## Using Live Validation
+## Using Local Hotloading
 
-1. In your cave_app, update the following file:
+1. In your `cave_app`, update the following file:
 
     `utils/run_server.sh`
     ```
@@ -64,12 +64,12 @@ pip install cave_utils
 
 2. Remove `cave_utils` from the root `requirements.txt` file
 
-3. In your cave_app, set `LIVE_API_VALIDATION_PRINT=True` in the `.env` file
+3. In your `cave_app`, set `LIVE_API_VALIDATION_PRINT=True` in the `.env` file
     - This will validate your data every time an API command is called for each session
 
-4. Use the following command to run your cave_app:
+4. Use the following command to run your `cave_app`:
     `cave run --docker-args "--volume {local_path_to_cave_utils}/cave_utils:/cave_utils"`
-    - As you edit cave_utils, the logs will be updated live
+    - As you edit `cave_utils`, any changes will be hotloaded into your running `cave_app`
 
 ## Using interactive mode and running tests
 

cave_utils-2.2.0/cave_utils/__init__.py

@@ -0,0 +1,13 @@
+"""
+The cave_utils package is a collection of utility classes and functions that are used in the CAVE project.
+
+On the left hand side, you will find all available submodules, and their associated docs.
+
+Click on a submodule to see the documentation for that submodule.
+"""
+
+from .log import LogObject, LogHelper
+from .socket import Socket
+from .api_utils.validator import Validator
+from .arguments import Arguments
+from .geo_utils import GeoUtils

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/__init__.py

@@ -11,6 +11,7 @@ Submodules (and their classes) are used to define the api at each level. You can
 
 See the left hand side for all available submodules.
 """
+
 from cave_utils.api_utils.validator_utils import *
 from cave_utils.api.extraKwargs import extraKwargs
 from cave_utils.api.settings import settings
@@ -95,6 +96,9 @@ class Root(ApiValidator):
             root_data=self.data,
             **kwargs,
         )
+        # Special logic to add timeLength to kwargs
+        # This is used to validate timeValues across the app
+        kwargs["timeLength"] = pamda.path(["settings", "time", "timeLength"], self.data)
         # Validate panes
         panes_data = self.data.get("panes")
         pane_validPaneIds = []

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/appBar.py

@@ -12,6 +12,7 @@ simultaneously.
 [predefined]: #appBar_data_star.spec
 [custom]: #appBar_data_star.spec
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 import type_enforced
 
@@ -52,9 +53,8 @@ class appBar_data_star(ApiValidator):
         bar: str,
         variant: [str, None] = None,
         color: [str, None] = None,
-        order: [dict, None] = None,
         apiCommand: [str, None] = None,
-        apiCommandKeys: [list, None] = None,
+        apiCommandKeys: [list[str], None] = None,
         **kwargs,
     ):
         """
@@ -88,7 +88,7 @@ class appBar_data_star(ApiValidator):
             * **Note**: It must be a valid RGBA string.
             * **Example**: `"rgba(255, 255, 255, 1)"`.
         * **`apiCommand`**: `[str]` = `None` → The name of the [API command][] to trigger.
-        * **`apiCommandKeys`**: `[list]` = `None` →
+        * **`apiCommandKeys`**: `[list[str]]` = `None` →
             * The root API keys to pass to your `execute_command` function if an
             `apiCommand` is provided. If omitted, all API keys are
             passed to `execute_command`.

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/extraKwargs.py

@@ -2,6 +2,7 @@
 Optionally, pass special arguments to adjust some options related to
 how the CAVE API server handles data.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator
 import type_enforced
 

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/globalOutputs.py

@@ -2,6 +2,7 @@
 
 These outputs should be general to the entire application and they can be compared across sessions.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 from cave_utils.api_utils.general import props, values, layout
 import type_enforced

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/groupedOutputs.py

@@ -1,6 +1,7 @@
 """
 Create grouped outputs for building generalized charts and tables.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 import type_enforced
 from pamda import pamda
@@ -279,13 +280,13 @@ class groupedOutputs_groupings_star(ApiValidator):
         levels_data = self.data.get("levels", {})
         levels_data_keys = list(levels_data.keys())
         data_data = self.data.get("data", {})
-
         CustomKeyValidator(
             data=levels_data,
             log=self.log,
             prepend_path=["levels"],
             validator=groupedOutputs_groupings_star_levels_star,
             acceptable_parents=levels_data_keys,
+            acceptable_data_levels=data_data,
             **kwargs,
         )
         groupedOutputs_groupings_star_data(
@@ -348,7 +349,14 @@ class groupedOutputs_groupings_star_levels_star(ApiValidator):
     """
 
     @staticmethod
-    def spec(name: str, parent: [str, None] = None, ordering: [list, None] = None, **kwargs):
+    def spec(
+        name: str,
+        parent: [str, None] = None,
+        ordering: [list, None] = None,
+        orderWithParent: bool = True,
+        coloring: [dict, None] = None,
+        **kwargs,
+    ):
         """
         Arguments:
 
@@ -358,16 +366,22 @@ class groupedOutputs_groupings_star_levels_star(ApiValidator):
             * **Notes**:
                 * The parent level key must be defined in `groupedOutputs.groupings.*.levels.*`
                 * If `None`, this will be considered to be the root of the hierarchy.
+        * **`ordering`**: `[list]` →
+            * The ordering of individual values for this level in charts and tables.
+            * **Note**: If none, the ordering will be alphabetical.
+            * **Note**: If a partial ordering is provided, the provided values will be placed first in order.
+            * **Note**: If a partial ordering is provided, the remaining values will be placed in alphabetical order.
+            * **Note**: All items in this list must be defined in `groupedOutputs.groupings.*.levels.*.values.*`
+        * **`orderWithParent`**: `[bool]`=True →
+            * Weather or not to order this level based on the parent level.
+            * If `True`, the ordering of this level will also be based on the parent level.
+            * If `False`, the ordering will be based on the ordering of this level only.
+        * **`coloring`**: `[dict]` →
+            * A dictionary of colors to be used for the level.
+            * Each key in this dictionary is a value in the level.
+            * Each value in this dictionary is an rgba string.
+            * **See**: `cave_utils.api.groupedOutputs.groupedOutputs_groupings_star_levels_star_coloring`
         """
-        # TODO: Figure out new way for ordering
-        # - `ordering`:
-        #     - Type: list
-        #     - What: The ordering of individual values for this level in charts and tables.
-        #     - Note: If none, the ordering will be alphabetical.
-        #     - Note: If a partial ordering is provided, the provided values will be placed first in order.
-        #     - Note: If a partial ordering is provided, the remaining values will be placed in alphabetical order.
-        #     - Note: All items in this list must be defined in `groupedOutputs.groupings.*.levels.*.values.*`
-        # """
         return {"kwargs": kwargs, "accepted_values": {}}
 
     def __extend_spec__(self, **kwargs):
@@ -378,9 +392,24 @@ class groupedOutputs_groupings_star_levels_star(ApiValidator):
                 valid_values=kwargs.get("acceptable_parents", []),
                 prepend_path=["parent"],
             )
-        # ordering = self.data.get("ordering")
-        # if ordering is not None:
-        #     print(ordering, kwargs.get("acceptable_data_keys", []))
-        #     self.__check_subset_valid__(
-        #         subset=ordering, valid_values=kwargs.get("acceptable_data_keys", []), prepend_path=["ordering"]
-        #     )
+        ordering = self.data.get("ordering")
+        if ordering is not None:
+            self.__check_subset_valid__(
+                subset=ordering,
+                valid_values=kwargs.get("acceptable_data_levels", {}).get(
+                    kwargs.get("CustomKeyValidatorFieldId"), []
+                ),
+                prepend_path=["ordering"],
+            )
+
+        coloring = self.data.get("coloring")
+        if coloring is not None:
+            self.__check_subset_valid__(
+                subset=list(coloring.keys()),
+                valid_values=kwargs.get("acceptable_data_levels", {}).get(
+                    kwargs.get("CustomKeyValidatorFieldId"), []
+                ),
+                prepend_path=["coloring"],
+            )
+            for key, value in coloring.items():
+                self.__check_rgba_string_valid__(rgba_string=value, prepend_path=["coloring", key])

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/mapFeatures.py

@@ -1,6 +1,7 @@
 """
 Create visualizations for your map, including `arc`s, `node`s, and `geo`s, and customize their appearance.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 from cave_utils.api_utils.general import props, valueLists, layout
 import type_enforced
@@ -155,8 +156,8 @@ class mapFeatures_data_star_data(ApiValidator):
             **kwargs,
         )
         # Validate that all lengths are the same
-        lengths = [len(v) for k, v in location_data.items() if k not in ["order", "timeValues"]] + [
-            len(v) for k, v in valueLists_data.items() if k not in ["order", "timeValues"]
+        lengths = [len(v) for k, v in location_data.items() if k not in ["timeValues", "order"]] + [
+            len(v) for k, v in valueLists_data.items() if k not in ["timeValues", "order"]
         ]
         if len(set(lengths)) > 1:
             self.__error__(msg=f"location and valueLists keys must have the same length.", path=[])
@@ -185,16 +186,35 @@ class mapFeatures_data_star_data_location(ApiValidator):
         layer_type = kwargs.get("layer_type")
         layer_geoJson = kwargs.get("layer_geoJson")
         passed_keys = list(self.data.keys())
-        # TODO Figure out way to handle timeValues and order
-        optional_keys = ["timeValues", "order"]
-        if layer_type == "geo" or (layer_type == "arc" and layer_geoJson):
+        optional_keys = []
+        if layer_type == "geo":
             required_keys = ["geoJsonValue"]
         elif layer_type == "arc":
-            if "path" in passed_keys:
+            if layer_geoJson is not None:
+                required_keys = ["geoJsonValue"]
+                optional_keys += [
+                    "path",
+                    "startLatitude",
+                    "startLongitude",
+                    "endLatitude",
+                    "endLongitude",
+                    "startAltitude",
+                    "endAltitude",
+                ]
+            elif "path" in passed_keys:
                 required_keys = ["path"]
+                optional_keys += [
+                    "startLatitude",
+                    "startLongitude",
+                    "endLatitude",
+                    "endLongitude",
+                    "geoJsonValue",
+                    "startAltitude",
+                    "endAltitude",
+                ]
             else:
                 required_keys = ["startLatitude", "startLongitude", "endLatitude", "endLongitude"]
-                optional_keys += ["startAltitude", "endAltitude"]
+                optional_keys += ["startAltitude", "endAltitude", "geoJsonValue", "path"]
         else:
             required_keys = ["latitude", "longitude"]
             optional_keys += ["altitude"]
@@ -209,8 +229,12 @@ class mapFeatures_data_star_data_location(ApiValidator):
                     path=[],
                 )
                 continue
-            if key in ["timeValues", "order"]:
-                continue
+            if key == "geoJsonValue":
+                if len(value_list) != len(set(value_list)):
+                    self.__warn__(
+                        msg=f"`geoJsonValue` should be a list of unique values. Otherwise, the corresponding map feature may not render correctly.",
+                        path=[key],
+                    )
             if not isinstance(value_list, list):
                 self.__error__(
                     msg=f"`{key}` must be a list but got {type(value_list)} instead.", path=[key]
@@ -240,7 +264,7 @@ class mapFeatures_data_star_data_location(ApiValidator):
                         altitudes = None
                 except:
                     self.__error__(
-                        msg=f"`path` must be a list of lists of lists of length 2 or 3. EG: `[[[0,0],[1,1]],[[2,2],[3,3],[4,4],[5,5]]]`",
+                        msg=f"`path` must be a list of lists of lists of length 2 [long,lat] or 3 [long,lat,alt]. EG: `[[[0,0],[1,1]],[[2,2],[3,3],[4,4],[5,5]]]`",
                         path=[key],
                     )
                     continue

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/maps.py

@@ -1,6 +1,7 @@
 """
 Configure the style and UI elements of your application's maps.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 import type_enforced
 

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/pages.py

@@ -1,6 +1,7 @@
 """
 Configure your application's pages.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 import type_enforced
 
@@ -82,6 +83,7 @@ class pages_data_star_pageLayout(ApiValidator):
         statId: [str, list, None] = None,
         showToolbar: bool = True,
         maximized: bool = False,
+        defaultToZero: bool = False,
         **kwargs,
     ):
         """
@@ -135,6 +137,7 @@ class pages_data_star_pageLayout(ApiValidator):
             * **Note**: If left unspecified (i.e., `None`), it will default to `settings.showToolbar`.
         * **`maximized`**: `[bool]` = `False` → Whether or not the layout should be maximized.
             * **Note**: If more than one chart belonging to the same page layout is set to `True`, the first one found in the list will take precedence.
+        * **`defaultToZero`**: `[bool]` = `False` → Whether or not the chart should default missing values to zero.
 
         [area chart]: https://en.wikipedia.org/wiki/Area_chart
         [bar chart]: https://en.wikipedia.org/wiki/Bar_chart

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/panes.py

@@ -3,6 +3,7 @@ Panes serve as main containers for UI controls such as toggles, text
 and number fields, sliders, etc. They can also contain buttons that
 facilitate interaction with actionable data.
 """
+
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
 from cave_utils.api_utils.general import props, values, layout
 import type_enforced

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api/settings.py

@@ -1,6 +1,7 @@
 """
 Configure general settings for your application like the icons to use, how to sync data with the server, and more.
 """
+
 from cave_utils.api_utils.validator_utils import *
 import type_enforced
 
@@ -291,3 +292,8 @@ class settings_time(ApiValidator):
             * **Example**: `"Decade"`.
         """
         return {"kwargs": kwargs, "accepted_values": {}}
+
+    def __extend_spec__(self, **kwargs):
+        timeLength = self.data.get("timeLength")
+        if timeLength < 1:
+            self.__error__(f"Time length must be greater than 0.", path=["timeLength"])

cave_utils-2.2.0/cave_utils/api_utils/__init__.py

@@ -0,0 +1,22 @@
+"""
+## Validation
+
+This code can be used directly for validation purposes:
+
+```py
+from cave_utils import Validator
+
+session_data = {
+    "kwargs": {
+        "wipeExisting": True,
+    },
+    # All of your session data to validate here
+}
+
+x = Validator(
+    session_data=session_data,
+)
+
+print(x.log.log)
+```
+"""

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api_utils/general.py

@@ -1,6 +1,7 @@
 """
 General API Spec items that are found in multiple places. This is not a key that should be passed as part of your `session_data`.
 """
+
 from pamda import pamda
 import type_enforced
 from cave_utils.api_utils.validator_utils import ApiValidator, CustomKeyValidator
@@ -17,7 +18,7 @@ class props(ApiValidator):
         display: [bool, None] = None,
         enabled: [bool, None] = None,
         apiCommand: [str, None] = None,
-        apiCommandKeys: [list, None] = None,
+        apiCommandKeys: [list[str], None] = None,
         options: [dict, None] = None,
         placeholder: [str, None] = None,
         maxValue: [float, int, None] = None,
@@ -29,7 +30,7 @@ class props(ApiValidator):
         precision: [int, None] = None,
         notationDisplay: [str, None] = None,
         unit: [str, None] = None,
-        views: [list, None] = None,
+        views: [list[str], None] = None,
         legendNotation: [str, None] = None,
         legendPrecision: [int, None] = None,
         legendNotationDisplay: [str, None] = None,
@@ -99,7 +100,7 @@ class props(ApiValidator):
         * **`apiCommand`**: `[str]` = `None` → The name of the API command to trigger.
             * **Note**: If `None`, no `apiCommand` is triggered.
             * **Note**: This attribute is applicable to all props except `"head"` props.
-        * **`apiCommandKeys`**: `[list]` = `None` →
+        * **`apiCommandKeys`**: `[list[str]]` = `None` →
             * The root API keys to pass to your `execute_command` function if an `apiCommand` is provided.
             * **Note**: If `None`, all API keys are passed to your `execute_command`.
             * **Note**: This attribute is applicable to all props except `"head"` props.
@@ -126,15 +127,28 @@ class props(ApiValidator):
         * **`rows`**: `[int]` = `None` →
             * The fixed number of rows to show for a `"textarea"` variant.
             * **Note**: This attribute is applicable exclusively to `"text"` props.
-        * **`views`**: `[list]` = `["year", "day", "hours", "minutes"]` →
+        * **`views`**: `[list[str]]` →
             * The available time units for the represented date and/or time.
+            * **Default Value**:
+                * When **`variant`** == `"date"`: `["year", "day"]`
+                * When **`variant`** == `"time"`: `["hours", "minutes"]`
+                * When **`variant`** == `"datetime"`: `["year", "day", "hours", "minutes"]`
             * **Accepted Values**:
-                * `"year"`: The year view
-                * `"month"`: The month view
-                * `"day"`: The day view
-                * `"hours"`: The hours view
-                * `"minutes"`: The minutes view
-                * `"seconds"`: The seconds view
+                * When **`variant`** == `"date"`:
+                    * `"year"`: The year view
+                    * `"month"`: The month view
+                    * `"day"`: The day view
+                * When **`variant`** == `"time"`:
+                    * `"hours"`: The hours view
+                    * `"minutes"`: The minutes view
+                    * `"seconds"`: The seconds view
+                * When **`variant`** == `"datetime"`:
+                    * `"year"`: The year view
+                    * `"month"`: The month view
+                    * `"day"`: The day view
+                    * `"hours"`: The hours view
+                    * `"minutes"`: The minutes view
+                    * `"seconds"`: The seconds view
             * **Notes**:
                 * The views will be presented in the order specified in the `views` array.
                 * This attribute is applicable exclusively to `"date"` props.
@@ -173,7 +187,7 @@ class props(ApiValidator):
             * **Notes**:
                 * If left unspecified (i.e., `None`), it will default to `settings.defaults.unitPlacement`.
                 * This attribute is applicable exclusively to `"num"` props.
-        * **`notation`**: `[int]` = `"standard"` → The formatting style of a numeric value.
+        * **`notation`**: `[str]` = `"standard"` → The formatting style of a numeric value.
             * **Accepted Values**:
                 * `"standard"`: Plain number formatting
                 * `"compact"`: Resembles the [metric prefix][] system
@@ -184,14 +198,18 @@ class props(ApiValidator):
                 * This attribute is applicable exclusively to `"num"` props.
         * **`notationDisplay`**: `[str]` = `"e+"` | `"short"` → Further customize the formatting within the selected `notation`.
             * **Accepted Values**:
-                * `"short"`: Add symbols `K`, `M`, `B`, and `T` (in `"en-US"`) to denote thousands, millions, billions, and trillions, respectively.
-                * `"long"`: Present numeric values with the informal suffix words `thousand`, `million`, `billion`, and `trillion` (in `"en-US"`).
-                * `"e"`: Exponent symbol in lowercase as per the chosen `locale` identifier
-                * `"e+"`: Similar to `"e"`, but with a plus sign for positive exponents.
-                * `"E"`: Exponent symbol in uppercase as per the chosen `locale` identifier
-                * `"E+"`: Similar to `"E"`, but with a plus sign for positive exponents.
-                * `"x10^"`: Formal scientific notation representation
-                * `"x10^+"`: Similar to `"x10^"`, with a plus sign for positive exponents.
+                * When **`notation`** == `"compact"`:
+                    * `"short"`: Add symbols `K`, `M`, `B`, and `T` (in `"en-US"`) to denote thousands, millions, billions, and trillions, respectively.
+                    * `"long"`: Present numeric values with the informal suffix words `thousand`, `million`, `billion`, and `trillion` (in `"en-US"`).
+                * When **`notation`** == `"scientific"` or `"engineering"`:
+                    * `"e"`: Exponent symbol in lowercase as per the chosen `locale` identifier
+                    * `"e+"`: Similar to `"e"`, but with a plus sign for positive exponents.
+                    * `"E"`: Exponent symbol in uppercase as per the chosen `locale` identifier
+                    * `"E+"`: Similar to `"E"`, but with a plus sign for positive exponents.
+                    * `"x10^"`: Formal scientific notation representation
+                    * `"x10^+"`: Similar to `"x10^"`, with a plus sign for positive exponents.
+                * When **`notation`** == `"standard"`:
+                    * No `notationDisplay` option is allowed for a `"standard"` notation
             * **Notes**:
                 * No `notationDisplay` option is provided for a `"standard"` notation
                 * The options `"short"` and `"long"` are only provided for the `"compact"` notation
@@ -304,20 +322,30 @@ class props(ApiValidator):
         for k, v in passed_values.items():
             if k not in required_fields + optional_fields:
                 kwargs[k] = v
+        notationDisplay_options_dict = {
+            "compact": ["short", "long"],
+            "scientific": ["e", "e+", "E", "E+", "x10^", "x10^+"],
+            "engineering": ["e", "e+", "E", "E+", "x10^", "x10^+"],
+            "standard": [],
+        }
+        notation = passed_values.get("notation", "standard")
+        legendNotation = passed_values.get("legendNotation", "standard")
+        view_options_dict = {
+            "date": ["year", "month", "day"],
+            "time": ["hours", "minutes", "seconds"],
+            "datetime": ["year", "month", "day", "hours", "minutes", "seconds"],
+        }
+        variant = passed_values.get("variant", None)
         return {
             "kwargs": kwargs,
             "accepted_values": {
                 "type": ["head", "num", "toggle", "button", "text", "selector", "date", "media"],
-                "views": ["year", "month", "day", "hours", "minutes", "seconds"],
+                "views": view_options_dict.get(variant, []),
                 "unitPlacement": ["after", "afterWithSpace", "before", "beforeWithSpace"],
-                # TODO: Validate
-                # compact: allowed notation displays -> "short", "long"
-                # scientific|engineering: allowed notation displays -> "e", "e+", "E", "E+", "x10^", "x10^+"
-                # standard: allowed notation displays -> None
                 "notation": ["compact", "precision", "scientific", "engineering"],
-                "notationDisplay": ["short", "long", "e", "e+", "E", "E+", "x10^", "x10^+"],
+                "notationDisplay": notationDisplay_options_dict.get(notation, []),
                 "legendNotation": ["compact", "precision", "scientific", "engineering"],
-                "legendNotationDisplay": ["short", "long", "e", "e+", "E", "E+", "x10^", "x10^+"],
+                "legendNotationDisplay": notationDisplay_options_dict.get(legendNotation, []),
                 "variant": {
                     "head": ["column", "row", "icon", "iconRow"],
                     "text": ["textarea"],
@@ -350,14 +378,15 @@ class props(ApiValidator):
             )
 
 
+@type_enforced.Enforcer
 class props_options(ApiValidator):
     @staticmethod
-    def spec(name: str, path: [list, None] = None, **kwargs):
+    def spec(name: str, path: [list[str], None] = None, **kwargs):
         """
         Arguments:
 
         * **`name`**: `[str]` → The name of the option.
-        * **`path`**: `[list]` = `None` → The path to an option.
+        * **`path`**: `[list[str]]` = `None` → The path to an option.
             * **Notes**:
                 * If `None`, the option will not be selectable
                 * This attribute is applicable exclusively to `"nested"` props
@@ -379,9 +408,6 @@ class props_options(ApiValidator):
                     msg="`path` must be specified and a list of strings for nested options"
                 )
                 return
-            self.__check_type_list__(
-                data=self.data.get("path", []), types=(str,), prepend_path=["path"]
-            )
 
 
 @type_enforced.Enforcer

{cave_utils-2.1.2 → cave_utils-2.2.0}/cave_utils/api_utils/validator.py

@@ -1,6 +1,7 @@
 """
 This module contains the primary Validator class that is used to validate your session_data against the API spec.
 """
+
 from cave_utils.api_utils.validator_utils import LogObject
 from cave_utils.api import Root
 import type_enforced
@@ -8,7 +9,7 @@ import type_enforced
 
 @type_enforced.Enforcer
 class Validator:
-    def __init__(self, session_data, ignore_keys: list = list(), **kwargs):
+    def __init__(self, session_data, ignore_keys: list[str] = list(), **kwargs):
         """
         Util to validate your session_data against the API spec.
 
@@ -16,7 +17,7 @@ class Validator:
 
         * **`session_data`**: `[dict]` → The data to validate.
             * **Note**: This should be the data you are sending to the server.
-        * **`ignore_keys`**: `[list]` = `None` → Keys to ignore when validating.
+        * **`ignore_keys`**: `[list[str]]` = `None` → Keys to ignore when validating.
             * **Note**: Any keys specified here will be not be validated if encountered in the data at any level.
         """
         self.session_data = session_data