danielutils 0.9.90__tar.gz → 0.9.91__tar.gz

{danielutils-0.9.90/danielutils.egg-info → danielutils-0.9.91}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: danielutils
-Version: 0.9.90
+Version: 0.9.91
 Summary: A python utils library for things I find useful
 Author-email: danielnachumdev <danielnachumdev@gmail.com>
 License: MIT License

{danielutils-0.9.90 → danielutils-0.9.91}/danielutils/__init__.py

@@ -40,4 +40,5 @@ from .generators import *
 from .university import *
 from .mock_ import *
 from .context_managers import *
-from .file_specifications import *
+from .file_specifications import *
+from .testing import *

{danielutils-0.9.90 → danielutils-0.9.91}/danielutils/aliases.py

@@ -150,16 +150,15 @@ T = TypeVar("T")
 
 Supplier = Callable[[], T]
 Runnable = Supplier[None]
-
+Consumer = Callable[[T], None]
 UnaryFunction = Callable[[U], T]
-UnaryOperator = UnaryFunction[T, T]
-Predicate = UnaryFunction[T, bool]
-Consumer = UnaryFunction[T, None]
+UnaryOperator = Callable[[T], T]
+Predicate = Callable[[T], bool]
 
 BinaryFunction = Callable[[A, B], T]
-BinaryOperator = BinaryFunction[T, T, T]
-Comparator = BinaryFunction[A, B, int]
-BinaryConsumer = BinaryFunction[T, T, None]
+BinaryOperator = Callable[[T, T], T]
+Comparator = Callable[[A, B], int]
+BinaryConsumer = Callable[[T, T], None]
 
 __all__ = [
     "UnaryFunction",

{danielutils-0.9.90 → danielutils-0.9.91}/danielutils/progress_bar/ascii_progress_bar.py

@@ -26,12 +26,11 @@ class AsciiProgressBar(ProgressBar):
             total_ = len(iterator)
         if total is not None:
             total_ = total
-        ProgressBar.__init__(self, total_, position)
+        ProgressBar.__init__(self, total_, position, desc=desc)
         self.iterator: Iterator = iterator
         self.pool: ProgressBarPool = pool
         self.num_bars: int = num_bars
         self.leave: bool = leave
-        self.desc: str = desc
         self.initial_value: float = 0
         self.current_value: float = 0
         self.ncols: int = ncols
@@ -95,7 +94,7 @@ class AsciiProgressBar(ProgressBar):
             bprint(to_print)
         self.prev_print = to_print
 
-    def update(self, amount: float = 1, refresh: bool = False):
+    def update(self, amount: float = 1, refresh: bool = False):  # type:ignore
         self.prev_value = self.current_value
         self.current_value = min(
             self.current_value + amount, self.total)  # type:ignore

{danielutils-0.9.90 → danielutils-0.9.91}/danielutils/progress_bar/progress_bar.py

@@ -20,7 +20,9 @@ class ProgressBar(ABC):
     DEFAULT_BAR_FORMAT = "{desc}: {percentage:3.0f}%|{bar}| {n_fmt}/{total_fmt} [{elapsed}<{remaining}"
 
     @abstractmethod
-    def __init__(self, total, position: int, unit="it", bar_format: str = DEFAULT_BAR_FORMAT, **kwargs) -> None:
+    def __init__(self, total, position: int, unit="it", bar_format: str = DEFAULT_BAR_FORMAT, *, desc: str,
+                 **kwargs) -> None:
+        self.desc: str = desc
         self.total = total
         self.position = position
         self.unit = unit
@@ -51,6 +53,9 @@ class ProgressBar(ABC):
         """A function to reset the progress-bar's progress
        """
 
+    @abstractmethod
+    def __iter__(self): ...
+
 
 try:
     from tqdm import tqdm

danielutils-0.9.91/danielutils/retry_executor/__init__.py

@@ -0,0 +1,3 @@
+from .backoff_strategies import *
+from .backoff_strategy import *
+from .retry_executor import *

danielutils-0.9.91/danielutils/retry_executor/backoff_strategies/__init__.py

@@ -0,0 +1,3 @@
+from .no_backoff import *
+from .constant_backoff import *
+from .exponential_backoff import *

danielutils-0.9.91/danielutils/retry_executor/backoff_strategies/constant_backoff.py

@@ -0,0 +1,19 @@
+from ..backoff_strategy import BackOffStrategy
+
+
+class ConstantBackOffStrategy(BackOffStrategy):
+    """
+    will always back off exactly the same amount of time
+
+    :param delay: The amount of milliseconds to sleep
+    """
+
+    def __init__(self, delay: int) -> None:
+        if not delay >= 0:
+            raise ValueError("delay must be positive")
+        super().__init__(lambda: delay)
+
+
+__all__ = [
+    "ConstantBackOffStrategy"
+]

danielutils-0.9.91/danielutils/retry_executor/backoff_strategies/exponential_backoff.py

@@ -0,0 +1,21 @@
+from ..backoff_strategy import BackOffStrategy
+
+
+class ExponentialBackOffStrategy(BackOffStrategy):
+    def __init__(self, initial: int, multiplier: float) -> None:
+        if not initial >= 0:
+            raise ValueError("initial must be positive")
+        if not multiplier >= 0:
+            raise ValueError("multiplier must be positive")
+        prev: float = 1.0
+
+        def inner() -> int:
+            nonlocal prev
+            return initial ** (prev := prev * multiplier)
+
+        super().__init__(inner)
+
+
+__all__ = [
+    "ExponentialBackOffStrategy"
+]

danielutils-0.9.91/danielutils/retry_executor/backoff_strategies/no_backoff.py

@@ -0,0 +1,12 @@
+from ..backoff_strategy import BackOffStrategy
+
+
+class NoBackOffStrategy(BackOffStrategy):
+
+    def __init__(self) -> None:
+        super().__init__(lambda: 0)
+
+
+__all__ = [
+    'NoBackOffStrategy',
+]

danielutils-0.9.91/danielutils/retry_executor/backoff_strategy.py

@@ -0,0 +1,22 @@
+from danielutils import Supplier
+
+
+class BackOffStrategy:
+    """
+    A class to create a common abstraction for backoff strategies
+    """
+
+    def __init__(self, supp: Supplier[int]) -> None:
+        self._supp = supp
+
+    def get_backoff(self) -> int:
+        """
+
+        :return: amount of milliseconds to sleep
+        """
+        return self._supp()
+
+
+__all__ = [
+    "BackOffStrategy"
+]

danielutils-0.9.91/danielutils/retry_executor/retry_executor.py

@@ -0,0 +1,37 @@
+import time
+from typing import Generic, TypeVar, Optional
+
+from danielutils import Supplier, Consumer
+from .backoff_strategies import ConstantBackOffStrategy
+
+from .backoff_strategy import BackOffStrategy
+
+T = TypeVar("T")
+
+
+class RetryExecutor(Generic[T]):
+    def __init__(self, backoff_strategy: BackOffStrategy = ConstantBackOffStrategy(200)) -> None:
+        self._backoff_strategy = backoff_strategy
+
+    def execute(self, supp: Supplier[T], max_retries: int = 5,
+                exception_callback: Optional[Consumer[Exception]] = None) -> Optional[T]:
+
+        for i in range(max_retries):
+
+            try:
+                return supp()
+            except Exception as e:
+                if exception_callback:
+                    exception_callback(e)
+
+            if i != max_retries - 1:
+                self._sleep()
+        return None
+
+    def _sleep(self) -> None:
+        time.sleep(self._backoff_strategy.get_backoff())
+
+
+__all__ = [
+    "RetryExecutor",
+]

danielutils-0.9.91/danielutils/testing/__init__.py

@@ -0,0 +1 @@
+from .unittest_ import *

danielutils-0.9.91/danielutils/testing/unittest_/__init__.py

@@ -0,0 +1,2 @@
+from .always_teardown_testcase import *
+from .auto_cwd_testcase import *

danielutils-0.9.91/danielutils/testing/unittest_/always_teardown_testcase.py

@@ -0,0 +1,37 @@
+import functools
+import unittest
+from typing import Optional, Callable
+from unittest import TestResult
+
+
+class AlwaysTeardownTestCase(unittest.TestCase):
+    """
+    SafeTestCase makes sure that tearDown / cleanup methods are always run when
+    They should be.
+    """
+
+    def run(self, result=None) -> Optional[TestResult]:
+        test_method = getattr(self, self._testMethodName)
+        wrapped_test = self._cleanup_wrapper(test_method, KeyboardInterrupt)
+        setattr(self, self._testMethodName, wrapped_test)
+
+        self.setUp = self._cleanup_wrapper(self.setUp, BaseException)
+
+        return super().run(result)
+
+    def _cleanup_wrapper(self, method: Callable, exception) -> Callable:
+        @functools.wraps(method)
+        def wrapper(*args, **kwargs):
+            try:
+                return method(*args, **kwargs)
+            except exception:
+                self.tearDown()
+                self.doCleanups()
+                raise
+
+        return wrapper
+
+
+__all__ = [
+    "AlwaysTeardownTestCase"
+]

danielutils-0.9.91/danielutils/testing/unittest_/auto_cwd_testcase.py

@@ -0,0 +1,49 @@
+import functools
+import os
+import unittest
+from typing import Optional, Callable
+
+from danielutils import create_directory, get_current_working_directory, set_current_working_directory, delete_directory
+
+
+def improved_setup(func: Callable) -> Callable:
+    @functools.wraps(func)
+    def wrapper(self):
+        self.test_folder = f"./{self.__class__.__name__}_test_folder"
+        create_directory(self.test_folder)
+        self.prev_cwd = get_current_working_directory()
+        set_current_working_directory(os.path.join(self.prev_cwd, self.test_folder))
+        if func is not None:
+            func(self)
+
+    return wrapper
+
+
+def improved_teardown(func: Callable) -> Callable:
+    @functools.wraps(func)
+    def wrapper(self):
+        if func is not None:
+            func(self)
+        set_current_working_directory(self.prev_cwd)
+        delete_directory(self.test_folder)
+
+    return wrapper
+
+
+class AutoCWDTestCase(unittest.TestCase):
+    @staticmethod
+    def _dummy():
+        pass
+
+    @classmethod
+    def __init_subclass__(cls, **kwargs):
+        dct = dict(cls.__dict__)
+        impl_setUp = dct.get("setUp", cls._dummy)
+        impl_tearDown = dct.get("tearDown", cls._dummy)
+        setattr(cls, "setUp", improved_setup(impl_setUp))
+        setattr(cls, "tearDown", improved_teardown(impl_tearDown))
+
+
+__all__ = [
+    'AutoCWDTestCase'
+]

{danielutils-0.9.90 → danielutils-0.9.91/danielutils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: danielutils
-Version: 0.9.90
+Version: 0.9.91
 Summary: A python utils library for things I find useful
 Author-email: danielnachumdev <danielnachumdev@gmail.com>
 License: MIT License

{danielutils-0.9.90 → danielutils-0.9.91}/danielutils.egg-info/SOURCES.txt

@@ -153,6 +153,13 @@ danielutils/reflection/interpreter/tracer.py
 danielutils/reflection/module/__init__.py
 danielutils/reflection/module/module_reflections.py
 danielutils/reflection/module/package_reflection.py
+danielutils/retry_executor/__init__.py
+danielutils/retry_executor/backoff_strategy.py
+danielutils/retry_executor/retry_executor.py
+danielutils/retry_executor/backoff_strategies/__init__.py
+danielutils/retry_executor/backoff_strategies/constant_backoff.py
+danielutils/retry_executor/backoff_strategies/exponential_backoff.py
+danielutils/retry_executor/backoff_strategies/no_backoff.py
 danielutils/snippets/__init__.py
 danielutils/snippets/try_get.py
 danielutils/system/__init__.py
@@ -163,6 +170,10 @@ danielutils/system/windows/win32_ctime.py
 danielutils/system/windows/windows.py
 danielutils/system/windows/utils/__init__.py
 danielutils/system/windows/utils/filetime.py
+danielutils/testing/__init__.py
+danielutils/testing/unittest_/__init__.py
+danielutils/testing/unittest_/always_teardown_testcase.py
+danielutils/testing/unittest_/auto_cwd_testcase.py
 danielutils/university/__init__.py
 danielutils/university/computability_and_complexity/__init__.py
 danielutils/university/computability_and_complexity/discreate_finite_automaton.py

{danielutils-0.9.90 → danielutils-0.9.91}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "danielutils"
-version = "0.9.90"
+version = "0.9.91"
 authors = [
     { name = "danielnachumdev", email = "danielnachumdev@gmail.com" },
 ]