cpython/Lib/dos-8x3/queue.py

141 lines
4.0 KiB
Python
Raw Normal View History

# A multi-producer, multi-consumer queue.
1997-11-26 11:44:34 -04:00
# define this exception to be compatible with Python 1.5's class
# exceptions, but also when -X option is used.
try:
class Empty(Exception):
1998-03-26 18:14:20 -04:00
pass
1997-11-26 11:44:34 -04:00
except TypeError:
# string based exceptions
1998-03-26 18:14:20 -04:00
Empty = 'Queue.Empty' # Exception raised by get_nowait()
class Queue:
1997-11-26 11:44:34 -04:00
def __init__(self, maxsize):
1998-03-26 18:14:20 -04:00
"""Initialize a queue object with a given maximum size.
1997-11-26 11:44:34 -04:00
1998-03-26 18:14:20 -04:00
If maxsize is <= 0, the queue size is infinite.
"""
import thread
self._init(maxsize)
self.mutex = thread.allocate_lock()
self.esema = thread.allocate_lock()
1998-08-11 23:38:11 -03:00
self.esema.acquire()
1998-03-26 18:14:20 -04:00
self.fsema = thread.allocate_lock()
1997-11-26 11:44:34 -04:00
def qsize(self):
1998-03-26 18:14:20 -04:00
"""Returns the approximate size of the queue (not reliable!)."""
1998-08-11 23:38:11 -03:00
self.mutex.acquire()
1998-03-26 18:14:20 -04:00
n = self._qsize()
1998-08-11 23:38:11 -03:00
self.mutex.release()
1998-03-26 18:14:20 -04:00
return n
1997-11-26 11:44:34 -04:00
def empty(self):
1998-03-26 18:14:20 -04:00
"""Returns 1 if the queue is empty, 0 otherwise (not reliable!)."""
1998-08-11 23:38:11 -03:00
self.mutex.acquire()
1998-03-26 18:14:20 -04:00
n = self._empty()
1998-08-11 23:38:11 -03:00
self.mutex.release()
1998-03-26 18:14:20 -04:00
return n
1997-11-26 11:44:34 -04:00
def full(self):
1998-03-26 18:14:20 -04:00
"""Returns 1 if the queue is full, 0 otherwise (not reliable!)."""
1998-08-11 23:38:11 -03:00
self.mutex.acquire()
1998-03-26 18:14:20 -04:00
n = self._full()
1998-08-11 23:38:11 -03:00
self.mutex.release()
1998-03-26 18:14:20 -04:00
return n
1997-11-26 11:44:34 -04:00
def put(self, item):
1998-04-09 18:47:39 -03:00
"""Put an item into the queue.
If the queue is full, block until a free slot is avaiable.
"""
1998-08-11 23:38:11 -03:00
self.fsema.acquire()
self.mutex.acquire()
1998-03-26 18:14:20 -04:00
was_empty = self._empty()
self._put(item)
if was_empty:
1998-08-11 23:38:11 -03:00
self.esema.release()
1998-03-26 18:14:20 -04:00
if not self._full():
1998-08-11 23:38:11 -03:00
self.fsema.release()
self.mutex.release()
1997-11-26 11:44:34 -04:00
def get(self):
1998-03-26 18:14:20 -04:00
"""Gets and returns an item from the queue.
1998-04-09 18:47:39 -03:00
1998-03-26 18:14:20 -04:00
This method blocks if necessary until an item is available.
"""
1998-08-11 23:38:11 -03:00
self.esema.acquire()
self.mutex.acquire()
1998-03-26 18:14:20 -04:00
was_full = self._full()
item = self._get()
if was_full:
1998-08-11 23:38:11 -03:00
self.fsema.release()
1998-03-26 18:14:20 -04:00
if not self._empty():
1998-08-11 23:38:11 -03:00
self.esema.release()
self.mutex.release()
1998-03-26 18:14:20 -04:00
return item
1997-11-26 11:44:34 -04:00
# Get an item from the queue if one is immediately available,
# raise Empty if the queue is empty or temporarily unavailable
def get_nowait(self):
1998-03-26 18:14:20 -04:00
"""Gets and returns an item from the queue.
1998-04-09 18:47:39 -03:00
1998-03-26 18:14:20 -04:00
Only gets an item if one is immediately available, Otherwise
this raises the Empty exception if the queue is empty or
temporarily unavailable.
"""
1998-08-11 23:38:11 -03:00
locked = self.esema.acquire(0)
self.mutex.acquire()
1998-03-26 18:14:20 -04:00
if self._empty():
# The queue is empty -- we can't have esema
1998-08-11 23:38:11 -03:00
self.mutex.release()
1998-03-26 18:14:20 -04:00
raise Empty
if not locked:
1998-08-11 23:38:11 -03:00
locked = self.esema.acquire(0)
1998-03-26 18:14:20 -04:00
if not locked:
# Somebody else has esema
# but we have mutex --
# go out of their way
1998-08-11 23:38:11 -03:00
self.mutex.release()
1998-03-26 18:14:20 -04:00
raise Empty
was_full = self._full()
item = self._get()
if was_full:
1998-08-11 23:38:11 -03:00
self.fsema.release()
1998-03-26 18:14:20 -04:00
if not self._empty():
1998-08-11 23:38:11 -03:00
self.esema.release()
self.mutex.release()
1998-03-26 18:14:20 -04:00
return item
1997-11-26 11:44:34 -04:00
# XXX Need to define put_nowait() as well.
# Override these methods to implement other queue organizations
# (e.g. stack or priority queue).
# These will only be called with appropriate locks held
# Initialize the queue representation
def _init(self, maxsize):
1998-03-26 18:14:20 -04:00
self.maxsize = maxsize
self.queue = []
1997-11-26 11:44:34 -04:00
def _qsize(self):
1998-03-26 18:14:20 -04:00
return len(self.queue)
1997-11-26 11:44:34 -04:00
# Check wheter the queue is empty
def _empty(self):
1998-03-26 18:14:20 -04:00
return not self.queue
1997-11-26 11:44:34 -04:00
# Check whether the queue is full
def _full(self):
1998-03-26 18:14:20 -04:00
return self.maxsize > 0 and len(self.queue) == self.maxsize
1997-11-26 11:44:34 -04:00
# Put a new item in the queue
def _put(self, item):
1998-03-26 18:14:20 -04:00
self.queue.append(item)
1997-11-26 11:44:34 -04:00
# Get an item from the queue
def _get(self):
1998-03-26 18:14:20 -04:00
item = self.queue[0]
del self.queue[0]
return item