acquire(self, blocking=True, timeout=None, num_locks=None)

Parameters

blocking : bool, optional

If false, don't wait on the lock in the scheduler at all.

timeout : string or number or timedelta, optional

Seconds to wait on the lock in the scheduler. This does not include local coroutine time, network transfer time, etc.. It is forbidden to specify a timeout when blocking is false. Instead of number of seconds, it is also possible to specify a timedelta in string format, e.g. "200ms".

num_locks : int, optional

Number of locks needed. If None, all locks are needed

Returns

True or False whether or not it successfully acquired the lock

Acquire the lock

Examples

This example is valid syntax, but we were not able to check execution

>>> lock = MultiLock(['x', 'y'])  # doctest: +SKIP
... lock.acquire(timeout="1s")  # doctest: +SKIP

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

distributed.multi_lock.MultiLock.acquire distributed.multi_lock.MultiLock

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

---

File: /distributed/multi_lock.py#173
type: <class 'function'>
Commit: