Welcome to dreadlocks’ documentation!

dreadlocks is a cross-platform file-locking software library for Python that supports thread-level locks, process-level locks, and both simultaneously.

Check out the Usage section for further information, including how to install the project.

Note

This is work in progress.

Contents

• Usage
  • Installation
  • Using dreadlocks
• API
  • dreadlocks Package
    • Functions
      • path_lock
        • path_lock()
      • process_level_path_lock
        • process_level_path_lock()
      • thread_level_path_lock
        • thread_level_path_lock()
    • Classes
      • AcquiringLockWouldBlockError
        • AcquiringLockWouldBlockError
      • AcquiringProcessLevelLockWouldBlockError
        • AcquiringProcessLevelLockWouldBlockError
      • AcquiringThreadLevelLockWouldBlockError
        • AcquiringThreadLevelLockWouldBlockError
      • RecursiveDeadlockError
        • RecursiveDeadlockError
    • Class Inheritance Diagram