celery.loaders.base.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  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>Loader Base Classes - celery.loaders.base &mdash; Celery v0.7.0 (unstable) documentation</title>
  7. <link rel="stylesheet" href="../static/nature.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.7.0 (unstable)',
  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.7.0 (unstable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Default Loader - celery.loaders.default" href="celery.loaders.default.html" />
  23. <link rel="prev" title="Loaders - celery.loaders" href="celery.loaders.html" />
  24. </head>
  25. <body>
  26. <div class="related">
  27. <h3>Navigation</h3>
  28. <ul>
  29. <li class="right" style="margin-right: 10px">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a></li>
  32. <li class="right" >
  33. <a href="../modindex.html" title="Global Module Index"
  34. accesskey="M">modules</a> |</li>
  35. <li class="right" >
  36. <a href="celery.loaders.default.html" title="Default Loader - celery.loaders.default"
  37. accesskey="N">next</a> |</li>
  38. <li class="right" >
  39. <a href="celery.loaders.html" title="Loaders - celery.loaders"
  40. accesskey="P">previous</a> |</li>
  41. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  42. <li><a href="index.html" accesskey="U">Module API Reference</a> &raquo;</li>
  43. </ul>
  44. </div>
  45. <div class="document">
  46. <div class="documentwrapper">
  47. <div class="bodywrapper">
  48. <div class="body">
  49. <div class="section" id="module-celery.loaders.base">
  50. <h1>Loader Base Classes - celery.loaders.base<a class="headerlink" href="#module-celery.loaders.base" title="Permalink to this headline">¶</a></h1>
  51. <dl class="class">
  52. <dt id="celery.loaders.base.BaseLoader">
  53. <em class="property">
  54. class </em><tt class="descclassname">celery.loaders.base.</tt><tt class="descname">BaseLoader</tt><a class="headerlink" href="#celery.loaders.base.BaseLoader" title="Permalink to this definition">¶</a></dt>
  55. <dd><p>The base class for loaders.</p>
  56. <p>Loaders handles to following things:</p>
  57. <ul>
  58. <li><p class="first">Reading celery client/worker configurations.</p>
  59. </li>
  60. <li><dl class="first docutils">
  61. <dt>What happens when a task starts?</dt>
  62. <dd><p class="first last">See <a title="celery.loaders.base.BaseLoader.on_task_init" class="reference internal" href="#celery.loaders.base.BaseLoader.on_task_init"><tt class="xref docutils literal"><span class="pre">on_task_init()</span></tt></a>.</p>
  63. </dd>
  64. </dl>
  65. </li>
  66. <li><dl class="first docutils">
  67. <dt>What happens when the worker starts?</dt>
  68. <dd><p class="first last">See <a title="celery.loaders.base.BaseLoader.on_worker_init" class="reference internal" href="#celery.loaders.base.BaseLoader.on_worker_init"><tt class="xref docutils literal"><span class="pre">on_worker_init()</span></tt></a>.</p>
  69. </dd>
  70. </dl>
  71. </li>
  72. <li><p class="first">What modules are imported to find tasks?</p>
  73. </li>
  74. </ul>
  75. <dl class="attribute">
  76. <dt id="celery.loaders.base.BaseLoader.conf">
  77. <tt class="descname">conf</tt><a class="headerlink" href="#celery.loaders.base.BaseLoader.conf" title="Permalink to this definition">¶</a></dt>
  78. <dd>Loader configuration.</dd></dl>
  79. <dl class="method">
  80. <dt id="celery.loaders.base.BaseLoader.on_task_init">
  81. <tt class="descname">on_task_init</tt><big>(</big><em>task_id</em>, <em>task</em><big>)</big><a class="headerlink" href="#celery.loaders.base.BaseLoader.on_task_init" title="Permalink to this definition">¶</a></dt>
  82. <dd>This method is called before a task is executed.</dd></dl>
  83. <dl class="method">
  84. <dt id="celery.loaders.base.BaseLoader.on_worker_init">
  85. <tt class="descname">on_worker_init</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.loaders.base.BaseLoader.on_worker_init" title="Permalink to this definition">¶</a></dt>
  86. <dd>This method is called when the worker (<tt class="docutils literal"><span class="pre">celeryd</span></tt>) starts.</dd></dl>
  87. </dd></dl>
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <div class="sphinxsidebar">
  93. <div class="sphinxsidebarwrapper">
  94. <h4>Previous topic</h4>
  95. <p class="topless"><a href="celery.loaders.html"
  96. title="previous chapter">Loaders - celery.loaders</a></p>
  97. <h4>Next topic</h4>
  98. <p class="topless"><a href="celery.loaders.default.html"
  99. title="next chapter">Default Loader - celery.loaders.default</a></p>
  100. <h3>This Page</h3>
  101. <ul class="this-page-menu">
  102. <li><a href="../sources/reference/celery.loaders.base.txt"
  103. rel="nofollow">Show Source</a></li>
  104. </ul>
  105. <div id="searchbox" style="display: none">
  106. <h3>Quick search</h3>
  107. <form class="search" action="../search.html" method="get">
  108. <input type="text" name="q" size="18" />
  109. <input type="submit" value="Go" />
  110. <input type="hidden" name="check_keywords" value="yes" />
  111. <input type="hidden" name="area" value="default" />
  112. </form>
  113. <p class="searchtip" style="font-size: 90%">
  114. Enter search terms or a module, class or function name.
  115. </p>
  116. </div>
  117. <script type="text/javascript">$('#searchbox').show(0);</script>
  118. </div>
  119. </div>
  120. <div class="clearer"></div>
  121. </div>
  122. <div class="related">
  123. <h3>Navigation</h3>
  124. <ul>
  125. <li class="right" style="margin-right: 10px">
  126. <a href="../genindex.html" title="General Index"
  127. >index</a></li>
  128. <li class="right" >
  129. <a href="../modindex.html" title="Global Module Index"
  130. >modules</a> |</li>
  131. <li class="right" >
  132. <a href="celery.loaders.default.html" title="Default Loader - celery.loaders.default"
  133. >next</a> |</li>
  134. <li class="right" >
  135. <a href="celery.loaders.html" title="Loaders - celery.loaders"
  136. >previous</a> |</li>
  137. <li><a href="../index.html">Celery v0.7.0 (unstable) documentation</a> &raquo;</li>
  138. <li><a href="index.html" >Module API Reference</a> &raquo;</li>
  139. </ul>
  140. </div>
  141. <div class="footer">
  142. &copy; Copyright 2009, Ask Solem.
  143. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
  144. </div>
  145. </body>
  146. </html>