queue — Класс синхронизированной очереди

Объекты очереди

Объекты очереди (Queue, LifoQueue или PriorityQueue) предоставляют описанные ниже публичные методы.

Queue.qsize()

Возвращает приблизительный размер очереди. Обратите внимание, что qsize() > 0 не гарантирует, что последующий get() не будет заблокирован, и qsize() < maxsize не гарантирует, что put() не будет заблокирован.

Queue.empty()

Возвращает True, если очередь пуста, False, в противном случае. Если empty() возвращает True, это не гарантирует, что последующий вызов put() не будет заблокирован. Аналогично, если empty() возвращает False, это не гарантирует, что последующий вызов get() не будет заблокирован.

Queue.full()

Возвращает True, если очередь полна, False, в противном случае. Если full() возвращает True, это не гарантирует, что последующий вызов get() не будет заблокирован. Аналогично, если full() возвращает False, это не гарантирует, что последующий вызов put() не будет заблокирован.

Queue.put(item, block=True, timeout=None)

Поместить item в очередь. Если необязательные аргументы block истинны и timeout — None, заблокировать, если необходимо, до тех пор, пока не появится свободное место. Если timeout — положительное число, блокировать не более timeout секунд и возбудить исключение Full, если свободное место не было доступно в течение этого времени. В противном случае (block ложно), поместить элемент в очередь, если свободное место доступно немедленно, иначе возбудить исключение Full (timeout игнорируется в этом случае).

Queue.put_nowait(item)

Эквивалентно put(item, block=False).

Queue.get(block=True, timeout=None)

Удалить и вернуть элемент из очереди. Если необязательные аргументы block истинны и timeout — None, заблокировать, если необходимо, до тех пор, пока не станет доступен элемент. Если timeout — положительное число, блокировать не более timeout секунд и возбудить исключение Empty, если элемент не был доступен в течение этого времени. В противном случае (block ложно), вернуть элемент, если он доступен немедленно, иначе возбудить исключение Empty (timeout игнорируется в этом случае).

До версии 3.0 на системах POSIX и для всех версий на Windows, если block истинно и timeout — None, эта операция переходит в непрерывно ожидающий режим на базовой блокировке. Это означает, что исключения не могут возникнуть, и, в частности, SIGINT не вызовет KeyboardInterrupt.

Queue.get_nowait()

Эквивалентно get(False).

Два метода предлагаются для отслеживания того, были ли задачи, помещенные в очередь, полностью обработаны демоническими потоками-потребителями.

Queue.task_done()

Указывает, что ранее помещенная в очередь задача выполнена. Используется потоками-потребителями очереди. Для каждого get(), используемого для извлечения задачи, последующий вызов task_done() сообщает очереди, что обработка задачи завершена.

Если join() в настоящее время заблокирован, он возобновится, когда все элементы будут обработаны (что означает, что вызов task_done() был получен для каждого элемента, который был помещен в очередь put()).

Возбуждает ValueError, если вызван большее количество раз, чем было элементов, помещенных в очередь.

Queue.join()

Блокирует, пока все элементы в очереди не будут извлечены и обработаны.

Счёт незавершенных задач увеличивается при добавлении элемента в очередь. Счёт уменьшается, когда поток-потребитель вызывает task_done(), чтобы указать, что элемент был извлечен и вся работа с ним завершена. Когда счёт незавершенных задач падает до нуля, join() разблокируется.

Пример того, как дождаться завершения задач, помещенных в очередь:

import threading
import queue

q = queue.Queue()

def worker():
    while True:
        item = q.get()
        print(f'Working on {item}')
        print(f'Finished {item}')
        q.task_done()

# Turn-on the worker thread.
threading.Thread(target=worker, daemon=True).start()

# Send thirty task requests to the worker.
for item in range(30):
    q.put(item)

# Block until all tasks are done.
q.join()
print('All work completed')

Объекты SimpleQueue

SimpleQueue объекты предоставляют описанные ниже публичные методы.

SimpleQueue.qsize()

Возвращает приблизительный размер очереди. Обратите внимание, что qsize() > 0 не гарантирует, что последующий вызов get() не заблокируется.

SimpleQueue.empty()

Возвращает True , если очередь пуста, False в противном случае. Если empty() возвращает False, это не гарантирует, что последующий вызов get() не заблокируется.

SimpleQueue.put(item, block=True, timeout=None)

Поместить элемент в очередь. Метод никогда не блокируется и всегда выполняется успешно (за исключением потенциальных ошибок низкого уровня, таких как невозможность выделения памяти). Необязательные аргументы block и timeout игнорируются и предоставляются только для совместимости с Queue.put().

Детали реализации CPython: Этот метод имеет реализацию на C, которая является реентерабельной. То есть вызов put() или get() может быть прерван другим вызовом put() в том же потоке без возникновения тупиковой ситуации или повреждения внутреннего состояния очереди. Это делает его подходящим для использования в деструкторах, таких как методы __del__ или weakref обратные вызовы.

SimpleQueue.put_nowait(item)

Эквивалентно put(item, block=False), предоставлено для совместимости с Queue.put_nowait().

SimpleQueue.get(block=True, timeout=None)

Удалить и вернуть элемент из очереди. Если необязательный аргумент block имеет значение true и timeout равен None (по умолчанию), блокировать, если необходимо, до тех пор, пока элемент не станет доступным. Если timeout — положительное число, блокировать не более timeout секунд и вызвать исключение Empty, если элемент не был доступен в течение этого времени. В противном случае (block ложно), вернуть элемент, если он сразу доступен, иначе вызвать исключение Empty (timeout игнорируется в этом случае).

SimpleQueue.get_nowait()

Эквивалентно get(False).