Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

File-based locks for Python for Linux and Windows

Project Description

Locket implements a lock that can be used by multiple processes provided they use the same path.

import locket

# Wait for lock
with locket.lock_file("path/to/lock/file"):
    perform_action()

# Raise error if lock cannot be acquired immediately
with locket.lock_file("path/to/lock/file", timeout=0):
    perform_action()

# Raise error if lock cannot be acquired after thirty seconds
with locket.lock_file("path/to/lock/file", timeout=30):
    perform_action()

# Without context managers:
lock = locket.lock_file("path/to/lock/file")
try:
    lock.acquire()
    perform_action()
finally:
    lock.release()

Locks largely behave as (non-reentrant) Lock instances from the threading module in the standard library. Specifically, their behaviour is:

  • Locks are uniquely identified by the file being locked, both in the same process and across different processes.
  • Locks are either in a locked or unlocked state.
  • When the lock is unlocked, calling acquire() returns immediately and changes the lock state to locked.
  • When the lock is locked, calling acquire() will block until the lock state changes to unlocked, or until the timeout expires.
  • If a process holds a lock, any thread in that process can call release() to change the state to unlocked.
  • Behaviour of locks after fork is undefined.

Release history Release notifications

This version
History Node

0.2.0

History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
locket-0.2.0.tar.gz (3.5 kB) Copy SHA256 hash SHA256 Source None May 19, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page