celery.rst 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. .. currentmodule:: celery
  2. .. automodule:: celery
  3. .. contents::
  4. :local:
  5. Application
  6. -----------
  7. .. autoclass:: Celery
  8. .. attribute:: main
  9. Name of the `__main__` module. Required for standalone scripts.
  10. If set this will be used instead of `__main__` when automatically
  11. generating task names.
  12. .. autoattribute:: conf
  13. .. autoattribute:: amqp
  14. .. autoattribute:: backend
  15. .. autoattribute:: loader
  16. .. autoattribute:: control
  17. .. autoattribute:: events
  18. .. autoattribute:: log
  19. .. autoattribute:: tasks
  20. .. autoattribute:: pool
  21. .. autoattribute:: Task
  22. .. automethod:: bugreport
  23. .. automethod:: config_from_object
  24. .. automethod:: config_from_envvar
  25. .. automethod:: config_from_cmdline
  26. .. automethod:: start
  27. .. automethod:: task
  28. .. automethod:: send_task
  29. .. autoattribute:: AsyncResult
  30. .. autoattribute:: TaskSetResult
  31. .. automethod:: worker_main
  32. .. autoattribute:: Worker
  33. .. autoattribute:: WorkController
  34. .. autoattribute:: Beat
  35. .. automethod:: broker_connection
  36. .. automethod:: default_connection
  37. .. automethod:: mail_admins
  38. .. automethod:: prepare_config
  39. .. automethod:: select_queues
  40. .. automethod:: now
  41. .. automethod:: set_current
  42. .. automethod:: finalize
  43. .. autoattribute:: Pickler
  44. Grouping Tasks
  45. --------------
  46. .. autofunction:: group
  47. .. autofunction:: chain
  48. .. autofunction:: chord
  49. .. autofunction:: subtask
  50. Proxies
  51. -------
  52. .. data:: current_app
  53. The currently set app for this thread.
  54. .. data:: current_task
  55. The task currently being executed
  56. (only set in the worker, or when eager/apply is used).