File: //usr/share/doc/python3-django-q/html/group.html
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Groups — Django Q2 1.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=86f27845" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<script src="_static/jquery.js?v=8dae8fb0"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=d6a008b6"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Iterable" href="iterable.html" />
<link rel="prev" title="Tasks" href="tasks.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Django Q2
</a>
<div class="version">
1.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html"> Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="configure.html"> Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="brokers.html"> Brokers</a></li>
<li class="toctree-l1"><a class="reference internal" href="tasks.html"> Tasks</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#"> Groups</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#reference">Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#django_q.result_group"><code class="docutils literal notranslate"><span class="pre">result_group()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#django_q.fetch_group"><code class="docutils literal notranslate"><span class="pre">fetch_group()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#django_q.count_group"><code class="docutils literal notranslate"><span class="pre">count_group()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#django_q.delete_group"><code class="docutils literal notranslate"><span class="pre">delete_group()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="iterable.html"> Iterable</a></li>
<li class="toctree-l1"><a class="reference internal" href="chain.html"> Chains</a></li>
<li class="toctree-l1"><a class="reference internal" href="schedules.html"> Schedules</a></li>
<li class="toctree-l1"><a class="reference internal" href="cluster.html"> Cluster</a></li>
<li class="toctree-l1"><a class="reference internal" href="monitor.html"> Monitor</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin.html"> Admin</a></li>
<li class="toctree-l1"><a class="reference internal" href="errors.html"> Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="signals.html"> Signals</a></li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html"> Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html"> Examples</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Django Q2</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Groups</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/group.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="groups">
<h1>Groups<a class="headerlink" href="#groups" title="Link to this heading"></a></h1>
<p>You can group together results by passing <a class="reference internal" href="tasks.html#django_q.async_task" title="django_q.async_task"><code class="xref py py-func docutils literal notranslate"><span class="pre">async_task()</span></code></a> the optional <code class="docutils literal notranslate"><span class="pre">group</span></code> keyword:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># result group example</span>
<span class="kn">from</span> <span class="nn">django_q.tasks</span> <span class="kn">import</span> <span class="n">async_task</span><span class="p">,</span> <span class="n">result_group</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">4</span><span class="p">):</span>
<span class="n">async_task</span><span class="p">(</span><span class="s1">'math.modf'</span><span class="p">,</span> <span class="n">i</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="s1">'modf'</span><span class="p">)</span>
<span class="c1"># wait until the group has 4 results</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">result_group</span><span class="p">(</span><span class="s1">'modf'</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
</pre></div>
</div>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">0.0</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">2.0</span><span class="p">),</span> <span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">3.0</span><span class="p">)]</span>
</pre></div>
</div>
<p>Note that this particular example can be achieved much faster with <a class="reference internal" href="iterable.html"><span class="doc">Iterable</span></a></p>
<p>Take care to not limit your results database too much and call <a class="reference internal" href="#django_q.delete_group" title="django_q.delete_group"><code class="xref py py-func docutils literal notranslate"><span class="pre">delete_group()</span></code></a> before each run, unless you want your results to keep adding up.
Instead of <a class="reference internal" href="#django_q.result_group" title="django_q.result_group"><code class="xref py py-func docutils literal notranslate"><span class="pre">result_group()</span></code></a> you can also use <a class="reference internal" href="#django_q.fetch_group" title="django_q.fetch_group"><code class="xref py py-func docutils literal notranslate"><span class="pre">fetch_group()</span></code></a> to return a queryset of <a class="reference internal" href="tasks.html#django_q.Task" title="django_q.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a> objects.:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># fetch group example</span>
<span class="kn">from</span> <span class="nn">django_q.tasks</span> <span class="kn">import</span> <span class="n">fetch_group</span><span class="p">,</span> <span class="n">count_group</span><span class="p">,</span> <span class="n">result_group</span>
<span class="c1"># count the number of failures</span>
<span class="n">failure_count</span> <span class="o">=</span> <span class="n">count_group</span><span class="p">(</span><span class="s1">'modf'</span><span class="p">,</span> <span class="n">failures</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># only use the successes</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">fetch_group</span><span class="p">(</span><span class="s1">'modf'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">failure_count</span><span class="p">:</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">results</span><span class="o">.</span><span class="n">exclude</span><span class="p">(</span><span class="n">success</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[</span><span class="n">task</span><span class="o">.</span><span class="n">result</span> <span class="k">for</span> <span class="n">task</span> <span class="ow">in</span> <span class="n">successes</span><span class="p">]</span>
<span class="c1"># this is the same as</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">fetch_group</span><span class="p">(</span><span class="s1">'modf'</span><span class="p">,</span> <span class="n">failures</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[</span><span class="n">task</span><span class="o">.</span><span class="n">result</span> <span class="k">for</span> <span class="n">task</span> <span class="ow">in</span> <span class="n">successes</span><span class="p">]</span>
<span class="c1"># and the same as</span>
<span class="n">results</span> <span class="o">=</span> <span class="n">result_group</span><span class="p">(</span><span class="s1">'modf'</span><span class="p">)</span> <span class="c1"># filters failures by default</span>
</pre></div>
</div>
<p>Getting results by using <a class="reference internal" href="#django_q.result_group" title="django_q.result_group"><code class="xref py py-func docutils literal notranslate"><span class="pre">result_group()</span></code></a> is of course much faster than using <a class="reference internal" href="#django_q.fetch_group" title="django_q.fetch_group"><code class="xref py py-func docutils literal notranslate"><span class="pre">fetch_group()</span></code></a>, but it doesn’t offer the benefits of Django’s queryset functions.</p>
<p>You can also access group functions from a task result instance:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django_q.tasks</span> <span class="kn">import</span> <span class="n">fetch</span>
<span class="n">task</span> <span class="o">=</span> <span class="n">fetch</span><span class="p">(</span><span class="s1">'winter-speaker-alpha-ceiling'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">task</span><span class="o">.</span><span class="n">group_count</span><span class="p">()</span> <span class="o">></span> <span class="mi">100</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="n">task</span><span class="o">.</span><span class="n">group_result</span><span class="p">())</span>
<span class="n">task</span><span class="o">.</span><span class="n">group_delete</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="s1">'Deleted group </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">task</span><span class="o">.</span><span class="n">group</span><span class="p">))</span>
</pre></div>
</div>
<p>or call them directly on <a class="reference internal" href="tasks.html#django_q.AsyncTask" title="django_q.AsyncTask"><code class="xref py py-class docutils literal notranslate"><span class="pre">AsyncTask</span></code></a> object:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django_q.tasks</span> <span class="kn">import</span> <span class="n">AsyncTask</span>
<span class="c1"># add a task to the math group and run it cached</span>
<span class="n">a</span> <span class="o">=</span> <span class="n">AsyncTask</span><span class="p">(</span><span class="s1">'math.floor'</span><span class="p">,</span> <span class="mf">2.5</span><span class="p">,</span> <span class="n">group</span><span class="o">=</span><span class="s1">'math'</span><span class="p">,</span> <span class="n">cached</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="c1"># wait until this tasks group has 10 results</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">a</span><span class="o">.</span><span class="n">result_group</span><span class="p">(</span><span class="n">count</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</pre></div>
</div>
<section id="reference">
<h2>Reference<a class="headerlink" href="#reference" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="django_q.result_group">
<span class="sig-name descname"><span class="pre">result_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cached</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#django_q.result_group" title="Link to this definition"></a></dt>
<dd><p>Returns the results of a task group</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>group_id</strong> (<em>str</em>) – the group identifier</p></li>
<li><p><strong>failures</strong> (<em>bool</em>) – set this to <code class="docutils literal notranslate"><span class="pre">True</span></code> to include failed results</p></li>
<li><p><strong>wait</strong> (<em>int</em>) – optional milliseconds to wait for a result or count. -1 for indefinite</p></li>
<li><p><strong>count</strong> (<em>int</em>) – block until there are this many results in the group</p></li>
<li><p><strong>cached</strong> (<em>bool</em>) – run this against the cache backend</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>a list of results</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="django_q.fetch_group">
<span class="sig-name descname"><span class="pre">fetch_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cached</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#django_q.fetch_group" title="Link to this definition"></a></dt>
<dd><p>Returns a list of tasks in a group</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>group_id</strong> (<em>str</em>) – the group identifier</p></li>
<li><p><strong>failures</strong> (<em>bool</em>) – set this to <code class="docutils literal notranslate"><span class="pre">False</span></code> to exclude failed tasks</p></li>
<li><p><strong>wait</strong> (<em>int</em>) – optional milliseconds to wait for a task or count. -1 for indefinite</p></li>
<li><p><strong>count</strong> (<em>int</em>) – block until there are this many tasks in the group</p></li>
<li><p><strong>cached</strong> (<em>bool</em>) – run this against the cache backend.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>a list of <a class="reference internal" href="tasks.html#django_q.Task" title="django_q.Task"><code class="xref py py-class docutils literal notranslate"><span class="pre">Task</span></code></a></p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="django_q.count_group">
<span class="sig-name descname"><span class="pre">count_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failures</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cached</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#django_q.count_group" title="Link to this definition"></a></dt>
<dd><p>Counts the number of task results in a group.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>group_id</strong> (<em>str</em>) – the group identifier</p></li>
<li><p><strong>failures</strong> (<em>bool</em>) – counts the number of failures if <code class="docutils literal notranslate"><span class="pre">True</span></code></p></li>
<li><p><strong>cached</strong> (<em>bool</em>) – run this against the cache backend.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the number of tasks or failures in a group</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="django_q.delete_group">
<span class="sig-name descname"><span class="pre">delete_group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tasks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cached</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#django_q.delete_group" title="Link to this definition"></a></dt>
<dd><p>Deletes a group label from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>group_id</strong> (<em>str</em>) – the group identifier</p></li>
<li><p><strong>tasks</strong> (<em>bool</em>) – also deletes the associated tasks if <code class="docutils literal notranslate"><span class="pre">True</span></code></p></li>
<li><p><strong>cached</strong> (<em>bool</em>) – run this against the cache backend.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the numbers of tasks affected</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="tasks.html" class="btn btn-neutral float-left" title="Tasks" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="iterable.html" class="btn btn-neutral float-right" title="Iterable" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015-2023, Ilan Steemers - 2022, Stan Triepels.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>