mirror of
https://github.com/evennia/evennia.git
synced 2026-03-27 02:06:32 +01:00
720 lines
No EOL
92 KiB
HTML
720 lines
No EOL
92 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.contrib.admin.utils — 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=245aff17" />
|
|
<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> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">django.contrib.admin.utils</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.contrib.admin.utils</h1><div class="highlight"><pre>
|
|
<span></span><span class="kn">import</span><span class="w"> </span><span class="nn">datetime</span>
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">decimal</span>
|
|
<span class="kn">import</span><span class="w"> </span><span class="nn">json</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">collections</span><span class="w"> </span><span class="kn">import</span> <span class="n">defaultdict</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">reduce</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">operator</span><span class="w"> </span><span class="kn">import</span> <span class="n">or_</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">FieldDoesNotExist</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.core.validators</span><span class="w"> </span><span class="kn">import</span> <span class="n">EMPTY_VALUES</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db</span><span class="w"> </span><span class="kn">import</span> <span class="n">models</span><span class="p">,</span> <span class="n">router</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">LOOKUP_SEP</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.db.models.deletion</span><span class="w"> </span><span class="kn">import</span> <span class="n">Collector</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.forms.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">pretty_name</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.urls</span><span class="w"> </span><span class="kn">import</span> <span class="n">NoReverseMatch</span><span class="p">,</span> <span class="n">reverse</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">formats</span><span class="p">,</span> <span class="n">timezone</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils.hashable</span><span class="w"> </span><span class="kn">import</span> <span class="n">make_hashable</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils.html</span><span class="w"> </span><span class="kn">import</span> <span class="n">format_html</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils.regex_helper</span><span class="w"> </span><span class="kn">import</span> <span class="n">_lazy_re_compile</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils.text</span><span class="w"> </span><span class="kn">import</span> <span class="n">capfirst</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils.translation</span><span class="w"> </span><span class="kn">import</span> <span class="n">ngettext</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.utils.translation</span><span class="w"> </span><span class="kn">import</span> <span class="n">override</span> <span class="k">as</span> <span class="n">translation_override</span>
|
|
|
|
<span class="n">QUOTE_MAP</span> <span class="o">=</span> <span class="p">{</span><span class="n">i</span><span class="p">:</span> <span class="s2">"_</span><span class="si">%02X</span><span class="s2">"</span> <span class="o">%</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="sa">b</span><span class="s1">'":/_#?;@&=+$,"[]<>%</span><span class="se">\n\\</span><span class="s1">'</span><span class="p">}</span>
|
|
<span class="n">UNQUOTE_MAP</span> <span class="o">=</span> <span class="p">{</span><span class="n">v</span><span class="p">:</span> <span class="nb">chr</span><span class="p">(</span><span class="n">k</span><span class="p">)</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">QUOTE_MAP</span><span class="o">.</span><span class="n">items</span><span class="p">()}</span>
|
|
<span class="n">UNQUOTE_RE</span> <span class="o">=</span> <span class="n">_lazy_re_compile</span><span class="p">(</span><span class="s2">"_(?:</span><span class="si">%s</span><span class="s2">)"</span> <span class="o">%</span> <span class="s2">"|"</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">x</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UNQUOTE_MAP</span><span class="p">]))</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">FieldIsAForeignKeyColumnName</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""A field is a foreign key attname, i.e. <FK>_id."""</span>
|
|
|
|
<span class="k">pass</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">lookup_spawns_duplicates</span><span class="p">(</span><span class="n">opts</span><span class="p">,</span> <span class="n">lookup_path</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return True if the given lookup path spawns duplicates.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">lookup_fields</span> <span class="o">=</span> <span class="n">lookup_path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">LOOKUP_SEP</span><span class="p">)</span>
|
|
<span class="c1"># Go through the fields (following all relations) and look for an m2m.</span>
|
|
<span class="k">for</span> <span class="n">field_name</span> <span class="ow">in</span> <span class="n">lookup_fields</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">field_name</span> <span class="o">==</span> <span class="s2">"pk"</span><span class="p">:</span>
|
|
<span class="n">field_name</span> <span class="o">=</span> <span class="n">opts</span><span class="o">.</span><span class="n">pk</span><span class="o">.</span><span class="n">name</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">field</span> <span class="o">=</span> <span class="n">opts</span><span class="o">.</span><span class="n">get_field</span><span class="p">(</span><span class="n">field_name</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">FieldDoesNotExist</span><span class="p">:</span>
|
|
<span class="c1"># Ignore query lookups.</span>
|
|
<span class="k">continue</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="s2">"path_infos"</span><span class="p">):</span>
|
|
<span class="c1"># This field is a relation; update opts to follow the relation.</span>
|
|
<span class="n">path_info</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">path_infos</span>
|
|
<span class="n">opts</span> <span class="o">=</span> <span class="n">path_info</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">to_opts</span>
|
|
<span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">path</span><span class="o">.</span><span class="n">m2m</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">path_info</span><span class="p">):</span>
|
|
<span class="c1"># This field is a m2m relation so duplicates must be</span>
|
|
<span class="c1"># handled.</span>
|
|
<span class="k">return</span> <span class="kc">True</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_last_value_from_parameters</span><span class="p">(</span><span class="n">parameters</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">parameters</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">value</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> <span class="n">value</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">prepare_lookup_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">separator</span><span class="o">=</span><span class="s2">","</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return a lookup value prepared to be used in queryset filtering.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="p">[</span><span class="n">prepare_lookup_value</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">v</span><span class="p">,</span> <span class="n">separator</span><span class="o">=</span><span class="n">separator</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">]</span>
|
|
<span class="c1"># if key ends with __in, split parameter into separate values</span>
|
|
<span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"__in"</span><span class="p">):</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">separator</span><span class="p">)</span>
|
|
<span class="c1"># if key ends with __isnull, special case '' and the string literals 'false' and '0'</span>
|
|
<span class="k">elif</span> <span class="n">key</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"__isnull"</span><span class="p">):</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">""</span><span class="p">,</span> <span class="s2">"false"</span><span class="p">,</span> <span class="s2">"0"</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">value</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">build_q_object_from_lookup_parameters</span><span class="p">(</span><span class="n">parameters</span><span class="p">):</span>
|
|
<span class="n">q_object</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">Q</span><span class="p">()</span>
|
|
<span class="k">for</span> <span class="n">param</span><span class="p">,</span> <span class="n">param_item_list</span> <span class="ow">in</span> <span class="n">parameters</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
|
<span class="n">q_object</span> <span class="o">&=</span> <span class="n">reduce</span><span class="p">(</span><span class="n">or_</span><span class="p">,</span> <span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Q</span><span class="p">((</span><span class="n">param</span><span class="p">,</span> <span class="n">item</span><span class="p">))</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">param_item_list</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">q_object</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">quote</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Ensure that primary key values do not confuse the admin URLs by escaping</span>
|
|
<span class="sd"> any '/', '_' and ':' and similarly problematic characters.</span>
|
|
<span class="sd"> Similar to urllib.parse.quote(), except that the quoting is slightly</span>
|
|
<span class="sd"> different so that it doesn't get automatically unquoted by the web browser.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">s</span><span class="o">.</span><span class="n">translate</span><span class="p">(</span><span class="n">QUOTE_MAP</span><span class="p">)</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="k">else</span> <span class="n">s</span>
|
|
|
|
|
|
<div class="viewcode-block" id="unquote">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.admin.accounts.html#evennia.web.admin.accounts.unquote">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">unquote</span><span class="p">(</span><span class="n">s</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Undo the effects of quote()."""</span>
|
|
<span class="k">return</span> <span class="n">UNQUOTE_RE</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="k">lambda</span> <span class="n">m</span><span class="p">:</span> <span class="n">UNQUOTE_MAP</span><span class="p">[</span><span class="n">m</span><span class="p">[</span><span class="mi">0</span><span class="p">]],</span> <span class="n">s</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">flatten</span><span class="p">(</span><span class="n">fields</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return a list which is a single level of flattening of the original list.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">flat</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
|
|
<span class="n">flat</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">field</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">flat</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">field</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">flat</span>
|
|
|
|
|
|
<div class="viewcode-block" id="flatten_fieldsets">
|
|
<a class="viewcode-back" href="../../../../api/evennia.web.admin.objects.html#evennia.web.admin.accounts.flatten_fieldsets">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">flatten_fieldsets</span><span class="p">(</span><span class="n">fieldsets</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Return a list of field names from an admin fieldsets structure."""</span>
|
|
<span class="n">field_names</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">opts</span> <span class="ow">in</span> <span class="n">fieldsets</span><span class="p">:</span>
|
|
<span class="n">field_names</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">flatten</span><span class="p">(</span><span class="n">opts</span><span class="p">[</span><span class="s2">"fields"</span><span class="p">]))</span>
|
|
<span class="k">return</span> <span class="n">field_names</span></div>
|
|
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_deleted_objects</span><span class="p">(</span><span class="n">objs</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">admin_site</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Find all objects related to ``objs`` that should also be deleted. ``objs``</span>
|
|
<span class="sd"> must be a homogeneous iterable of objects (e.g. a QuerySet).</span>
|
|
|
|
<span class="sd"> Return a nested list of strings suitable for display in the</span>
|
|
<span class="sd"> template with the ``unordered_list`` filter.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">obj</span> <span class="o">=</span> <span class="n">objs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
|
<span class="k">except</span> <span class="ne">IndexError</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="p">[],</span> <span class="p">{},</span> <span class="nb">set</span><span class="p">(),</span> <span class="p">[]</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">using</span> <span class="o">=</span> <span class="n">router</span><span class="o">.</span><span class="n">db_for_write</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="p">)</span>
|
|
<span class="n">collector</span> <span class="o">=</span> <span class="n">NestedObjects</span><span class="p">(</span><span class="n">using</span><span class="o">=</span><span class="n">using</span><span class="p">,</span> <span class="n">origin</span><span class="o">=</span><span class="n">objs</span><span class="p">)</span>
|
|
<span class="n">collector</span><span class="o">.</span><span class="n">collect</span><span class="p">(</span><span class="n">objs</span><span class="p">)</span>
|
|
<span class="n">perms_needed</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">format_callback</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
|
|
<span class="n">model</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="vm">__class__</span>
|
|
<span class="n">opts</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">_meta</span>
|
|
|
|
<span class="n">no_edit_link</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">capfirst</span><span class="p">(</span><span class="n">opts</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">),</span> <span class="n">obj</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="n">admin_site</span><span class="o">.</span><span class="n">is_registered</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">admin_site</span><span class="o">.</span><span class="n">get_model_admin</span><span class="p">(</span><span class="n">model</span><span class="p">)</span><span class="o">.</span><span class="n">has_delete_permission</span><span class="p">(</span>
|
|
<span class="n">request</span><span class="p">,</span> <span class="n">obj</span>
|
|
<span class="p">):</span>
|
|
<span class="n">perms_needed</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">opts</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">)</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">admin_url</span> <span class="o">=</span> <span class="n">reverse</span><span class="p">(</span>
|
|
<span class="s2">"</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">_</span><span class="si">%s</span><span class="s2">_change"</span>
|
|
<span class="o">%</span> <span class="p">(</span><span class="n">admin_site</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">opts</span><span class="o">.</span><span class="n">app_label</span><span class="p">,</span> <span class="n">opts</span><span class="o">.</span><span class="n">model_name</span><span class="p">),</span>
|
|
<span class="kc">None</span><span class="p">,</span>
|
|
<span class="p">(</span><span class="n">quote</span><span class="p">(</span><span class="n">obj</span><span class="o">.</span><span class="n">pk</span><span class="p">),),</span>
|
|
<span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">NoReverseMatch</span><span class="p">:</span>
|
|
<span class="c1"># Change url doesn't exist -- don't display link to edit</span>
|
|
<span class="k">return</span> <span class="n">no_edit_link</span>
|
|
|
|
<span class="c1"># Display a link to the admin page.</span>
|
|
<span class="k">return</span> <span class="n">format_html</span><span class="p">(</span>
|
|
<span class="s1">'</span><span class="si">{}</span><span class="s1">: <a href="</span><span class="si">{}</span><span class="s1">"></span><span class="si">{}</span><span class="s1"></a>'</span><span class="p">,</span> <span class="n">capfirst</span><span class="p">(</span><span class="n">opts</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">),</span> <span class="n">admin_url</span><span class="p">,</span> <span class="n">obj</span>
|
|
<span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="c1"># Don't display link to edit, because it either has no</span>
|
|
<span class="c1"># admin or is edited inline.</span>
|
|
<span class="k">return</span> <span class="n">no_edit_link</span>
|
|
|
|
<span class="n">to_delete</span> <span class="o">=</span> <span class="n">collector</span><span class="o">.</span><span class="n">nested</span><span class="p">(</span><span class="n">format_callback</span><span class="p">)</span>
|
|
|
|
<span class="n">protected</span> <span class="o">=</span> <span class="p">[</span><span class="n">format_callback</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">collector</span><span class="o">.</span><span class="n">protected</span><span class="p">]</span>
|
|
<span class="n">model_count</span> <span class="o">=</span> <span class="p">{</span>
|
|
<span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">verbose_name_plural</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">objs</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">model</span><span class="p">,</span> <span class="n">objs</span> <span class="ow">in</span> <span class="n">collector</span><span class="o">.</span><span class="n">model_objs</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="k">return</span> <span class="n">to_delete</span><span class="p">,</span> <span class="n">model_count</span><span class="p">,</span> <span class="n">perms_needed</span><span class="p">,</span> <span class="n">protected</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">NestedObjects</span><span class="p">(</span><span class="n">Collector</span><span class="p">):</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">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">edges</span> <span class="o">=</span> <span class="p">{}</span> <span class="c1"># {from_instance: [to_instances]}</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">protected</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">model_objs</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="nb">set</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">add_edge</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">source</span><span class="p">,</span> <span class="n">target</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">edges</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">target</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">collect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">objs</span><span class="p">,</span> <span class="n">source</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">source_attr</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">objs</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">source_attr</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">source_attr</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"+"</span><span class="p">):</span>
|
|
<span class="n">related_name</span> <span class="o">=</span> <span class="n">source_attr</span> <span class="o">%</span> <span class="p">{</span>
|
|
<span class="s2">"class"</span><span class="p">:</span> <span class="n">source</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model_name</span><span class="p">,</span>
|
|
<span class="s2">"app_label"</span><span class="p">:</span> <span class="n">source</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">app_label</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">related_name</span><span class="p">),</span> <span class="n">obj</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">add_edge</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">obj</span><span class="p">)</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">model_objs</span><span class="p">[</span><span class="n">obj</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="p">]</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
|
<span class="k">try</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">collect</span><span class="p">(</span><span class="n">objs</span><span class="p">,</span> <span class="n">source_attr</span><span class="o">=</span><span class="n">source_attr</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">models</span><span class="o">.</span><span class="n">ProtectedError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">protected</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">protected_objects</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">models</span><span class="o">.</span><span class="n">RestrictedError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">protected</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">restricted_objects</span><span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">related_objects</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">related_model</span><span class="p">,</span> <span class="n">related_fields</span><span class="p">,</span> <span class="n">objs</span><span class="p">):</span>
|
|
<span class="n">qs</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">related_objects</span><span class="p">(</span><span class="n">related_model</span><span class="p">,</span> <span class="n">related_fields</span><span class="p">,</span> <span class="n">objs</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">qs</span><span class="o">.</span><span class="n">select_related</span><span class="p">(</span>
|
|
<span class="o">*</span><span class="p">[</span><span class="n">related_field</span><span class="o">.</span><span class="n">name</span> <span class="k">for</span> <span class="n">related_field</span> <span class="ow">in</span> <span class="n">related_fields</span><span class="p">]</span>
|
|
<span class="p">)</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_nested</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">seen</span><span class="p">,</span> <span class="n">format_callback</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">seen</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="p">[]</span>
|
|
<span class="n">seen</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
|
<span class="n">children</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="n">child</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">edges</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="p">()):</span>
|
|
<span class="n">children</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_nested</span><span class="p">(</span><span class="n">child</span><span class="p">,</span> <span class="n">seen</span><span class="p">,</span> <span class="n">format_callback</span><span class="p">))</span>
|
|
<span class="k">if</span> <span class="n">format_callback</span><span class="p">:</span>
|
|
<span class="n">ret</span> <span class="o">=</span> <span class="p">[</span><span class="n">format_callback</span><span class="p">(</span><span class="n">obj</span><span class="p">)]</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">ret</span> <span class="o">=</span> <span class="p">[</span><span class="n">obj</span><span class="p">]</span>
|
|
<span class="k">if</span> <span class="n">children</span><span class="p">:</span>
|
|
<span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">children</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">ret</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">nested</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">format_callback</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return the graph as a nested list.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">seen</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
|
|
<span class="n">roots</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="n">root</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">edges</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">()):</span>
|
|
<span class="n">roots</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_nested</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">seen</span><span class="p">,</span> <span class="n">format_callback</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">roots</span>
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">can_fast_delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> We always want to load the objects into memory so that we can display</span>
|
|
<span class="sd"> them to the user in confirm page.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="kc">False</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">model_format_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return a `dict` with keys 'verbose_name' and 'verbose_name_plural',</span>
|
|
<span class="sd"> typically for use with string formatting.</span>
|
|
|
|
<span class="sd"> `obj` may be a `Model` instance, `Model` subclass, or `QuerySet` instance.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">base</span><span class="o">.</span><span class="n">ModelBase</span><span class="p">)):</span>
|
|
<span class="n">opts</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">_meta</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">QuerySet</span><span class="p">):</span>
|
|
<span class="n">opts</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">opts</span> <span class="o">=</span> <span class="n">obj</span>
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="s2">"verbose_name"</span><span class="p">:</span> <span class="n">opts</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">,</span>
|
|
<span class="s2">"verbose_name_plural"</span><span class="p">:</span> <span class="n">opts</span><span class="o">.</span><span class="n">verbose_name_plural</span><span class="p">,</span>
|
|
<span class="p">}</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">model_ngettext</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return the appropriate `verbose_name` or `verbose_name_plural` value for</span>
|
|
<span class="sd"> `obj` depending on the count `n`.</span>
|
|
|
|
<span class="sd"> `obj` may be a `Model` instance, `Model` subclass, or `QuerySet` instance.</span>
|
|
<span class="sd"> If `obj` is a `QuerySet` instance, `n` is optional and the length of the</span>
|
|
<span class="sd"> `QuerySet` is used.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">query</span><span class="o">.</span><span class="n">QuerySet</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">n</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="n">n</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">count</span><span class="p">()</span>
|
|
<span class="n">obj</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">model</span>
|
|
<span class="n">d</span> <span class="o">=</span> <span class="n">model_format_dict</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
|
<span class="n">singular</span><span class="p">,</span> <span class="n">plural</span> <span class="o">=</span> <span class="n">d</span><span class="p">[</span><span class="s2">"verbose_name"</span><span class="p">],</span> <span class="n">d</span><span class="p">[</span><span class="s2">"verbose_name_plural"</span><span class="p">]</span>
|
|
<span class="k">return</span> <span class="n">ngettext</span><span class="p">(</span><span class="n">singular</span><span class="p">,</span> <span class="n">plural</span><span class="p">,</span> <span class="n">n</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">lookup_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">model_admin</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="n">opts</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">_meta</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">f</span> <span class="o">=</span> <span class="n">_get_non_gfk_field</span><span class="p">(</span><span class="n">opts</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="p">(</span><span class="n">FieldDoesNotExist</span><span class="p">,</span> <span class="n">FieldIsAForeignKeyColumnName</span><span class="p">):</span>
|
|
<span class="c1"># For non-regular field values, the value is either a method,</span>
|
|
<span class="c1"># property, related field, or returned via a callable.</span>
|
|
<span class="k">if</span> <span class="nb">callable</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="n">name</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">attr</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">model_admin</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="ow">and</span> <span class="n">name</span> <span class="o">!=</span> <span class="s2">"__str__"</span><span class="p">:</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">model_admin</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">attr</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">sentinel</span> <span class="o">=</span> <span class="nb">object</span><span class="p">()</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">sentinel</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="nb">callable</span><span class="p">(</span><span class="n">attr</span><span class="p">):</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">attr</span><span class="p">()</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">attr</span> <span class="ow">is</span> <span class="n">sentinel</span><span class="p">:</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="n">obj</span>
|
|
<span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">LOOKUP_SEP</span><span class="p">):</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="n">part</span><span class="p">,</span> <span class="n">sentinel</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">attr</span> <span class="ow">is</span> <span class="n">sentinel</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">attr</span>
|
|
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">model_admin</span><span class="p">,</span> <span class="s2">"model"</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">model_admin</span><span class="o">.</span><span class="n">model</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">model_admin</span><span class="o">.</span><span class="n">model</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="n">f</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">f</span><span class="p">,</span> <span class="n">attr</span><span class="p">,</span> <span class="n">value</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_get_non_gfk_field</span><span class="p">(</span><span class="n">opts</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> For historical reasons, the admin app relies on GenericForeignKeys as being</span>
|
|
<span class="sd"> "not found" by get_field(). This could likely be cleaned up.</span>
|
|
|
|
<span class="sd"> Reverse relations should also be excluded as these aren't attributes of the</span>
|
|
<span class="sd"> model (rather something like `foo_set`).</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">field</span> <span class="o">=</span> <span class="n">opts</span><span class="o">.</span><span class="n">get_field</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="p">(</span>
|
|
<span class="n">field</span><span class="o">.</span><span class="n">is_relation</span>
|
|
<span class="ow">and</span>
|
|
<span class="c1"># Generic foreign keys OR reverse relations</span>
|
|
<span class="p">((</span><span class="n">field</span><span class="o">.</span><span class="n">many_to_one</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">field</span><span class="o">.</span><span class="n">related_model</span><span class="p">)</span> <span class="ow">or</span> <span class="n">field</span><span class="o">.</span><span class="n">one_to_many</span><span class="p">)</span>
|
|
<span class="p">):</span>
|
|
<span class="k">raise</span> <span class="n">FieldDoesNotExist</span><span class="p">()</span>
|
|
|
|
<span class="c1"># Avoid coercing <FK>_id fields to FK</span>
|
|
<span class="k">if</span> <span class="p">(</span>
|
|
<span class="n">field</span><span class="o">.</span><span class="n">is_relation</span>
|
|
<span class="ow">and</span> <span class="ow">not</span> <span class="n">field</span><span class="o">.</span><span class="n">many_to_many</span>
|
|
<span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="s2">"attname"</span><span class="p">)</span>
|
|
<span class="ow">and</span> <span class="n">field</span><span class="o">.</span><span class="n">attname</span> <span class="o">==</span> <span class="n">name</span>
|
|
<span class="p">):</span>
|
|
<span class="k">raise</span> <span class="n">FieldIsAForeignKeyColumnName</span><span class="p">()</span>
|
|
|
|
<span class="k">return</span> <span class="n">field</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">label_for_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="n">model_admin</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">return_attr</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">form</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Return a sensible label for a field name. The name can be a callable,</span>
|
|
<span class="sd"> property (but not created with @property decorator), or the name of an</span>
|
|
<span class="sd"> object's attribute, as well as a model field, including across related</span>
|
|
<span class="sd"> objects. If return_attr is True, also return the resolved attribute</span>
|
|
<span class="sd"> (which could be a callable). This will be None if (and only if) the name</span>
|
|
<span class="sd"> refers to a field.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">field</span> <span class="o">=</span> <span class="n">_get_non_gfk_field</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">verbose_name</span>
|
|
<span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
|
|
<span class="c1"># field is likely a ForeignObjectRel</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">related_model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">verbose_name</span>
|
|
<span class="k">except</span> <span class="n">FieldDoesNotExist</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s2">"__str__"</span><span class="p">:</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">)</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">str</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="nb">callable</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="n">name</span>
|
|
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">model_admin</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">model_admin</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">form</span> <span class="ow">and</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">form</span><span class="o">.</span><span class="n">fields</span><span class="p">:</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">fields</span><span class="p">[</span><span class="n">name</span><span class="p">]</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="n">get_fields_from_path</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">name</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
|
<span class="k">except</span> <span class="p">(</span><span class="n">FieldDoesNotExist</span><span class="p">,</span> <span class="n">NotRelationField</span><span class="p">):</span>
|
|
<span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"Unable to lookup '</span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2">' on </span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">object_name</span><span class="si">}</span><span class="s2">"</span>
|
|
<span class="k">if</span> <span class="n">model_admin</span><span class="p">:</span>
|
|
<span class="n">message</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">" or </span><span class="si">{</span><span class="n">model_admin</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">"</span>
|
|
<span class="k">if</span> <span class="n">form</span><span class="p">:</span>
|
|
<span class="n">message</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">" or </span><span class="si">{</span><span class="n">form</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">"</span>
|
|
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="s2">"short_description"</span><span class="p">):</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">attr</span><span class="o">.</span><span class="n">short_description</span>
|
|
<span class="k">elif</span> <span class="p">(</span>
|
|
<span class="nb">isinstance</span><span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="nb">property</span><span class="p">)</span>
|
|
<span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">attr</span><span class="p">,</span> <span class="s2">"fget"</span><span class="p">)</span>
|
|
<span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">attr</span><span class="o">.</span><span class="n">fget</span><span class="p">,</span> <span class="s2">"short_description"</span><span class="p">)</span>
|
|
<span class="p">):</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">attr</span><span class="o">.</span><span class="n">fget</span><span class="o">.</span><span class="n">short_description</span>
|
|
<span class="k">elif</span> <span class="nb">callable</span><span class="p">(</span><span class="n">attr</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="n">attr</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"<lambda>"</span><span class="p">:</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="s2">"--"</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">pretty_name</span><span class="p">(</span><span class="n">attr</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">pretty_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">FieldIsAForeignKeyColumnName</span><span class="p">:</span>
|
|
<span class="n">label</span> <span class="o">=</span> <span class="n">pretty_name</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>
|
|
<span class="n">attr</span> <span class="o">=</span> <span class="n">name</span>
|
|
|
|
<span class="k">if</span> <span class="n">return_attr</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">attr</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">label</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">help_text_for_field</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">model</span><span class="p">):</span>
|
|
<span class="n">help_text</span> <span class="o">=</span> <span class="s2">""</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">field</span> <span class="o">=</span> <span class="n">_get_non_gfk_field</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="p">(</span><span class="n">FieldDoesNotExist</span><span class="p">,</span> <span class="n">FieldIsAForeignKeyColumnName</span><span class="p">):</span>
|
|
<span class="k">pass</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="s2">"help_text"</span><span class="p">):</span>
|
|
<span class="n">help_text</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">help_text</span>
|
|
<span class="k">return</span> <span class="n">help_text</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">display_for_field</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">empty_value_display</span><span class="p">):</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.contrib.admin.templatetags.admin_list</span><span class="w"> </span><span class="kn">import</span> <span class="n">_boolean_icon</span>
|
|
|
|
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="s2">"flatchoices"</span><span class="p">,</span> <span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">field</span><span class="o">.</span><span class="n">flatchoices</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">empty_value_display</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
|
<span class="c1"># Allow list-like choices.</span>
|
|
<span class="n">flatchoices</span> <span class="o">=</span> <span class="n">make_hashable</span><span class="p">(</span><span class="n">field</span><span class="o">.</span><span class="n">flatchoices</span><span class="p">)</span>
|
|
<span class="n">value</span> <span class="o">=</span> <span class="n">make_hashable</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="nb">dict</span><span class="p">(</span><span class="n">flatchoices</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">empty_value_display</span><span class="p">)</span>
|
|
|
|
<span class="c1"># BooleanField needs special-case null-handling, so it comes before the</span>
|
|
<span class="c1"># general null test.</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">BooleanField</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">_boolean_icon</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">field</span><span class="o">.</span><span class="n">empty_values</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">empty_value_display</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">DateTimeField</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">localize</span><span class="p">(</span><span class="n">timezone</span><span class="o">.</span><span class="n">template_localtime</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">DateField</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">TimeField</span><span class="p">)):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">localize</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">DecimalField</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">number_format</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">field</span><span class="o">.</span><span class="n">decimal_places</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">IntegerField</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">FloatField</span><span class="p">)):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">number_format</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">FileField</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">format_html</span><span class="p">(</span><span class="s1">'<a href="</span><span class="si">{}</span><span class="s1">"></span><span class="si">{}</span><span class="s1"></a>'</span><span class="p">,</span> <span class="n">value</span><span class="o">.</span><span class="n">url</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">models</span><span class="o">.</span><span class="n">JSONField</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">ensure_ascii</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="bp">cls</span><span class="o">=</span><span class="n">field</span><span class="o">.</span><span class="n">encoder</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">display_for_value</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">empty_value_display</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">display_for_value</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">empty_value_display</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">display_for_value</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">empty_value_display</span><span class="p">,</span> <span class="n">boolean</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.contrib.admin.templatetags.admin_list</span><span class="w"> </span><span class="kn">import</span> <span class="n">_boolean_icon</span>
|
|
|
|
<span class="k">if</span> <span class="n">boolean</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">_boolean_icon</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">EMPTY_VALUES</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">empty_value_display</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">localize</span><span class="p">(</span><span class="n">timezone</span><span class="o">.</span><span class="n">template_localtime</span><span class="p">(</span><span class="n">value</span><span class="p">))</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">date</span><span class="p">,</span> <span class="n">datetime</span><span class="o">.</span><span class="n">time</span><span class="p">)):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">localize</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">int</span><span class="p">,</span> <span class="n">decimal</span><span class="o">.</span><span class="n">Decimal</span><span class="p">,</span> <span class="nb">float</span><span class="p">)):</span>
|
|
<span class="k">return</span> <span class="n">formats</span><span class="o">.</span><span class="n">number_format</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
|
|
<span class="k">return</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">)</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">value</span><span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">class</span><span class="w"> </span><span class="nc">NotRelationField</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
|
<span class="k">pass</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_model_from_relation</span><span class="p">(</span><span class="n">field</span><span class="p">):</span>
|
|
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="s2">"path_infos"</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">field</span><span class="o">.</span><span class="n">path_infos</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">to_opts</span><span class="o">.</span><span class="n">model</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">NotRelationField</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">reverse_field_path</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Create a reversed field path.</span>
|
|
|
|
<span class="sd"> E.g. Given (Order, "user__groups"),</span>
|
|
<span class="sd"> return (Group, "user__order").</span>
|
|
|
|
<span class="sd"> Final field must be a related model, not a data field.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">reversed_path</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="n">parent</span> <span class="o">=</span> <span class="n">model</span>
|
|
<span class="n">pieces</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">LOOKUP_SEP</span><span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">piece</span> <span class="ow">in</span> <span class="n">pieces</span><span class="p">:</span>
|
|
<span class="n">field</span> <span class="o">=</span> <span class="n">parent</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">get_field</span><span class="p">(</span><span class="n">piece</span><span class="p">)</span>
|
|
<span class="c1"># skip trailing data field if extant:</span>
|
|
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">reversed_path</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span><span class="n">pieces</span><span class="p">)</span> <span class="o">-</span> <span class="mi">1</span><span class="p">:</span> <span class="c1"># final iteration</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">get_model_from_relation</span><span class="p">(</span><span class="n">field</span><span class="p">)</span>
|
|
<span class="k">except</span> <span class="n">NotRelationField</span><span class="p">:</span>
|
|
<span class="k">break</span>
|
|
|
|
<span class="c1"># Field should point to another model</span>
|
|
<span class="k">if</span> <span class="n">field</span><span class="o">.</span><span class="n">is_relation</span> <span class="ow">and</span> <span class="ow">not</span> <span class="p">(</span><span class="n">field</span><span class="o">.</span><span class="n">auto_created</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">field</span><span class="o">.</span><span class="n">concrete</span><span class="p">):</span>
|
|
<span class="n">related_name</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">related_query_name</span><span class="p">()</span>
|
|
<span class="n">parent</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">remote_field</span><span class="o">.</span><span class="n">model</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">related_name</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">field</span><span class="o">.</span><span class="n">name</span>
|
|
<span class="n">parent</span> <span class="o">=</span> <span class="n">field</span><span class="o">.</span><span class="n">related_model</span>
|
|
<span class="n">reversed_path</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">related_name</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">parent</span><span class="p">,</span> <span class="n">LOOKUP_SEP</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">reversed_path</span><span class="p">))</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">get_fields_from_path</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""Return list of Fields given path relative to model.</span>
|
|
|
|
<span class="sd"> e.g. (ModelX, "user__groups__name") -> [</span>
|
|
<span class="sd"> <django.db.models.fields.related.ForeignKey object at 0x...>,</span>
|
|
<span class="sd"> <django.db.models.fields.related.ManyToManyField object at 0x...>,</span>
|
|
<span class="sd"> <django.db.models.fields.CharField object at 0x...>,</span>
|
|
<span class="sd"> ]</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">pieces</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">LOOKUP_SEP</span><span class="p">)</span>
|
|
<span class="n">fields</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="n">piece</span> <span class="ow">in</span> <span class="n">pieces</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">fields</span><span class="p">:</span>
|
|
<span class="n">parent</span> <span class="o">=</span> <span class="n">get_model_from_relation</span><span class="p">(</span><span class="n">fields</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="n">parent</span> <span class="o">=</span> <span class="n">model</span>
|
|
<span class="n">fields</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">parent</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">get_field</span><span class="p">(</span><span class="n">piece</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">fields</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">construct_change_message</span><span class="p">(</span><span class="n">form</span><span class="p">,</span> <span class="n">formsets</span><span class="p">,</span> <span class="n">add</span><span class="p">):</span>
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
<span class="sd"> Construct a JSON structure describing changes from a changed object.</span>
|
|
<span class="sd"> Translations are deactivated so that strings are stored untranslated.</span>
|
|
<span class="sd"> Translation happens later on LogEntry access.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># Evaluating `form.changed_data` prior to disabling translations is required</span>
|
|
<span class="c1"># to avoid fields affected by localization from being included incorrectly,</span>
|
|
<span class="c1"># e.g. where date formats differ such as MM/DD/YYYY vs DD/MM/YYYY.</span>
|
|
<span class="n">changed_data</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">changed_data</span>
|
|
<span class="k">with</span> <span class="n">translation_override</span><span class="p">(</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="c1"># Deactivate translations while fetching verbose_name for form</span>
|
|
<span class="c1"># field labels and using `field_name`, if verbose_name is not provided.</span>
|
|
<span class="c1"># Translations will happen later on LogEntry access.</span>
|
|
<span class="n">changed_field_labels</span> <span class="o">=</span> <span class="n">_get_changed_field_labels_from_form</span><span class="p">(</span><span class="n">form</span><span class="p">,</span> <span class="n">changed_data</span><span class="p">)</span>
|
|
|
|
<span class="n">change_message</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">if</span> <span class="n">add</span><span class="p">:</span>
|
|
<span class="n">change_message</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">"added"</span><span class="p">:</span> <span class="p">{}})</span>
|
|
<span class="k">elif</span> <span class="n">form</span><span class="o">.</span><span class="n">changed_data</span><span class="p">:</span>
|
|
<span class="n">change_message</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">"changed"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"fields"</span><span class="p">:</span> <span class="n">changed_field_labels</span><span class="p">}})</span>
|
|
<span class="k">if</span> <span class="n">formsets</span><span class="p">:</span>
|
|
<span class="k">with</span> <span class="n">translation_override</span><span class="p">(</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="k">for</span> <span class="n">formset</span> <span class="ow">in</span> <span class="n">formsets</span><span class="p">:</span>
|
|
<span class="k">for</span> <span class="n">added_object</span> <span class="ow">in</span> <span class="n">formset</span><span class="o">.</span><span class="n">new_objects</span><span class="p">:</span>
|
|
<span class="n">change_message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"added"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s2">"name"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">added_object</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">),</span>
|
|
<span class="s2">"object"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">added_object</span><span class="p">),</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">changed_object</span><span class="p">,</span> <span class="n">changed_fields</span> <span class="ow">in</span> <span class="n">formset</span><span class="o">.</span><span class="n">changed_objects</span><span class="p">:</span>
|
|
<span class="n">change_message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"changed"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s2">"name"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">changed_object</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">),</span>
|
|
<span class="s2">"object"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">changed_object</span><span class="p">),</span>
|
|
<span class="s2">"fields"</span><span class="p">:</span> <span class="n">_get_changed_field_labels_from_form</span><span class="p">(</span>
|
|
<span class="n">formset</span><span class="o">.</span><span class="n">forms</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">changed_fields</span>
|
|
<span class="p">),</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
<span class="k">for</span> <span class="n">deleted_object</span> <span class="ow">in</span> <span class="n">formset</span><span class="o">.</span><span class="n">deleted_objects</span><span class="p">:</span>
|
|
<span class="n">change_message</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
|
<span class="p">{</span>
|
|
<span class="s2">"deleted"</span><span class="p">:</span> <span class="p">{</span>
|
|
<span class="s2">"name"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">deleted_object</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">verbose_name</span><span class="p">),</span>
|
|
<span class="s2">"object"</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">deleted_object</span><span class="p">),</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">change_message</span>
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_get_changed_field_labels_from_form</span><span class="p">(</span><span class="n">form</span><span class="p">,</span> <span class="n">changed_data</span><span class="p">):</span>
|
|
<span class="n">changed_field_labels</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="k">for</span> <span class="n">field_name</span> <span class="ow">in</span> <span class="n">changed_data</span><span class="p">:</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">verbose_field_name</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">fields</span><span class="p">[</span><span class="n">field_name</span><span class="p">]</span><span class="o">.</span><span class="n">label</span> <span class="ow">or</span> <span class="n">field_name</span>
|
|
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
|
|
<span class="n">verbose_field_name</span> <span class="o">=</span> <span class="n">field_name</span>
|
|
<span class="n">changed_field_labels</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">verbose_field_name</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">changed_field_labels</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> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">django.contrib.admin.utils</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |