celery.datastructures.html 11 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>Datastructures - celery.datastructures &mdash; Celery v0.3.2 (unstable) documentation</title>
  7. <link rel="stylesheet" href="../static/agogo.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.3.2 (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.3.2 (unstable) documentation" href="../index.html" />
  21. <link rel="up" title="Module API Reference" href="index.html" />
  22. <link rel="next" title="Logging - celery.log" href="celery.log.html" />
  23. <link rel="prev" title="Configuration - celery.conf" href="celery.conf.html" />
  24. </head>
  25. <body>
  26. <div class="header-wrapper">
  27. <div class="header">
  28. <h1><a href="../index.html">Celery v0.3.2 (unstable) documentation</a></h1>
  29. <div class="rel">
  30. <a href="../genindex.html" title="General Index"
  31. accesskey="I">index</a> |
  32. <a href="../modindex.html" title="Global Module Index"
  33. accesskey="M">modules</a> |
  34. <a href="celery.log.html" title="Logging - celery.log"
  35. accesskey="N">next</a> |
  36. <a href="celery.conf.html" title="Configuration - celery.conf"
  37. accesskey="P">previous</a>
  38. </div>
  39. </div>
  40. </div>
  41. <div class="content-wrapper">
  42. <div class="content">
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="module-celery.datastructures">
  48. <h1>Datastructures - celery.datastructures<a class="headerlink" href="#module-celery.datastructures" title="Permalink to this headline">¶</a></h1>
  49. <p>Custom Datastructures</p>
  50. <dl class="class">
  51. <dt id="celery.datastructures.ExceptionInfo">
  52. <em class="property">
  53. class </em><tt class="descclassname">celery.datastructures.</tt><tt class="descname">ExceptionInfo</tt><big>(</big><em>exc_info</em><big>)</big><a class="headerlink" href="#celery.datastructures.ExceptionInfo" title="Permalink to this definition">¶</a></dt>
  54. <dd><p>Exception wrapping an exception and its traceback.</p>
  55. <table class="docutils field-list" frame="void" rules="none">
  56. <col class="field-name" />
  57. <col class="field-body" />
  58. <tbody valign="top">
  59. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>exc_info</em> &#8211; The exception tuple info as returned by
  60. <tt class="xref docutils literal"><span class="pre">traceback.format_exception()</span></tt>.</td>
  61. </tr>
  62. </tbody>
  63. </table>
  64. <dl class="attribute">
  65. <dt id="celery.datastructures.ExceptionInfo.exception">
  66. <tt class="descname">exception</tt><a class="headerlink" href="#celery.datastructures.ExceptionInfo.exception" title="Permalink to this definition">¶</a></dt>
  67. <dd>The original exception.</dd></dl>
  68. <dl class="attribute">
  69. <dt id="celery.datastructures.ExceptionInfo.traceback">
  70. <tt class="descname">traceback</tt><a class="headerlink" href="#celery.datastructures.ExceptionInfo.traceback" title="Permalink to this definition">¶</a></dt>
  71. <dd>A traceback from the point when <a title="celery.datastructures.ExceptionInfo.exception" class="reference internal" href="#celery.datastructures.ExceptionInfo.exception"><tt class="xref docutils literal"><span class="pre">exception</span></tt></a> was raised.</dd></dl>
  72. </dd></dl>
  73. <dl class="class">
  74. <dt id="celery.datastructures.PositionQueue">
  75. <em class="property">
  76. class </em><tt class="descclassname">celery.datastructures.</tt><tt class="descname">PositionQueue</tt><big>(</big><em>length</em><big>)</big><a class="headerlink" href="#celery.datastructures.PositionQueue" title="Permalink to this definition">¶</a></dt>
  77. <dd><p>A positional queue of a specific length, with slots that are either
  78. filled or unfilled. When all of the positions are filled, the queue
  79. is considered <a title="celery.datastructures.PositionQueue.full" class="reference internal" href="#celery.datastructures.PositionQueue.full"><tt class="xref docutils literal"><span class="pre">full()</span></tt></a>.</p>
  80. <table class="docutils field-list" frame="void" rules="none">
  81. <col class="field-name" />
  82. <col class="field-body" />
  83. <tbody valign="top">
  84. <tr class="field"><th class="field-name">Parameter:</th><td class="field-body"><em>length</em> &#8211; see <a title="celery.datastructures.PositionQueue.length" class="reference internal" href="#celery.datastructures.PositionQueue.length"><tt class="xref docutils literal"><span class="pre">length</span></tt></a>.</td>
  85. </tr>
  86. </tbody>
  87. </table>
  88. <dl class="attribute">
  89. <dt id="celery.datastructures.PositionQueue.length">
  90. <tt class="descname">length</tt><a class="headerlink" href="#celery.datastructures.PositionQueue.length" title="Permalink to this definition">¶</a></dt>
  91. <dd>The number of items required for the queue to be considered full.</dd></dl>
  92. <dl class="class">
  93. <dt id="celery.datastructures.PositionQueue.UnfilledPosition">
  94. <em class="property">
  95. class </em><tt class="descname">UnfilledPosition</tt><big>(</big><em>position</em><big>)</big><a class="headerlink" href="#celery.datastructures.PositionQueue.UnfilledPosition" title="Permalink to this definition">¶</a></dt>
  96. <dd>Describes an unfilled slot.</dd></dl>
  97. <dl class="attribute">
  98. <dt id="celery.datastructures.PositionQueue.filled">
  99. <tt class="descclassname">PositionQueue.</tt><tt class="descname">filled</tt><a class="headerlink" href="#celery.datastructures.PositionQueue.filled" title="Permalink to this definition">¶</a></dt>
  100. <dd>Returns the filled slots as a list.</dd></dl>
  101. <dl class="method">
  102. <dt id="celery.datastructures.PositionQueue.full">
  103. <tt class="descclassname">PositionQueue.</tt><tt class="descname">full</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.datastructures.PositionQueue.full" title="Permalink to this definition">¶</a></dt>
  104. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if all of the slots has been filled.</dd></dl>
  105. </dd></dl>
  106. </div>
  107. </div>
  108. </div>
  109. </div>
  110. </div>
  111. <div class="sidebar">
  112. <h3>Contents</h3>
  113. <ul class="current">
  114. <li class="toctree-l1"><a class="reference external" href="../introduction.html">celery - Distributed Task Queue for Django.</a></li>
  115. <li class="toctree-l1"><a class="reference external" href="../faq.html">Frequently Asked Questions</a></li>
  116. <li class="toctree-l1 current"><a class="reference external" href="index.html">Module API Reference</a><ul class="current">
  117. <li class="toctree-l2"><a class="reference external" href="celery.task.html">Tasks - celery.task</a></li>
  118. <li class="toctree-l2"><a class="reference external" href="celery.result.html">Task Result - celery.result</a></li>
  119. <li class="toctree-l2"><a class="reference external" href="celery.registry.html">Task Registry - celery.registry</a></li>
  120. <li class="toctree-l2"><a class="reference external" href="celery.discovery.html">Task Discovery - celery.discovery</a></li>
  121. <li class="toctree-l2"><a class="reference external" href="celery.worker.html">Multiprocessing Worker - celery.worker</a></li>
  122. <li class="toctree-l2"><a class="reference external" href="celery.backends.html">Backends - celery.backends</a></li>
  123. <li class="toctree-l2"><a class="reference external" href="celery.backends.base.html">Backend: Base - celery.backends.base</a></li>
  124. <li class="toctree-l2"><a class="reference external" href="celery.backends.database.html">Backend: Database - celery.backends.database</a></li>
  125. <li class="toctree-l2"><a class="reference external" href="celery.backends.cache.html">Backend: Cache - celery.backends.cache</a></li>
  126. <li class="toctree-l2"><a class="reference external" href="celery.backends.tyrant.html">Backend: Tokyo Tyrant - celery.backends.tyrant</a></li>
  127. <li class="toctree-l2"><a class="reference external" href="celery.conf.html">Configuration - celery.conf</a></li>
  128. <li class="toctree-l2 current"><a class="current reference external" href="">Datastructures - celery.datastructures</a></li>
  129. <li class="toctree-l2"><a class="reference external" href="celery.log.html">Logging - celery.log</a></li>
  130. <li class="toctree-l2"><a class="reference external" href="celery.managers.html">Django Model Managers - celery.managers</a></li>
  131. <li class="toctree-l2"><a class="reference external" href="celery.models.html">Django Models - celery.models</a></li>
  132. <li class="toctree-l2"><a class="reference external" href="celery.messaging.html">Messaging - celery.messaging</a></li>
  133. <li class="toctree-l2"><a class="reference external" href="celery.platform.html">Platform Specific - celery.platform</a></li>
  134. <li class="toctree-l2"><a class="reference external" href="celery.timer.html">Timers - celery.timer</a></li>
  135. <li class="toctree-l2"><a class="reference external" href="celery.bin.celeryd.html">Celery Worker Daemon - celery.bin.celeryd</a></li>
  136. </ul>
  137. </li>
  138. <li class="toctree-l1"><a class="reference external" href="../changelog.html">Change history</a></li>
  139. </ul>
  140. <h3 style="margin-top: 1.5em;">Search</h3>
  141. <form class="search" action="../search.html" method="get">
  142. <input type="text" name="q" size="18" />
  143. <input type="submit" value="Go" />
  144. <input type="hidden" name="check_keywords" value="yes" />
  145. <input type="hidden" name="area" value="default" />
  146. </form>
  147. <p class="searchtip" style="font-size: 90%">
  148. Enter search terms or a module, class or function name.
  149. </p>
  150. </div>
  151. <div class="clearer"></div>
  152. </div>
  153. </div>
  154. <div class="footer-wrapper">
  155. <div class="footer">
  156. <div class="left">
  157. <a href="../genindex.html" title="General Index"
  158. >index</a> |
  159. <a href="../modindex.html" title="Global Module Index"
  160. >modules</a> |
  161. <a href="celery.log.html" title="Logging - celery.log"
  162. >next</a> |
  163. <a href="celery.conf.html" title="Configuration - celery.conf"
  164. >previous</a>
  165. <br/>
  166. <a href="../sources/reference/celery.datastructures.txt"
  167. rel="nofollow">Show Source</a>
  168. </div>
  169. <div class="right">
  170. &copy; Copyright 2009, Ask Solem.<br/>
  171. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  172. </div>
  173. <div class="clearer"></div>
  174. </div>
  175. </div>
  176. </body>
  177. </html>