Merge pull request #182 from jamesob/jamesob-22-11-lock-doc

doc: add note about lock event keys
coleifer · Nov 4, 2022 · 2b9bfd6 · 2b9bfd6
2 parents 3fe8097 + 93304ab
commit 2b9bfd6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/walrus/lock.py b/walrus/lock.py
@@ -13,6 +13,13 @@ class Lock(object):
     a value is pushed into this list, signalling that the lock is
     available.
 
+    .. warning::
+        The event list for each lock persists
+        indefinitely unless removed using :py:meth:`Lock.clear` or
+        otherwise manually in the Redis database. For this reason,
+        be cautious when creating locks dynamically, or your
+        keyspace might grow in an unbounded way.
+
     The lock uses Lua scripts to ensure the atomicity of its
     operations.