README.md

TasksLock API Python Client README

The Python TasksLock API client allows any Python application to consume locks from a TasksLock API instance.

Using This Client

Install Dependencies

To install dependencies:

pip install -r requirements.in

Client Usage

To use the client:

# Import the client
from taskslock.client.task_lock_service import TasksLockService

# Construct a TasksLockService instance
tasks_lock_service = TasksLockService()


def some_sync_func_that_does_not_wait():
    task_lock = tasks_lock_service.acquire_lock('some-task-name', 'some-context-id', False)
    if task_lock.is_locked:
        # Lock acquired, do something and release lock
        ...
        task_lock.release()
    else:
        # Lock not acquired, handle that case
        ...


def some_sync_func_that_waits():
    # Blocks until lock is acquired
    task_lock = tasks_lock_service.acquire_lock('some-task-name', 'some-context-id', True)
    # No need to check if lock acquired because method blocks until a lock is acquired
    # Do something and release lock
    ...
    task_lock.release()