Rename redlock() decorator to synchronize()

pottery/__init__.py

@@ -40,7 +40,7 @@
 from .hyper import HyperLogLog  # isort:skip
 from .nextid import NextId  # isort:skip
 from .redlock import Redlock  # isort:skip
-from .redlock import redlock  # isort:skip
+from .redlock import synchronize  # isort:skip
 from .timer import ContextTimer  # isort:skip
 
 from .counter import RedisCounter
@@ -66,7 +66,7 @@
     'HyperLogLog',
     'NextId',
     'Redlock',
-    'redlock',
+    'synchronize',
     'ContextTimer',
 
     'RedisCounter',

pottery/redlock.py

@@ -551,26 +551,26 @@ def __repr__(self) -> str:
         )
 
 
-def redlock(*,
-            key: str,
-            masters: Iterable[Redis] = frozenset(),
-            auto_release_time: int = AUTO_RELEASE_TIME,
-            ) -> Callable[[F], F]:
+def synchronize(*,
+                key: str,
+                masters: Iterable[Redis] = frozenset(),
+                auto_release_time: int = AUTO_RELEASE_TIME,
+                ) -> Callable[[F], F]:
     def decorator(func: F) -> F:
         @functools.wraps(func)
         def wrapper(*args: Any, **kwargs: Any) -> Any:
-            redlock_ = Redlock(
+            redlock = Redlock(
                 key=key,
                 masters=masters,
                 auto_release_time=auto_release_time,
             )
-            with ContextTimer() as timer, redlock_:
+            with ContextTimer() as timer, redlock:
                 return_value = func(*args, **kwargs)
 
             _logger.info(
                 '%s() held %s for %d ms',
                 func.__qualname__,
-                redlock_.key,
+                redlock.key,
                 timer.elapsed(),
             )
             return return_value

tests/test_redlock.py

@@ -16,7 +16,7 @@
 from pottery import Redlock
 from pottery import ReleaseUnlockedLock
 from pottery import TooManyExtensions
-from pottery import redlock
+from pottery import synchronize
 from tests.base import TestCase  # type: ignore
 
 
@@ -180,22 +180,19 @@ def test_repr(self):
             "<Redlock key=redlock:printer value=b'' timeout=0>"
 
 
-class RedlockDecoratorTests(TestCase):
-    def setUp(self):
-        super().setUp()
-
-        def expensive_method(*args, **kwargs):
+class SynchronizeTests(TestCase):
+    def test_synchronize(self):
+        @synchronize(
+            key='expensive-func',
+            masters={self.redis},
+            auto_release_time=1500,
+        )
+        def expensive_func():
             time.sleep(1)
             return time.time()
 
-        self.expensive_method = redlock(
-            key='expensive-method',
-            masters={self.redis},
-        )(expensive_method)
-
-    def test_redlock_decorator(self):
         with concurrent.futures.ThreadPoolExecutor() as executor:
-            futures = [executor.submit(self.expensive_method) for _ in range(3)]
+            futures = [executor.submit(expensive_func) for _ in range(3)]
         results = sorted(future.result() for future in futures)
         for result1, result2 in zip(results, results[1:]):
             delta = result2 - result1