This document describes the current stable version of Celery (3.1). For development docs, go here.

celery.datastructures

Custom types and data structures.

AttributeDict

class celery.datastructures.AttributeDict

Dict subclass with attribute access.

class celery.datastructures.AttributeDictMixin

Augment classes with a Mapping interface by adding attribute access.

I.e. d.key -> d[key].

DictAttribute

class celery.datastructures.DictAttribute(obj)

Dict interface to attributes.

obj[k] -> obj.k obj[k] = val -> obj.k = val

get(key, default=None)

items()

iteritems()

iterkeys()

itervalues()

keys()

obj = None

setdefault(key, default)

values()

ConfigurationView

class celery.datastructures.ConfigurationView(changes, defaults)

A view over an applications configuration dicts.

Custom (but older) version of collections.ChainMap.

If the key does not exist in changes, the defaults dicts are consulted.

Parameters:

• changes – Dict containing changes to the configuration.
• defaults – List of dicts containing the default configuration.

add_defaults(d)

changes = None

clear()

Remove all changes, but keep defaults.

defaults = None

first(*keys)

get(key, default=None)

items()

iteritems()

iterkeys()

itervalues()

keys()

setdefault(key, default)

update(*args, **kwargs)

values()

ExceptionInfo

class celery.datastructures.ExceptionInfo(exc_info=None, internal=False)

Exception wrapping an exception and its traceback.

Parameters:exc_info – The exception info tuple as returned by sys.exc_info().

exception = None

Exception instance.

internal = False

Set to true if this is an internal error.

tb = None

Pickleable traceback instance for use with traceback

traceback = None

String representation of the traceback.

type = None

Exception type.

LimitedSet

class celery.datastructures.LimitedSet(maxlen=None, expires=None, data=None, heap=None)

Kind-of Set with limitations.

Good for when you need to test for membership (a in set), but the set should not grow unbounded.

Parameters:

• maxlen – Maximum number of members before we start evicting expired members.
• expires – Time in seconds, before a membership expires.

add(key, now=<built-in function time>, heappush=<built-in function heappush>)

Add a new member.

as_dict()

clear()

Remove all members

discard(value)

Remove membership by finding value.

pop_value(value)

Remove membership by finding value.

purge(limit=None, offset=0, now=<built-in function time>)

Purge expired items.

update(other)

LRUCache

class celery.datastructures.LRUCache(limit=None)

LRU Cache implementation using a doubly linked list to track access.

Parameters:limit – The maximum number of keys to keep in the cache. When a new key is inserted and the limit has been exceeded, the Least Recently Used key will be discarded from the cache.

incr(key, delta=1)

items()

iteritems()

iterkeys()

itervalues()

keys()

popitem(last=True)

update(*args, **kwargs)

values()