Merge pull request #14 from ourstudio-se/13-add-compositions

Adding compositions

Author: znittzel

maz/compositions/__init__.py

@@ -0,0 +1,56 @@
+from dataclasses import dataclass
+from typing import Callable, Any
+from time import sleep
+from functools import partial
+from maz import compose
+
+class retry_until:
+
+    """
+        Calls input function until condition is met
+        or number of retries equals `retries`.
+    """
+
+    def __init__(self, function, retries: int, condition: Callable[[Any], bool]):
+        if retries < 1:
+            raise ValueError(f"`retries` must be greater or equal to 1, got {retries}")
+
+        self.function = function
+        self.retries = retries
+        self.condition = condition
+
+    def __call__(self, *args, **kwargs):
+
+        for i in range(self.retries):
+            result = self.function(*args, **kwargs)
+            if self.condition(result):
+                return result
+
+        return result
+
+class waiting:
+    
+    """
+        Returns a new function that when executed will wait `in_seconds` seconds 
+        before executing the original function.
+    """
+
+    def __init__(self, function, in_seconds: float):
+        self.function = function
+        self.in_seconds = in_seconds
+
+    def __call__(self, *args, **kwargs):
+        sleep(self.in_seconds)
+        return self.function(*args, **kwargs)
+
+class named:
+
+    """
+        Returns an object with properties name and function.
+    """
+
+    name: str
+    function: Callable[[Any], Any]
+
+    def __call__(self, *args: Any, **kwds: Any) -> Any:
+        return self.function(args, kwds)

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = maz
-version = 0.0.7
+version = 0.0.8
 author = ourstudio
 author_email = rikard@ourstudio.se
 description = Functional programming tools.
@@ -9,4 +9,4 @@ long_description_content_type = text/markdown
 
 [options]
 packages = find:
-where = maz
+where = maz*

tests/test_maz_compositions.py

@@ -0,0 +1,39 @@
+import time
+from functools import partial
+from maz.compositions import retry_until, waiting
+
+def test_retryer():
+
+    retryer = retry_until(
+        function=partial(
+            next, 
+            iter([0,0,1,2,3])
+        ),
+        retries=3,
+        condition=lambda j: j == 1,
+    )
+
+    assert retryer() == 1
+
+    retryer = retry_until(
+        function=partial(
+            next, 
+            iter([0,0,1,2,3])
+        ),
+        retries=2,
+        condition=lambda j: j == 1,
+    )
+
+    assert retryer() == 0
+
+def test_timeout():
+
+    waiting_fn = waiting(
+        lambda x: x+1,
+        1.1,
+    )
+
+    start_time = time.time()
+    assert waiting_fn(3) == 4
+    total_time = time.time()-start_time
+    assert total_time > 1