Sort out various lint/test issue. Do not depend directly on redis.

Author: ionelmc

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
     hooks:
       - id: ruff
         # Using --unsafe-fixes can change code behavior
-        args: [--fix, --exit-non-zero-on-fix, --show-fixes] # , --unsafe-fixes]
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes, --unsafe-fixes]
       - id: ruff-format
   - repo: https://github.com/tombi-toml/tombi-pre-commit
     rev: v0.9.16

examples/bench.py

@@ -76,7 +76,7 @@ def run():
                 t = round(time.time()) + 1
                 load = [(t, duration, type_) for _ in range(concurrency)]
                 logging.info('Running %s', load)
-                ret = [i for i in pool.map(test, load)]
+                ret = list(pool.map(test, load))
             if concurrency > 1:
                 logging.critical(
                     '%14s %12.3fs %11s %20s %10.2f %10s %10s',

examples/plain.py

@@ -15,10 +15,10 @@
     # Probably Windows.
     try:
         import msvcrt
-    except ImportError:
+    except ImportError as exc:
         # FIXME what to do on other platforms?
         # Just give up here.
-        raise ImportError('getch not available')
+        raise ImportError('getch not available') from exc
     else:
         getch = msvcrt.getch
 else:

examples/test-tmux.py

@@ -5,30 +5,30 @@
 subprocess.check_call('tox -e py38-dj3-nocov --notest'.split())
 
 left_commands = [
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
-    '.tox/py38-dj3-nocov/bin/python examples/plain.py %s' % sys.argv[1],
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
+    f'.tox/py38-dj3-nocov/bin/python examples/plain.py {sys.argv[1]}',
 ]
 right_commands = left_commands
 session = ''
 
 if right_commands:
-    session += 'tmux selectp -t0;tmux splitw -hd -p50 "%s"; ' % right_commands[-1]
+    session += f'tmux selectp -t0;tmux splitw -hd -p50 "{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)  # noqa: UP031
 
 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)  # noqa: UP031
 if left_commands:
     session += left_commands[0]
 

pyproject.toml

@@ -34,9 +34,6 @@ classifiers = [
     # "Programming Language :: Python :: Implementation :: Stackless",
     "Topic :: Utilities",
 ]
-dependencies = [
-    "redis>=2.10.0",
-]
 dynamic = [
     "readme",
 ]
@@ -52,6 +49,12 @@ dynamic = [
     django = [
         "django-redis>=3.8.0",
     ]
+    redis = [
+        "redis>=2.10.0",
+    ]
+    valkey = [
+        "valkey",
+    ]
 
 [build-system]
 requires = [

src/redis_lock/__init__.py

@@ -102,7 +102,7 @@ class Lock:
     _lock_renewal_interval: float
     _lock_renewal_thread: Union[threading.Thread, None]
 
-    def __init__(self, redis_client, name, expire=None, id=None, auto_renewal=False, strict=True, signal_expire=1000, blocking=True):
+    def __init__(self, redis_client, name, expire=None, id=None, auto_renewal=False, signal_expire=1000, blocking=True):
         """
         :param redis_client:
             An instance of :class:`~StrictRedis`.
@@ -126,8 +126,6 @@ def __init__(self, redis_client, name, expire=None, id=None, auto_renewal=False,
             an interval of ``expire*2/3``. If wishing to use a different renewal
             time, subclass Lock, call ``super().__init__()`` then set
             ``self._lock_renewal_interval`` to your desired interval.
-        :param strict:
-            If set ``True`` then the ``redis_client`` needs to be an instance of ``redis.StrictRedis``.
         :param signal_expire:
             Advanced option to override signal list expiration in milliseconds. Increase it for very slow clients. Default: ``1000``.
         :param blocking:

src/redis_lock/django_valkey_cache.py

@@ -0,0 +1,53 @@
+from django.core.cache.backends.base import DEFAULT_TIMEOUT
+from django_valkey.cache import ValkeyCache as PlainValkeyCache
+
+from redis_lock import Lock
+from redis_lock import reset_all
+
+
+class ValkeyCache(PlainValkeyCache):
+    @property
+    def __client(self):
+        try:
+            return self.client.get_client()
+        except Exception as exc:
+            raise NotImplementedError(
+                f"ValkeyCache doesn't have a raw client: {exc}. Use 'redis_cache.client.DefaultClient' as the CLIENT_CLASS !"
+            ) from exc
+
+    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):
+        """
+        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
+        is invoked inside of a lock.
+        """
+        if lock_key is None:
+            lock_key = 'get_or_set:' + key
+
+        val = self.get(key, version=version)
+        if val is not None:
+            return val
+
+        with self.lock(lock_key, expire=expire, id=id):
+            # Was the value set while we were trying to acquire the lock?
+            val = self.get(key, version=version)
+            if val is not None:
+                return val
+
+            # Nope, create value now.
+            val = value_creator()
+
+            if val is None:
+                raise ValueError('`value_creator` must return a value')
+
+            self.set(key, val, timeout=timeout, version=version)
+            return val
+
+    def reset_all(self):
+        """
+        Forcibly deletes all locks if its remains (like a crash reason). Use this with care.
+        """
+        reset_all(self.__client)

tests/helper.py

@@ -28,7 +28,7 @@
 
             eventlet.monkey_patch()
         else:
-            raise RuntimeError('Invalid effect spec %r.' % effect)
+            raise RuntimeError(f'Invalid effect spec {effect!r}.')
     logging.info('threading.get_ident.__module__=%s', threading.get_ident.__module__)
     if test_name == 'test_simple':
         conn = StrictRedis(unix_socket_path=redis_socket)
@@ -82,5 +82,5 @@ def cb_no_overlap():
         for pid in pids:
             os.waitpid(pid, 0)
     else:
-        raise RuntimeError('Invalid test spec %r.' % test_name)
+        raise RuntimeError(f'Invalid test spec {test_name!r}.')
     logging.info('DIED.')

tests/test_django_integration.py

@@ -2,6 +2,8 @@
 
 import pytest
 
+import redis_lock
+
 try:
     import django
 except ImportError:
@@ -14,6 +16,7 @@
 def redis_socket_static(tmpdir_factory):
     path = str(tmpdir_factory.getbasetemp() / 'redis.sock')
     os.environ['REDIS_SOCKET'] = path
+    redis_lock.reset_all_script = None
     return path
 
 
@@ -37,7 +40,7 @@ def none_creator():
         return None
 
     def assert_false_creator():
-        assert False
+        raise AssertionError
 
     assert cache.locked_get_or_set('foobar-aosl', creator_42) == 42
     assert cache.locked_get_or_set('foobar-aosl', assert_false_creator) == 42
@@ -47,7 +50,7 @@ def assert_false_creator():
     except ValueError:
         pass
     else:
-        assert False
+        raise AssertionError
 
 
 @pytest.mark.skipif('not django')

tests/test_django_valkey_integration.py

@@ -2,6 +2,8 @@
 
 import pytest
 
+import redis_lock
+
 try:
     import django
 except ImportError:
@@ -14,6 +16,7 @@
 def redis_socket_static(tmpdir_factory):
     path = str(tmpdir_factory.getbasetemp() / 'redis.sock')
     os.environ['REDIS_SOCKET'] = path
+    redis_lock.reset_all_script = None
     return path
 
 
@@ -37,7 +40,7 @@ def none_creator():
         return None
 
     def assert_false_creator():
-        assert False
+        raise AssertionError
 
     assert caches['valkey'].locked_get_or_set('foobar-aosl', creator_42) == 42
     assert caches['valkey'].locked_get_or_set('foobar-aosl', assert_false_creator) == 42
@@ -47,7 +50,7 @@ def assert_false_creator():
     except ValueError:
         pass
     else:
-        assert False
+        raise AssertionError
 
 
 @pytest.mark.skipif('not django')