/usr/share/pyshared/celery/app/amqp.py is in python-celery 2.5.3-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 | # -*- coding: utf-8 -*-
"""
celery.app.amqp
~~~~~~~~~~~~~~~
AMQ related functionality.
:copyright: (c) 2009 - 2012 by Ask Solem.
:license: BSD, see LICENSE for more details.
"""
from __future__ import absolute_import
from datetime import timedelta
from kombu import BrokerConnection, Exchange
from kombu import compat as messaging
from kombu.pools import ProducerPool
from .. import routes as _routes
from .. import signals
from ..utils import cached_property, textindent, uuid
#: List of known options to a Kombu producers send method.
#: Used to extract the message related options out of any `dict`.
MSG_OPTIONS = ("mandatory", "priority", "immediate", "routing_key",
"serializer", "delivery_mode", "compression")
#: Human readable queue declaration.
QUEUE_FORMAT = """
. %(name)s exchange:%(exchange)s (%(exchange_type)s) \
binding:%(binding_key)s
"""
#: Set of exchange names that have already been declared.
_exchanges_declared = set()
#: Set of queue names that have already been declared.
_queues_declared = set()
def extract_msg_options(options, keep=MSG_OPTIONS):
"""Extracts known options to `basic_publish` from a dict,
and returns a new dict."""
return dict((name, options.get(name)) for name in keep)
class Queues(dict):
"""Queue name⇒ declaration mapping.
Celery will consult this mapping to find the options
for any queue by name.
:param queues: Initial mapping.
"""
#: If set, this is a subset of queues to consume from.
#: The rest of the queues are then used for routing only.
_consume_from = None
def __init__(self, queues):
dict.__init__(self)
for queue_name, options in (queues or {}).items():
self.add(queue_name, **options)
def add(self, queue, exchange=None, routing_key=None,
exchange_type="direct", **options):
"""Add new queue.
:param queue: Name of the queue.
:keyword exchange: Name of the exchange.
:keyword routing_key: Binding key.
:keyword exchange_type: Type of exchange.
:keyword \*\*options: Additional declaration options.
"""
q = self[queue] = self.options(exchange, routing_key,
exchange_type, **options)
return q
def options(self, exchange, routing_key,
exchange_type="direct", **options):
"""Creates new option mapping for queue, with required
keys present."""
return dict(options, routing_key=routing_key,
binding_key=routing_key,
exchange=exchange,
exchange_type=exchange_type)
def format(self, indent=0, indent_first=True):
"""Format routing table into string for log dumps."""
active = self.consume_from
if not active:
return ""
info = [QUEUE_FORMAT.strip() % dict(
name=(name + ":").ljust(12), **config)
for name, config in sorted(active.iteritems())]
if indent_first:
return textindent("\n".join(info), indent)
return info[0] + "\n" + textindent("\n".join(info[1:]), indent)
def select_subset(self, wanted, create_missing=True):
"""Select subset of the currently defined queues.
Does not return anything: queues not in `wanted` will
be discarded in-place.
:param wanted: List of wanted queue names.
:keyword create_missing: By default any unknown queues will be
added automatically, but if disabled
the occurrence of unknown queues
in `wanted` will raise :exc:`KeyError`.
"""
acc = {}
for queue in wanted:
try:
options = self[queue]
except KeyError:
if not create_missing:
raise
options = self.options(queue, queue)
acc[queue] = options
self._consume_from = acc
self.update(acc)
@property
def consume_from(self):
if self._consume_from is not None:
return self._consume_from
return self
@classmethod
def with_defaults(cls, queues, default_exchange, default_exchange_type):
"""Alternate constructor that adds default exchange and
exchange type information to queues that does not have any."""
if queues is None:
queues = {}
for opts in queues.values():
opts.setdefault("exchange", default_exchange),
opts.setdefault("exchange_type", default_exchange_type)
opts.setdefault("binding_key", default_exchange)
opts.setdefault("routing_key", opts.get("binding_key"))
return cls(queues)
class TaskPublisher(messaging.Publisher):
auto_declare = False
retry = False
retry_policy = None
def __init__(self, *args, **kwargs):
self.app = kwargs.pop("app")
self.retry = kwargs.pop("retry", self.retry)
self.retry_policy = kwargs.pop("retry_policy",
self.retry_policy or {})
self.utc = kwargs.pop("enable_utc", False)
super(TaskPublisher, self).__init__(*args, **kwargs)
def declare(self):
if self.exchange.name and \
self.exchange.name not in _exchanges_declared:
super(TaskPublisher, self).declare()
_exchanges_declared.add(self.exchange.name)
def _declare_queue(self, name, retry=False, retry_policy={}):
options = self.app.amqp.queues[name]
queue = messaging.entry_to_queue(name, **options)(self.channel)
if retry:
self.connection.ensure(queue, queue.declare, **retry_policy)()
else:
queue.declare()
return queue
def _declare_exchange(self, name, type, retry=False, retry_policy={}):
ex = Exchange(name, type=type, durable=self.durable,
auto_delete=self.auto_delete)(self.channel)
if retry:
return self.connection.ensure(ex, ex.declare, **retry_policy)
return ex.declare()
def delay_task(self, task_name, task_args=None, task_kwargs=None,
countdown=None, eta=None, task_id=None, taskset_id=None,
expires=None, exchange=None, exchange_type=None,
event_dispatcher=None, retry=None, retry_policy=None,
queue=None, now=None, retries=0, chord=None, **kwargs):
"""Send task message."""
connection = self.connection
_retry_policy = self.retry_policy
if retry_policy: # merge default and custom policy
_retry_policy = dict(_retry_policy, **retry_policy)
# declare entities
if queue and queue not in _queues_declared:
entity = self._declare_queue(queue, retry, _retry_policy)
_exchanges_declared.add(entity.exchange.name)
_queues_declared.add(entity.name)
if exchange and exchange not in _exchanges_declared:
self._declare_exchange(exchange,
exchange_type or self.exchange_type, retry, _retry_policy)
_exchanges_declared.add(exchange)
task_id = task_id or uuid()
task_args = task_args or []
task_kwargs = task_kwargs or {}
if not isinstance(task_args, (list, tuple)):
raise ValueError("task args must be a list or tuple")
if not isinstance(task_kwargs, dict):
raise ValueError("task kwargs must be a dictionary")
if countdown: # Convert countdown to ETA.
now = now or self.app.now()
eta = now + timedelta(seconds=countdown)
if isinstance(expires, (int, float)):
now = now or self.app.now()
expires = now + timedelta(seconds=expires)
eta = eta and eta.isoformat()
expires = expires and expires.isoformat()
body = {"task": task_name,
"id": task_id,
"args": task_args or [],
"kwargs": task_kwargs or {},
"retries": retries or 0,
"eta": eta,
"expires": expires,
"utc": self.utc}
if taskset_id:
body["taskset"] = taskset_id
if chord:
body["chord"] = chord
do_retry = retry if retry is not None else self.retry
send = self.send
if do_retry:
send = connection.ensure(self, self.send, **_retry_policy)
send(body, exchange=exchange, **extract_msg_options(kwargs))
signals.task_sent.send(sender=task_name, **body)
if event_dispatcher:
event_dispatcher.send("task-sent", uuid=task_id,
name=task_name,
args=repr(task_args),
kwargs=repr(task_kwargs),
retries=retries,
eta=eta,
expires=expires)
return task_id
def __exit__(self, *exc_info):
try:
self.release()
except AttributeError:
self.close()
class PublisherPool(ProducerPool):
def __init__(self, app):
self.app = app
super(PublisherPool, self).__init__(self.app.pool,
limit=self.app.pool.limit)
def create_producer(self):
conn = self.connections.acquire(block=True)
pub = self.app.amqp.TaskPublisher(conn, auto_declare=False)
conn._producer_chan = pub.channel
return pub
class AMQP(object):
BrokerConnection = BrokerConnection
Publisher = messaging.Publisher
Consumer = messaging.Consumer
ConsumerSet = messaging.ConsumerSet
#: Cached and prepared routing table.
_rtable = None
def __init__(self, app):
self.app = app
def flush_routes(self):
self._rtable = _routes.prepare(self.app.conf.CELERY_ROUTES)
def Queues(self, queues):
"""Create new :class:`Queues` instance, using queue defaults
from the current configuration."""
conf = self.app.conf
if not queues and conf.CELERY_DEFAULT_QUEUE:
queues = {conf.CELERY_DEFAULT_QUEUE: {
"exchange": conf.CELERY_DEFAULT_EXCHANGE,
"exchange_type": conf.CELERY_DEFAULT_EXCHANGE_TYPE,
"binding_key": conf.CELERY_DEFAULT_ROUTING_KEY}}
return Queues.with_defaults(queues, conf.CELERY_DEFAULT_EXCHANGE,
conf.CELERY_DEFAULT_EXCHANGE_TYPE)
def Router(self, queues=None, create_missing=None):
"""Returns the current task router."""
return _routes.Router(self.routes, queues or self.queues,
self.app.either("CELERY_CREATE_MISSING_QUEUES",
create_missing), app=self.app)
def TaskConsumer(self, *args, **kwargs):
"""Returns consumer for a single task queue."""
default_queue_name, default_queue = self.get_default_queue()
defaults = dict({"queue": default_queue_name}, **default_queue)
defaults["routing_key"] = defaults.pop("binding_key", None)
return self.Consumer(*args,
**self.app.merge(defaults, kwargs))
def TaskPublisher(self, *args, **kwargs):
"""Returns publisher used to send tasks.
You should use `app.send_task` instead.
"""
conf = self.app.conf
_, default_queue = self.get_default_queue()
defaults = {"exchange": default_queue["exchange"],
"exchange_type": default_queue["exchange_type"],
"routing_key": conf.CELERY_DEFAULT_ROUTING_KEY,
"serializer": conf.CELERY_TASK_SERIALIZER,
"compression": conf.CELERY_MESSAGE_COMPRESSION,
"retry": conf.CELERY_TASK_PUBLISH_RETRY,
"retry_policy": conf.CELERY_TASK_PUBLISH_RETRY_POLICY,
"enable_utc": conf.CELERY_ENABLE_UTC,
"app": self.app}
return TaskPublisher(*args, **self.app.merge(defaults, kwargs))
def get_task_consumer(self, connection, queues=None, **kwargs):
"""Return consumer configured to consume from all known task
queues."""
return self.ConsumerSet(connection,
from_dict=queues or self.queues.consume_from,
**kwargs)
def get_default_queue(self):
"""Returns `(queue_name, queue_options)` tuple for the queue
configured to be default (:setting:`CELERY_DEFAULT_QUEUE`)."""
q = self.app.conf.CELERY_DEFAULT_QUEUE
return q, self.queues[q]
@cached_property
def queues(self):
"""Queue name⇒ declaration mapping."""
return self.Queues(self.app.conf.CELERY_QUEUES)
@property
def routes(self):
if self._rtable is None:
self.flush_routes()
return self._rtable
@cached_property
def publisher_pool(self):
return PublisherPool(self.app)
|