python-utils 3.7.0__tar.gz → 3.8.1__tar.gz

{python-utils-3.7.0/python_utils.egg-info → python-utils-3.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-utils
-Version: 3.7.0
+Version: 3.8.1
 Summary: Python Utils is a module with some convenient utilities not included with the standard Python install
 Home-page: https://github.com/WoLpH/python-utils
 Author: Rick van Hattem
@@ -8,10 +8,23 @@ Author-email: Wolph@wol.ph
 License: BSD
 Classifier: License :: OSI Approved :: BSD License
 Requires-Python: >3.8.0
+License-File: LICENSE
+Requires-Dist: typing_extensions>3.10.0.2
 Provides-Extra: loguru
+Requires-Dist: loguru; extra == "loguru"
 Provides-Extra: docs
+Requires-Dist: mock; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: python-utils; extra == "docs"
 Provides-Extra: tests
-License-File: LICENSE
+Requires-Dist: flake8; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-mypy; extra == "tests"
+Requires-Dist: pytest-asyncio; extra == "tests"
+Requires-Dist: sphinx; extra == "tests"
+Requires-Dist: types-setuptools; extra == "tests"
+Requires-Dist: loguru; extra == "tests"
 
 Useful Python Utils
 ==============================================================================

{python-utils-3.7.0 → python-utils-3.8.1}/_python_utils_tests/test_aio.py

@@ -30,7 +30,13 @@ async def test_acontainer():
         yield 2
         yield 3
 
+    async def empty_gen():
+        if False:
+            yield 1
+
     assert await acontainer(async_gen) == [1, 2, 3]
     assert await acontainer(async_gen()) == [1, 2, 3]
     assert await acontainer(async_gen, set) == {1, 2, 3}
     assert await acontainer(async_gen(), set) == {1, 2, 3}
+    assert await acontainer(empty_gen) == []
+    assert await acontainer(empty_gen()) == []

python-utils-3.8.1/_python_utils_tests/test_containers.py

@@ -0,0 +1,73 @@
+import pytest
+
+from python_utils import containers
+
+
+def test_unique_list_ignore() -> None:
+    a: containers.UniqueList[int] = containers.UniqueList()
+    a.append(1)
+    a.append(1)
+    assert a == [1]
+
+    a = containers.UniqueList(*range(20))
+    with pytest.raises(RuntimeError):
+        a[10:20:2] = [1, 2, 3, 4, 5]
+
+    a[3] = 5
+
+
+def test_unique_list_raise() -> None:
+    a: containers.UniqueList[int] = containers.UniqueList(
+        *range(20), on_duplicate='raise'
+    )
+    with pytest.raises(ValueError):
+        a[10:20:2] = [1, 2, 3, 4, 5]
+
+    a[10:20:2] = [21, 22, 23, 24, 25]
+    with pytest.raises(ValueError):
+        a[3] = 5
+
+    del a[10]
+    del a[5:15]
+
+
+def test_sliceable_deque() -> None:
+    d: containers.SliceableDeque[int] = containers.SliceableDeque(range(10))
+    assert d[0] == 0
+    assert d[-1] == 9
+    assert d[1:3] == [1, 2]
+    assert d[1:3:2] == [1]
+    assert d[1:3:-1] == []
+    assert d[3:1] == []
+    assert d[3:1:-1] == [3, 2]
+    assert d[3:1:-2] == [3]
+    with pytest.raises(ValueError):
+        assert d[1:3:0]
+    assert d[1:3:1] == [1, 2]
+    assert d[1:3:2] == [1]
+    assert d[1:3:-1] == []
+
+
+def test_sliceable_deque_pop() -> None:
+    d: containers.SliceableDeque[int] = containers.SliceableDeque(range(10))
+
+    assert d.pop() == 9 == 9
+    assert d.pop(0) == 0
+
+    with pytest.raises(IndexError):
+        assert d.pop(100)
+
+    with pytest.raises(IndexError):
+        assert d.pop(2)
+
+    with pytest.raises(IndexError):
+        assert d.pop(-2)
+
+
+def test_sliceable_deque_eq() -> None:
+    d: containers.SliceableDeque[int] = containers.SliceableDeque([1, 2, 3])
+    assert d == [1, 2, 3]
+    assert d == (1, 2, 3)
+    assert d == {1, 2, 3}
+    assert d == d
+    assert d == containers.SliceableDeque([1, 2, 3])

{python-utils-3.7.0 → python-utils-3.8.1}/_python_utils_tests/test_decorators.py

@@ -60,7 +60,7 @@ def test_wraps_classmethod():  # type: ignore
     some_class.some_classmethod.assert_called_with(123)  # type: ignore
 
 
-def test_wraps_classmethod():  # type: ignore
+def test_wraps_annotated_classmethod():  # type: ignore
     some_class = SomeClass()
     some_class.some_annotated_classmethod = MagicMock()
     wrapped_method = wraps_classmethod(SomeClass.some_annotated_classmethod)(

{python-utils-3.7.0 → python-utils-3.8.1}/_python_utils_tests/test_generators.py

@@ -16,7 +16,7 @@ async def test_abatcher():
 
 
 @pytest.mark.asyncio
-async def test_abatcher_timed():
+async def test_abatcher_timed() -> None:
     batches: types.List[types.List[int]] = []
     async for batch in python_utils.abatcher(
         python_utils.acount(stop=10, delay=0.08), interval=0.1

{python-utils-3.7.0 → python-utils-3.8.1}/python_utils/__about__.py

@@ -7,4 +7,4 @@ __description__: str = (
 )
 __url__: str = 'https://github.com/WoLpH/python-utils'
 # Omit type info due to automatic versioning script
-__version__ = '3.7.0'
+__version__ = '3.8.1'

{python-utils-3.7.0 → python-utils-3.8.1}/python_utils/aio.py

@@ -48,7 +48,7 @@ async def acontainer(
 
     item: _T
     items: types.List[_T] = []
-    async for item in iterable_:
+    async for item in iterable_:  # pragma: no branch
         items.append(item)
 
     return container(items)

{python-utils-3.7.0 → python-utils-3.8.1}/python_utils/containers.py

@@ -1,7 +1,7 @@
 # pyright: reportIncompatibleMethodOverride=false
 import abc
-import typing
 import collections
+import typing
 
 from . import types
 
@@ -238,7 +238,7 @@ class UniqueList(types.List[HT]):
     def insert(self, index: types.SupportsIndex, value: HT) -> None:
         if value in self._set:
             if self.on_duplicate == 'raise':
-                raise ValueError('Duplicate value: %s' % value)
+                raise ValueError(f'Duplicate value: {value}')
             else:
                 return
 
@@ -248,7 +248,7 @@ class UniqueList(types.List[HT]):
     def append(self, value: HT) -> None:
         if value in self._set:
             if self.on_duplicate == 'raise':
-                raise ValueError('Duplicate value: %s' % value)
+                raise ValueError(f'Duplicate value: {value}')
             else:
                 return
 
@@ -258,11 +258,11 @@ class UniqueList(types.List[HT]):
     def __contains__(self, item: HT) -> bool:  # type: ignore
         return item in self._set
 
-    @types.overload
+    @typing.overload
     def __setitem__(self, indices: types.SupportsIndex, values: HT) -> None:
         ...
 
-    @types.overload
+    @typing.overload
     def __setitem__(self, indices: slice, values: types.Iterable[HT]) -> None:
         ...
 
@@ -310,28 +310,30 @@ class UniqueList(types.List[HT]):
         super().__delitem__(index)
 
 
-class SlicableDeque(types.Generic[T], collections.deque):  # type: ignore
-    @types.overload
+# Type hinting `collections.deque` does not work consistently between Python
+# runtime, mypy and pyright currently so we have to ignore the errors
+class SliceableDeque(types.Generic[T], collections.deque):  # type: ignore
+    @typing.overload
     def __getitem__(self, index: types.SupportsIndex) -> T:
         ...
 
-    @types.overload
-    def __getitem__(self, index: slice) -> 'SlicableDeque[T]':
+    @typing.overload
+    def __getitem__(self, index: slice) -> 'SliceableDeque[T]':
         ...
 
     def __getitem__(
         self, index: types.Union[types.SupportsIndex, slice]
-    ) -> types.Union[T, 'SlicableDeque[T]']:
+    ) -> types.Union[T, 'SliceableDeque[T]']:
         '''
         Return the item or slice at the given index.
 
-        >>> d = SlicableDeque[int]([1, 2, 3, 4, 5])
+        >>> d = SliceableDeque[int]([1, 2, 3, 4, 5])
         >>> d[1:4]
-        SlicableDeque([2, 3, 4])
+        SliceableDeque([2, 3, 4])
 
-        >>> d = SlicableDeque[str](['a', 'b', 'c'])
+        >>> d = SliceableDeque[str](['a', 'b', 'c'])
         >>> d[-2:]
-        SlicableDeque(['b', 'c'])
+        SliceableDeque(['b', 'c'])
 
         '''
         if isinstance(index, slice):
@@ -340,6 +342,30 @@ class SlicableDeque(types.Generic[T], collections.deque):  # type: ignore
         else:
             return types.cast(T, super().__getitem__(index))
 
+    def __eq__(self, other: types.Any) -> bool:
+        # Allow for comparison with a list or tuple
+        if isinstance(other, list):
+            return list(self) == other
+        elif isinstance(other, tuple):
+            return tuple(self) == other
+        elif isinstance(other, set):
+            return set(self) == other
+        else:
+            return super().__eq__(other)
+
+    def pop(self, index: int = -1) -> T:
+        # We need to allow for an index but a deque only allows the removal of
+        # the first or last item.
+        if index == 0:
+            return typing.cast(T, super().popleft())
+        elif index in {-1, len(self) - 1}:
+            return typing.cast(T, super().pop())
+        else:
+            raise IndexError(
+                'Only index 0 and the last index (`N-1` or `-1`) '
+                'are supported'
+            )
+
 
 if __name__ == '__main__':
     import doctest

{python-utils-3.7.0 → python-utils-3.8.1}/python_utils/decorators.py

@@ -1,3 +1,4 @@
+import contextlib
 import functools
 import logging
 import random
@@ -175,7 +176,9 @@ def wraps_classmethod(
     def _wraps_classmethod(
         wrapper: types.Callable[types.Concatenate[types.Any, _P], _T],
     ) -> types.Callable[types.Concatenate[types.Type[_S], _P], _T]:
-        try:  # pragma: no cover
+        # For some reason `functools.update_wrapper` fails on some test
+        # runs but not while running actual code
+        with contextlib.suppress(AttributeError):
             wrapper = functools.update_wrapper(
                 wrapper,
                 wrapped,
@@ -185,11 +188,6 @@ def wraps_classmethod(
                     if a != '__annotations__'
                 ),
             )
-        except AttributeError:
-            # For some reason `functools.update_wrapper` fails on some test
-            # runs but not while running actual code
-            pass
-
         if annotations := getattr(wrapped, '__annotations__', {}):
             annotations.pop('self', None)
             wrapper.__annotations__ = annotations

{python-utils-3.7.0 → python-utils-3.8.1/python_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-utils
-Version: 3.7.0
+Version: 3.8.1
 Summary: Python Utils is a module with some convenient utilities not included with the standard Python install
 Home-page: https://github.com/WoLpH/python-utils
 Author: Rick van Hattem
@@ -8,10 +8,23 @@ Author-email: Wolph@wol.ph
 License: BSD
 Classifier: License :: OSI Approved :: BSD License
 Requires-Python: >3.8.0
+License-File: LICENSE
+Requires-Dist: typing_extensions>3.10.0.2
 Provides-Extra: loguru
+Requires-Dist: loguru; extra == "loguru"
 Provides-Extra: docs
+Requires-Dist: mock; extra == "docs"
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: python-utils; extra == "docs"
 Provides-Extra: tests
-License-File: LICENSE
+Requires-Dist: flake8; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-mypy; extra == "tests"
+Requires-Dist: pytest-asyncio; extra == "tests"
+Requires-Dist: sphinx; extra == "tests"
+Requires-Dist: types-setuptools; extra == "tests"
+Requires-Dist: loguru; extra == "tests"
 
 Useful Python Utils
 ==============================================================================

python-utils-3.7.0/_python_utils_tests/test_containers.py

@@ -1,31 +0,0 @@
-import pytest
-
-from python_utils import containers
-
-
-def test_unique_list_ignore() -> None:
-    a: containers.UniqueList[int] = containers.UniqueList()
-    a.append(1)
-    a.append(1)
-    assert a == [1]
-
-    a = containers.UniqueList(*range(20))
-    with pytest.raises(RuntimeError):
-        a[10:20:2] = [1, 2, 3, 4, 5]
-
-    a[3] = 5
-
-
-def test_unique_list_raise() -> None:
-    a: containers.UniqueList[int] = containers.UniqueList(
-        *range(20), on_duplicate='raise'
-    )
-    with pytest.raises(ValueError):
-        a[10:20:2] = [1, 2, 3, 4, 5]
-
-    a[10:20:2] = [21, 22, 23, 24, 25]
-    with pytest.raises(ValueError):
-        a[3] = 5
-
-    del a[10]
-    del a[5:15]