mirror of
https://github.com/evennia/evennia.git
synced 2026-03-19 06:16:31 +01:00
1146 lines
No EOL
96 KiB
HTML
1146 lines
No EOL
96 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<title>evennia.web.api package — 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 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="module-evennia.web.api">
|
||
<span id="evennia-web-api-package"></span><h1>evennia.web.api package<a class="headerlink" href="#module-evennia.web.api" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-evennia.web.api.filters">
|
||
<span id="evennia-web-api-filters-module"></span><h2>evennia.web.api.filters module<a class="headerlink" href="#module-evennia.web.api.filters" title="Permalink to this headline">¶</a></h2>
|
||
<p>FilterSets allow clients to specify querystrings that will determine the data
|
||
that is retrieved in GET requests. By default, Django Rest Framework uses the
|
||
‘django-filter’ package as its backend. Django-filter also has a section in its
|
||
documentation specifically regarding DRF integration.</p>
|
||
<p><a class="reference external" href="https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html">https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html</a></p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">AccountDBFilterSet</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">queryset=None</em>, <em class="sig-param">*</em>, <em class="sig-param">request=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#AccountDBFilterSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.filters.BaseTypeclassFilterSet" title="evennia.web.api.filters.BaseTypeclassFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.BaseTypeclassFilterSet</span></code></a></p>
|
||
<p>This adds filters for Account objects</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/filters.html#AccountDBFilterSet.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_key', 'db_typeclass_path', 'db_tags__db_key', 'db_tags__db_category', 'username', 'db_is_connected', 'db_is_bot']</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <django_filters.filterset.FilterSetOptions object></em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet.base_filters">
|
||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'db_is_bot': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_is_connected': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_key': <django_filters.filters.CharFilter object>, 'db_tags__db_category': <django_filters.filters.CharFilter object>, 'db_tags__db_key': <django_filters.filters.CharFilter object>, 'db_typeclass_path': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>, 'username': <django_filters.filters.CharFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.AccountDBFilterSet.declared_filters">
|
||
<code class="sig-name descname">declared_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.AccountDBFilterSet.declared_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.AliasFilter">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">AliasFilter</code><span class="sig-paren">(</span><em class="sig-param">field_name=None</em>, <em class="sig-param">lookup_expr='exact'</em>, <em class="sig-param">*</em>, <em class="sig-param">label=None</em>, <em class="sig-param">method=None</em>, <em class="sig-param">distinct=False</em>, <em class="sig-param">exclude=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#AliasFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.AliasFilter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.filters.TagTypeFilter" title="evennia.web.api.filters.TagTypeFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.TagTypeFilter</span></code></a></p>
|
||
<p>A filter for objects by their aliases (tags with a tagtype of ‘alias’</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.AliasFilter.tag_type">
|
||
<code class="sig-name descname">tag_type</code><em class="property"> = 'alias'</em><a class="headerlink" href="#evennia.web.api.filters.AliasFilter.tag_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.BaseTypeclassFilterSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">BaseTypeclassFilterSet</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">queryset=None</em>, <em class="sig-param">*</em>, <em class="sig-param">request=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#BaseTypeclassFilterSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.BaseTypeclassFilterSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django_filters.rest_framework.filterset.FilterSet</span></code></p>
|
||
<p>A parent class with filters for aliases and permissions</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.BaseTypeclassFilterSet._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <django_filters.filterset.FilterSetOptions object></em><a class="headerlink" href="#evennia.web.api.filters.BaseTypeclassFilterSet._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.BaseTypeclassFilterSet.base_filters">
|
||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.BaseTypeclassFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.BaseTypeclassFilterSet.declared_filters">
|
||
<code class="sig-name descname">declared_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.BaseTypeclassFilterSet.declared_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.filters.BaseTypeclassFilterSet.filter_name">
|
||
<em class="property">static </em><code class="sig-name descname">filter_name</code><span class="sig-paren">(</span><em class="sig-param">queryset</em>, <em class="sig-param">name</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#BaseTypeclassFilterSet.filter_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.BaseTypeclassFilterSet.filter_name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Filters a queryset by aliases or the key of the typeclass
|
||
:param queryset: The queryset being filtered
|
||
:param name: The name of the field
|
||
:param value: The value passed in from GET params</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The filtered queryset</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">ObjectDBFilterSet</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">queryset=None</em>, <em class="sig-param">*</em>, <em class="sig-param">request=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#ObjectDBFilterSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.filters.BaseTypeclassFilterSet" title="evennia.web.api.filters.BaseTypeclassFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.BaseTypeclassFilterSet</span></code></a></p>
|
||
<p>This adds filters for ObjectDB instances - characters, rooms, exits, etc</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/filters.html#ObjectDBFilterSet.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_key', 'db_typeclass_path', 'db_tags__db_key', 'db_tags__db_category', 'db_location__db_key', 'db_home__db_key', 'db_location__id', 'db_home__id']</em><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.objects.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <django_filters.filterset.FilterSetOptions object></em><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet.base_filters">
|
||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'db_home__db_key': <django_filters.filters.CharFilter object>, 'db_home__id': <django_filters.filters.NumberFilter object>, 'db_key': <django_filters.filters.CharFilter object>, 'db_location__db_key': <django_filters.filters.CharFilter object>, 'db_location__id': <django_filters.filters.NumberFilter object>, 'db_tags__db_category': <django_filters.filters.CharFilter object>, 'db_tags__db_key': <django_filters.filters.CharFilter object>, 'db_typeclass_path': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ObjectDBFilterSet.declared_filters">
|
||
<code class="sig-name descname">declared_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.ObjectDBFilterSet.declared_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.PermissionFilter">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">PermissionFilter</code><span class="sig-paren">(</span><em class="sig-param">field_name=None</em>, <em class="sig-param">lookup_expr='exact'</em>, <em class="sig-param">*</em>, <em class="sig-param">label=None</em>, <em class="sig-param">method=None</em>, <em class="sig-param">distinct=False</em>, <em class="sig-param">exclude=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#PermissionFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.PermissionFilter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.filters.TagTypeFilter" title="evennia.web.api.filters.TagTypeFilter"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.TagTypeFilter</span></code></a></p>
|
||
<p>A filter for objects by their permissions (tags with a tagtype of ‘permission’</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.PermissionFilter.tag_type">
|
||
<code class="sig-name descname">tag_type</code><em class="property"> = 'permission'</em><a class="headerlink" href="#evennia.web.api.filters.PermissionFilter.tag_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">ScriptDBFilterSet</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">queryset=None</em>, <em class="sig-param">*</em>, <em class="sig-param">request=None</em>, <em class="sig-param">prefix=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#ScriptDBFilterSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.filters.BaseTypeclassFilterSet" title="evennia.web.api.filters.BaseTypeclassFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.BaseTypeclassFilterSet</span></code></a></p>
|
||
<p>This adds filters for Script objects</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/filters.html#ScriptDBFilterSet.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_key', 'db_typeclass_path', 'db_tags__db_key', 'db_tags__db_category', 'db_desc', 'db_obj__db_key', 'db_obj__id', 'db_account__id', 'db_account__username', 'db_is_active', 'db_persistent', 'db_interval']</em><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.scripts.html#evennia.scripts.models.ScriptDB" title="evennia.scripts.models.ScriptDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.models.ScriptDB</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet._meta">
|
||
<code class="sig-name descname">_meta</code><em class="property"> = <django_filters.filterset.FilterSetOptions object></em><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet._meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet.base_filters">
|
||
<code class="sig-name descname">base_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'db_account__id': <django_filters.filters.NumberFilter object>, 'db_account__username': <django_filters.filters.CharFilter object>, 'db_desc': <django_filters.filters.CharFilter object>, 'db_interval': <django_filters.filters.NumberFilter object>, 'db_is_active': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_key': <django_filters.filters.CharFilter object>, 'db_obj__db_key': <django_filters.filters.CharFilter object>, 'db_obj__id': <django_filters.filters.NumberFilter object>, 'db_persistent': <django_filters.rest_framework.filters.BooleanFilter object>, 'db_tags__db_category': <django_filters.filters.CharFilter object>, 'db_tags__db_key': <django_filters.filters.CharFilter object>, 'db_typeclass_path': <django_filters.filters.CharFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet.base_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.ScriptDBFilterSet.declared_filters">
|
||
<code class="sig-name descname">declared_filters</code><em class="property"> = {'alias': <evennia.web.api.filters.AliasFilter object>, 'name': <django_filters.filters.CharFilter object>, 'permission': <evennia.web.api.filters.PermissionFilter object>}</em><a class="headerlink" href="#evennia.web.api.filters.ScriptDBFilterSet.declared_filters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.filters.TagTypeFilter">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">TagTypeFilter</code><span class="sig-paren">(</span><em class="sig-param">field_name=None</em>, <em class="sig-param">lookup_expr='exact'</em>, <em class="sig-param">*</em>, <em class="sig-param">label=None</em>, <em class="sig-param">method=None</em>, <em class="sig-param">distinct=False</em>, <em class="sig-param">exclude=False</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#TagTypeFilter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.TagTypeFilter" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django_filters.filters.CharFilter</span></code></p>
|
||
<p>This class lets you create different filters for tags of a specified db_tagtype.</p>
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.filters.TagTypeFilter.filter">
|
||
<code class="sig-name descname">filter</code><span class="sig-paren">(</span><em class="sig-param">qs</em>, <em class="sig-param">value</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/filters.html#TagTypeFilter.filter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.TagTypeFilter.filter" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.filters.TagTypeFilter.tag_type">
|
||
<code class="sig-name descname">tag_type</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.filters.TagTypeFilter.tag_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="evennia.web.api.filters.get_tag_query">
|
||
<code class="sig-prename descclassname">evennia.web.api.filters.</code><code class="sig-name descname">get_tag_query</code><span class="sig-paren">(</span><em class="sig-param">tag_type: Optional[str], key: str</em><span class="sig-paren">)</span> → django.db.models.query_utils.Q<a class="reference internal" href="../_modules/evennia/web/api/filters.html#get_tag_query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.filters.get_tag_query" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a Q object for searching by tag names for typeclasses
|
||
:param tag_type: The type of tag (None, ‘alias’, etc)
|
||
:type tag_type: str or None
|
||
:param key: The name of the tag
|
||
:type key: str</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>A Q object that for searching by this tag type and name</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.api.permissions">
|
||
<span id="evennia-web-api-permissions-module"></span><h2>evennia.web.api.permissions module<a class="headerlink" href="#module-evennia.web.api.permissions" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.permissions.</code><code class="sig-name descname">EvenniaPermission</code><a class="reference internal" href="../_modules/evennia/web/api/permissions.html#EvenniaPermission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.permissions.BasePermission</span></code></p>
|
||
<p>A Django Rest Framework permission class that allows us to use
|
||
Evennia’s permission structure. Based on the action in a given
|
||
view, we’ll check a corresponding Evennia access/lock check.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.MINIMUM_CREATE_PERMISSION">
|
||
<code class="sig-name descname">MINIMUM_CREATE_PERMISSION</code><em class="property"> = 'builder'</em><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.MINIMUM_CREATE_PERMISSION" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.MINIMUM_LIST_PERMISSION">
|
||
<code class="sig-name descname">MINIMUM_LIST_PERMISSION</code><em class="property"> = 'builder'</em><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.MINIMUM_LIST_PERMISSION" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.check_locks">
|
||
<em class="property">static </em><code class="sig-name descname">check_locks</code><span class="sig-paren">(</span><em class="sig-param">obj</em>, <em class="sig-param">user</em>, <em class="sig-param">locks</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/permissions.html#EvenniaPermission.check_locks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.check_locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Checks access for user for object with given locks
|
||
:param obj: Object instance we’re checking
|
||
:param user: User who we’re checking permissions
|
||
:type user: Account
|
||
:param locks: list of lockstrings
|
||
:type locks: list</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>True if they have access, False if they don’t</p>
|
||
</dd>
|
||
<dt class="field-even">Return type</dt>
|
||
<dd class="field-even"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.destroy_locks">
|
||
<code class="sig-name descname">destroy_locks</code><em class="property"> = ['delete']</em><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.destroy_locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.has_object_permission">
|
||
<code class="sig-name descname">has_object_permission</code><span class="sig-paren">(</span><em class="sig-param">request</em>, <em class="sig-param">view</em>, <em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/permissions.html#EvenniaPermission.has_object_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.has_object_permission" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Checks object-level permissions after has_permission</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>request</strong> (<em>Request</em>) – The incoming request object.</p></li>
|
||
<li><p><strong>view</strong> (<em>View</em>) – The django view we are checking permission for.</p></li>
|
||
<li><p><strong>obj</strong> – Object we’re checking object-level permissions for</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>If permission is granted or not. If we return False here, a PermissionDenied
|
||
error will be raised from the view.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>This method assumes that has_permission has already returned True. We check
|
||
equivalent Evennia permissions in the request.user to determine if they can
|
||
complete the action.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.has_permission">
|
||
<code class="sig-name descname">has_permission</code><span class="sig-paren">(</span><em class="sig-param">request</em>, <em class="sig-param">view</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/permissions.html#EvenniaPermission.has_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.has_permission" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Checks for permissions</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>request</strong> (<em>Request</em>) – The incoming request object.</p></li>
|
||
<li><p><strong>view</strong> (<em>View</em>) – The django view we are checking permission for.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>If permission is granted or not. If we return False here, a PermissionDenied
|
||
error will be raised from the view.</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Notes</p>
|
||
<p>This method is a check that always happens first. If there’s an object involved,
|
||
such as with retrieve, update, or delete, then the has_object_permission method
|
||
is called after this, assuming this returns <cite>True</cite>.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.update_locks">
|
||
<code class="sig-name descname">update_locks</code><em class="property"> = ['control', 'edit']</em><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.update_locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.permissions.EvenniaPermission.view_locks">
|
||
<code class="sig-name descname">view_locks</code><em class="property"> = ['examine']</em><a class="headerlink" href="#evennia.web.api.permissions.EvenniaPermission.view_locks" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.api.serializers">
|
||
<span id="evennia-web-api-serializers-module"></span><h2>evennia.web.api.serializers module<a class="headerlink" href="#module-evennia.web.api.serializers" title="Permalink to this headline">¶</a></h2>
|
||
<p>Serializers in the Django Rest Framework are similar to Forms in normal django.
|
||
They’re used for transmitting and validating data, both going to clients and
|
||
coming to the server. However, where forms often contained presentation logic,
|
||
such as specifying widgets to use for selection, serializers typically leave
|
||
those decisions in the hands of clients, and are more focused on converting
|
||
data from the server to JSON (serialization) for a response, and validating
|
||
and converting JSON data sent from clients to our enpoints into python objects,
|
||
often django model instances, that we can use (deserialization).</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">AccountSerializer</code><span class="sig-paren">(</span><em class="sig-param">instance=None</em>, <em class="sig-param">data=<class 'rest_framework.fields.empty'></em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="evennia.web.api.serializers.TypeclassSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||
<p>This uses the DefaultAccount object to have access to the sessions property</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['username', 'session_ids', 'nicks', 'id', 'db_key', 'attributes', 'db_typeclass_path', 'aliases', 'tags', 'permissions']</em><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.accounts.DefaultAccount</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer.Meta.read_only_fields">
|
||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer._declared_fields">
|
||
<code class="sig-name descname">_declared_fields</code><em class="property"> = {'aliases': SerializerMethodField(), 'attributes': SerializerMethodField(), 'db_key': CharField(required=False), 'nicks': SerializerMethodField(), 'permissions': SerializerMethodField(), 'session_ids': SerializerMethodField(), 'tags': SerializerMethodField()}</em><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer._declared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.AccountSerializer.get_session_ids">
|
||
<em class="property">static </em><code class="sig-name descname">get_session_ids</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountSerializer.get_session_ids"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.get_session_ids" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets a list of session IDs connected to this Account
|
||
:param obj: Account we’re grabbing sessions from
|
||
:type obj: DefaultAccount</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of session IDs</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.AttributeSerializer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">AttributeSerializer</code><span class="sig-paren">(</span><em class="sig-param">instance=None</em>, <em class="sig-param">data=<class 'rest_framework.fields.empty'></em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.AttributeSerializer.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AttributeSerializer.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_key', 'db_category', 'db_attrtype', 'value_display', 'db_value']</em><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AttributeSerializer.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.typeclasses.html#evennia.typeclasses.attributes.Attribute" title="evennia.typeclasses.attributes.Attribute"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.attributes.Attribute</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.AttributeSerializer._declared_fields">
|
||
<code class="sig-name descname">_declared_fields</code><em class="property"> = {'db_value': CharField(required=False, write_only=True), 'value_display': SerializerMethodField(source='value')}</em><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer._declared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.AttributeSerializer.get_value_display">
|
||
<em class="property">static </em><code class="sig-name descname">get_value_display</code><span class="sig-paren">(</span><em class="sig-param">obj: evennia.typeclasses.attributes.Attribute</em><span class="sig-paren">)</span> → str<a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer.get_value_display"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.get_value_display" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets the string display of an Attribute’s value for serialization
|
||
:param obj: Attribute being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>The Attribute’s value in string format</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">ObjectDBSerializer</code><span class="sig-paren">(</span><em class="sig-param">instance=None</em>, <em class="sig-param">data=<class 'rest_framework.fields.empty'></em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="evennia.web.api.serializers.TypeclassSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_location', 'db_home', 'contents', 'exits', 'nicks', 'id', 'db_key', 'attributes', 'db_typeclass_path', 'aliases', 'tags', 'permissions']</em><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.Meta.read_only_fields">
|
||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer._declared_fields">
|
||
<code class="sig-name descname">_declared_fields</code><em class="property"> = {'aliases': SerializerMethodField(), 'attributes': SerializerMethodField(), 'contents': SerializerMethodField(), 'exits': SerializerMethodField(), 'nicks': SerializerMethodField(), 'permissions': SerializerMethodField(), 'tags': SerializerMethodField()}</em><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer._declared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.get_contents">
|
||
<em class="property">static </em><code class="sig-name descname">get_contents</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.get_contents"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.get_contents" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets non-exits for the object
|
||
:param obj: Object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of data from SimpleObjectDBSerializer</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.ObjectDBSerializer.get_exits">
|
||
<em class="property">static </em><code class="sig-name descname">get_exits</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.get_exits"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.get_exits" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets exits for the object
|
||
:param obj: Object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of data from SimpleObjectDBSerializer</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.ScriptDBSerializer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">ScriptDBSerializer</code><span class="sig-paren">(</span><em class="sig-param">instance=None</em>, <em class="sig-param">data=<class 'rest_framework.fields.empty'></em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptDBSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="evennia.web.api.serializers.TypeclassSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.ScriptDBSerializer.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptDBSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ScriptDBSerializer.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_interval', 'db_persistent', 'db_start_delay', 'db_is_active', 'db_repeats', 'id', 'db_key', 'attributes', 'db_typeclass_path', 'aliases', 'tags', 'permissions']</em><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ScriptDBSerializer.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.scripts.html#evennia.scripts.models.ScriptDB" title="evennia.scripts.models.ScriptDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.scripts.models.ScriptDB</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ScriptDBSerializer.Meta.read_only_fields">
|
||
<code class="sig-name descname">read_only_fields</code><em class="property"> = ['id']</em><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.read_only_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.ScriptDBSerializer._declared_fields">
|
||
<code class="sig-name descname">_declared_fields</code><em class="property"> = {'aliases': SerializerMethodField(), 'attributes': SerializerMethodField(), 'permissions': SerializerMethodField(), 'tags': SerializerMethodField()}</em><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer._declared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.SimpleObjectDBSerializer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">SimpleObjectDBSerializer</code><span class="sig-paren">(</span><em class="sig-param">instance=None</em>, <em class="sig-param">data=<class 'rest_framework.fields.empty'></em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#SimpleObjectDBSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.SimpleObjectDBSerializer.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#SimpleObjectDBSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['id', 'db_key']</em><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.SimpleObjectDBSerializer._declared_fields">
|
||
<code class="sig-name descname">_declared_fields</code><em class="property"> = {}</em><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer._declared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.TagSerializer">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">TagSerializer</code><span class="sig-paren">(</span><em class="sig-param">instance=None</em>, <em class="sig-param">data=<class 'rest_framework.fields.empty'></em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TagSerializer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.serializers.ModelSerializer</span></code></p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.TagSerializer.Meta">
|
||
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TagSerializer.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer.Meta" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.TagSerializer.Meta.fields">
|
||
<code class="sig-name descname">fields</code><em class="property"> = ['db_key', 'db_category', 'db_data', 'db_tagtype']</em><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer.Meta.fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.TagSerializer.Meta.model">
|
||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer.Meta.model" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="evennia.typeclasses.html#evennia.typeclasses.tags.Tag" title="evennia.typeclasses.tags.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.typeclasses.tags.Tag</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.TagSerializer._declared_fields">
|
||
<code class="sig-name descname">_declared_fields</code><em class="property"> = {}</em><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer._declared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.serializers.</code><code class="sig-name descname">TypeclassSerializerMixin</code><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>Mixin that contains types shared by typeclasses. A note about tags, aliases, and permissions. You
|
||
might note that the methods and fields are defined here, but they’re included explicitly in each child
|
||
class. What gives? It’s a DRF error: serializer method fields which are inherited do not resolve correctly
|
||
in child classes, and as of this current version (3.11) you must have them in the child classes explicitly
|
||
to avoid field errors. Similarly, the child classes must contain the attribute serializer explicitly to
|
||
not have them render PK-related fields.</p>
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.get_aliases">
|
||
<em class="property">static </em><code class="sig-name descname">get_aliases</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_aliases"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_aliases" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Serializes tags from the object’s Aliashandler
|
||
:param obj: Typeclassed object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of TagSerializer data</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.get_attributes">
|
||
<em class="property">static </em><code class="sig-name descname">get_attributes</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_attributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_attributes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Serializes attributes from the object’s AttributeHandler
|
||
:param obj: Typeclassed object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of AttributeSerializer data</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.get_nicks">
|
||
<em class="property">static </em><code class="sig-name descname">get_nicks</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_nicks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_nicks" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Serializes attributes from the object’s NicksHandler
|
||
:param obj: Typeclassed object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of AttributeSerializer data</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.get_permissions">
|
||
<em class="property">static </em><code class="sig-name descname">get_permissions</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_permissions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_permissions" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Serializes tags from the object’s Permissionshandler
|
||
:param obj: Typeclassed object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of TagSerializer data</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.get_tags">
|
||
<em class="property">static </em><code class="sig-name descname">get_tags</code><span class="sig-paren">(</span><em class="sig-param">obj</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_tags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_tags" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Serializes tags from the object’s Tagshandler
|
||
:param obj: Typeclassed object being serialized</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>List of TagSerializer data</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields">
|
||
<code class="sig-name descname">shared_fields</code><em class="property"> = ['id', 'db_key', 'attributes', 'db_typeclass_path', 'aliases', 'tags', 'permissions']</em><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.api.tests">
|
||
<span id="evennia-web-api-tests-module"></span><h2>evennia.web.api.tests module<a class="headerlink" href="#module-evennia.web.api.tests" title="Permalink to this headline">¶</a></h2>
|
||
<p>Tests for the REST API</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.tests.</code><code class="sig-name descname">TestEvenniaRESTApi</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="evennia.utils.html#evennia.utils.test_resources.EvenniaTest" title="evennia.utils.test_resources.EvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.EvenniaTest</span></code></a></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi._overridden_settings">
|
||
<code class="sig-name descname">_overridden_settings</code><em class="property"> = {'AUTH_USERNAME_VALIDATORS': [], 'REST_API_ENABLED': True, 'ROOT_URLCONF': 'evennia.web.api.tests'}</em><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi._overridden_settings" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.client_class">
|
||
<code class="sig-name descname">client_class</code><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.client_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.test.APIClient</span></code></p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.get_view_details">
|
||
<code class="sig-name descname">get_view_details</code><span class="sig-paren">(</span><em class="sig-param">action</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.get_view_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.get_view_details" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Helper function for generating list of named tuples</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.maxDiff">
|
||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.setUp">
|
||
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.setUp" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets up testing environment</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.tearDown">
|
||
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.tearDown" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Hook method for deconstructing the test fixture after testing it.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.test_create">
|
||
<code class="sig-name descname">test_create</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.test_create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.test_create" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.test_delete">
|
||
<code class="sig-name descname">test_delete</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.test_delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.test_delete" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.test_list">
|
||
<code class="sig-name descname">test_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.test_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.test_list" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.test_retrieve">
|
||
<code class="sig-name descname">test_retrieve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.test_retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.test_retrieve" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.test_set_attribute">
|
||
<code class="sig-name descname">test_set_attribute</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.test_set_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.test_set_attribute" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.tests.TestEvenniaRESTApi.test_update">
|
||
<code class="sig-name descname">test_update</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/tests.html#TestEvenniaRESTApi.test_update"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.tests.TestEvenniaRESTApi.test_update" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.api.urls">
|
||
<span id="evennia-web-api-urls-module"></span><h2>evennia.web.api.urls module<a class="headerlink" href="#module-evennia.web.api.urls" title="Permalink to this headline">¶</a></h2>
|
||
<p>The Django Rest Framework provides a way of generating urls for different
|
||
views that implement standard CRUD operations in a quick way, using ‘routers’
|
||
and ‘viewsets’. A viewset implements standard CRUD actions and any custom actions
|
||
that you want, and then a router will automatically generate URLs based on the
|
||
actions that it detects for a viewset. For example, below we create a DefaultRouter.
|
||
We then register ObjectDBViewSet, a viewset for CRUD operations for ObjectDB
|
||
instances, to the ‘objects’ base endpoint. That will generate a number of URLs
|
||
like the following:
|
||
list objects: action: GET, url: /objects/, view name: object-list
|
||
create object: action: POST, url: /objects/, view name: object-list
|
||
retrieve object: action: GET, url: /objects/<:pk>, view name: object-detail
|
||
update object: action: POST, url: /objects/<:pk>, view name: object-detail
|
||
delete object: action: DELETE, url: /objects/<:pk>, view name: object-detail
|
||
set attribute: action: POST, url: /objects/<:pk>/set-attribute, view name: object-set-attribute</p>
|
||
</div>
|
||
<div class="section" id="module-evennia.web.api.views">
|
||
<span id="evennia-web-api-views-module"></span><h2>evennia.web.api.views module<a class="headerlink" href="#module-evennia.web.api.views" title="Permalink to this headline">¶</a></h2>
|
||
<p>Views are the functions that are called by different url endpoints.
|
||
The Django Rest Framework provides collections called ‘ViewSets’, which
|
||
can generate a number of views for the common CRUD operations.</p>
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">AccountDBViewSet</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#AccountDBViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.TypeclassViewSetMixin" title="evennia.web.api.views.TypeclassViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.TypeclassViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||
<p>Viewset for Account objects</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.basename">
|
||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.description">
|
||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.detail">
|
||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.filterset_class">
|
||
<code class="sig-name descname">filterset_class</code><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.filterset_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.filters.AccountDBFilterSet" title="evennia.web.api.filters.AccountDBFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.AccountDBFilterSet</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.name">
|
||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.queryset">
|
||
<code class="sig-name descname">queryset</code><em class="property"> = <QuerySet [Dummy(account#1)]></em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.serializer_class">
|
||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer" title="evennia.web.api.serializers.AccountSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.AccountSerializer</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.AccountDBViewSet.suffix">
|
||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.AccountDBViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.CharacterViewSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">CharacterViewSet</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#CharacterViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.ObjectDBViewSet" title="evennia.web.api.views.ObjectDBViewSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.ObjectDBViewSet</span></code></a></p>
|
||
<p>This overrides the queryset to only retrieve Character objects
|
||
based on your DefaultCharacter typeclass path.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.CharacterViewSet.basename">
|
||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.CharacterViewSet.description">
|
||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.CharacterViewSet.detail">
|
||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.CharacterViewSet.name">
|
||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.CharacterViewSet.queryset">
|
||
<code class="sig-name descname">queryset</code><em class="property"> = <QuerySet []></em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.CharacterViewSet.suffix">
|
||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.CharacterViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.ExitViewSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">ExitViewSet</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#ExitViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.ExitViewSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.ObjectDBViewSet" title="evennia.web.api.views.ObjectDBViewSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.ObjectDBViewSet</span></code></a></p>
|
||
<p>Viewset for Exit objects</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ExitViewSet.basename">
|
||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ExitViewSet.description">
|
||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ExitViewSet.detail">
|
||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ExitViewSet.name">
|
||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ExitViewSet.queryset">
|
||
<code class="sig-name descname">queryset</code><em class="property"> = <QuerySet []></em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ExitViewSet.suffix">
|
||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ExitViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">ObjectDBViewSet</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#ObjectDBViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.TypeclassViewSetMixin" title="evennia.web.api.views.TypeclassViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.TypeclassViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||
<p>An example of a basic viewset for all ObjectDB instances. It declares the
|
||
serializer to use for both retrieving and changing/creating/deleting
|
||
instances. Serializers are similar to django forms, used for the
|
||
transmitting of data (typically json).</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.basename">
|
||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.description">
|
||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.detail">
|
||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.filterset_class">
|
||
<code class="sig-name descname">filterset_class</code><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.filterset_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.filters.ObjectDBFilterSet" title="evennia.web.api.filters.ObjectDBFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.ObjectDBFilterSet</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.name">
|
||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.queryset">
|
||
<code class="sig-name descname">queryset</code><em class="property"> = <QuerySet []></em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.serializer_class">
|
||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer" title="evennia.web.api.serializers.ObjectDBSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ObjectDBSerializer</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ObjectDBViewSet.suffix">
|
||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ObjectDBViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.RoomViewSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">RoomViewSet</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#RoomViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.RoomViewSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.ObjectDBViewSet" title="evennia.web.api.views.ObjectDBViewSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.ObjectDBViewSet</span></code></a></p>
|
||
<p>Viewset for Room objects</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.RoomViewSet.basename">
|
||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.RoomViewSet.description">
|
||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.RoomViewSet.detail">
|
||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.RoomViewSet.name">
|
||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.RoomViewSet.queryset">
|
||
<code class="sig-name descname">queryset</code><em class="property"> = <QuerySet []></em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.RoomViewSet.suffix">
|
||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.RoomViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">ScriptDBViewSet</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#ScriptDBViewSet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.views.TypeclassViewSetMixin" title="evennia.web.api.views.TypeclassViewSetMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.views.TypeclassViewSetMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">rest_framework.viewsets.ModelViewSet</span></code></p>
|
||
<p>Viewset for Script objects</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.basename">
|
||
<code class="sig-name descname">basename</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.basename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.description">
|
||
<code class="sig-name descname">description</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.detail">
|
||
<code class="sig-name descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.filterset_class">
|
||
<code class="sig-name descname">filterset_class</code><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.filterset_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.filters.ScriptDBFilterSet" title="evennia.web.api.filters.ScriptDBFilterSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.filters.ScriptDBFilterSet</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.name">
|
||
<code class="sig-name descname">name</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.queryset">
|
||
<code class="sig-name descname">queryset</code><em class="property"> = <QuerySet []></em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.queryset" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.serializer_class">
|
||
<code class="sig-name descname">serializer_class</code><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.serializer_class" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>alias of <a class="reference internal" href="#evennia.web.api.serializers.ScriptDBSerializer" title="evennia.web.api.serializers.ScriptDBSerializer"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.api.serializers.ScriptDBSerializer</span></code></a></p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.ScriptDBViewSet.suffix">
|
||
<code class="sig-name descname">suffix</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.api.views.ScriptDBViewSet.suffix" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="evennia.web.api.views.TypeclassViewSetMixin">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.api.views.</code><code class="sig-name descname">TypeclassViewSetMixin</code><a class="reference internal" href="../_modules/evennia/web/api/views.html#TypeclassViewSetMixin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||
<p>This mixin adds some shared functionality to each viewset of a typeclass. They all use the same
|
||
permission classes and filter backend. You can override any of these in your own viewsets.</p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.TypeclassViewSetMixin.filter_backends">
|
||
<code class="sig-name descname">filter_backends</code><em class="property"> = [<class 'django_filters.rest_framework.backends.DjangoFilterBackend'>]</em><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin.filter_backends" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.api.views.TypeclassViewSetMixin.permission_classes">
|
||
<code class="sig-name descname">permission_classes</code><em class="property"> = [<class 'evennia.web.api.permissions.EvenniaPermission'>]</em><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin.permission_classes" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.api.views.TypeclassViewSetMixin.set_attribute">
|
||
<code class="sig-name descname">set_attribute</code><span class="sig-paren">(</span><em class="sig-param">request</em>, <em class="sig-param">pk=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/views.html#TypeclassViewSetMixin.set_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.api.views.TypeclassViewSetMixin.set_attribute" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>This is an example of a custom action added to a viewset. Based on the name of the
|
||
method, it will create a default url_name (used for reversing) and url_path.
|
||
The ‘pk’ argument is automatically passed to this action because it has a url path
|
||
of the format <object type>/:pk/set-attribute. The get_object method is automatically
|
||
set in the expected viewset classes that will inherit this, using the pk that’s
|
||
passed along to retrieve the object.</p>
|
||
<p>This action will set an attribute if the db_value is defined, or remove it
|
||
if no db_value is provided.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</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>
|
||
<p><h3><a href="../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">evennia.web.api package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.api.filters">evennia.web.api.filters module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.api.permissions">evennia.web.api.permissions module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.api.serializers">evennia.web.api.serializers module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.api.tests">evennia.web.api.tests module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.api.urls">evennia.web.api.urls module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.api.views">evennia.web.api.views module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/api/evennia.web.api.rst.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="evennia.web.api.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="../../0.9.1/index.html">0.9.1 (master 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 documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
|
||
</div>
|
||
</body>
|
||
</html> |