# 8.10. `Queue` — A synchronized queue class

注解

The `Queue` module has been renamed to `queue` in Python 3. The 2to3 tool will automatically adapt imports when converting your sources to Python 3.

Source code: Lib/Queue.py

The `Queue` module implements multi-producer, multi-consumer queues. It is especially useful in threaded programming when information must be exchanged safely between multiple threads. The `Queue` class in this module implements all the required locking semantics. It depends on the availability of thread support in Python; see the `threading` module.

The module implements three types of queue, which differ only in the order in which the entries are retrieved. In a FIFO queue, the first tasks added are the first retrieved. In a LIFO queue, the most recently added entry is the first retrieved (operating like a stack). With a priority queue, the entries are kept sorted (using the `heapq` module) and the lowest valued entry is retrieved first.

The `Queue` module defines the following classes and exceptions:

class `Queue.``Queue`(maxsize=0)

  Constructor for a FIFO queue. maxsize is an integer that sets the upperbound limit on the number of items that can be placed in the queue. Insertion will block once this size has been reached, until queue items are consumed. If maxsize is less than or equal to zero, the queue size is infinite.

class `Queue.``LifoQueue`(maxsize=0)

  Constructor for a LIFO queue. maxsize is an integer that sets the upperbound limit on the number of items that can be placed in the queue. Insertion will block once this size has been reached, until queue items are consumed. If maxsize is less than or equal to zero, the queue size is infinite.

  2.6 新版功能.

class `Queue.``PriorityQueue`(maxsize=0)

  优先级队列构造函数。 maxsize 是个整数，用于设置可以放入队列中的项目数的上限。当达到这个大小的时候，插入操作将阻塞至队列中的项目被消费掉。如果 maxsize 小于等于零，队列尺寸为无限大。

  最小值先被取出( 最小值条目是由 `sorted(list(entries))[0]` 返回的条目)。条目的典型模式是一个以下形式的元组： `(priority_number, data)` 。

  2.6 新版功能.

exception `Queue.``Empty`

  Exception raised when non-blocking `get()` (or `get_nowait()`) is called on a `Queue` object which is empty.

exception `Queue.``Full`

  Exception raised when non-blocking `put()` (or `put_nowait()`) is called on a `Queue` object which is full.

参见

`collections.deque` is an alternative implementation of unbounded queues with fast atomic `append()` and `popleft()` operations that do not require locking.

## 8.10.1. Queue对象

Queue objects (`Queue`, `LifoQueue`, or `PriorityQueue`) provide the public methods described below.

`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[, timeout]])

  将 item 放入队列。如果可选参数 block 是 true 并且 timeout 是 `None` (默认)，则在必要时阻塞至有空闲插槽可用。如果 timeout 是个正数，将最多阻塞 timeout 秒，如果在这段时间没有可用的空闲插槽，将引发 `Full` 异常。反之 (block 是 false)，如果空闲插槽立即可用，则把 item 放入队列，否则引发 `Full` 异常 ( 在这种情况下，timeout 将被忽略)。

  2.3 新版功能: The timeout parameter.

`Queue.``put_nowait`(item)

  相当于 `put(item, False)` 。

`Queue.``get`([block[, timeout]])

  从队列中移除并返回一个项目。如果可选参数 block 是 true 并且 timeout 是 `None` (默认值)，则在必要时阻塞至项目可得到。如果 timeout 是个正数，将最多阻塞 timeout 秒，如果在这段时间内项目不能得到，将引发 `Empty` 异常。反之 (block 是 false) , 如果一个项目立即可得到，则返回一个项目，否则引发 `Empty` 异常 (这种情况下，timeout 将被忽略)。

  2.3 新版功能: The timeout parameter.

`Queue.``get_nowait`()

  相当于 `get(False)` 。

提供了两个方法，用于支持跟踪 排队的任务 是否 被守护的消费者线程 完整的处理。

`Queue.``task_done`()

  表示前面排队的任务已经被完成。被队列的消费者线程使用。每个 `get()` 被用于获取一个任务， 后续调用 `task_done()` 告诉队列，该任务的处理已经完成。

  如果 `join()` 当前正在阻塞，在所有条目都被处理后，将解除阻塞(意味着每个 `put()` 进队列的条目的 `task_done()` 都被收到)。

  如果被调用的次数多于放入队列中的项目数量，将引发 `ValueError` 异常 。

  2.5 新版功能.

`Queue.``join`()

  阻塞至队列中所有的元素都被接收和处理完毕。

  当条目添加到队列的时候，未完成任务的计数就会增加。每当消费者线程调用 `task_done()` 表示这个条目已经被回收，该条目所有工作已经完成，未完成计数就会减少。当未完成计数降到零的时候， `join()` 阻塞被解除。

  2.5 新版功能.

如何等待排队的任务被完成的示例：

    def worker():
        while True:
            item = q.get()
            do_work(item)
            q.task_done()

    q = Queue()
    for i in range(num_worker_threads):
         t = Thread(target=worker)
         t.daemon = True
         t.start()

    for item in source():
        q.put(item)

    q.join()       # block until all tasks are done