Примітиви синхронізації

Вихідний код: Lib/asyncio/locks.py

Примітиви синхронізації asyncio розроблені таким чином, щоб бути подібними до модулів threading з двома важливими застереженнями:

  • примітиви asyncio не є потокобезпечними, тому їх не слід використовувати для синхронізації потоків ОС (для цього використовуйте threading);

  • методи цих примітивів синхронізації не приймають аргумент timeout; використовуйте функцію asyncio.wait_for() для виконання операцій із тайм-аутами.

asyncio має такі базові примітиви синхронізації:

Замок

class asyncio.Lock(*, loop=None)

Реалізує блокування м’ютексу для асинхронних завдань. Небезпечно для потоків.

Асинхронне блокування можна використовувати, щоб гарантувати ексклюзивний доступ до спільного ресурсу.

Найкращим способом використання Lock є оператор async with:

lock = asyncio.Lock()

# ... later
async with lock:
    # access shared state

що еквівалентно:

lock = asyncio.Lock()

# ... later
await lock.acquire()
try:
    # access shared state
finally:
    lock.release()

Deprecated since version 3.8, will be removed in version 3.10: The loop parameter.

coroutine acquire()

Придбайте замок.

Цей метод очікує, поки блокування буде розблоковано, встановлює його на заблоковано та повертає True.

Якщо в acquire() заблоковано більше ніж одну співпрограму, яка очікує розблокування блокування, зрештою виконується лише одна співпрограма.

Отримання блокування є чесним: співпрограма, яка продовжується, буде першою співпрограмою, яка почала очікувати на блокування.

release()

Відпустіть замок.

Коли замок заблоковано, скиньте його на розблоковано та поверніться.

Якщо блокування розблоковано, виникає RuntimeError.

locked()

Повертає True, якщо блокування заблоковано.

Подія

class asyncio.Event(*, loop=None)

Об’єкт події. Небезпечно для потоків.

Асинхронну подію можна використовувати для сповіщення кількох асинхронних завдань про те, що сталася якась подія.

Об’єкт Event керує внутрішнім прапором, який можна встановити на true за допомогою методу set() і скинути на false за допомогою методу clear(). Метод wait() блокується, доки прапор не буде встановлено на true. Спочатку для прапора встановлено значення false.

Deprecated since version 3.8, will be removed in version 3.10: The loop parameter.

Приклад:

async def waiter(event):
    print('waiting for it ...')
    await event.wait()
    print('... got it!')

async def main():
    # Create an Event object.
    event = asyncio.Event()

    # Spawn a Task to wait until 'event' is set.
    waiter_task = asyncio.create_task(waiter(event))

    # Sleep for 1 second and set the event.
    await asyncio.sleep(1)
    event.set()

    # Wait until the waiter task is finished.
    await waiter_task

asyncio.run(main())
coroutine wait()

Дочекайтеся встановлення події.

Якщо подія встановлена, негайно поверніть True. Інакше заблокуйте, доки інше завдання не викличе set().

set()

Встановити подію.

Усі завдання, які очікують встановлення події, будуть негайно активовані.

clear()

Очистити (скасувати) подію.

Завдання, що очікують на wait(), тепер блокуватимуться, доки метод set() не буде викликано знову.

is_set()

Повертає True, якщо подія встановлена.

Хвороба

class asyncio.Condition(lock=None, *, loop=None)

Об’єкт Condition. Небезпечно для потоків.

Примітив асинхронної умови може використовуватися завданням для очікування настання певної події та отримання ексклюзивного доступу до спільного ресурсу.

По суті, об’єкт Condition поєднує функціональні можливості Event і Lock. Кілька об’єктів Condition можуть використовувати один Lock, що дозволяє координувати ексклюзивний доступ до спільного ресурсу між різними завданнями, зацікавленими в певних станах цього спільного ресурсу.

Додатковий аргумент lock має бути об’єктом Lock або None. В останньому випадку новий об’єкт Lock створюється автоматично.

Deprecated since version 3.8, will be removed in version 3.10: The loop parameter.

Найкращим способом використання умови є оператор async with:

cond = asyncio.Condition()

# ... later
async with cond:
    await cond.wait()

що еквівалентно:

cond = asyncio.Condition()

# ... later
await cond.acquire()
try:
    await cond.wait()
finally:
    cond.release()
coroutine acquire()

Отримайте основний замок.

Цей метод чекає, доки базове блокування розблокується, встановлює його на locked і повертає True.

notify(n=1)

Wake up at most n tasks (1 by default) waiting on this condition. The method is no-op if no tasks are waiting.

Блокування має бути отримано перед викликом цього методу та звільнено незабаром після цього. У разі виклику з розблокованим блокуванням виникає помилка RuntimeError.

locked()

Повертає True, якщо основне блокування отримано.

notify_all()

Розбудіть усі завдання, що очікують за цієї умови.

Цей метод діє як notify(), але активує всі завдання, що очікують.

Блокування має бути отримано перед викликом цього методу та звільнено незабаром після цього. У разі виклику з розблокованим блокуванням виникає помилка RuntimeError.

release()

Звільніть базовий замок.

Під час виклику для розблокованого блокування виникає RuntimeError.

coroutine wait()

Дочекайтеся повідомлення.

Якщо завдання, що викликає, не отримало блокування під час виклику цього методу, виникає RuntimeError.

Цей метод знімає основне блокування, а потім блокує, доки його не розбудить виклик notify() або notify_all(). Після пробудження умова знову блокується, і цей метод повертає True.

coroutine wait_for(predicate)

Зачекайте, поки предикат стане true.

The predicate must be a callable which result will be interpreted as a boolean value. The final value is the return value.

Семафор

class asyncio.Semaphore(value=1, *, loop=None)

Об’єкт Semaphore. Небезпечно для потоків.

Семафор керує внутрішнім лічильником, який зменшується при кожному виклику acquire() і збільшується при кожному виклику release(). Лічильник ніколи не може опускатися нижче нуля; коли acquire() виявляє, що він дорівнює нулю, він блокується, чекаючи, поки якесь завдання викличе release().

Необов’язковий аргумент value дає початкове значення для внутрішнього лічильника (1 за замовчуванням). Якщо вказане значення менше ніж 0, виникає ValueError.

Deprecated since version 3.8, will be removed in version 3.10: The loop parameter.

Кращим способом використання семафора є оператор async with:

sem = asyncio.Semaphore(10)

# ... later
async with sem:
    # work with shared resource

що еквівалентно:

sem = asyncio.Semaphore(10)

# ... later
await sem.acquire()
try:
    # work with shared resource
finally:
    sem.release()
coroutine acquire()

Придбайте семафор.

Якщо внутрішній лічильник більший за нуль, зменште його на одиницю та негайно поверніть True. Якщо він дорівнює нулю, дочекайтеся виклику release() і поверніть True.

locked()

Повертає True, якщо семафор не може бути отриманий негайно.

release()

Відпустіть семафор, збільшивши внутрішній лічильник на одиницю. Може розбудити завдання, яке очікує отримання семафора.

На відміну від BoundedSemaphore, Semaphore дозволяє робити більше викликів release(), ніж викликів acquire().

Обмежений семафор

class asyncio.BoundedSemaphore(value=1, *, loop=None)

Обмежений семафорний об’єкт. Небезпечно для потоків.

Обмежений семафор — це версія Semaphore, яка викликає ValueError у release(), якщо він збільшує внутрішній лічильник вище початкового значення.

Deprecated since version 3.8, will be removed in version 3.10: The loop parameter.

Змінено в версії 3.9: Отримання блокування за допомогою оператора await lock або yield from lock та/або with (with await lock, with (yield from lock)) було видалено . Натомість використовуйте async with lock.