Apply precommit reformatting.

Author: ionelmc

.pre-commit-config.yaml

@@ -5,20 +5,20 @@
 exclude: '^(\.tox|ci/templates|\.bumpversion\.cfg)(/|$)'
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: master
+    rev: v4.1.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: debug-statements
   - repo: https://github.com/timothycrosley/isort
-    rev: master
+    rev: 5.10.1
     hooks:
       - id: isort
   - repo: https://gitlab.com/pycqa/flake8
-    rev: master
+    rev: 3.9.2
     hooks:
       - id: flake8
   - repo: https://github.com/psf/black
-    rev: main
+    rev: 22.1.0
     hooks:
       - id: black

MANIFEST.in

@@ -2,6 +2,7 @@ graft docs
 graft src
 graft ci
 graft tests
+graft examples
 
 include .bumpversion.cfg
 include .cookiecutterrc

examples/bench.py

@@ -62,15 +62,7 @@ def run():
 logging.critical("============== ============= =========== ========= ========== ========== ========== ==========")
 
 
-for concurrency in (
-    1,
-    2,
-    3,
-    6,
-    12,
-    24,
-    48
-):
+for concurrency in (1, 2, 3, 6, 12, 24, 48):
     for duration in (
         0,
         0.01,
@@ -88,11 +80,20 @@ def run():
             if concurrency > 1:
                 logging.critical(
                     "%14s %12.3fs %11s %20s %10.2f %10s %10s",
-                    type_, duration, concurrency, sum(ret), sum(ret) / len(ret), min(ret), max(ret)
+                    type_,
+                    duration,
+                    concurrency,
+                    sum(ret),
+                    sum(ret) / len(ret),
+                    min(ret),
+                    max(ret),
                 )
             else:
                 logging.critical(
                     "%14s %12.3fs %11s %20s",
-                    type_, duration, concurrency, sum(ret),
+                    type_,
+                    duration,
+                    concurrency,
+                    sum(ret),
                 )
 logging.critical("============== ============= =========== ========= ========== ========== ========== ==========")

examples/bench.rst

@@ -74,4 +74,3 @@ Key takeaways:
 
   * Some clients never get to acquire the lock.
     Note the ``Min`` column being ``0`` and the ``Max`` column being very high (indicating how many acquires a single client got).
-

examples/plain.py

@@ -22,6 +22,7 @@
     else:
         getch = msvcrt.getch
 else:
+
     def getch():
         """getch() -> key character
 
@@ -42,6 +43,7 @@ def getch():
             termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
         return ch
 
+
 logging.basicConfig(level="DEBUG", format="%(asctime)s | %(process)6s | %(message)s")
 
 c = redis.StrictRedis()

examples/test-tmux.py

@@ -25,16 +25,10 @@
 if right_commands:
     session += 'tmux selectp -t0;tmux splitw -hd -p50 \"%s\"; ' % right_commands[-1]
 for index, command in enumerate(right_commands[:-1]):
-    session += 'tmux selectp -t1;tmux splitw -d -p%i \"%s\"; ' % (
-        100 / (len(right_commands) - index),
-        command
-    )
+    session += 'tmux selectp -t1;tmux splitw -d -p%i \"%s\"; ' % (100 / (len(right_commands) - index), command)
 
 for index, command in enumerate(left_commands[1:]):
-    session += 'tmux selectp -t0;tmux splitw -d -p%i \"%s\"; ' % (
-        100 / (len(left_commands) - index),
-        command
-    )
+    session += 'tmux selectp -t0;tmux splitw -d -p%i \"%s\"; ' % (100 / (len(left_commands) - index), command)
 if left_commands:
     session += left_commands[0]
 

setup.py

@@ -75,5 +75,5 @@ def read(*names, **kwargs):
         'django': [
             'django-redis>=3.8.0',
         ]
-    }
+    },
 )

src/redis_lock/__init__.py

@@ -94,6 +94,7 @@ class Lock(object):
     """
     A Lock context manager implemented via redis SETNX/BLPOP.
     """
+
     unlock_script = None
     extend_script = None
     reset_script = None
@@ -132,8 +133,7 @@ def __init__(self, redis_client, name, expire=None, id=None, auto_renewal=False,
             Advanced option to override signal list expiration in milliseconds. Increase it for very slow clients. Default: ``1000``.
         """
         if strict and not isinstance(redis_client, StrictRedis):
-            raise ValueError("redis_client must be instance of StrictRedis. "
-                             "Use strict=False if you know what you're doing.")
+            raise ValueError("redis_client must be instance of StrictRedis. Use strict=False if you know what you're doing.")
         if auto_renewal and expire is None:
             raise ValueError("Expire may not be None when auto_renewal is set")
 
@@ -161,9 +161,7 @@ def __init__(self, redis_client, name, expire=None, id=None, auto_renewal=False,
             raise TypeError(f"Incorrect type for `id`. Must be bytes/str not {type(id)}.")
         self._name = 'lock:' + name
         self._signal = 'lock-signal:' + name
-        self._lock_renewal_interval = (float(expire) * 2 / 3
-                                       if auto_renewal
-                                       else None)
+        self._lock_renewal_interval = float(expire) * 2 / 3 if auto_renewal else None
         self._lock_renewal_thread = None
 
         self.register_scripts(redis_client)
@@ -255,10 +253,7 @@ def extend(self, expire=None):
         elif self._expire is not None:
             expire = self._expire
         else:
-            raise TypeError(
-                "To extend a lock 'expire' must be provided as an "
-                "argument to extend() method or at initialization time."
-            )
+            raise TypeError("To extend a lock 'expire' must be provided as an argument to extend() method or at initialization time.")
 
         error = self.extend_script(client=self._client, keys=(self._name, self._signal), args=(self._id, expire))
         if error == 1:
@@ -292,18 +287,18 @@ def _start_lock_renewer(self):
             raise AlreadyStarted("Lock refresh thread already started")
 
         logger_for_refresh_start.debug(
-            "Starting renewal thread for Lock(%r). Refresh interval: %s seconds.",
-            self._name,
-            self._lock_renewal_interval
+            "Starting renewal thread for Lock(%r). Refresh interval: %s seconds.", self._name, self._lock_renewal_interval
         )
         self._lock_renewal_stop = threading.Event()
         self._lock_renewal_thread = threading.Thread(
             group=None,
             target=self._lock_renewer,
-            kwargs={'name': self._name,
-                    'lockref': weakref.ref(self),
-                    'interval': self._lock_renewal_interval,
-                    'stop': self._lock_renewal_stop}
+            kwargs={
+                'name': self._name,
+                'lockref': weakref.ref(self),
+                'interval': self._lock_renewal_interval,
+                'stop': self._lock_renewal_stop,
+            },
         )
         self._lock_renewal_thread.demon = True
         self._lock_renewal_thread.start()

src/redis_lock/django_cache.py

@@ -6,23 +6,19 @@
 
 
 class RedisCache(PlainRedisCache):
-
     @property
     def __client(self):
         try:
             return self.client.get_client()
         except Exception as exc:
             raise NotImplementedError(
-                "RedisCache doesn't have a raw client: %r. "
-                "Use 'redis_cache.client.DefaultClient' as the CLIENT_CLASS !" % exc
+                f"RedisCache doesn't have a raw client: {exc}. Use 'redis_cache.client.DefaultClient' as the CLIENT_CLASS !"
             )
 
     def lock(self, key, expire=None, id=None, auto_renewal=False):
         return Lock(self.__client, key, expire=expire, id=id, auto_renewal=auto_renewal)
 
-    def locked_get_or_set(self, key, value_creator, version=None,
-                          expire=None, id=None, lock_key=None,
-                          timeout=DEFAULT_TIMEOUT):
+    def locked_get_or_set(self, key, value_creator, version=None, expire=None, id=None, lock_key=None, timeout=DEFAULT_TIMEOUT):
         """
         Fetch a given key from the cache. If the key does not exist, the key is added and
         set to the value returned when calling `value_creator`. The creator function

tests/conftest.py

@@ -15,12 +15,7 @@ def redis_server(tmp_path):
     except OSError:
         pass
     with TestProcess(
-        'redis-server',
-        '--port', '0',
-        '--save', '',
-        '--appendonly', 'yes',
-        '--dir', tmp_path,
-        '--unixsocket', UDS_PATH
+        'redis-server', '--port', '0', '--save', '', '--appendonly', 'yes', '--dir', tmp_path, '--unixsocket', UDS_PATH
     ) as redis_server:
         wait_for_strings(redis_server.read, TIMEOUT, 'ready to accept connections')
         yield redis_server