Merge pull request #23 from luizalabs/ro-lock_default_timeout

[PROPOSAL] Use cache backend default timeout when expire param is not given.

django_toolkit/concurrent/locks.py

@@ -1,4 +1,5 @@
 from django.core.cache import caches
+from django.core.cache.backends.base import DEFAULT_TIMEOUT
 
 
 class LockActiveError(Exception):
@@ -43,7 +44,7 @@ def __init__(
         self,
         key,
         cache_alias='default',
-        expire=0,
+        expire=DEFAULT_TIMEOUT,
         raise_exception=True
     ):
         super(CacheLock, self).__init__()

docs/concurrent.md

@@ -37,6 +37,7 @@ Django cache alias.
 `expire`
 
 Time in seconds to expire the cache.
+This argument defaults to the backend timeout configuration.
 
 `raise_exception`
 

tests/concurrent/test_locks.py

@@ -57,3 +57,11 @@ def test_should_not_raise_exception_when_raise_exception_is_false(self):
 
             with CacheLock(key='test', raise_exception=False) as lock:
                 assert lock.active is False
+
+    def test_should_use_default_cache_timeout_when_expire_is_not_given(self):
+        with CacheLock(cache_alias='explicit_timeout', key='test') as lock:
+            assert lock.cache.get(lock._key)
+
+    def test_should_expire_immediately_when_expire_is_zero(self):
+        with CacheLock(key='test', expire=0) as lock:
+            assert not lock.cache.get(lock._key)

tests/settings.py

@@ -32,7 +32,11 @@
     },
     'access_token': {
         'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
-    }
+    },
+    'explicit_timeout': {
+        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+        'TIMEOUT': 300,
+    },
 }
 
 TOOLKIT = {