sqlalchemy.util.queue.Queue

class documentation

class Queue(QueueCommon[_T]): (source)

Undocumented

Method	`__init__`	Initialize a queue object with a given maximum size.
Method	`empty`	Return True if the queue is empty, False otherwise (not reliable!).
Method	`full`	Return True if the queue is full, False otherwise (not reliable!).
Method	`get`	Remove and return an item from the queue.
Method	`get_nowait`	Remove and return an item from the queue without blocking.
Method	`put`	Put an item into the queue.
Method	`put_nowait`	Put an item into the queue without blocking.
Method	`qsize`	Return the approximate size of the queue (not reliable!).
Instance Variable	`maxsize`	Undocumented
Instance Variable	`mutex`	Undocumented
Instance Variable	`not_empty`	Undocumented
Instance Variable	`not_full`	Undocumented
Instance Variable	`queue`	Undocumented
Instance Variable	`use_lifo`	Undocumented
Method	`_empty`	Undocumented
Method	`_full`	Undocumented
Method	`_get`	Undocumented
Method	`_init`	Undocumented
Method	`_put`	Undocumented
Method	`_qsize`	Undocumented

def __init__(self, maxsize: int = 0, use_lifo: bool = False): (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.__init__

Initialize a queue object with a given maximum size. If `maxsize` is <= 0, the queue size is infinite. If `use_lifo` is True, this Queue acts like a Stack (LIFO).

def empty(self) -> bool: (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.empty

Return True if the queue is empty, False otherwise (not reliable!).

def full(self) -> bool: (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.full

Return True if the queue is full, False otherwise (not reliable!).

def get(self, block: bool = True, timeout: Optional[float] = None) -> _T: (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.get

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

def get_nowait(self) -> _T: (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.get_nowait

Remove and return an item from the queue without blocking. Only get an item if one is immediately available. Otherwise raise the ``Empty`` exception.

def put(self, item: _T, block: bool = True, timeout: Optional[float] = None): (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.put

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

def put_nowait(self, item: _T): (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.put_nowait

Put an item into the queue without blocking. Only enqueue the item if a free slot is immediately available. Otherwise raise the ``Full`` exception.

def qsize(self) -> int: (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.qsize

Return the approximate size of the queue (not reliable!).

maxsize = (source) ¶

overrides sqlalchemy.util.queue.QueueCommon.maxsize

Undocumented

mutex = (source) ¶

Undocumented

not_empty = (source) ¶