This document describes the current stable version of Celery (4.0). For development docs, go here.
Source code for celery.app.registry
# -*- coding: utf-8 -*-
"""Registry of available tasks."""
from __future__ import absolute_import, unicode_literals
import inspect
from importlib import import_module
from celery._state import get_current_app
from celery.exceptions import NotRegistered, InvalidTaskError
from celery.five import items
__all__ = ['TaskRegistry']
[docs]class TaskRegistry(dict):
"""Map of registered tasks."""
NotRegistered = NotRegistered
def __missing__(self, key):
raise self.NotRegistered(key)
[docs] def register(self, task):
"""Register a task in the task registry.
The task will be automatically instantiated if not already an
instance. Name must be configured prior to registration.
"""
if task.name is None:
raise InvalidTaskError(
'Task class {0!r} must specify .name attribute'.format(
type(task).__name__))
self[task.name] = inspect.isclass(task) and task() or task
[docs] def unregister(self, name):
"""Unregister task by name.
Arguments:
name (str): name of the task to unregister, or a
:class:`celery.task.base.Task` with a valid `name` attribute.
Raises:
celery.exceptions.NotRegistered: if the task is not registered.
"""
try:
self.pop(getattr(name, 'name', name))
except KeyError:
raise self.NotRegistered(name)
# -- these methods are irrelevant now and will be removed in 4.0
[docs] def filter_types(self, type):
return {name: task for name, task in items(self)
if getattr(task, 'type', 'regular') == type}
def _unpickle_task(name):
return get_current_app().tasks[name]
def _unpickle_task_v2(name, module=None):
if module:
import_module(module)
return get_current_app().tasks[name]