Added type hinting to new container classes

Author: wolph

python_utils/containers.py

@@ -1,6 +1,7 @@
 # pyright: reportIncompatibleMethodOverride=false
 import abc
 import typing
+import collections
 
 from . import types
 
@@ -19,6 +20,8 @@
 VT_cast = types.Optional[types.Callable[..., VT]]
 #: A type alias for the hashable values of the `UniqueList`
 HT = types.TypeVar('HT', bound=types.Hashable)
+#: A type alias for a regular generic type
+T = types.TypeVar('T')
 
 # Using types.Union instead of | since Python 3.7 doesn't fully support it
 DictUpdateArgs = types.Union[
@@ -28,6 +31,8 @@
     '_typeshed.SupportsKeysAndGetItem[KT, VT]',
 ]
 
+OnDuplicate = types.Literal['ignore', 'raise']
+
 
 class CastedDictBase(types.Dict[KT, VT], abc.ABC):
     _key_cast: KT_cast[KT]
@@ -222,7 +227,7 @@ class UniqueList(types.List[HT]):
     def __init__(
         self,
         *args: HT,
-        on_duplicate: types.Literal['raise', 'ignore'] = 'ignore',
+        on_duplicate: OnDuplicate = 'ignore',
     ):
         self.on_duplicate = on_duplicate
         self._set = set()
@@ -305,9 +310,19 @@ def __delitem__(
         super().__delitem__(index)
 
 
-class SlicableDeque(Generic[T], deque):
-    def __getitem__(self, index: Union[int, slice]) -> Union[T, 'SlicableDeque[T]']:
-        """
+class SlicableDeque(types.Generic[T], collections.deque):  # type: ignore
+    @types.overload
+    def __getitem__(self, index: types.SupportsIndex) -> T:
+        ...
+
+    @types.overload
+    def __getitem__(self, index: slice) -> 'SlicableDeque[T]':
+        ...
+
+    def __getitem__(
+        self, index: types.Union[types.SupportsIndex, slice]
+    ) -> types.Union[T, 'SlicableDeque[T]']:
+        '''
         Return the item or slice at the given index.
 
         >>> d = SlicableDeque[int]([1, 2, 3, 4, 5])
@@ -318,23 +333,12 @@ def __getitem__(self, index: Union[int, slice]) -> Union[T, 'SlicableDeque[T]']:
         >>> d[-2:]
         SlicableDeque(['b', 'c'])
 
-        """
+        '''
         if isinstance(index, slice):
             start, stop, step = index.indices(len(self))
             return self.__class__(self[i] for i in range(start, stop, step))
         else:
-            return super().__getitem__(index)
-
-    def pop(self) -> T:
-        """
-        Remove and return the rightmost element.
-
-        >>> d = SlicableDeque[float]([1.5, 2.5, 3.5])
-        >>> d.pop()
-        3.5
-
-        """
-        return super().pop()
+            return types.cast(T, super().__getitem__(index))
 
 
 if __name__ == '__main__':

python_utils/converters.py

@@ -366,8 +366,8 @@ def remap(
     new_max = types.cast(_TN, type_(new_max))
     new_min = types.cast(_TN, type_(new_min))
 
-    # These might not be floats but the Python type system doesn't understand the
-    # generic type system in this case
+    # These might not be floats but the Python type system doesn't understand
+    # the generic type system in this case
     old_range = types.cast(float, old_max) - types.cast(float, old_min)
     new_range = types.cast(float, new_max) - types.cast(float, new_min)
 

python_utils/decorators.py

@@ -107,7 +107,8 @@ def __listify(*args: types.Any, **kwargs: types.Any) -> TC:
                     return collection(iter(()))
                 else:
                     raise TypeError(
-                        f'{function} returned `None` and `allow_empty` is `False`'
+                        f'{function} returned `None` and `allow_empty` '
+                        'is `False`'
                     )
             else:
                 return collection(result)

python_utils/types.py

@@ -1,7 +1,7 @@
 # pyright: reportWildcardImportFromLibrary=false
 import datetime
 import decimal
-from typing_extensions import *  # type: ignore  # pragma: no cover  # noqa: F403
+from typing_extensions import *  # type: ignore  # noqa: F403
 from typing import *  # type: ignore  # pragma: no cover  # noqa: F403
 from types import *  # type: ignore  # pragma: no cover  # noqa: F403
 

tox.ini

@@ -1,15 +1,13 @@
 [tox]
-envlist = black, py37, py38, py39, py310, py311, pypy3, flake8, docs, mypy, pyright
+envlist = black, py38, py39, py310, py311, flake8, docs, mypy, pyright
 skip_missing_interpreters = True
 
 [testenv]
 basepython =
-    py37: python3.7
     py38: python3.8
     py39: python3.9
     py310: python3.10
     py311: python3.11
-    pypy: pypy
 
 setenv = PY_IGNORE_IMPORTMISMATCH=1
 deps =