Privex Django Lock Manager Logo
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 »
  • Overview: module code

All modules for which code is available

  • django.apps.config
  • django.db.models.base
  • django.db.models.manager
  • django.db.models.query_utils
  • functools
  • lockmgr.apps
  • lockmgr.lockmgr
  • lockmgr.management.commands.clear_lock
  • lockmgr.management.commands.list_locks
  • lockmgr.management.commands.reset_locks
  • lockmgr.management.commands.set_lock
  • lockmgr.models
  • tests.test_lockmgr
  • tests.test_lockmgr_class
  • tests.test_renew
  • unittest.case

© Copyright 2019, Privex Inc. Revision 930f566c.

Built with Sphinx using a theme provided by Read the Docs.