mirror of
https://github.com/evennia/evennia.git
synced 2026-03-27 18:26:32 +01:00
208 lines
No EOL
14 KiB
HTML
208 lines
No EOL
14 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>evennia.web.admin.utils — Evennia 2.x documentation</title>
|
|
<link rel="stylesheet" href="../../../../_static/nature.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
|
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
|
<script src="../../../../_static/jquery.js"></script>
|
|
<script src="../../../../_static/underscore.js"></script>
|
|
<script src="../../../../_static/doctools.js"></script>
|
|
<script src="../../../../_static/language_data.js"></script>
|
|
<link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
|
|
<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 2.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../../../evennia.html" accesskey="U">evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.utils</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../../../../index.html">
|
|
<img class="logo" src="../../../../_static/evennia_logo.png" alt="Logo"/>
|
|
</a></p>
|
|
<div 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" />
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<script>$('#searchbox').show(0);</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>
|
|
<h3>Doc Versions</h3>
|
|
<ul>
|
|
|
|
<li><a href="utils.html">2.x (main branch)</a></li>
|
|
<ul>
|
|
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
|
|
|
|
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for evennia.web.admin.utils</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</span>
|
|
<span class="sd">Helper utils for admin views.</span>
|
|
|
|
<span class="sd">"""</span>
|
|
|
|
<span class="kn">import</span> <span class="nn">importlib</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">get_all_cmdsets</span><span class="p">,</span> <span class="n">get_all_typeclasses</span><span class="p">,</span> <span class="n">inherits_from</span>
|
|
|
|
|
|
<div class="viewcode-block" id="get_and_load_typeclasses"><a class="viewcode-back" href="../../../../api/evennia.web.admin.utils.html#evennia.web.admin.utils.get_and_load_typeclasses">[docs]</a><span class="k">def</span> <span class="nf">get_and_load_typeclasses</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">excluded_parents</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"> Get all typeclasses. We we need to initialize things here</span>
|
|
<span class="sd"> for them to be actually available in the admin process.</span>
|
|
<span class="sd"> This is intended to be used with forms.ChoiceField.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> parent (str or class, optional): Limit selection to this class and its children</span>
|
|
<span class="sd"> (at any distance).</span>
|
|
<span class="sd"> exclude (list): Class-parents to exclude from the resulting list. All</span>
|
|
<span class="sd"> children of these paretns will be skipped.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> list: A list of (str, str), the way ChoiceField wants it.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># this is necessary in order to have typeclasses imported and accessible</span>
|
|
<span class="c1"># in the inheritance tree.</span>
|
|
<span class="kn">import</span> <span class="nn">evennia</span>
|
|
|
|
<span class="n">evennia</span><span class="o">.</span><span class="n">_init</span><span class="p">()</span>
|
|
|
|
<span class="c1"># this return a dict (path: class}</span>
|
|
<span class="n">tmap</span> <span class="o">=</span> <span class="n">get_all_typeclasses</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="n">parent</span><span class="p">)</span>
|
|
|
|
<span class="c1"># filter out any excludes</span>
|
|
<span class="n">excluded_parents</span> <span class="o">=</span> <span class="n">excluded_parents</span> <span class="ow">or</span> <span class="p">[]</span>
|
|
<span class="n">tpaths</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="n">path</span>
|
|
<span class="k">for</span> <span class="n">path</span><span class="p">,</span> <span class="n">tclass</span> <span class="ow">in</span> <span class="n">tmap</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">inherits_from</span><span class="p">(</span><span class="n">tclass</span><span class="p">,</span> <span class="n">excl</span><span class="p">)</span> <span class="k">for</span> <span class="n">excl</span> <span class="ow">in</span> <span class="n">excluded_parents</span><span class="p">)</span>
|
|
<span class="p">]</span>
|
|
|
|
<span class="c1"># sort so we get custom paths (not in evennia repo) first</span>
|
|
<span class="n">tpaths</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">tpaths</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">k</span><span class="p">:</span> <span class="p">(</span><span class="mi">1</span> <span class="k">if</span> <span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"evennia."</span><span class="p">)</span> <span class="k">else</span> <span class="mi">0</span><span class="p">,</span> <span class="n">k</span><span class="p">))</span>
|
|
|
|
<span class="c1"># the base models are not typeclasses so we filter them out</span>
|
|
<span class="n">tpaths</span> <span class="o">=</span> <span class="p">[</span>
|
|
<span class="n">path</span>
|
|
<span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">tpaths</span>
|
|
<span class="k">if</span> <span class="n">path</span>
|
|
<span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span>
|
|
<span class="s2">"evennia.objects.models.ObjectDB"</span><span class="p">,</span>
|
|
<span class="s2">"evennia.accounts.models.AccountDB"</span><span class="p">,</span>
|
|
<span class="s2">"evennia.scripts.models.ScriptDB"</span><span class="p">,</span>
|
|
<span class="s2">"evennia.comms.models.ChannelDB"</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="p">]</span>
|
|
|
|
<span class="c1"># return on form excepted by ChoiceField</span>
|
|
<span class="k">return</span> <span class="p">[(</span><span class="n">path</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">tpaths</span> <span class="k">if</span> <span class="n">path</span><span class="p">]</span></div>
|
|
|
|
|
|
<div class="viewcode-block" id="get_and_load_cmdsets"><a class="viewcode-back" href="../../../../api/evennia.web.admin.utils.html#evennia.web.admin.utils.get_and_load_cmdsets">[docs]</a><span class="k">def</span> <span class="nf">get_and_load_cmdsets</span><span class="p">(</span><span class="n">parent</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">excluded_parents</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"> Get all cmdsets available or as children based on a parent cmdset. We need</span>
|
|
<span class="sd"> to initialize things here to make sure as much as possible is loaded in the</span>
|
|
<span class="sd"> admin process. This is intended to be used with forms.ChoiceField.</span>
|
|
|
|
<span class="sd"> Args:</span>
|
|
<span class="sd"> parent (str, optional): Python-path to the parent cmdset, if any.</span>
|
|
<span class="sd"> excluded_parents (list): A list of cmset-paths to exclude from the result.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> list: A list of (str, str), the way ChoiceField wants it.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="c1"># we must do this to have cmdsets imported and accessible in the inheritance tree.</span>
|
|
<span class="kn">import</span> <span class="nn">evennia</span>
|
|
|
|
<span class="n">evennia</span><span class="o">.</span><span class="n">_init</span><span class="p">()</span>
|
|
|
|
<span class="n">cmap</span> <span class="o">=</span> <span class="n">get_all_cmdsets</span><span class="p">(</span><span class="n">parent</span><span class="p">)</span>
|
|
|
|
<span class="n">excluded_parents</span> <span class="o">=</span> <span class="n">excluded_parents</span> <span class="ow">or</span> <span class="p">[]</span>
|
|
<span class="n">cpaths</span> <span class="o">=</span> <span class="p">[</span><span class="n">path</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">cmap</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">any</span><span class="p">(</span><span class="n">path</span> <span class="o">==</span> <span class="n">excluded</span> <span class="k">for</span> <span class="n">excluded</span> <span class="ow">in</span> <span class="n">excluded_parents</span><span class="p">)]</span>
|
|
|
|
<span class="n">cpaths</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">cpaths</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">k</span><span class="p">:</span> <span class="p">(</span><span class="mi">1</span> <span class="k">if</span> <span class="n">k</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"evennia."</span><span class="p">)</span> <span class="k">else</span> <span class="mi">0</span><span class="p">,</span> <span class="n">k</span><span class="p">))</span>
|
|
|
|
<span class="c1"># return on form expected by ChoiceField</span>
|
|
<span class="k">return</span> <span class="p">[(</span><span class="s2">""</span><span class="p">,</span> <span class="s2">"-"</span><span class="p">)]</span> <span class="o">+</span> <span class="p">[(</span><span class="n">path</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">cpaths</span> <span class="k">if</span> <span class="n">path</span><span class="p">]</span></div>
|
|
</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 2.x</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-2"><a href="../../../evennia.html" >evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.utils</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2023, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |