celery.registry.html 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Task Registry - celery.registry &mdash; Celery v0.1.15 documentation</title>
  7. <link rel="stylesheet" href="../static/default.css" type="text/css" />
  8. <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../',
  12. VERSION: '0.1.15',
  13. COLLAPSE_MODINDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../static/jquery.js"></script>
  19. <script type="text/javascript" src="../static/doctools.js"></script>
  20. <link rel="top" title="Celery v0.1.15 documentation" href="../index.html" />
  21. <link rel="next" title="Task Discovery - celery.discovery" href="celery.discovery.html" />
  22. <link rel="prev" title="Task Result - celery.result" href="celery.result.html" />
  23. </head>
  24. <body>
  25. <div class="related">
  26. <h3>Navigation</h3>
  27. <ul>
  28. <li class="right" style="margin-right: 10px">
  29. <a href="../genindex.html" title="General Index"
  30. accesskey="I">index</a></li>
  31. <li class="right" >
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |</li>
  34. <li class="right" >
  35. <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
  36. accesskey="N">next</a> |</li>
  37. <li class="right" >
  38. <a href="celery.result.html" title="Task Result - celery.result"
  39. accesskey="P">previous</a> |</li>
  40. <li><a href="../index.html">Celery v0.1.15 documentation</a> &raquo;</li>
  41. </ul>
  42. </div>
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="module-celery.registry">
  48. <h1>Task Registry - celery.registry<a class="headerlink" href="#module-celery.registry" title="Permalink to this headline">¶</a></h1>
  49. <p>celery.registry</p>
  50. <dl class="exception">
  51. <dt id="celery.registry.AlreadyRegistered">
  52. <em class="property">
  53. exception </em><tt class="descclassname">celery.registry.</tt><tt class="descname">AlreadyRegistered</tt><a class="headerlink" href="#celery.registry.AlreadyRegistered" title="Permalink to this definition">¶</a></dt>
  54. <dd>The task is already registered.</dd></dl>
  55. <dl class="exception">
  56. <dt id="celery.registry.NotRegistered">
  57. <em class="property">
  58. exception </em><tt class="descclassname">celery.registry.</tt><tt class="descname">NotRegistered</tt><a class="headerlink" href="#celery.registry.NotRegistered" title="Permalink to this definition">¶</a></dt>
  59. <dd>The task is not registered.</dd></dl>
  60. <dl class="class">
  61. <dt id="celery.registry.TaskRegistry">
  62. <em class="property">
  63. class </em><tt class="descclassname">celery.registry.</tt><tt class="descname">TaskRegistry</tt><a class="headerlink" href="#celery.registry.TaskRegistry" title="Permalink to this definition">¶</a></dt>
  64. <dd><p>Site registry for tasks.</p>
  65. <dl class="exception">
  66. <dt id="celery.registry.TaskRegistry.AlreadyRegistered">
  67. <em class="property">
  68. exception </em><tt class="descname">AlreadyRegistered</tt><a class="headerlink" href="#celery.registry.TaskRegistry.AlreadyRegistered" title="Permalink to this definition">¶</a></dt>
  69. <dd>The task is already registered.</dd></dl>
  70. <dl class="exception">
  71. <dt id="celery.registry.TaskRegistry.NotRegistered">
  72. <em class="property">
  73. exception </em><tt class="descclassname">TaskRegistry.</tt><tt class="descname">NotRegistered</tt><a class="headerlink" href="#celery.registry.TaskRegistry.NotRegistered" title="Permalink to this definition">¶</a></dt>
  74. <dd>The task is not registered.</dd></dl>
  75. <dl class="method">
  76. <dt id="celery.registry.TaskRegistry.autodiscover">
  77. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">autodiscover</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.autodiscover" title="Permalink to this definition">¶</a></dt>
  78. <dd>Autodiscover tasks using <tt class="docutils literal"><span class="pre">celery.discovery.autodiscover</span></tt>.</dd></dl>
  79. <dl class="method">
  80. <dt id="celery.registry.TaskRegistry.filter_types">
  81. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">filter_types</tt><big>(</big><em>type</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.filter_types" title="Permalink to this definition">¶</a></dt>
  82. <dd>Return all tasks of a specific type.</dd></dl>
  83. <dl class="method">
  84. <dt id="celery.registry.TaskRegistry.get_all">
  85. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">get_all</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.get_all" title="Permalink to this definition">¶</a></dt>
  86. <dd>Get all task types.</dd></dl>
  87. <dl class="method">
  88. <dt id="celery.registry.TaskRegistry.get_all_periodic">
  89. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">get_all_periodic</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.get_all_periodic" title="Permalink to this definition">¶</a></dt>
  90. <dd>Get all periodic task types.</dd></dl>
  91. <dl class="method">
  92. <dt id="celery.registry.TaskRegistry.get_all_regular">
  93. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">get_all_regular</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.get_all_regular" title="Permalink to this definition">¶</a></dt>
  94. <dd>Get all regular task types.</dd></dl>
  95. <dl class="method">
  96. <dt id="celery.registry.TaskRegistry.get_task">
  97. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">get_task</tt><big>(</big><em>task_name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.get_task" title="Permalink to this definition">¶</a></dt>
  98. <dd>Get task by name.</dd></dl>
  99. <dl class="method">
  100. <dt id="celery.registry.TaskRegistry.register">
  101. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">register</tt><big>(</big><em>task</em>, <em>task_name=None</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.register" title="Permalink to this definition">¶</a></dt>
  102. <dd><p>Register a task in the task registry.</p>
  103. <p>Task can either be a regular function, or a class inheriting
  104. from <a title="celery.task.Task" class="reference external" href="celery.task.html#celery.task.Task"><tt class="xref docutils literal"><span class="pre">celery.task.Task</span></tt></a>.</p>
  105. <p>If the task is a regular function, the <tt class="docutils literal"><span class="pre">task_name</span></tt> argument is
  106. required.</p>
  107. </dd></dl>
  108. <dl class="method">
  109. <dt id="celery.registry.TaskRegistry.unregister">
  110. <tt class="descclassname">TaskRegistry.</tt><tt class="descname">unregister</tt><big>(</big><em>task_name</em><big>)</big><a class="headerlink" href="#celery.registry.TaskRegistry.unregister" title="Permalink to this definition">¶</a></dt>
  111. <dd>Unregister task by name.</dd></dl>
  112. </dd></dl>
  113. <dl class="data">
  114. <dt id="celery.registry.tasks">
  115. <tt class="descclassname">celery.registry.</tt><tt class="descname">tasks</tt><a class="headerlink" href="#celery.registry.tasks" title="Permalink to this definition">¶</a></dt>
  116. <dt>
  117. <tt class="descname">The global task registry.</tt></dt>
  118. <dd></dd></dl>
  119. </div>
  120. </div>
  121. </div>
  122. </div>
  123. <div class="sphinxsidebar">
  124. <div class="sphinxsidebarwrapper">
  125. <h4>Previous topic</h4>
  126. <p class="topless"><a href="celery.result.html"
  127. title="previous chapter">Task Result - celery.result</a></p>
  128. <h4>Next topic</h4>
  129. <p class="topless"><a href="celery.discovery.html"
  130. title="next chapter">Task Discovery - celery.discovery</a></p>
  131. <h3>This Page</h3>
  132. <ul class="this-page-menu">
  133. <li><a href="../sources/reference/celery.registry.txt"
  134. rel="nofollow">Show Source</a></li>
  135. </ul>
  136. <div id="searchbox" style="display: none">
  137. <h3>Quick search</h3>
  138. <form class="search" action="../search.html" method="get">
  139. <input type="text" name="q" size="18" />
  140. <input type="submit" value="Go" />
  141. <input type="hidden" name="check_keywords" value="yes" />
  142. <input type="hidden" name="area" value="default" />
  143. </form>
  144. <p class="searchtip" style="font-size: 90%">
  145. Enter search terms or a module, class or function name.
  146. </p>
  147. </div>
  148. <script type="text/javascript">$('#searchbox').show(0);</script>
  149. </div>
  150. </div>
  151. <div class="clearer"></div>
  152. </div>
  153. <div class="related">
  154. <h3>Navigation</h3>
  155. <ul>
  156. <li class="right" style="margin-right: 10px">
  157. <a href="../genindex.html" title="General Index"
  158. >index</a></li>
  159. <li class="right" >
  160. <a href="../modindex.html" title="Global Module Index"
  161. >modules</a> |</li>
  162. <li class="right" >
  163. <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
  164. >next</a> |</li>
  165. <li class="right" >
  166. <a href="celery.result.html" title="Task Result - celery.result"
  167. >previous</a> |</li>
  168. <li><a href="../index.html">Celery v0.1.15 documentation</a> &raquo;</li>
  169. </ul>
  170. </div>
  171. <div class="footer">
  172. &copy; Copyright 2009, Ask Solem.
  173. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  174. </div>
  175. </body>
  176. </html>