API reference

• portalocker package
  • Submodules
    • portalocker.redis module
      • DEFAULT_THREAD_SLEEP_TIME
      • DEFAULT_UNAVAILABLE_TIMEOUT
      • PubSubWorkerThread
      • REDIS_LOCK_PROTOCOL_VERSION
      • RedisLock
      • RedisLockHolder
      • RedisLockMode
    • portalocker.constants module
      • LOCK_EX
      • LOCK_NB
      • LOCK_SH
      • LOCK_UN
      • LockFlags
    • portalocker.exceptions module
      • AlreadyLocked
      • BaseLockException
      • FileToLarge
      • LockException
    • portalocker.portalocker module
      • BaseLocker
      • FlockLocker
      • LockCallable
      • LockfLocker
      • PosixLocker
      • UnlockCallable
      • lock()
      • unlock()
    • portalocker.utils module
      • Lock
      • open_atomic()
    • portalocker.types module
      • FileArgument
      • FileOpenKwargs
      • Filename
      • HasFileno
      • IO
      • Mode
  • Module contents
    • AlreadyLocked
      • AlreadyLocked.holder_pid
    • BoundedSemaphore
      • BoundedSemaphore.acquire()
      • BoundedSemaphore.get_filename()
      • BoundedSemaphore.get_filenames()
      • BoundedSemaphore.get_random_filenames()
      • BoundedSemaphore.lock
      • BoundedSemaphore.release()
      • BoundedSemaphore.try_lock()
    • LOCK_EX
    • LOCK_NB
    • LOCK_SH
    • LOCK_UN
    • Lock
      • Lock.acquire()
      • Lock.check_interval
      • Lock.fail_when_locked
      • Lock.fh
      • Lock.file_open_kwargs
      • Lock.filename
      • Lock.flags
      • Lock.mode
      • Lock.raise_on_release_error
      • Lock.release()
      • Lock.timeout
      • Lock.truncate
    • LockException
    • LockFlags
      • LockFlags.EXCLUSIVE
      • LockFlags.NON_BLOCKING
      • LockFlags.SHARED
      • LockFlags.UNBLOCK
    • NamedBoundedSemaphore
    • PidFileLock
      • PidFileLock.acquire()
      • PidFileLock.fail_closed()
      • PidFileLock.read_pid()
      • PidFileLock.release()
    • RLock
      • RLock.acquire()
      • RLock.release()
    • RedisLock
      • RedisLock.DEFAULT_REDIS_KWARGS
      • RedisLock.acquire()
      • RedisLock.channel
      • RedisLock.channel_handler()
      • RedisLock.check_or_kill_lock()
      • RedisLock.client_name
      • RedisLock.close_connection
      • RedisLock.connection
      • RedisLock.flags
      • RedisLock.get_connection()
      • RedisLock.holder_id
      • RedisLock.legacy_client_name
      • RedisLock.mode
      • RedisLock.pubsub
      • RedisLock.redis_kwargs
      • RedisLock.release()
      • RedisLock.thread
      • RedisLock.timeout
      • RedisLock.writer_elected
    • TemporaryFileLock
      • TemporaryFileLock.acquire()
      • TemporaryFileLock.release()
    • lock()
    • open_atomic()
    • unlock()