yangck
/
celery


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Built-in Task Classes - celery.task.builtins &mdash; Celery v0.3.20 (unstable) documentation</title>
    <link rel="stylesheet" href="../static/nature.css" type="text/css" />
    <link rel="stylesheet" href="../static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '0.3.20 (unstable)',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../static/jquery.js"></script>
    <script type="text/javascript" src="../static/doctools.js"></script>
    <link rel="top" title="Celery v0.3.20 (unstable) documentation" href="../index.html" />
    <link rel="up" title="Module API Reference" href="index.html" />
    <link rel="next" title="Task Discovery - celery.discovery" href="celery.discovery.html" />
    <link rel="prev" title="Task Registry - celery.registry" href="celery.registry.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="celery.registry.html" title="Task Registry - celery.registry"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">Celery v0.3.20 (unstable) documentation</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">Module API Reference</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-celery.task.builtins">
<h1>Built-in Task Classes - celery.task.builtins<a class="headerlink" href="#module-celery.task.builtins" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="celery.task.builtins.AsynchronousMapTask">
<em class="property">
class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">AsynchronousMapTask</tt><a class="headerlink" href="#celery.task.builtins.AsynchronousMapTask" title="Permalink to this definition">¶</a></dt>
<dd><p>Task used internally by <tt class="xref docutils literal"><span class="pre">dmap_async()</span></tt> and
<tt class="xref docutils literal"><span class="pre">TaskSet.map_async()</span></tt>.</p>
<dl class="method">
<dt id="celery.task.builtins.AsynchronousMapTask.run">
<tt class="descname">run</tt><big>(</big><em>serfunc</em>, <em>args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.AsynchronousMapTask.run" title="Permalink to this definition">¶</a></dt>
<dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>

</dd></dl>

<dl class="class">
<dt id="celery.task.builtins.DeleteExpiredTaskMetaTask">
<em class="property">
class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">DeleteExpiredTaskMetaTask</tt><a class="headerlink" href="#celery.task.builtins.DeleteExpiredTaskMetaTask" title="Permalink to this definition">¶</a></dt>
<dd><p>A periodic task that deletes expired task metadata every day.</p>
<p>This runs the current backend&#8217;s
<a title="celery.backends.base.BaseBackend.cleanup" class="reference external" href="celery.backends.base.html#celery.backends.base.BaseBackend.cleanup"><tt class="xref docutils literal"><span class="pre">celery.backends.base.BaseBackend.cleanup()</span></tt></a> method.</p>
<dl class="method">
<dt id="celery.task.builtins.DeleteExpiredTaskMetaTask.run">
<tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.DeleteExpiredTaskMetaTask.run" title="Permalink to this definition">¶</a></dt>
<dd>The method run by <tt class="docutils literal"><span class="pre">celeryd</span></tt>.</dd></dl>

</dd></dl>

<dl class="class">
<dt id="celery.task.builtins.ExecuteRemoteTask">
<em class="property">
class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">ExecuteRemoteTask</tt><a class="headerlink" href="#celery.task.builtins.ExecuteRemoteTask" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute an arbitrary function or object.</p>
<p><em>Note</em> You probably want <tt class="xref docutils literal"><span class="pre">execute_remote()</span></tt> instead, which this
is an internal component of.</p>
<p>The object must be pickleable, so you can&#8217;t use lambdas or functions
defined in the REPL (that is the python shell, or <tt class="docutils literal"><span class="pre">ipython</span></tt>).</p>
<dl class="method">
<dt id="celery.task.builtins.ExecuteRemoteTask.run">
<tt class="descname">run</tt><big>(</big><em>ser_callable</em>, <em>fargs</em>, <em>fkwargs</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.ExecuteRemoteTask.run" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><em>ser_callable</em> &#8211; A pickled function or callable object.</li>
<li><em>fargs</em> &#8211; Positional arguments to apply to the function.</li>
<li><em>fkwargs</em> &#8211; Keyword arguments to apply to the function.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="celery.task.builtins.PingTask">
<em class="property">
class </em><tt class="descclassname">celery.task.builtins.</tt><tt class="descname">PingTask</tt><a class="headerlink" href="#celery.task.builtins.PingTask" title="Permalink to this definition">¶</a></dt>
<dd><p>The task used by <tt class="xref docutils literal"><span class="pre">ping()</span></tt>.</p>
<dl class="method">
<dt id="celery.task.builtins.PingTask.run">
<tt class="descname">run</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#celery.task.builtins.PingTask.run" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the string <tt class="docutils literal"><span class="pre">&quot;pong&quot;</span></tt>.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h4>Previous topic</h4>
            <p class="topless"><a href="celery.registry.html"
                                  title="previous chapter">Task Registry - celery.registry</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="celery.discovery.html"
                                  title="next chapter">Task Discovery - celery.discovery</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../sources/reference/celery.task.builtins.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="../search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="celery.discovery.html" title="Task Discovery - celery.discovery"
             >next</a> |</li>
        <li class="right" >
          <a href="celery.registry.html" title="Task Registry - celery.registry"
             >previous</a> |</li>
        <li><a href="../index.html">Celery v0.3.20 (unstable) documentation</a> &raquo;</li>
          <li><a href="index.html" >Module API Reference</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2009, Ask Solem.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.2.
    </div>
  </body>
</html>