mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 16:26:30 +01:00
395 lines
No EOL
32 KiB
HTML
395 lines
No EOL
32 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>evennia.help.models — 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> »</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.help.models</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.models</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""</span>
|
|
<span class="sd">Models for the help system.</span>
|
|
|
|
<span class="sd">The database-tied help system is only half of Evennia's help</span>
|
|
<span class="sd">functionality, the other one being the auto-generated command help</span>
|
|
<span class="sd">that is created on the fly from each command's `__doc__` string. The</span>
|
|
<span class="sd">persistent database system defined here is intended for all other</span>
|
|
<span class="sd">forms of help that do not concern commands, like information about the</span>
|
|
<span class="sd">game world, policy info, rules and similar.</span>
|
|
|
|
<span class="sd">"""</span>
|
|
<span class="kn">from</span> <span class="nn">django.contrib.contenttypes.models</span> <span class="kn">import</span> <span class="n">ContentType</span>
|
|
<span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">models</span>
|
|
<span class="kn">from</span> <span class="nn">django.urls</span> <span class="kn">import</span> <span class="n">reverse</span>
|
|
<span class="kn">from</span> <span class="nn">django.utils.text</span> <span class="kn">import</span> <span class="n">slugify</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">evennia.utils.idmapper.models</span> <span class="kn">import</span> <span class="n">SharedMemoryModel</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.help.manager</span> <span class="kn">import</span> <span class="n">HelpEntryManager</span>
|
|
<span class="kn">from</span> <span class="nn">evennia.typeclasses.models</span> <span class="kn">import</span> <span class="n">Tag</span><span class="p">,</span> <span class="n">TagHandler</span><span class="p">,</span> <span class="n">AliasHandler</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="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">lazy_property</span>
|
|
|
|
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"HelpEntry"</span><span class="p">,)</span>
|
|
|
|
|
|
<span class="c1"># ------------------------------------------------------------</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># HelpEntry</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># ------------------------------------------------------------</span>
|
|
|
|
|
|
<div class="viewcode-block" id="HelpEntry"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry">[docs]</a><span class="k">class</span> <span class="nc">HelpEntry</span><span class="p">(</span><span class="n">SharedMemoryModel</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> A generic help entry.</span>
|
|
|
|
<span class="sd"> An HelpEntry object has the following properties defined:</span>
|
|
<span class="sd"> key - main name of entry</span>
|
|
<span class="sd"> help_category - which category entry belongs to (defaults to General)</span>
|
|
<span class="sd"> entrytext - the actual help text</span>
|
|
<span class="sd"> permissions - perm strings</span>
|
|
|
|
<span class="sd"> Method:</span>
|
|
<span class="sd"> access</span>
|
|
|
|
<span class="sd"> """</span>
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1"># HelpEntry Database Model setup</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># These database fields are all set using their corresponding properties,</span>
|
|
<span class="c1"># named same as the field, but withtout the db_* prefix.</span>
|
|
|
|
<span class="c1"># title of the help entry</span>
|
|
<span class="n">db_key</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span>
|
|
<span class="s2">"help key"</span><span class="p">,</span> <span class="n">max_length</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">help_text</span><span class="o">=</span><span class="s2">"key to search for"</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># help category</span>
|
|
<span class="n">db_help_category</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span>
|
|
<span class="s2">"help category"</span><span class="p">,</span>
|
|
<span class="n">max_length</span><span class="o">=</span><span class="mi">255</span><span class="p">,</span>
|
|
<span class="n">default</span><span class="o">=</span><span class="s2">"General"</span><span class="p">,</span>
|
|
<span class="n">help_text</span><span class="o">=</span><span class="s2">"organizes help entries in lists"</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># the actual help entry text, in any formatting.</span>
|
|
<span class="n">db_entrytext</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">TextField</span><span class="p">(</span>
|
|
<span class="s2">"help entry"</span><span class="p">,</span> <span class="n">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">help_text</span><span class="o">=</span><span class="s2">"the main body of help text"</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># lock string storage</span>
|
|
<span class="n">db_lock_storage</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">TextField</span><span class="p">(</span><span class="s2">"locks"</span><span class="p">,</span> <span class="n">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">help_text</span><span class="o">=</span><span class="s2">"normally view:all()."</span><span class="p">)</span>
|
|
<span class="c1"># tags are primarily used for permissions</span>
|
|
<span class="n">db_tags</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ManyToManyField</span><span class="p">(</span>
|
|
<span class="n">Tag</span><span class="p">,</span>
|
|
<span class="n">blank</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
<span class="n">help_text</span><span class="o">=</span><span class="s2">"tags on this object. Tags are simple string markers to "</span>
|
|
<span class="s2">"identify, group and alias objects."</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="c1"># (deprecated, only here to allow MUX helpfile load (don't use otherwise)).</span>
|
|
<span class="c1"># TODO: remove this when not needed anymore.</span>
|
|
<span class="n">db_staff_only</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">BooleanField</span><span class="p">(</span><span class="n">default</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Database manager</span>
|
|
<span class="n">objects</span> <span class="o">=</span> <span class="n">HelpEntryManager</span><span class="p">()</span>
|
|
<span class="n">_is_deleted</span> <span class="o">=</span> <span class="kc">False</span>
|
|
|
|
<span class="c1"># lazy-loaded handlers</span>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.locks"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.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="HelpEntry.tags"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.tags">[docs]</a> <span class="nd">@lazy_property</span>
|
|
<span class="k">def</span> <span class="nf">tags</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">TagHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.aliases"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.aliases">[docs]</a> <span class="nd">@lazy_property</span>
|
|
<span class="k">def</span> <span class="nf">aliases</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">return</span> <span class="n">AliasHandler</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span></div>
|
|
|
|
<span class="k">class</span> <span class="nc">Meta</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="s2">"Define Django meta options"</span>
|
|
<span class="n">verbose_name</span> <span class="o">=</span> <span class="s2">"Help Entry"</span>
|
|
<span class="n">verbose_name_plural</span> <span class="o">=</span> <span class="s2">"Help Entries"</span>
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># HelpEntry main class methods</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1">#</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">"<HelpEntry </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">>"</span>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.access"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.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">"read"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Determines if another object has permission to access.</span>
|
|
<span class="sd"> accessing_obj - object trying to access this one</span>
|
|
<span class="sd"> access_type - type of access sought</span>
|
|
<span class="sd"> default - what to return if no lock of access_type was found</span>
|
|
<span class="sd"> """</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>
|
|
|
|
<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">"""</span>
|
|
<span class="sd"> Property for easily retaining a search index entry for this object.</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="p">{</span>
|
|
<span class="s2">"key"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_key</span><span class="p">,</span>
|
|
<span class="s2">"aliases"</span><span class="p">:</span> <span class="s2">" "</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="o">.</span><span class="n">all</span><span class="p">()),</span>
|
|
<span class="s2">"category"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_help_category</span><span class="p">,</span>
|
|
<span class="s2">"text"</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">db_entrytext</span><span class="p">,</span>
|
|
<span class="s2">"tags"</span><span class="p">:</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">tag</span><span class="p">)</span> <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">all</span><span class="p">()),</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="c1">#</span>
|
|
<span class="c1"># Web/Django methods</span>
|
|
<span class="c1">#</span>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.web_get_admin_url"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.web_get_admin_url">[docs]</a> <span class="k">def</span> <span class="nf">web_get_admin_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Returns the URI path for the Django Admin page for this object.</span>
|
|
|
|
<span class="sd"> ex. Account#1 = '/admin/accounts/accountdb/1/change/'</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> path (str): URI path to Django Admin page for object.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="n">content_type</span> <span class="o">=</span> <span class="n">ContentType</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_for_model</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">reverse</span><span class="p">(</span>
|
|
<span class="s2">"admin:</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">content_type</span><span class="o">.</span><span class="n">app_label</span><span class="p">,</span> <span class="n">content_type</span><span class="o">.</span><span class="n">model</span><span class="p">),</span> <span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,)</span>
|
|
<span class="p">)</span></div>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.web_get_create_url"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.web_get_create_url">[docs]</a> <span class="nd">@classmethod</span>
|
|
<span class="k">def</span> <span class="nf">web_get_create_url</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Returns the URI path for a View that allows users to create new</span>
|
|
<span class="sd"> instances of this object.</span>
|
|
|
|
<span class="sd"> ex. Chargen = '/characters/create/'</span>
|
|
|
|
<span class="sd"> For this to work, the developer must have defined a named view somewhere</span>
|
|
<span class="sd"> in urls.py that follows the format 'modelname-action', so in this case</span>
|
|
<span class="sd"> a named view of 'character-create' would be referenced by this method.</span>
|
|
|
|
<span class="sd"> ex.</span>
|
|
<span class="sd"> url(r'characters/create/', ChargenView.as_view(), name='character-create')</span>
|
|
|
|
<span class="sd"> If no View has been created and defined in urls.py, returns an</span>
|
|
<span class="sd"> HTML anchor.</span>
|
|
|
|
<span class="sd"> This method is naive and simply returns a path. Securing access to</span>
|
|
<span class="sd"> the actual view and limiting who can create new objects is the</span>
|
|
<span class="sd"> developer's responsibility.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> path (str): URI path to object creation page, if defined.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">reverse</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">-create"</span> <span class="o">%</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">cls</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="k">except</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="s2">"#"</span></div>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.web_get_detail_url"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.web_get_detail_url">[docs]</a> <span class="k">def</span> <span class="nf">web_get_detail_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Returns the URI path for a View that allows users to view details for</span>
|
|
<span class="sd"> this object.</span>
|
|
|
|
<span class="sd"> ex. Oscar (Character) = '/characters/oscar/1/'</span>
|
|
|
|
<span class="sd"> For this to work, the developer must have defined a named view somewhere</span>
|
|
<span class="sd"> in urls.py that follows the format 'modelname-action', so in this case</span>
|
|
<span class="sd"> a named view of 'character-detail' would be referenced by this method.</span>
|
|
|
|
<span class="sd"> ex.</span>
|
|
<span class="sd"> url(r'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/$',</span>
|
|
<span class="sd"> CharDetailView.as_view(), name='character-detail')</span>
|
|
|
|
<span class="sd"> If no View has been created and defined in urls.py, returns an</span>
|
|
<span class="sd"> HTML anchor.</span>
|
|
|
|
<span class="sd"> This method is naive and simply returns a path. Securing access to</span>
|
|
<span class="sd"> the actual view and limiting who can view this object is the developer's</span>
|
|
<span class="sd"> responsibility.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> path (str): URI path to object detail page, if defined.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">reverse</span><span class="p">(</span>
|
|
<span class="s2">"</span><span class="si">%s</span><span class="s2">-detail"</span> <span class="o">%</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</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">kwargs</span><span class="o">=</span><span class="p">{</span><span class="s2">"category"</span><span class="p">:</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_help_category</span><span class="p">),</span> <span class="s2">"topic"</span><span class="p">:</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_key</span><span class="p">)},</span>
|
|
<span class="p">)</span>
|
|
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="s2">"#"</span></div>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.web_get_update_url"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.web_get_update_url">[docs]</a> <span class="k">def</span> <span class="nf">web_get_update_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Returns the URI path for a View that allows users to update this</span>
|
|
<span class="sd"> object.</span>
|
|
|
|
<span class="sd"> ex. Oscar (Character) = '/characters/oscar/1/change/'</span>
|
|
|
|
<span class="sd"> For this to work, the developer must have defined a named view somewhere</span>
|
|
<span class="sd"> in urls.py that follows the format 'modelname-action', so in this case</span>
|
|
<span class="sd"> a named view of 'character-update' would be referenced by this method.</span>
|
|
|
|
<span class="sd"> ex.</span>
|
|
<span class="sd"> url(r'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/change/$',</span>
|
|
<span class="sd"> CharUpdateView.as_view(), name='character-update')</span>
|
|
|
|
<span class="sd"> If no View has been created and defined in urls.py, returns an</span>
|
|
<span class="sd"> HTML anchor.</span>
|
|
|
|
<span class="sd"> This method is naive and simply returns a path. Securing access to</span>
|
|
<span class="sd"> the actual view and limiting who can modify objects is the developer's</span>
|
|
<span class="sd"> responsibility.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> path (str): URI path to object update page, if defined.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">reverse</span><span class="p">(</span>
|
|
<span class="s2">"</span><span class="si">%s</span><span class="s2">-update"</span> <span class="o">%</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</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">kwargs</span><span class="o">=</span><span class="p">{</span><span class="s2">"category"</span><span class="p">:</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_help_category</span><span class="p">),</span> <span class="s2">"topic"</span><span class="p">:</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_key</span><span class="p">)},</span>
|
|
<span class="p">)</span>
|
|
<span class="k">except</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="s2">"#"</span></div>
|
|
|
|
<div class="viewcode-block" id="HelpEntry.web_get_delete_url"><a class="viewcode-back" href="../../../api/evennia.help.models.html#evennia.help.admin.HelpEntry.web_get_delete_url">[docs]</a> <span class="k">def</span> <span class="nf">web_get_delete_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""</span>
|
|
<span class="sd"> Returns the URI path for a View that allows users to delete this object.</span>
|
|
|
|
<span class="sd"> ex. Oscar (Character) = '/characters/oscar/1/delete/'</span>
|
|
|
|
<span class="sd"> For this to work, the developer must have defined a named view somewhere</span>
|
|
<span class="sd"> in urls.py that follows the format 'modelname-action', so in this case</span>
|
|
<span class="sd"> a named view of 'character-detail' would be referenced by this method.</span>
|
|
|
|
<span class="sd"> ex.</span>
|
|
<span class="sd"> url(r'characters/(?P<slug>[\w\d\-]+)/(?P<pk>[0-9]+)/delete/$',</span>
|
|
<span class="sd"> CharDeleteView.as_view(), name='character-delete')</span>
|
|
|
|
<span class="sd"> If no View has been created and defined in urls.py, returns an</span>
|
|
<span class="sd"> HTML anchor.</span>
|
|
|
|
<span class="sd"> This method is naive and simply returns a path. Securing access to</span>
|
|
<span class="sd"> the actual view and limiting who can delete this object is the developer's</span>
|
|
<span class="sd"> responsibility.</span>
|
|
|
|
<span class="sd"> Returns:</span>
|
|
<span class="sd"> path (str): URI path to object deletion page, if defined.</span>
|
|
|
|
<span class="sd"> """</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="n">reverse</span><span class="p">(</span>
|
|
<span class="s2">"</span><span class="si">%s</span><span class="s2">-delete"</span> <span class="o">%</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</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">kwargs</span><span class="o">=</span><span class="p">{</span><span class="s2">"category"</span><span class="p">:</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_help_category</span><span class="p">),</span> <span class="s2">"topic"</span><span class="p">:</span> <span class="n">slugify</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">db_key</span><span class="p">)},</span>
|
|
<span class="p">)</span>
|
|
<span class="k">except</span><span class="p">:</span>
|
|
<span class="k">return</span> <span class="s2">"#"</span></div>
|
|
|
|
<span class="c1"># Used by Django Sites/Admin</span>
|
|
<span class="n">get_absolute_url</span> <span class="o">=</span> <span class="n">web_get_detail_url</span></div>
|
|
</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="models.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> »</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.help.models</a></li>
|
|
</ul>
|
|
<div class="develop">develop branch</div>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2020, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |