Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-24 16:56:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/_modules/evennia/help/filehelp.html
Griatch 4dc5b239aa Updated HTML docs
2021-05-30 21:07:39 +02:00

314 lines
No EOL
25 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.help.filehelp &#8212; Evennia 1.0-dev 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 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.help.filehelp</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.help.filehelp</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">The filehelp-system allows for defining help files outside of the game. These</span>
<span class="sd">will be treated as non-command help entries and displayed in the same way as</span>
<span class="sd">help entries created using the `sethelp` default command. After changing an</span>
<span class="sd">entry on-disk you need to reload the server to have the change show in-game.</span>
<span class="sd">An filehelp file is a regular python module with dicts representing each help</span>
<span class="sd">entry. If a list `HELP_ENTRY_DICTS` is found in the module, this should be a list of</span>
<span class="sd">dicts. Otherwise *all* top-level dicts in the module will be assumed to be a</span>
<span class="sd">help-entry dict.</span>
<span class="sd">Each help-entry dict is on the form</span>
<span class="sd">::</span>
<span class="sd"> {&#39;key&#39;: &lt;str&gt;,</span>
<span class="sd"> &#39;text&#39;: &lt;str&gt;,</span>
<span class="sd"> &#39;category&#39;: &lt;str&gt;, # optional, otherwise settings.DEFAULT_HELP_CATEGORY</span>
<span class="sd"> &#39;aliases&#39;: &lt;list&gt;, # optional</span>
<span class="sd"> &#39;locks&#39;: &lt;str&gt;} # optional, use access-type &#39;view&#39;. Default is view:all()</span>
<span class="sd">The `text`` should be formatted on the same form as other help entry-texts and</span>
<span class="sd">can contain ``# subtopics`` as normal.</span>
<span class="sd">New help-entry modules are added to the system by providing the python-path to</span>
<span class="sd">the module to `settings.FILE_HELP_ENTRY_MODULES`. Note that if same-key entries are</span>
<span class="sd">added, entries in latter modules will override that of earlier ones. Use</span>
<span class="sd">`settings.DEFAULT_HELP_CATEGORY`` to customize what category is used if</span>
<span class="sd">not set explicitly.</span>
<span class="sd">An example of the contents of a module:</span>
<span class="sd">::</span>
<span class="sd"> help_entry1 = {</span>
<span class="sd"> &quot;key&quot;: &quot;The Gods&quot;, # case-insensitive, also partial-matching (&#39;gods&#39;) works</span>
<span class="sd"> &quot;aliases&quot;: [&#39;pantheon&#39;, &#39;religion&#39;],</span>
<span class="sd"> &quot;category&quot;: &quot;Lore&quot;,</span>
<span class="sd"> &quot;locks&quot;: &quot;view:all()&quot;, # this is optional unless restricting access</span>
<span class="sd"> &quot;text&quot;: &#39;&#39;&#39;</span>
<span class="sd"> The gods formed the world ...</span>
<span class="sd"> # Subtopics</span>
<span class="sd"> ## Pantheon</span>
<span class="sd"> ...</span>
<span class="sd"> ### God of love</span>
<span class="sd"> ...</span>
<span class="sd"> ### God of war</span>
<span class="sd"> ...</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="sd"> }</span>
<span class="sd"> HELP_ENTRY_DICTS = [</span>
<span class="sd"> help_entry1,</span>
<span class="sd"> ...</span>
<span class="sd"> ]</span>
<span class="sd">----</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">variable_from_module</span><span class="p">,</span> <span class="n">make_iter</span><span class="p">,</span> <span class="n">all_from_module</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">evennia.utils</span> <span class="kn">import</span> <span class="n">logger</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">lazy_property</span>
<span class="kn">from</span> <span class="nn">evennia.locks.lockhandler</span> <span class="kn">import</span> <span class="n">LockHandler</span>
<span class="n">_DEFAULT_HELP_CATEGORY</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">DEFAULT_HELP_CATEGORY</span>
<div class="viewcode-block" id="FileHelpEntry"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry">[docs]</a><span class="nd">@dataclass</span>
<span class="k">class</span> <span class="nc">FileHelpEntry</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Represents a help entry read from file. This mimics the api of the</span>
<span class="sd"> database-bound HelpEntry so that they can be used interchangeably in the</span>
<span class="sd"> help command.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">key</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">aliases</span><span class="p">:</span> <span class="nb">list</span>
<span class="n">help_category</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">entrytext</span><span class="p">:</span> <span class="nb">str</span>
<span class="n">lock_storage</span><span class="p">:</span> <span class="nb">str</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">search_index_entry</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Property for easily retaining a search index entry for this object.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="p">,</span>
<span class="s2">&quot;aliases&quot;</span><span class="p">:</span> <span class="s2">&quot; &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aliases</span><span class="p">),</span>
<span class="s2">&quot;category&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">help_category</span><span class="p">,</span>
<span class="s2">&quot;tags&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;locks&quot;</span><span class="p">:</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="s2">&quot;text&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">entrytext</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">key</span>
<span class="k">def</span> <span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="sa">f</span><span class="s2">&quot;&lt;FileHelpEntry </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2">&gt;&quot;</span>
<div class="viewcode-block" id="FileHelpEntry.locks"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.locks">[docs]</a> <span class="nd">@lazy_property</span>
<span class="k">def</span> <span class="nf">locks</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">LockHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
<div class="viewcode-block" id="FileHelpEntry.access"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpEntry.access">[docs]</a> <span class="k">def</span> <span class="nf">access</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">accessing_obj</span><span class="p">,</span> <span class="n">access_type</span><span class="o">=</span><span class="s2">&quot;view&quot;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Determines if another object has permission to access this help entry.</span>
<span class="sd"> Args:</span>
<span class="sd"> accessing_obj (Object or Account): Entity trying to access this one.</span>
<span class="sd"> access_type (str): type of access sought.</span>
<span class="sd"> default (bool): What to return if no lock of `access_type` was found.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">locks</span><span class="o">.</span><span class="n">check</span><span class="p">(</span><span class="n">accessing_obj</span><span class="p">,</span> <span class="n">access_type</span><span class="o">=</span><span class="n">access_type</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="n">default</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="FileHelpStorageHandler"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler">[docs]</a><span class="k">class</span> <span class="nc">FileHelpStorageHandler</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This reads and stores help entries for quick access. By default</span>
<span class="sd"> it reads modules from `settings.FILE_HELP_ENTRY_MODULES`.</span>
<span class="sd"> Note that this is not meant to any searching/lookup - that is all handled</span>
<span class="sd"> by the help command.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="FileHelpStorageHandler.__init__"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler.__init__">[docs]</a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">help_file_modules</span><span class="o">=</span><span class="n">settings</span><span class="o">.</span><span class="n">FILE_HELP_ENTRY_MODULES</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Initialize the storage.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">help_file_modules</span> <span class="o">=</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">part</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">make_iter</span><span class="p">(</span><span class="n">help_file_modules</span><span class="p">)]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">help_entries</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">help_entries_dict</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">load</span><span class="p">()</span></div>
<div class="viewcode-block" id="FileHelpStorageHandler.load"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler.load">[docs]</a> <span class="k">def</span> <span class="nf">load</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Load/reload file-based help-entries from file.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">loaded_help_dicts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">module_or_path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">help_file_modules</span><span class="p">:</span>
<span class="n">help_dict_list</span> <span class="o">=</span> <span class="n">variable_from_module</span><span class="p">(</span>
<span class="n">module_or_path</span><span class="p">,</span> <span class="n">variable</span><span class="o">=</span><span class="s2">&quot;HELP_ENTRY_DICTS&quot;</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">help_dict_list</span><span class="p">:</span>
<span class="n">help_dict_list</span> <span class="o">=</span> <span class="p">[</span>
<span class="n">dct</span> <span class="k">for</span> <span class="n">dct</span> <span class="ow">in</span> <span class="n">all_from_module</span><span class="p">(</span><span class="n">module_or_path</span><span class="p">)</span><span class="o">.</span><span class="n">values</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dct</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)]</span>
<span class="k">if</span> <span class="n">help_dict_list</span><span class="p">:</span>
<span class="n">loaded_help_dicts</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">help_dict_list</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">log_err</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Could not find file-help module </span><span class="si">{</span><span class="n">module_or_path</span><span class="si">}</span><span class="s2"> (skipping).&quot;</span><span class="p">)</span>
<span class="c1"># validate and parse dicts into FileEntryHelp objects and make sure they are unique-by-key</span>
<span class="c1"># by letting latter added ones override earlier ones.</span>
<span class="n">unique_help_entries</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">for</span> <span class="n">dct</span> <span class="ow">in</span> <span class="n">loaded_help_dicts</span><span class="p">:</span>
<span class="n">key</span> <span class="o">=</span> <span class="n">dct</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;key&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">category</span> <span class="o">=</span> <span class="n">dct</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;category&#39;</span><span class="p">,</span> <span class="n">_DEFAULT_HELP_CATEGORY</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="n">aliases</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">dct</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;aliases&#39;</span><span class="p">,</span> <span class="p">[]))</span>
<span class="n">entrytext</span> <span class="o">=</span> <span class="n">dct</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;text&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
<span class="n">locks</span> <span class="o">=</span> <span class="n">dct</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;locks&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">key</span> <span class="ow">and</span> <span class="n">entrytext</span><span class="p">:</span>
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Cannot load file-help-entry (missing key or text): </span><span class="si">{</span><span class="n">dct</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="k">continue</span>
<span class="n">unique_help_entries</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">FileHelpEntry</span><span class="p">(</span>
<span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">help_category</span><span class="o">=</span><span class="n">category</span><span class="p">,</span> <span class="n">aliases</span><span class="o">=</span><span class="n">aliases</span><span class="p">,</span> <span class="n">lock_storage</span><span class="o">=</span><span class="n">locks</span><span class="p">,</span>
<span class="n">entrytext</span><span class="o">=</span><span class="n">entrytext</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">help_entries_dict</span> <span class="o">=</span> <span class="n">unique_help_entries</span>
<span class="bp">self</span><span class="o">.</span><span class="n">help_entries</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">unique_help_entries</span><span class="o">.</span><span class="n">values</span><span class="p">())</span></div>
<div class="viewcode-block" id="FileHelpStorageHandler.all"><a class="viewcode-back" href="../../../api/evennia.help.filehelp.html#evennia.help.filehelp.FileHelpStorageHandler.all">[docs]</a> <span class="k">def</span> <span class="nf">all</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">return_dict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Get all help entries.</span>
<span class="sd"> Args:</span>
<span class="sd"> return_dict (bool): Return a dict ``{key: FileHelpEntry,...}``. Otherwise,</span>
<span class="sd"> return a list of ``FileHelpEntry`.</span>
<span class="sd"> Returns:</span>
<span class="sd"> dict or list: Depending on the setting of ``return_dict``.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">help_entries_dict</span> <span class="k">if</span> <span class="n">return_dict</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">help_entries</span></div></div>
<span class="c1"># singleton to hold the loaded help entries</span>
<span class="n">FILE_HELP_ENTRIES</span> <span class="o">=</span> <span class="n">FileHelpStorageHandler</span><span class="p">()</span>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<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">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li><a href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">IRC</a> -
<a href="https://discord.gg/NecFePw">Discord</a> -
<a href="https://groups.google.com/forum/#%21forum/evennia">Forums</a>
</li>
<li><a href="http://evennia.blogspot.com/">Evennia Dev blog</a> </li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="filehelp.html">1.0-dev (develop 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="clearer"></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 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.help.filehelp</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink