Fix type definitions across all modules

Author: chrimaho

src/tests/test_dictionaries.py

@@ -18,7 +18,15 @@
 import pytest
 
 # ## Local First Party Imports ----
-from toolbox_python.collection_types import int_list, int_tuple, str_list, str_tuple
+from toolbox_python.collection_types import (
+    dict_int_str,
+    dict_str_int,
+    dict_str_str,
+    int_list,
+    int_tuple,
+    str_list,
+    str_tuple,
+)
 
 # Local Module Imports
 from toolbox_python.dictionaries import dict_reverse_keys_and_values
@@ -36,7 +44,7 @@ class TestDictionaries(TestCase):
     @classmethod
     def setUpClass(cls) -> None:
 
-        cls.dict_basic: dict[str, int] = {"a": 1, "b": 2, "c": 3}
+        cls.dict_basic: dict_str_int = {"a": 1, "b": 2, "c": 3}
 
         cls.dict_iterables: dict[
             str, Union[str_list, int_list, str_tuple, int_tuple]
@@ -71,8 +79,8 @@ def setUpClass(cls) -> None:
 
     def test_reverse_dict_one_for_one(self) -> None:
         _input = self.dict_basic
-        _output = dict_reverse_keys_and_values(_input)
-        _expected = {"1": "a", "2": "b", "3": "c"}
+        _output: dict_int_str = dict_reverse_keys_and_values(_input)
+        _expected: dict_str_str = {"1": "a", "2": "b", "3": "c"}
         assert _output == _expected
 
     def test_reverse_dict_iterables(self) -> None:
@@ -110,7 +118,7 @@ def test_reverse_dict_iterables_with_duplicates(self) -> None:
     def test_reverse_dict_embedded_dicts(self) -> None:
         _input = self.dict_with_dicts
         _output = dict_reverse_keys_and_values(_input)
-        _expected = {
+        _expected: dict_str_str = {
             "11": "aa",
             "22": "bb",
             "33": "cc",

src/tests/test_strings.py

@@ -11,11 +11,10 @@
 
 
 # ## Python StdLib Imports ----
-# Python StdLib Imports
 from unittest import TestCase
 
 # ## Local First Party Imports ----
-# Local Module Imports
+from toolbox_python.collection_types import str_list
 from toolbox_python.strings import (
     str_contains,
     str_contains_all,
@@ -103,14 +102,14 @@ def setUp(self) -> None:
 
     def test_str_separate_number_chars1(self) -> None:
         _input = "-12.1grams"
-        _output: list[str] = str_separate_number_chars(_input)
-        _expected: list[str] = ["-12.1", "grams"]
+        _output: str_list = str_separate_number_chars(_input)
+        _expected: str_list = ["-12.1", "grams"]
         assert _output == _expected
 
     def test_str_separate_number_chars2(self) -> None:
         _input = "abcd2343 abw34324 abc3243-23A 123"
-        _output: list[str] = str_separate_number_chars(_input)
-        _expected: list[str] = [
+        _output: str_list = str_separate_number_chars(_input)
+        _expected: str_list = [
             "abcd",
             "2343",
             "abw",

src/toolbox_python/bools.py

@@ -33,12 +33,21 @@
 # ---------------------------------------------------------------------------- #
 
 
+# ---------------------------------------------------------------------------- #
+#  Imports                                                                  ####
+# ---------------------------------------------------------------------------- #
+
+
+# ## Local First Party Imports ----
+from toolbox_python.collection_types import str_list
+
+
 # ---------------------------------------------------------------------------- #
 #  Exports                                                                  ####
 # ---------------------------------------------------------------------------- #
 
 
-__all__: list[str] = ["strtobool", "STR_TO_BOOL_MAP"]
+__all__: str_list = ["strtobool", "STR_TO_BOOL_MAP"]
 
 
 # ---------------------------------------------------------------------------- #

src/toolbox_python/checkers.py

@@ -25,15 +25,20 @@
 from typeguard import typechecked
 
 # ## Local First Party Imports ----
-from toolbox_python.collection_types import any_collection, scalar, str_collection
+from toolbox_python.collection_types import (
+    any_collection,
+    scalar,
+    str_collection,
+    str_list,
+)
 
 
 ## --------------------------------------------------------------------------- #
 ##  Exports                                                                 ####
 ## --------------------------------------------------------------------------- #
 
 
-__all__: list[str] = [
+__all__: str_list = [
     "all_elements_contains",
     "any_element_contains",
     "assert_all_in",
@@ -638,7 +643,7 @@ def assert_all_values_of_type(
         if isinstance(check_type, type):
             msg += f"Must be '{check_type}'"
         else:
-            types: list[str] = [f"'{typ.__name__}'" for typ in check_type]
+            types: str_list = [f"'{typ.__name__}'" for typ in check_type]
             msg += f"Must be: {' or '.join(types)}"
         raise TypeError(msg)
 
@@ -733,7 +738,7 @@ def assert_any_values_of_type(
         if isinstance(check_type, type):
             msg += f"Must be: '{check_type.__name__}'"
         else:
-            types: list[str] = [f"'{typ.__name__}'" for typ in check_type]
+            types: str_list = [f"'{typ.__name__}'" for typ in check_type]
             msg += f"Must be: {' or '.join(types)}"
         raise TypeError(msg)
 

src/toolbox_python/classes.py

@@ -41,13 +41,16 @@
 # ## Python StdLib Imports ----
 from typing import Any
 
+# ## Local First Party Imports ----
+from toolbox_python.collection_types import str_list
+
 
 # ---------------------------------------------------------------------------- #
 #  Exports                                                                  ####
 # ---------------------------------------------------------------------------- #
 
 
-__all__: list[str] = ["get_full_class_name"]
+__all__: str_list = ["get_full_class_name"]
 
 
 # ---------------------------------------------------------------------------- #

src/toolbox_python/collection_types.py

@@ -110,6 +110,8 @@
 
 
 dict_str_any = dict[str, Any]
+dict_str_str = dict[str, str]
+dict_int_str = dict[int, str]
 
 
 log_levels = Literal["debug", "info", "warning", "error", "critical"]

src/toolbox_python/defaults.py

@@ -40,22 +40,23 @@
 from __future__ import annotations
 
 # ## Python StdLib Imports ----
-from typing import Any, Optional, Union
+from typing import Any
 
 # ## Python Third Party Imports ----
 from typeguard import typechecked
 
 # ## Local First Party Imports ----
 from toolbox_python.bools import strtobool
 from toolbox_python.checkers import is_type
+from toolbox_python.collection_types import str_list
 
 
 # ---------------------------------------------------------------------------- #
 #  Exports                                                                  ####
 # ---------------------------------------------------------------------------- #
 
 
-__all__: list[str] = ["defaults", "Defaults"]
+__all__: str_list = ["defaults", "Defaults"]
 
 
 # ---------------------------------------------------------------------------- #
@@ -196,8 +197,8 @@ def __call__(self, *args, **kwargs) -> Any:
     def get(
         self,
         value: Any,
-        default: Optional[Any] = None,
-        cast: Optional[Union[str, type]] = None,
+        default: Any | None = None,
+        cast: str | type | None = None,
     ) -> Any:
         """
         !!! note "Summary"
@@ -250,8 +251,8 @@ def get(
 
     def _validate_value_and_default(
         self,
-        value: Optional[Any] = None,
-        default: Optional[Any] = None,
+        value: Any | None = None,
+        default: Any | None = None,
     ) -> Defaults:
         """
         !!! note "Summary"
@@ -284,7 +285,7 @@ def _validate_value_and_default(
 
     def _validate_type(
         self,
-        check_type: Optional[Union[str, type]] = None,
+        check_type: str | type | None = None,
     ) -> Defaults:
         """
         !!! note "Summary"
@@ -306,7 +307,7 @@ def _validate_type(
         ??? tip "See Also"
             - [`Defaults.get()`][toolbox_python.defaults.Defaults.get]
         """
-        valid_types: list[str] = [
+        valid_types: str_list = [
             "bool",
             "dict",
             "int",

src/toolbox_python/dictionaries.py

@@ -42,14 +42,14 @@
 from typeguard import typechecked
 
 # ## Local First Party Imports ----
-from toolbox_python.collection_types import dict_any, dict_str_int
+from toolbox_python.collection_types import dict_any, dict_str_any, str_list
 
 
 # ---------------------------------------------------------------------------- #
 #  Exports                                                                  ####
 # ---------------------------------------------------------------------------- #
 
-__all__: list[str] = ["dict_reverse_keys_and_values"]
+__all__: str_list = ["dict_reverse_keys_and_values"]
 
 
 # ---------------------------------------------------------------------------- #
@@ -62,7 +62,7 @@
 @typechecked
 def dict_reverse_keys_and_values(
     dictionary: dict_any,
-) -> dict_str_int:
+) -> dict_str_any:
     """
     !!! note "Summary"
         Take the `key` and `values` of a dictionary, and reverse them.
@@ -201,7 +201,7 @@ def dict_reverse_keys_and_values(
         !!! observation "Here, the process would be to run a recursive process when it recognises that any `value` is a `#!py dict` object. So long as there are no duplicate values in any of the contained `#!py dict`'s, the resulting output will be a big, flat dictionary."
         </div>
     """
-    output_dict: dict_str_int = dict()
+    output_dict: dict_str_any = dict()
     for key, value in dictionary.items():
         if isinstance(value, (str, int, float)):
             output_dict[str(value)] = key
@@ -216,7 +216,7 @@ def dict_reverse_keys_and_values(
                     )
                 output_dict[str(elem)] = key
         elif isinstance(value, dict):
-            interim_dict: dict_str_int = dict_reverse_keys_and_values(value)
+            interim_dict: dict_str_any = dict_reverse_keys_and_values(value)
             output_dict = {
                 **output_dict,
                 **interim_dict,

src/toolbox_python/lists.py

@@ -47,14 +47,20 @@
 from typeguard import typechecked
 
 # ## Local First Party Imports ----
-from toolbox_python.collection_types import any_list, any_tuple, collection, scalar
+from toolbox_python.collection_types import (
+    any_list,
+    any_tuple,
+    collection,
+    scalar,
+    str_list,
+)
 
 
 # ---------------------------------------------------------------------------- #
 #  Exports                                                                  ####
 # ---------------------------------------------------------------------------- #
 
-__all__: list[str] = ["flatten", "flat_list", "product"]
+__all__: str_list = ["flatten", "flat_list", "product"]
 
 
 # ---------------------------------------------------------------------------- #

src/toolbox_python/output.py

@@ -364,13 +364,13 @@ def list_columns(
         Full credit goes to:<br>
         https://stackoverflow.com/questions/1524126/how-to-print-a-list-more-nicely#answer-36085705
     """
-    string_list: list[str] = [str(item) for item in obj]
+    string_list: str_list = [str(item) for item in obj]
     if cols_wide > len(string_list):
         cols_wide = len(string_list)
     max_len: int = max(len(item) for item in string_list)
     if columnwise:
         cols_wide = int(ceil(len(string_list) / cols_wide))
-    segmented_list: list[list[str]] = [
+    segmented_list: list[str_list] = [
         string_list[index : index + cols_wide]
         for index in range(0, len(string_list), cols_wide)
     ]
@@ -379,7 +379,7 @@ def list_columns(
             segmented_list[-1].extend(
                 [""] * (len(string_list) - len(segmented_list[-1]))
             )
-        combined_list: Union[list[list[str]], Any] = zip(*segmented_list)
+        combined_list: Union[list[str_list], Any] = zip(*segmented_list)
     else:
         combined_list = segmented_list
     printer: str = "\n".join(