qp.core.queuing.AnnotatedQueue

class AnnotatedQueue[source]

Bases: OrderedDict

Lightweight class that maintains a basic queue of operations, in addition to metadata annotations.

queue

Returns a list of objects in the annotated queue

queue

Returns a list of objects in the annotated queue

append(obj, **kwargs)

Append obj into the queue with kwargs metadata.

clear()

copy()

fromkeys(iterable[, value])

Create a new ordered dictionary with keys from iterable and values set to value.

get(key[, default])

Return the value for key if key is in the dictionary, else default.

get_info(obj)

Retrieve the metadata for obj.

items()

keys()

move_to_end(key[, last])

Move an existing element to the end (or beginning if last is false).

pop(key[,default])

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem([last])

Remove and return a (key, value) pair from the dictionary.

remove(obj)

Remove obj from the queue.

setdefault(key[, default])

Insert key with a value of default if key is not in the dictionary.

update([E, ]**F)

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

update_info(obj, **kwargs)

Update obj's metadata with kwargs if it exists in the queue.

values()

append(obj, **kwargs)[source]

Append obj into the queue with kwargs metadata.

clear() → None.  Remove all items from od.
copy() → a shallow copy of od
classmethod fromkeys(iterable, value=None)

Create a new ordered dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

get_info(obj)[source]

Retrieve the metadata for obj. Raises a QueuingError if obj is not in the queue.

items() → a set-like object providing a view on D's items[source]
keys() → a set-like object providing a view on D's keys
move_to_end(key, last=True)

Move an existing element to the end (or beginning if last is false).

Raise KeyError if the element does not exist.

pop(key[, default]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem(last=True)

Remove and return a (key, value) pair from the dictionary.

Pairs are returned in LIFO order if last is true or FIFO order if false.

remove(obj)[source]

Remove obj from the queue. Passes silently if the object is not in the queue.

setdefault(key, default=None)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

update_info(obj, **kwargs)[source]

Update obj’s metadata with kwargs if it exists in the queue.

values() → an object providing a view on D's values