orionis.cache.locks.lock.CacheLock

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class CacheLock: (source)

Undocumented

Async Method	`__acquireDatabaseLock`	Acquire the row-based database lock, polling until available.
Async Method	`__aenter__`	Acquire the lock before entering the protected block.
Async Method	`__aexit__`	Release the lock after leaving the protected block.
Method	`__init__`	Initialize the lock for key on backend.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_backend`	Undocumented
Instance Variable	`_impl`	Undocumented
Instance Variable	`_key`	Undocumented
Instance Variable	`_owner`	Undocumented
Instance Variable	`_timeout`	Undocumented

async def __acquireDatabaseLock(self): (source) ¶

Acquire the row-based database lock, polling until available.

Mirrors the blocking semantics of the other branches: it waits until the lock is free, raising once timeout elapses.

Returns
`None`	This method does not return a value.

Raises
`TimeoutError`	If the lock cannot be acquired before timeout elapses.

async def __aenter__(self) -> Self: (source) ¶

Acquire the lock before entering the protected block.

Returns
`Self`	This `CacheLock` instance.

async def __aexit__(self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: types.TracebackType | None): (source) ¶

Release the lock after leaving the protected block.

Parameters
exc_type:`type[BaseException] \| None`	Exception type, if any.
exc_val:`BaseException \| None`	Exception instance, if any.
exc_tb:`types.TracebackType \| None`	Traceback object, if any.

Returns
`None`	Complete the documented operation without returning a value.

def __init__(self, backend: Any, key: str, timeout: float | None = None): (source) ¶

Initialize the lock for key on backend.

Parameters
backend:`Any`	Raw cache backend.
key:`str`	Cache key to lock on.
timeout:`float \| None`	Lock timeout in seconds. `None` means no timeout.

Returns
`None`	Complete the documented operation without returning a value.

Undocumented

Undocumented

_impl: asyncio.Lock | RedLock | None = (source) ¶

Undocumented

Undocumented

Undocumented

Undocumented