Python Library Reference

7.8.1 Queue Objects

Class Queue implements queue objects and has the methods described below. This class can be derived from in order to implement other queue organizations (e.g. stack) but the inheritable interface is not described here. See the source code for details. The public methods are:

qsize(

)

Return the approximate size of the queue. Because of multithreading semantics, this number is not reliable.

empty(

)

Return True if the queue is empty, False otherwise. Because of multithreading semantics, this is not reliable.

full(

)

Return True if the queue is full, False otherwise. Because of multithreading semantics, this is not reliable.

put(	item[, block[, timeout]])

Put item into the queue. If optional args block is true and timeout is None (the default), block if necessary until a free slot is available. If timeout is a positive number, it blocks at most timeout seconds and raises the Full exception if no free slot was available within that time. Otherwise (block is false), put an item on the queue if a free slot is immediately available, else raise the Full exception (timeout is ignored in that case).

New in version 2.3: the timeout parameter.

put_nowait(

item)

Equivalent to put(item, False).

get(	[block[, timeout]])

Remove and return an item from the queue. If optional args block is true and timeout is None (the default), block if necessary until an item is available. If timeout is a positive number, it blocks at most timeout seconds and raises the Empty exception if no item was available within that time. Otherwise (block is false), return an item if one is immediately available, else raise the Empty exception (timeout is ignored in that case).

New in version 2.3: the timeout parameter.

get_nowait(

)

Equivalent to get(False).

Python Library Reference

Previous: 7.8 Queue Up: 7.8 Queue Next: 7.9 mmap

Release 2.4c1, documentation updated on 18 November 2004.