cave-utils 2.0.2__tar.gz → 2.0.3__tar.gz

{cave_utils-2.0.2 → cave_utils-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cave_utils
-Version: 2.0.2
+Version: 2.0.3
 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-2.0.2 → cave_utils-2.0.3}/cave_utils/api_utils/general.py

@@ -82,9 +82,12 @@ class props(ApiValidator):
                     * `"hstepper"`: Select a unique option along a horizontal slider
                     * `"vstepper"`: Select a unique option along a vertical slider
                 * When **`type`** == `"date"`:
-                    * `"date"`: Select a date via a calendar pop-up that appears when the element is clicked
+                    * `"date"`: Select a date via a calendar pop-up that appears when the element is clicked (default)
+                        * **Note**: Passed as `YYYY-MM-DD`
                     * `"time"`: Select a time via a clock pop-up that appears when the element is clicked
+                        * **Note**: Passed as `HH:MM:SS`
                     * `"datetime"`: Select date and time via a pop-up with calendar and clock tabs that appear when the element is clicked
+                        * **Note**: Passed as `YYYY-MM-DDTHH:MM:SS`
                 * When **`type`** == `"media"`:
                     * `"picture"`: Show a PNG or JPG image
                     * `"video"`: Display a YouTube, Vimeo, or Dailymotion video clip
@@ -509,10 +512,13 @@ class values(ApiValidator):
                 options = list(prop_spec.get("options", {}).keys())
                 self.__check_subset_valid__(prop_value, options, prepend_path=[prop_key])
             elif prop_type == "date":
-                pass
-                # TODO: Validate date string
+                self.__check_date_valid__(
+                    prop_value,
+                    date_variant=prop_spec.get("variant", "date"),
+                    prepend_path=[prop_key],
+                )
             elif prop_type == "media":
-                self.__check_url_valid__(prop_value)
+                self.__check_url_valid__(prop_value, prepend_path=[prop_key])
 
 
 @type_enforced.Enforcer
@@ -593,8 +599,14 @@ class valueLists(ApiValidator):
                     msg=f"`{prop_key}` with the prop type of `{prop_type}` can not have an associated value."
                 )
             elif prop_type == "date":
-                pass
-                # TODO: Validate date string
+                prop_value_list_set = list(set(prop_value_list))
+                date_variant = prop_spec.get("variant", "date")
+                for prop_value in prop_value_list:
+                    if not self.__check_date_valid__(
+                        prop_value, date_variant=date_variant, prepend_path=[prop_key]
+                    ):
+                        continue
             elif prop_type == "media":
                 for prop_value in prop_value_list:
-                    self.__check_url_valid__(prop_value)
+                    if not self.__check_url_valid__(prop_value, prepend_path=[prop_key]):
+                        continue

{cave_utils-2.0.2 → cave_utils-2.0.3}/cave_utils/api_utils/validator_utils.py

@@ -3,7 +3,7 @@ Special utility functions to help in validating your data against the CAVE API.
 """
 from pamda import pamda
 import type_enforced
-import re
+import re, datetime
 from cave_utils.log import LogHelper, LogObject
 
 
@@ -143,6 +143,47 @@ class ApiValidator:
         )
         if re.match(regex, url) is None:
             self.__error__(path=prepend_path, msg="Invalid url")
+            return False
+        return True
+
+    def __check_date_valid__(self, input: str, date_variant: str, prepend_path: list = list()):
+        """
+        Validate a date string and if an issue is present, log an error.
+        """
+        if date_variant == "date":
+            try:
+                datetime.datetime.strptime(input, "%Y-%m-%d")
+            except ValueError:
+                self.__error__(
+                    path=prepend_path,
+                    msg=f"Invalid input for type of `date` with variant `date`. Must be in the format `YYYY-MM-DD`",
+                )
+                return False
+        elif date_variant == "datetime":
+            try:
+                datetime.datetime.strptime(input, "%Y-%m-%dT%H:%M:%S")
+            except ValueError:
+                self.__error__(
+                    path=prepend_path,
+                    msg=f"Invalid input for type of `date` with variant `datetime`. Must be in the format `YYYY-MM-DDTHH:MM:SS`",
+                )
+                return False
+        elif date_variant == "time":
+            try:
+                datetime.datetime.strptime(input, "%H:%M:%S")
+            except ValueError:
+                self.__error__(
+                    path=prepend_path,
+                    msg=f"Invalid input for type of `date` with variant `time`. Must be in the format `HH:MM:SS`",
+                )
+                return False
+        else:
+            self.__error__(
+                path=prepend_path,
+                msg=f"Invalid variant ({date_variant}) for prop with type `date`. Must be one of `date`, `datetime`, or `time`",
+            )
+            return False
+        return True
 
     def __check_subset_valid__(
         self,

{cave_utils-2.0.2 → cave_utils-2.0.3}/cave_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cave-utils
-Version: 2.0.2
+Version: 2.0.3
 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-2.0.2 → cave_utils-2.0.3}/pyproject.toml

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

{cave_utils-2.0.2 → cave_utils-2.0.3}/setup.cfg

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

{cave_utils-2.0.2 → cave_utils-2.0.3}/test/test_validator.py

@@ -391,7 +391,7 @@ example = {
                         "t2_b1_tw1",
                         "t2_b1_tw2",
                     ],
-                    "dateItemExample": "07/20/1969",
+                    "dateItemExample": "1969-07-20",
                     "timeItemExample": "20:17:40",
                     "dateTimeItemExample": "1969-07-20T20:17:40",
                 },