gcs-mutex-lock

A global file-based mutex lock using Google Cloud Storage, inspired by gcslock. Supports retries with exponential backoff via backoff.

The mutex is created with GCS consistency guarantees.

Use Cases

Use this for:

• If you just want a simple, serverless, global lock
• High-latency applications (i.e. batch ETL processes)
• Long-running, distributed compute processes

Don't use this for:

• Low-latency applications
• Low-latency locks
• Client-side applications

Installation

pip install git+https://github.com/thinkingmachines/gcs-mutex-lock.git

Usage

Simple usage:

from gcs_mutex_lock import gcs_lock

# Acquire a lock
acquired = gcs_lock.lock('gs://bucket-name/lock-name')
print(acquired)

# Release the lock
gcs_lock.unlock('gs://bucket-name/lock-name')

Wait for lock to be freed, then acquire it:

# Acquire lock, then retry with (truncated) exponential backoff
acquired = gcs_lock.wait_for_lock_expo('gs://bucket-name/lock-name')
print(acquired)

Backoff

To configure backoff parameters, see the backoff docs.

The backoff parameters can be passed as *args and **kwargs to any of the wait_for_lock* functions.

Exponential Backoff w/Jitter

Use the wait_for_lock_expo for exponential backoff. Full jitter is included by default, so pass jitter=None to see pure exponential behavior.

The default backoff behavior for wait_for_lock_expo is defined in this AWS post.