Privex Django Lock Manager
latest
Main:
Privex Django Lock Manager (django-lockmgr) documentation
Installing Django Lock Manager
Download and install from PyPi using pipenv / pip (recommended)
(Alternative) Manual install from Git
Post-installation
Code Documentation:
Using Django Lock Manager
Using the context manager LockMgr (recommended)
Using the raw module lock management functions
Extra documentation
API Docs (lockmgr.lockmgr)
clean_locks
get_lock
is_locked
renew_lock
set_lock
unlock
LockMgr
Methods
__init__
lock
renew
unlock
__enter__
__exit__
Database Models (lockmgr.models)
default_lock_expiry
Lock
Methods
get_next_by_created_at
get_next_by_updated_at
get_previous_by_created_at
get_previous_by_updated_at
Attributes
created_at
expired
expires_in
expires_seconds
lock_process
locked_by
locked_until
name
objects
updated_at
Django Management Commands
clear_lock
Command
Methods
__init__
add_arguments
handle
Attributes
help
list_locks
Command
Methods
__init__
handle
Attributes
help
reset_locks
Command
Methods
__init__
add_arguments
handle
Attributes
help
set_lock
Command
Methods
__init__
add_arguments
handle
Attributes
help
Unit Testing
How to use the unit tests
Testing pre-requisites
Running the tests via Django Test Runner / Django-Nose
Unit Test List / Overview
tests.test_lockmgr
TestLockMgrModule
Methods
test_getlock_clean
test_getlock_unlock
test_is_locked
test_lock_expiry
test_lock_no_expiry
test_lock_zero_expiry
Attributes
tests.test_lockmgr_class
TestLockMgrClass
Methods
test_lock_wait
test_lock_wait_timeout
test_lockmgr
test_lockmgr_except
Attributes
tests.test_renew
TestLockRenew
Methods
test_lockmgr_renew_expired
test_lockmgr_renew_main
test_renew_existing_name
test_renew_existing_name_add_time
test_renew_existing_object_add_time
test_renew_lock_object
test_renew_non_existing_name
test_renew_non_existing_name_create
test_renew_shorter_expiration
test_renew_shorter_expiration_add_time
Attributes
Privex Django Lock Manager
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
C
|
D
|
E
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
R
|
S
|
T
|
U
|
V
|
W
_
__enter__() (lockmgr.lockmgr.LockMgr method)
__exit__() (lockmgr.lockmgr.LockMgr method)
__init__() (lockmgr.lockmgr.LockMgr method)
(lockmgr.management.commands.clear_lock.Command method)
(lockmgr.management.commands.list_locks.Command method)
(lockmgr.management.commands.reset_locks.Command method)
(lockmgr.management.commands.set_lock.Command method)
A
add_arguments() (lockmgr.management.commands.clear_lock.Command method)
,
[1]
,
[2]
(lockmgr.management.commands.reset_locks.Command method)
,
[1]
,
[2]
(lockmgr.management.commands.set_lock.Command method)
,
[1]
,
[2]
C
clean_locks() (in module lockmgr.lockmgr)
,
[1]
Command (class in lockmgr.management.commands.clear_lock)
,
[1]
(class in lockmgr.management.commands.list_locks)
,
[1]
(class in lockmgr.management.commands.reset_locks)
,
[1]
(class in lockmgr.management.commands.set_lock)
,
[1]
created_at (lockmgr.models.Lock attribute)
D
default_lock_expiry() (in module lockmgr.models)
E
expired() (lockmgr.models.Lock property)
,
[1]
,
[2]
expires (lockmgr.lockmgr.LockMgr attribute)
,
[1]
expires_in() (lockmgr.models.Lock property)
,
[1]
,
[2]
expires_seconds() (lockmgr.models.Lock property)
,
[1]
,
[2]
G
get_lock() (in module lockmgr.lockmgr)
,
[1]
get_next_by_created_at() (lockmgr.models.Lock method)
get_next_by_updated_at() (lockmgr.models.Lock method)
get_previous_by_created_at() (lockmgr.models.Lock method)
get_previous_by_updated_at() (lockmgr.models.Lock method)
H
handle() (lockmgr.management.commands.clear_lock.Command method)
,
[1]
,
[2]
(lockmgr.management.commands.list_locks.Command method)
,
[1]
,
[2]
(lockmgr.management.commands.reset_locks.Command method)
,
[1]
,
[2]
(lockmgr.management.commands.set_lock.Command method)
,
[1]
,
[2]
help (lockmgr.management.commands.clear_lock.Command attribute)
(lockmgr.management.commands.list_locks.Command attribute)
(lockmgr.management.commands.reset_locks.Command attribute)
(lockmgr.management.commands.set_lock.Command attribute)
I
is_locked() (in module lockmgr.lockmgr)
,
[1]
L
Lock (class in lockmgr.models)
,
[1]
lock() (lockmgr.lockmgr.LockMgr method)
,
[1]
,
[2]
Lock.DoesNotExist
,
[1]
Lock.MultipleObjectsReturned
,
[1]
lock_process (lockmgr.lockmgr.LockMgr attribute)
,
[1]
(lockmgr.models.Lock attribute)
Locked
locked_by (lockmgr.lockmgr.LockMgr attribute)
,
[1]
(lockmgr.models.Lock attribute)
,
[1]
,
[2]
locked_until (lockmgr.models.Lock attribute)
,
[1]
,
[2]
LockFail
LockMgr (class in lockmgr.lockmgr)
,
[1]
lockmgr.lockmgr (module)
lockmgr.management.commands (module)
lockmgr.management.commands.clear_lock (module)
lockmgr.management.commands.list_locks (module)
lockmgr.management.commands.reset_locks (module)
lockmgr.management.commands.set_lock (module)
lockmgr.models (module)
LockMgrConfig (class in lockmgr.apps)
LockNotFound
LockSetResult (class in lockmgr.lockmgr)
LockSetStatus (class in lockmgr.lockmgr)
M
main_lock (lockmgr.lockmgr.LockMgr attribute)
,
[1]
N
name (lockmgr.apps.LockMgrConfig attribute)
(lockmgr.lockmgr.LockMgr attribute)
,
[1]
(lockmgr.models.Lock attribute)
,
[1]
,
[2]
O
objects (lockmgr.models.Lock attribute)
R
renew() (lockmgr.lockmgr.LockMgr method)
,
[1]
,
[2]
renew_lock() (in module lockmgr.lockmgr)
,
[1]
S
set_lock() (in module lockmgr.lockmgr)
,
[1]
T
test_getlock_clean() (tests.test_lockmgr.TestLockMgrModule method)
,
[1]
,
[2]
test_getlock_unlock() (tests.test_lockmgr.TestLockMgrModule method)
,
[1]
,
[2]
test_is_locked() (tests.test_lockmgr.TestLockMgrModule method)
,
[1]
,
[2]
test_lock_expiry() (tests.test_lockmgr.TestLockMgrModule method)
,
[1]
,
[2]
test_lock_no_expiry() (tests.test_lockmgr.TestLockMgrModule method)
,
[1]
,
[2]
test_lock_wait() (tests.test_lockmgr_class.TestLockMgrClass method)
,
[1]
,
[2]
test_lock_wait_timeout() (tests.test_lockmgr_class.TestLockMgrClass method)
,
[1]
,
[2]
test_lock_zero_expiry() (tests.test_lockmgr.TestLockMgrModule method)
,
[1]
,
[2]
test_lockmgr() (tests.test_lockmgr_class.TestLockMgrClass method)
,
[1]
,
[2]
test_lockmgr_except() (tests.test_lockmgr_class.TestLockMgrClass method)
,
[1]
,
[2]
test_lockmgr_renew_expired() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_lockmgr_renew_main() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_existing_name() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_existing_name_add_time() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_existing_object_add_time() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_lock_object() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_non_existing_name() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_non_existing_name_create() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_shorter_expiration() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
test_renew_shorter_expiration_add_time() (tests.test_renew.TestLockRenew method)
,
[1]
,
[2]
TestLockMgrClass (class in tests.test_lockmgr_class)
,
[1]
TestLockMgrModule (class in tests.test_lockmgr)
,
[1]
TestLockRenew (class in tests.test_renew)
,
[1]
tests (module)
tests.test_lockmgr (module)
tests.test_lockmgr_class (module)
tests.test_renew (module)
U
unlock() (in module lockmgr.lockmgr)
,
[1]
(lockmgr.lockmgr.LockMgr method)
,
[1]
,
[2]
updated_at (lockmgr.models.Lock attribute)
V
version (lockmgr.apps.LockMgrConfig attribute)
W
wait (lockmgr.lockmgr.LockMgr attribute)
,
[1]
Read the Docs
v: latest
Versions
latest
stable
develop
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.