Queue :: Queue :: Class Queue
[hide private]
[frames] | no frames]

Class Queue

source code

Known Subclasses:
threadutils.ThreadPool

Create a queue object with a given maximum size.

If maxsize is <= 0, the queue size is infinite.

Instance Methods [hide private]
 
__init__(self, maxsize=0) source code
 
_empty(self) source code
 
_full(self) source code
 
_get(self) source code
 
_init(self, maxsize) source code
 
_put(self, item) source code
 
_qsize(self) source code
 
empty(self)
Return True if the queue is empty, False otherwise (not reliable!).
source code
 
full(self)
Return True if the queue is full, False otherwise (not reliable!).
source code
 
get(self, block=True, timeout=None)
Remove and return an item from the queue.
source code
 
get_nowait(self)
Remove and return an item from the queue without blocking.
source code
 
join(self)
Blocks until all items in the Queue have been gotten and processed.
source code
 
put(self, item, block=True, timeout=None)
Put an item into the queue.
source code
 
put_nowait(self, item)
Put an item into the queue without blocking.
source code
 
qsize(self)
Return the approximate size of the queue (not reliable!).
source code
 
task_done(self)
Indicate that a formerly enqueued task is complete.
source code
Method Details [hide private]

get(self, block=True, timeout=None)

source code 

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).

get_nowait(self)

source code 

Remove and return an item from the queue without blocking.

Only get an item if one is immediately available. Otherwise raise the Empty exception.

join(self)

source code 

Blocks until all items in the Queue have been gotten and processed.

The count of unfinished tasks goes up whenever an item is added to the queue. The count goes down whenever a consumer thread calls task_done() to indicate the item was retrieved and all work on it is complete.

When the count of unfinished tasks drops to zero, join() unblocks.

put(self, item, block=True, timeout=None)

source code 

Put an 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).

put_nowait(self, item)

source code 

Put an item into the queue without blocking.

Only enqueue the item if a free slot is immediately available. Otherwise raise the Full exception.

task_done(self)

source code 

Indicate that a formerly enqueued task is complete.

Used by Queue consumer threads. For each get() used to fetch a task, a subsequent call to task_done() tells the queue that the processing on the task is complete.

If a join() is currently blocking, it will resume when all items have been processed (meaning that a task_done() call was received for every item that had been put() into the queue).

Raises a ValueError if called more times than there were items placed in the queue.