Significant improvements to the checkers module

- Added `OPERATORS` constant dictionary to define comparison operations.
- Introduced `is_valid_value` and `assert_is_valid_value` functions for value validation based on operators.
- Updated documentation in `checkers.md` to include new functions and constants.
- Enhanced test coverage in `test_checkers.py` for the new validation functions.
- Improved docstrings across all functions

Author: chrimaho

docs/code/checkers.md

@@ -5,6 +5,15 @@
             -
 
 
+## Constants
+
+::: toolbox_python.checkers
+    options:
+        show_root_heading: false
+        members:
+            - OPERATORS
+
+
 ## `is_*()` functions
 
 ::: toolbox_python.checkers
@@ -17,6 +26,7 @@
             - is_value_in_iterable
             - is_all_values_in_iterable
             - is_any_values_in_iterable
+            - is_valid_value
 
 
 ## `is_*()` function aliases
@@ -31,6 +41,7 @@
             - is_in
             - is_any_in
             - is_all_in
+            - is_valid
 
 
 ## `assert_*()` functions
@@ -45,6 +56,7 @@
             - assert_value_in_iterable
             - assert_any_values_in_iterable
             - assert_all_values_in_iterable
+            - assert_is_valid_value
 
 
 ## `assert_*()` function aliases
@@ -54,11 +66,15 @@
         show_root_heading: false
         members:
             - assert_type
+            - assert_is_type
             - assert_all_type
+            - assert_all_is_type
             - assert_any_type
+            - assert_any_is_type
             - assert_in
             - assert_any_in
             - assert_all_in
+            - assert_is_valid
 
 
 ## `*_contains()` functions

src/tests/test_checkers.py

@@ -19,7 +19,11 @@
 from parameterized import parameterized
 
 # ## Local First Party Imports ----
-from tests.setup import name_func_nested_list, name_func_predefined_name
+from tests.setup import (
+    name_func_flat_list,
+    name_func_nested_list,
+    name_func_predefined_name,
+)
 from toolbox_python.checkers import (
     all_elements_contains,
     any_element_contains,
@@ -32,6 +36,7 @@
     assert_any_values_in_iterable,
     assert_any_values_of_type,
     assert_in,
+    assert_is_valid,
     assert_type,
     assert_value_in_iterable,
     assert_value_of_type,
@@ -46,6 +51,7 @@
     is_any_values_of_type,
     is_in,
     is_type,
+    is_valid,
     is_value_in_iterable,
     is_value_of_type,
 )
@@ -75,7 +81,12 @@
 # ---------------------------------------------------------------------------- #
 
 
-class TestSuite(TestCase):
+## --------------------------------------------------------------------------- #
+##  Types                                                                   ####
+## --------------------------------------------------------------------------- #
+
+
+class TestTypes(TestCase):
 
     def setUp(self) -> None:
         pass
@@ -230,6 +241,14 @@ def test_is_any_values_of_type(
                 assert_any_values_of_type(_vals, _typ)
                 assert_any_type(_vals, _typ)
 
+
+## --------------------------------------------------------------------------- #
+##  Iterables                                                               ####
+## --------------------------------------------------------------------------- #
+
+
+class TestIterables(TestCase):
+
     @parameterized.expand(
         (
             ("list", ["a", "b", "c"]),
@@ -371,3 +390,68 @@ def test_get_elements_containing(
             _out = tuple(sorted(_out))
             _exp = tuple(sorted(_exp))
         assert _out == _exp
+
+
+## --------------------------------------------------------------------------- #
+##  Values                                                                  ####
+## --------------------------------------------------------------------------- #
+
+
+TRUES = (
+    (5, "<", 10),
+    (5, "<=", 10),
+    (5, "<=", 5),
+    (10, ">", 5),
+    (10, ">=", 5),
+    (5, ">=", 5),
+    (5, "==", 5),
+    (5, "!=", 10),
+    (3, "in", [1, 2, 3, 4]),
+    (5, "not in", (1, 2, 3, 4)),
+)
+FALSES = (
+    (10, "<", 5),
+    (10, "<=", 5),
+    (5, ">", 10),
+    (5, ">=", 10),
+    (5, "==", 10),
+    (5, "!=", 5),
+    (5, "in", [1, 2, 3, 4]),
+    (3, "not in", (1, 2, 3, 4)),
+)
+
+
+class TestValues(TestCase):
+
+    @parameterized.expand(
+        input=TRUES,
+        name_func=name_func_flat_list,
+    )
+    def test_is_valid(self, _val: Any, _op: str, _targ: Any) -> None:
+        assert is_valid(_val, _op, _targ) == True
+
+    @parameterized.expand(
+        input=FALSES,
+        name_func=name_func_flat_list,
+    )
+    def test_not_is_valid(self, _val: Any, _op: str, _targ: Any) -> None:
+        assert is_valid(_val, _op, _targ) == False
+
+    @parameterized.expand(
+        input=TRUES,
+        name_func=name_func_flat_list,
+    )
+    def test_assert_is_valid(self, _val: Any, _op: str, _targ: Any) -> None:
+        assert assert_is_valid(_val, _op, _targ) is None
+
+    @parameterized.expand(
+        input=FALSES,
+        name_func=name_func_flat_list,
+    )
+    def test_assert_not_is_valid(self, _val: Any, _op: str, _targ: Any) -> None:
+        with pytest.raises(ValueError):
+            assert_is_valid(_val, _op, _targ)
+
+    def test_assert_is_valid_unknown_operator(self) -> None:
+        with pytest.raises(ValueError):
+            assert_is_valid(5, "unknown", 10)