celery.result.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  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 Result - celery.result &mdash; Celery v0.1.14 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.14',
  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.14 documentation" href="../index.html" />
  21. <link rel="next" title="Task Registry - celery.registry" href="celery.registry.html" />
  22. <link rel="prev" title="Tasks - celery.task" href="celery.task.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.registry.html" title="Task Registry - celery.registry"
  36. accesskey="N">next</a> |</li>
  37. <li class="right" >
  38. <a href="celery.task.html" title="Tasks - celery.task"
  39. accesskey="P">previous</a> |</li>
  40. <li><a href="../index.html">Celery v0.1.14 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.result">
  48. <h1>Task Result - celery.result<a class="headerlink" href="#module-celery.result" title="Permalink to this headline">¶</a></h1>
  49. <p>celery.result</p>
  50. <dl class="class">
  51. <dt id="celery.result.AsyncResult">
  52. <em class="property">
  53. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">AsyncResult</tt><big>(</big><em>task_id</em><big>)</big><a class="headerlink" href="#celery.result.AsyncResult" title="Permalink to this definition">¶</a></dt>
  54. <dd>Pending task result using the default backend.</dd></dl>
  55. <dl class="class">
  56. <dt id="celery.result.BaseAsyncResult">
  57. <em class="property">
  58. class </em><tt class="descclassname">celery.result.</tt><tt class="descname">BaseAsyncResult</tt><big>(</big><em>task_id</em>, <em>backend</em><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult" title="Permalink to this definition">¶</a></dt>
  59. <dd><p>Base class for pending result, takes <tt class="docutils literal"><span class="pre">backend</span></tt> argument.</p>
  60. <dl class="method">
  61. <dt id="celery.result.BaseAsyncResult.get">
  62. <tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.get" title="Permalink to this definition">¶</a></dt>
  63. <dd>Alias to <tt class="docutils literal"><span class="pre">wait</span></tt>.</dd></dl>
  64. <dl class="method">
  65. <dt id="celery.result.BaseAsyncResult.is_done">
  66. <tt class="descname">is_done</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.is_done" title="Permalink to this definition">¶</a></dt>
  67. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully.</dd></dl>
  68. <dl class="method">
  69. <dt id="celery.result.BaseAsyncResult.ready">
  70. <tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.ready" title="Permalink to this definition">¶</a></dt>
  71. <dd>Returns <tt class="xref docutils literal"><span class="pre">True</span></tt> if the task executed successfully, or raised
  72. an exception. If the task is still pending, or is waiting for retry
  73. then <tt class="xref docutils literal"><span class="pre">False</span></tt> is returned.</dd></dl>
  74. <dl class="attribute">
  75. <dt id="celery.result.BaseAsyncResult.result">
  76. <tt class="descname">result</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.result" title="Permalink to this definition">¶</a></dt>
  77. <dd>The tasks resulting value.</dd></dl>
  78. <dl class="attribute">
  79. <dt id="celery.result.BaseAsyncResult.status">
  80. <tt class="descname">status</tt><a class="headerlink" href="#celery.result.BaseAsyncResult.status" title="Permalink to this definition">¶</a></dt>
  81. <dd>The current status of the task.</dd></dl>
  82. <dl class="method">
  83. <dt id="celery.result.BaseAsyncResult.successful">
  84. <tt class="descname">successful</tt><big>(</big><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.successful" title="Permalink to this definition">¶</a></dt>
  85. <dd>Alias to <tt class="docutils literal"><span class="pre">is_done</span></tt>.</dd></dl>
  86. <dl class="method">
  87. <dt id="celery.result.BaseAsyncResult.wait">
  88. <tt class="descname">wait</tt><big>(</big><em>timeout=None</em><big>)</big><a class="headerlink" href="#celery.result.BaseAsyncResult.wait" title="Permalink to this definition">¶</a></dt>
  89. <dd><p>Return the result when it arrives.</p>
  90. <p>If timeout is not <tt class="xref docutils literal"><span class="pre">None</span></tt> and the result does not arrive within
  91. <tt class="docutils literal"><span class="pre">timeout</span></tt> seconds then <tt class="docutils literal"><span class="pre">celery.backends.base.TimeoutError</span></tt> is
  92. raised. If the remote call raised an exception then that exception
  93. will be reraised by get().</p>
  94. </dd></dl>
  95. </dd></dl>
  96. </div>
  97. </div>
  98. </div>
  99. </div>
  100. <div class="sphinxsidebar">
  101. <div class="sphinxsidebarwrapper">
  102. <h4>Previous topic</h4>
  103. <p class="topless"><a href="celery.task.html"
  104. title="previous chapter">Tasks - celery.task</a></p>
  105. <h4>Next topic</h4>
  106. <p class="topless"><a href="celery.registry.html"
  107. title="next chapter">Task Registry - celery.registry</a></p>
  108. <h3>This Page</h3>
  109. <ul class="this-page-menu">
  110. <li><a href="../sources/reference/celery.result.txt"
  111. rel="nofollow">Show Source</a></li>
  112. </ul>
  113. <div id="searchbox" style="display: none">
  114. <h3>Quick search</h3>
  115. <form class="search" action="../search.html" method="get">
  116. <input type="text" name="q" size="18" />
  117. <input type="submit" value="Go" />
  118. <input type="hidden" name="check_keywords" value="yes" />
  119. <input type="hidden" name="area" value="default" />
  120. </form>
  121. <p class="searchtip" style="font-size: 90%">
  122. Enter search terms or a module, class or function name.
  123. </p>
  124. </div>
  125. <script type="text/javascript">$('#searchbox').show(0);</script>
  126. </div>
  127. </div>
  128. <div class="clearer"></div>
  129. </div>
  130. <div class="related">
  131. <h3>Navigation</h3>
  132. <ul>
  133. <li class="right" style="margin-right: 10px">
  134. <a href="../genindex.html" title="General Index"
  135. >index</a></li>
  136. <li class="right" >
  137. <a href="../modindex.html" title="Global Module Index"
  138. >modules</a> |</li>
  139. <li class="right" >
  140. <a href="celery.registry.html" title="Task Registry - celery.registry"
  141. >next</a> |</li>
  142. <li class="right" >
  143. <a href="celery.task.html" title="Tasks - celery.task"
  144. >previous</a> |</li>
  145. <li><a href="../index.html">Celery v0.1.14 documentation</a> &raquo;</li>
  146. </ul>
  147. </div>
  148. <div class="footer">
  149. &copy; Copyright 2009, Ask Solem.
  150. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.1.
  151. </div>
  152. </body>
  153. </html>