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



Utilities for safely pickling exceptions.

exception celery.utils.serialization.UnpickleableExceptionWrapper(exc_module, exc_cls_name, exc_args, text=None)[source]

Wraps unpickleable exceptions.



>>> def pickle_it(raising_function):
...     try:
...         raising_function()
...     except Exception as e:
...         exc = UnpickleableExceptionWrapper(
...             e.__class__.__module__,
...             e.__class__.__name__,
...             e.args,
...         )
...         pickle.dumps(exc)  # Works fine.
exc_args = None

The arguments for the original exception.

exc_cls_name = None

The name of the original exception class.

exc_module = None

The module of the original exception.

classmethod from_exception(exc)[source]
celery.utils.serialization.subclass_exception(name, parent, module)[source]
celery.utils.serialization.find_pickleable_exception(exc, loads=<built-in function loads>, dumps=<built-in function dumps>)[source]

With an exception instance, iterate over its super classes (by mro) and find the first super exception that is pickleable. It does not go below Exception (i.e. it skips Exception, BaseException and object). If that happens you should use UnpickleableException instead.

Parameters:exc – An exception instance.

Will return the nearest pickleable parent exception class (except Exception and parents), or if the exception is pickleable it will return None.

:rtype Exception:

celery.utils.serialization.create_exception_cls(name, module, parent=None)[source]

Dynamically create an exception class.


Make sure exception is pickleable.

celery.utils.serialization.get_pickleable_etype(cls, loads=<built-in function loads>, dumps=<built-in function dumps>)[source]

Get original exception from exception pickled using get_pickleable_exception().

Previous topic


Next topic


This Page