routes.py 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. # -*- coding: utf-8 -*-
  2. """
  3. celery.routes
  4. ~~~~~~~~~~~~~
  5. Contains utilities for working with task routers,
  6. (:setting:`CELERY_ROUTES`).
  7. """
  8. from __future__ import absolute_import
  9. from celery.exceptions import QueueNotFound
  10. from celery.five import string_t
  11. from celery.utils import lpmerge
  12. from celery.utils.functional import firstmethod, mlazy
  13. from celery.utils.imports import instantiate
  14. __all__ = ['MapRoute', 'Router', 'prepare']
  15. _first_route = firstmethod('route_for_task')
  16. class MapRoute(object):
  17. """Creates a router out of a :class:`dict`."""
  18. def __init__(self, map):
  19. self.map = map
  20. def route_for_task(self, task, *args, **kwargs):
  21. route = self.map.get(task)
  22. if route:
  23. return dict(route)
  24. class Router(object):
  25. def __init__(self, routes=None, queues=None,
  26. create_missing=False, app=None):
  27. self.app = app
  28. self.queues = {} if queues is None else queues
  29. self.routes = [] if routes is None else routes
  30. self.create_missing = create_missing
  31. def route(self, options, task, args=(), kwargs={}):
  32. options = self.expand_destination(options) # expands 'queue'
  33. if self.routes:
  34. route = self.lookup_route(task, args, kwargs)
  35. if route: # expands 'queue' in route.
  36. return lpmerge(self.expand_destination(route), options)
  37. if 'queue' not in options:
  38. options = lpmerge(self.expand_destination(
  39. self.app.conf.CELERY_DEFAULT_QUEUE), options)
  40. return options
  41. def expand_destination(self, route):
  42. # Route can be a queue name: convenient for direct exchanges.
  43. if isinstance(route, string_t):
  44. queue, route = route, {}
  45. else:
  46. # can use defaults from configured queue, but override specific
  47. # things (like the routing_key): great for topic exchanges.
  48. queue = route.pop('queue', None)
  49. if queue:
  50. try:
  51. Q = self.queues[queue] # noqa
  52. except KeyError:
  53. raise QueueNotFound(
  54. 'Queue {0!r} missing from CELERY_QUEUES'.format(queue))
  55. # needs to be declared by publisher
  56. route['queue'] = Q
  57. return route
  58. def lookup_route(self, task, args=None, kwargs=None):
  59. return _first_route(self.routes, task, args, kwargs)
  60. def prepare(routes):
  61. """Expands the :setting:`CELERY_ROUTES` setting."""
  62. def expand_route(route):
  63. if isinstance(route, dict):
  64. return MapRoute(route)
  65. if isinstance(route, string_t):
  66. return mlazy(instantiate, route)
  67. return route
  68. if routes is None:
  69. return ()
  70. if not isinstance(routes, (list, tuple)):
  71. routes = (routes, )
  72. return [expand_route(route) for route in routes]