Python中的queue
queue模块
实现了多生产者、多消费者队列,适用于安全地在多线程间交换消息的线程编程。其实现了一个基本的先进先出(FIFO)容器。
queue模块定义了以下类和异常:
python
class queue.Queue(maxsize=0)
FIFO 队列的构造函数。maxsize 是一个整数,用于设置可放入队列中的项数的上限。一旦达到此大小,插入将阻塞,直到队列中的项目被消耗。如果 maxsize 小于或等于零,则队列大小为无限。
python
class queue.LifoQueue(maxsize=0)
LIFO对列构造函数。maxsize是个整数,用于设置可以放入队列中的项目数的上限。当达到这个大小的时候,插入操作将阻塞,直到队列中的项目被消耗。如果 maxsize 小于等于零,队列尺寸为无限大。
python
class queue.PriorityQueue(maxsize=0)
优先级队列构造函数。 maxsize 是个整数,用于设置可以放入队列中的项目数的上限。当达到这个大小的时候,插入操作将阻塞,直到队列中的项目被消耗。如果 maxsize 小于等于零,队列尺寸为无限大。
python
class queue.SimpleQueue
无界的 FIFO 队列构造函数。简单的队列,缺少任务跟踪等高级功能。
python
exception queue.Empty
对空的 Queue 对象,调用非阻塞的 get() (or get_nowait()) 时,引发的异常。
python
exception queue.Full
对满的 Queue 对象,调用非阻塞的 put() (or put_nowait()) 时,引发的异常。
队列对象(Queue、LifoQueue、PriorityQueue)提供下列描述的公共方法
python
Queue.qsize()
返回队列的大致大小。注意,qsize() > 0 不保证后续的 get() 不被阻塞,qsize() < maxsize 也不保证 put() 不被阻塞。
python
Queue.empty()
如果队列为空,返回 True ,否则返回 False 。返回 True ,不保证后续调用 的put() 不被阻塞。返回 False ,不保证后续调用的 get() 不被阻塞。
python
Queue.full()
如果队列是满的返回 True ,否则返回 False 。True 不保证后续调用的 get() 不被阻塞。False 不保证后续调用的 put() 不被阻塞。
python
Queue.put(item, block=True, timeout=None)
将 item 放入队列。如果可选参数 block 是 true 并且 timeout 是 None (默认),则在必要时阻塞至有空闲插槽可用。如果 timeout 是个正数,将最多阻塞 timeout 秒,如果在这段时间没有可用的空闲插槽,将引发 Full 异常。反之 (block 是 false),如果空闲插槽立即可用,则把 item 放入队列,否则引发 Full 异常 ( 在这种情况下,timeout 将被忽略)。
python
Queue.put_nowait(item)
相当于 put(item, False) 。
python
Queue.get(block=True, timeout=None)
从队列中移除并返回一个项目。如果可选参数 block 是 true 并且 timeout 是 None (默认值),则在必要时阻塞至项目可得到。如果 timeout 是个正数,将最多阻塞 timeout 秒,如果在这段时间内项目不能得到,将引发 Empty 异常。反之 (block 是 false) , 如果一个项目立即可得到,则返回一个项目,否则引发 Empty 异常 (这种情况下,timeout 将被忽略)。
POSIX系统3.0之前,以及所有版本的Windows系统中,如果 block 是 true 并且 timeout 是 None , 这个操作将进入基础锁的不间断等待。这意味着,没有异常能发生,尤其是 SIGINT 将不会触发 KeyboardInterrupt 异常。
python
Queue.get_nowait()
相当于 get(False) 。
提供了两个方法,用于支持跟踪 排队的任务 是否 被守护的消费者线程 完整的处理。
python
Queue.task_done()
表示前面排队的任务已经被完成。被队列的消费者线程使用。每个 get() 被用于获取一个任务, 后续调用 task_done() 告诉队列,该任务的处理已经完成。
如果 join() 当前正在阻塞,在所有条目都被处理后,将解除阻塞(意味着每个 put() 进队列的条目的 task_done() 都被收到)。
如果被调用的次数多于放入队列中的项目数量,将引发 ValueError 异常 。
python
Queue.join()
阻塞至队列中所有的元素都被接收和处理完毕。
当条目添加到队列的时候,未完成任务的计数就会增加。每当消费者线程调用 task_done() 表示这个条目已经被回收,该条目所有工作已经完成,未完成计数就会减少。当未完成计数降到零的时候, join() 阻塞被解除。
QQueue
源自Qt框架,是一个C++实现的队列类,继承自QList,因此可以方便地利用QList的功能实现队列的基本操作,是一个先进先出(FIFO)的队列,用于存储具有相同类型的数据。提供了以下一些常用接口:
QQueue()
:构造函数,创建一个空的队列。
~QQueue()
:析构函数,销毁队列及其所有元素。
void enqueue(const T &value)
:将值value添加到队列的末尾。
T dequeue()
:从队列的头部移除并返回第一个元素。如果队列为空,这个函数的行为是未定义的。
T &head()
:返回队列头部元素的引用。如果队列为空,这个函数的行为是未定义的。
const T &head() const
:返回队列头部元素的只读引用。如果队列为空,这个函数的行为是未定义的。
bool isEmpty() const
:返回队列是否为空的布尔值。
int size() const
:返回队列中的元素个数。
void clear()
:清空队列中的所有元素。
bool contains(const T &value) const
:检查队列是否包含特定值value。
int count(const T &value) const
:返回队列中特定值value的个数。
T &first()
:返回队列中第一个元素的引用。如果队列为空,这个函数的行为是未定义的。
const T &first() const
:返回队列中第一个元素的只读引用。如果队列为空,这个函数的行为是未定义的。
T &last()
:返回队列中最后一个元素的引用。如果队列为空,这个函数的行为是未定义的。
const T &last() const
:返回队列中最后一个元素的只读引用。如果队列为空,这个函数的行为是未定义的。