philiprehberger-lock-run

Prevent duplicate script execution using file-based locking.

Installation

pip install philiprehberger-lock-run

from philiprehberger_lock_run import lock

with lock("my-job"):
    do_work()

from philiprehberger_lock_run import locked

@locked("my-job")
def scheduled_task():
    ...

Wait up to 10 seconds for the lock to become available:

with lock("my-job", timeout=10):
    do_work()

with lock("my-job", lock_dir="/var/lock"):
    do_work()

Check whether another process currently holds a lock (non-blocking):

from philiprehberger_lock_run import is_locked

if is_locked("my-job"):
    print("Another process is running my-job")

Remove orphaned lock files older than a threshold (defaults to 24 hours). Only files that are not currently held are removed:

from philiprehberger_lock_run import cleanup_locks

removed = cleanup_locks(max_age_seconds=3600)
print(f"Removed {len(removed)} stale lock files")

Name	Description
`lock(name, *, timeout=0, lock_dir=None)`	Context manager that acquires a file lock. Raises `LockError` on failure.
`locked(name, **kwargs)`	Decorator that wraps the function body in a file lock.
`is_locked(name, *, lock_dir=None)`	Return `True` if another process currently holds the named lock. Performs a non-blocking try-acquire.
`cleanup_locks(lock_dir=None, *, max_age_seconds=86400)`	Remove orphaned lock files older than `max_age_seconds` that are not currently held. Returns the list of removed file names.
`LockError`	Raised when a lock cannot be acquired. Extends `RuntimeError`.

pip install -e .
python -m pytest tests/ -v

If you find this project useful:

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for philiprehberger-lock-run 0.2.0
File	Size	Uploaded
philiprehberger_lock_run-0.2.0.tar.gz	183.1 kB	May 31, 2026	Details

Table of built distributions (wheels) for philiprehberger-lock-run 0.2.0
File	Interpreter	ABI	Platform	Reset
philiprehberger_lock_run-0.2.0-py3-none-any.whl 5.2 kB May 31, 2026	Python 3	none	any	Details

Total release size: 188.4 kB

Download URL	philiprehberger_lock_run-0.2.0.tar.gz
Size	183.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`83cb7c5fc97a4fc77d22689dc9d0ec45051ff3b97bb09d74817591f911b4202c`
BLAKE2b-256 checksum How to use checksums	`61ee149de4530137b2a55caa366b2a7323f46d6484d7267267e0ae4c460a6070`
Upload date	May 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.13`

Download URL	philiprehberger_lock_run-0.2.0-py3-none-any.whl
Size	5.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5ba870bc85b4aabf24fba1f310c8d44670b85bc4e5fe1f1fb939f0dc3d8f4c74`
BLAKE2b-256 checksum How to use checksums	`a7092ce68854c30f0474caec3449c46b372eab9e97072e3dc6440c9b2cd4f4ce`
Upload date	May 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.12.13`