evennia/docs/5.x/_modules/django/db/models/aggregates.html
2025-07-01 10:01:48 +02:00

325 lines
No EOL
38 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>django.db.models.aggregates &#8212; Evennia latest documentation</title>
<link rel="stylesheet" href="../../../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../../../../_static/nature.css?v=e2c0865a" />
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">django.db.models.aggregates</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for django.db.models.aggregates</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Classes to represent the definitions of aggregate functions.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">django.core.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">FieldError</span><span class="p">,</span> <span class="n">FullResultSet</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models.expressions</span><span class="w"> </span><span class="kn">import</span> <span class="n">Case</span><span class="p">,</span> <span class="n">Func</span><span class="p">,</span> <span class="n">Star</span><span class="p">,</span> <span class="n">Value</span><span class="p">,</span> <span class="n">When</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models.fields</span><span class="w"> </span><span class="kn">import</span> <span class="n">IntegerField</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models.functions.comparison</span><span class="w"> </span><span class="kn">import</span> <span class="n">Coalesce</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models.functions.mixins</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
<span class="n">FixDurationInputMixin</span><span class="p">,</span>
<span class="n">NumericOutputFieldMixin</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;Aggregate&quot;</span><span class="p">,</span>
<span class="s2">&quot;Avg&quot;</span><span class="p">,</span>
<span class="s2">&quot;Count&quot;</span><span class="p">,</span>
<span class="s2">&quot;Max&quot;</span><span class="p">,</span>
<span class="s2">&quot;Min&quot;</span><span class="p">,</span>
<span class="s2">&quot;StdDev&quot;</span><span class="p">,</span>
<span class="s2">&quot;Sum&quot;</span><span class="p">,</span>
<span class="s2">&quot;Variance&quot;</span><span class="p">,</span>
<span class="p">]</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Aggregate</span><span class="p">(</span><span class="n">Func</span><span class="p">):</span>
<span class="n">template</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%(function)s</span><span class="s2">(</span><span class="si">%(distinct)s%(expressions)s</span><span class="s2">)&quot;</span>
<span class="n">contains_aggregate</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">name</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">filter_template</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> FILTER (WHERE </span><span class="si">%%</span><span class="s2">(filter)s)&quot;</span>
<span class="n">window_compatible</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">allow_distinct</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">empty_result_set_value</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">expressions</span><span class="p">,</span> <span class="n">distinct</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="nb">filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span>
<span class="p">):</span>
<span class="k">if</span> <span class="n">distinct</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">allow_distinct</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> does not allow distinct.&quot;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
<span class="k">if</span> <span class="n">default</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">empty_result_set_value</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2"> does not allow default.&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">distinct</span> <span class="o">=</span> <span class="n">distinct</span>
<span class="bp">self</span><span class="o">.</span><span class="n">filter</span> <span class="o">=</span> <span class="nb">filter</span>
<span class="bp">self</span><span class="o">.</span><span class="n">default</span> <span class="o">=</span> <span class="n">default</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">expressions</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_source_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Don&#39;t return the filter expression since it&#39;s not a source field.</span>
<span class="k">return</span> <span class="p">[</span><span class="n">e</span><span class="o">.</span><span class="n">_output_field_or_none</span> <span class="k">for</span> <span class="n">e</span> <span class="ow">in</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_source_expressions</span><span class="p">()]</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_source_expressions</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">source_expressions</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_source_expressions</span><span class="p">()</span>
<span class="k">return</span> <span class="n">source_expressions</span> <span class="o">+</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">]</span>
<span class="k">def</span><span class="w"> </span><span class="nf">set_source_expressions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exprs</span><span class="p">):</span>
<span class="o">*</span><span class="n">exprs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span> <span class="o">=</span> <span class="n">exprs</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">set_source_expressions</span><span class="p">(</span><span class="n">exprs</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">resolve_expression</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">allow_joins</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reuse</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">summarize</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">for_save</span><span class="o">=</span><span class="kc">False</span>
<span class="p">):</span>
<span class="c1"># Aggregates are not allowed in UPDATE queries, so ignore for_save</span>
<span class="n">c</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">resolve_expression</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">allow_joins</span><span class="p">,</span> <span class="n">reuse</span><span class="p">,</span> <span class="n">summarize</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">filter</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">c</span><span class="o">.</span><span class="n">filter</span><span class="o">.</span><span class="n">resolve_expression</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">allow_joins</span><span class="p">,</span> <span class="n">reuse</span><span class="p">,</span> <span class="n">summarize</span><span class="p">)</span>
<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">filter</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">summarize</span><span class="p">:</span>
<span class="c1"># Summarized aggregates cannot refer to summarized aggregates.</span>
<span class="k">for</span> <span class="n">ref</span> <span class="ow">in</span> <span class="n">c</span><span class="o">.</span><span class="n">get_refs</span><span class="p">():</span>
<span class="k">if</span> <span class="n">query</span><span class="o">.</span><span class="n">annotations</span><span class="p">[</span><span class="n">ref</span><span class="p">]</span><span class="o">.</span><span class="n">is_summary</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">FieldError</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;Cannot compute </span><span class="si">{</span><span class="n">c</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">(&#39;</span><span class="si">{</span><span class="n">ref</span><span class="si">}</span><span class="s2">&#39;): &#39;</span><span class="si">{</span><span class="n">ref</span><span class="si">}</span><span class="s2">&#39; is an aggregate&quot;</span>
<span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_summary</span><span class="p">:</span>
<span class="c1"># Call Aggregate.get_source_expressions() to avoid</span>
<span class="c1"># returning self.filter and including that in this loop.</span>
<span class="n">expressions</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">Aggregate</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span><span class="o">.</span><span class="n">get_source_expressions</span><span class="p">()</span>
<span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">expr</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">expressions</span><span class="p">):</span>
<span class="k">if</span> <span class="n">expr</span><span class="o">.</span><span class="n">contains_aggregate</span><span class="p">:</span>
<span class="n">before_resolved</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_source_expressions</span><span class="p">()[</span><span class="n">index</span><span class="p">]</span>
<span class="n">name</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">before_resolved</span><span class="o">.</span><span class="n">name</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">before_resolved</span><span class="p">,</span> <span class="s2">&quot;name&quot;</span><span class="p">)</span>
<span class="k">else</span> <span class="nb">repr</span><span class="p">(</span><span class="n">before_resolved</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">raise</span> <span class="n">FieldError</span><span class="p">(</span>
<span class="s2">&quot;Cannot compute </span><span class="si">%s</span><span class="s2">(&#39;</span><span class="si">%s</span><span class="s2">&#39;): &#39;</span><span class="si">%s</span><span class="s2">&#39; is an aggregate&quot;</span>
<span class="o">%</span> <span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="n">default</span> <span class="o">:=</span> <span class="n">c</span><span class="o">.</span><span class="n">default</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">c</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">default</span><span class="p">,</span> <span class="s2">&quot;resolve_expression&quot;</span><span class="p">):</span>
<span class="n">default</span> <span class="o">=</span> <span class="n">default</span><span class="o">.</span><span class="n">resolve_expression</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">allow_joins</span><span class="p">,</span> <span class="n">reuse</span><span class="p">,</span> <span class="n">summarize</span><span class="p">)</span>
<span class="k">if</span> <span class="n">default</span><span class="o">.</span><span class="n">_output_field_or_none</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">default</span><span class="o">.</span><span class="n">output_field</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">_output_field_or_none</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">default</span> <span class="o">=</span> <span class="n">Value</span><span class="p">(</span><span class="n">default</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">_output_field_or_none</span><span class="p">)</span>
<span class="n">c</span><span class="o">.</span><span class="n">default</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># Reset the default argument before wrapping.</span>
<span class="n">coalesce</span> <span class="o">=</span> <span class="n">Coalesce</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">default</span><span class="p">,</span> <span class="n">output_field</span><span class="o">=</span><span class="n">c</span><span class="o">.</span><span class="n">_output_field_or_none</span><span class="p">)</span>
<span class="n">coalesce</span><span class="o">.</span><span class="n">is_summary</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">is_summary</span>
<span class="k">return</span> <span class="n">coalesce</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">default_alias</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">expressions</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">expr</span> <span class="k">for</span> <span class="n">expr</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_source_expressions</span><span class="p">()</span> <span class="k">if</span> <span class="n">expr</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">expressions</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s2">&quot;name&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="s2">&quot;</span><span class="si">%s</span><span class="s2">__</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s2">&quot;Complex expressions require an alias&quot;</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">get_group_by_cols</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">[]</span>
<span class="k">def</span><span class="w"> </span><span class="nf">as_sql</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">compiler</span><span class="p">,</span> <span class="n">connection</span><span class="p">,</span> <span class="o">**</span><span class="n">extra_context</span><span class="p">):</span>
<span class="n">extra_context</span><span class="p">[</span><span class="s2">&quot;distinct&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="s2">&quot;DISTINCT &quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">distinct</span> <span class="k">else</span> <span class="s2">&quot;&quot;</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">:</span>
<span class="k">if</span> <span class="n">connection</span><span class="o">.</span><span class="n">features</span><span class="o">.</span><span class="n">supports_aggregate_filter_clause</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">filter_sql</span><span class="p">,</span> <span class="n">filter_params</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="o">.</span><span class="n">as_sql</span><span class="p">(</span><span class="n">compiler</span><span class="p">,</span> <span class="n">connection</span><span class="p">)</span>
<span class="k">except</span> <span class="n">FullResultSet</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">template</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter_template</span> <span class="o">%</span> <span class="n">extra_context</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s2">&quot;template&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">template</span>
<span class="p">)</span>
<span class="n">sql</span><span class="p">,</span> <span class="n">params</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">as_sql</span><span class="p">(</span>
<span class="n">compiler</span><span class="p">,</span>
<span class="n">connection</span><span class="p">,</span>
<span class="n">template</span><span class="o">=</span><span class="n">template</span><span class="p">,</span>
<span class="nb">filter</span><span class="o">=</span><span class="n">filter_sql</span><span class="p">,</span>
<span class="o">**</span><span class="n">extra_context</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">sql</span><span class="p">,</span> <span class="p">(</span><span class="o">*</span><span class="n">params</span><span class="p">,</span> <span class="o">*</span><span class="n">filter_params</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">copy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
<span class="n">copy</span><span class="o">.</span><span class="n">filter</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">source_expressions</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">get_source_expressions</span><span class="p">()</span>
<span class="n">condition</span> <span class="o">=</span> <span class="n">When</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">,</span> <span class="n">then</span><span class="o">=</span><span class="n">source_expressions</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="n">copy</span><span class="o">.</span><span class="n">set_source_expressions</span><span class="p">([</span><span class="n">Case</span><span class="p">(</span><span class="n">condition</span><span class="p">)]</span> <span class="o">+</span> <span class="n">source_expressions</span><span class="p">[</span><span class="mi">1</span><span class="p">:])</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">Aggregate</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span><span class="o">.</span><span class="n">as_sql</span><span class="p">(</span>
<span class="n">compiler</span><span class="p">,</span> <span class="n">connection</span><span class="p">,</span> <span class="o">**</span><span class="n">extra_context</span>
<span class="p">)</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">as_sql</span><span class="p">(</span><span class="n">compiler</span><span class="p">,</span> <span class="n">connection</span><span class="p">,</span> <span class="o">**</span><span class="n">extra_context</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_get_repr_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">options</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_get_repr_options</span><span class="p">()</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">distinct</span><span class="p">:</span>
<span class="n">options</span><span class="p">[</span><span class="s2">&quot;distinct&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">distinct</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">:</span>
<span class="n">options</span><span class="p">[</span><span class="s2">&quot;filter&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span>
<span class="k">return</span> <span class="n">options</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Avg</span><span class="p">(</span><span class="n">FixDurationInputMixin</span><span class="p">,</span> <span class="n">NumericOutputFieldMixin</span><span class="p">,</span> <span class="n">Aggregate</span><span class="p">):</span>
<span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;AVG&quot;</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Avg&quot;</span>
<span class="n">allow_distinct</span> <span class="o">=</span> <span class="kc">True</span>
<div class="viewcode-block" id="Count">
<a class="viewcode-back" href="../../../../api/evennia.typeclasses.managers.html#evennia.commands.default.building.Count">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Count</span><span class="p">(</span><span class="n">Aggregate</span><span class="p">):</span>
<span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;COUNT&quot;</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Count&quot;</span>
<span class="n">output_field</span> <span class="o">=</span> <span class="n">IntegerField</span><span class="p">()</span>
<span class="n">allow_distinct</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">empty_result_set_value</span> <span class="o">=</span> <span class="mi">0</span>
<div class="viewcode-block" id="Count.__init__">
<a class="viewcode-back" href="../../../../api/evennia.typeclasses.managers.html#evennia.commands.default.building.Count.__init__">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="nb">filter</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
<span class="k">if</span> <span class="n">expression</span> <span class="o">==</span> <span class="s2">&quot;*&quot;</span><span class="p">:</span>
<span class="n">expression</span> <span class="o">=</span> <span class="n">Star</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">Star</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">filter</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Star cannot be used with filter. Please specify a field.&quot;</span><span class="p">)</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="nb">filter</span><span class="o">=</span><span class="nb">filter</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">)</span></div>
</div>
<div class="viewcode-block" id="Max">
<a class="viewcode-back" href="../../../../api/evennia.commands.default.building.html#evennia.commands.default.building.Max">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Max</span><span class="p">(</span><span class="n">Aggregate</span><span class="p">):</span>
<span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;MAX&quot;</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Max&quot;</span></div>
<div class="viewcode-block" id="Min">
<a class="viewcode-back" href="../../../../api/evennia.commands.default.building.html#evennia.commands.default.building.Min">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">Min</span><span class="p">(</span><span class="n">Aggregate</span><span class="p">):</span>
<span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;MIN&quot;</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Min&quot;</span></div>
<span class="k">class</span><span class="w"> </span><span class="nc">StdDev</span><span class="p">(</span><span class="n">NumericOutputFieldMixin</span><span class="p">,</span> <span class="n">Aggregate</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;StdDev&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">sample</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;STDDEV_SAMP&quot;</span> <span class="k">if</span> <span class="n">sample</span> <span class="k">else</span> <span class="s2">&quot;STDDEV_POP&quot;</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_get_repr_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_get_repr_options</span><span class="p">(),</span> <span class="s2">&quot;sample&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">==</span> <span class="s2">&quot;STDDEV_SAMP&quot;</span><span class="p">}</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Sum</span><span class="p">(</span><span class="n">FixDurationInputMixin</span><span class="p">,</span> <span class="n">Aggregate</span><span class="p">):</span>
<span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;SUM&quot;</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Sum&quot;</span>
<span class="n">allow_distinct</span> <span class="o">=</span> <span class="kc">True</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Variance</span><span class="p">(</span><span class="n">NumericOutputFieldMixin</span><span class="p">,</span> <span class="n">Aggregate</span><span class="p">):</span>
<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;Variance&quot;</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">expression</span><span class="p">,</span> <span class="n">sample</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">=</span> <span class="s2">&quot;VAR_SAMP&quot;</span> <span class="k">if</span> <span class="n">sample</span> <span class="k">else</span> <span class="s2">&quot;VAR_POP&quot;</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="o">**</span><span class="n">extra</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_get_repr_options</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="p">{</span><span class="o">**</span><span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_get_repr_options</span><span class="p">(),</span> <span class="s2">&quot;sample&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">==</span> <span class="s2">&quot;VAR_SAMP&quot;</span><span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<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="../../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">django.db.models.aggregates</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>