prefect.locking.protocol

Classes

LockManager ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L5" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

aacquire_lock ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L33" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

aacquire_lock(self, key: str, holder: str, acquire_timeout: Optional[float] = None, hold_timeout: Optional[float] = None) -> bool

Acquire a lock for a transaction record with the given key. Will block other actors from updating this transaction record until the lock is released.

Args:

• key: Unique identifier for the transaction record.
• holder: Unique identifier for the holder of the lock.
• acquire_timeout: Max number of seconds to wait for the record to become available if it is locked while attempting to acquire a lock. Pass 0 to attempt to acquire a lock without waiting. Blocks indefinitely by default.
• hold_timeout: Max number of seconds to hold the lock for. Holds the lock indefinitely by default.

Returns:

• True if the lock was successfully acquired; False otherwise.

acquire_lock ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L6" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

acquire_lock(self, key: str, holder: str, acquire_timeout: Optional[float] = None, hold_timeout: Optional[float] = None) -> bool

Acquire a lock for a transaction record with the given key. Will block other actors from updating this transaction record until the lock is released.

Args:

• key: Unique identifier for the transaction record.
• holder: Unique identifier for the holder of the lock.
• acquire_timeout: Max number of seconds to wait for the record to become available if it is locked while attempting to acquire a lock. Pass 0 to attempt to acquire a lock without waiting. Blocks indefinitely by default.
• hold_timeout: Max number of seconds to hold the lock for. Holds the lock indefinitely by default.

Returns:

• True if the lock was successfully acquired; False otherwise.

await_for_lock ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

await_for_lock(self, key: str, timeout: Optional[float] = None) -> bool

Wait for the corresponding transaction record to become free.

Args:

• key: Unique identifier for the transaction record.
• timeout: Maximum time to wait. None means to wait indefinitely.

Returns:

• True if the lock becomes free within the timeout; False otherwise.

is_lock_holder ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L83" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

is_lock_holder(self, key: str, holder: str) -> bool

Check if the current holder is the lock holder for the transaction record.

Args:

• key: Unique identifier for the transaction record.
• holder: Unique identifier for the holder of the lock.

Returns:

• True if the current holder is the lock holder; False otherwise.

is_locked ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L71" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

is_locked(self, key: str) -> bool

Simple check to see if the corresponding record is currently locked.

Args:

• key: Unique identifier for the transaction record.

Returns:

• True is the record is locked; False otherwise.

release_lock ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L60" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

release_lock(self, key: str, holder: str) -> None

Releases the lock on the corresponding transaction record.

Args:

• key: Unique identifier for the transaction record.
• holder: Unique identifier for the holder of the lock. Must match the holder provided when acquiring the lock.

wait_for_lock ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/locking/protocol.py#L96" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

wait_for_lock(self, key: str, timeout: Optional[float] = None) -> bool

Wait for the corresponding transaction record to become free.

Args:

• key: Unique identifier for the transaction record.
• timeout: Maximum time to wait. None means to wait indefinitely.

Returns:

• True if the lock becomes free within the timeout; False otherwise.