Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-20 23:06:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.web.api.serializers.html
Evennia docbuilder action 243d596662 Updated HTML docs.
2025-08-15 18:14:21 +00:00

740 lines
No EOL
76 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>evennia.web.api.serializers &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.web.api.tests" href="evennia.web.api.tests.html" />
<link rel="prev" title="evennia.web.api.root" href="evennia.web.api.root.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<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="right" >
<a href="evennia.web.api.tests.html" title="evennia.web.api.tests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.web.api.root.html" title="evennia.web.api.root"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.web.api.html" accesskey="U">evennia.web.api</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.api.serializers</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.web.api.serializers">
<span id="evennia-web-api-serializers"></span><h1>evennia.web.api.serializers<a class="headerlink" href="#module-evennia.web.api.serializers" title="Link to this heading"></a></h1>
<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="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AttributeSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">AttributeSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Serialize Attribute views.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AttributeSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AttributeSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.typeclasses.attributes.html#evennia.typeclasses.attributes.Attribute" title="evennia.typeclasses.attributes.Attribute"><code class="xref py py-class docutils literal notranslate"><span class="pre">Attribute</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AttributeSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['db_key',</span> <span class="pre">'db_category',</span> <span class="pre">'db_attrtype',</span> <span class="pre">'value_display',</span> <span class="pre">'db_value']</span></em><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AttributeSerializer.get_value_display">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_value_display</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="evennia.typeclasses.attributes.html#evennia.typeclasses.attributes.Attribute" title="evennia.typeclasses.attributes.Attribute"><span class="pre">Attribute</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AttributeSerializer.get_value_display"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AttributeSerializer.get_value_display" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>The Attribute’s value in string format</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TagSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">TagSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TagSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TagSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TagSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TagSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.typeclasses.tags.html#evennia.typeclasses.tags.Tag" title="evennia.typeclasses.tags.Tag"><code class="xref py py-class docutils literal notranslate"><span class="pre">Tag</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TagSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['db_key',</span> <span class="pre">'db_category',</span> <span class="pre">'db_data',</span> <span class="pre">'db_tagtype']</span></em><a class="headerlink" href="#evennia.web.api.serializers.TagSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.SimpleObjectDBSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">SimpleObjectDBSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#SimpleObjectDBSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.SimpleObjectDBSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#SimpleObjectDBSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultObject</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id',</span> <span class="pre">'db_key']</span></em><a class="headerlink" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">TypeclassSerializerMixin</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields">
<span class="sig-name descname"><span class="pre">shared_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id',</span> <span class="pre">'db_key',</span> <span class="pre">'attributes',</span> <span class="pre">'db_typeclass_path',</span> <span class="pre">'aliases',</span> <span class="pre">'tags',</span> <span class="pre">'permissions']</span></em><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin.get_tags">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_tags</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_tags"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_tags" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of TagSerializer data</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin.get_aliases">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_aliases</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_aliases"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_aliases" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of TagSerializer data</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin.get_permissions">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_permissions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_permissions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_permissions" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of TagSerializer data</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin.get_attributes">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_attributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_attributes" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of AttributeSerializer data</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassSerializerMixin.get_nicks">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_nicks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassSerializerMixin.get_nicks"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_nicks" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of AttributeSerializer data</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassListSerializerMixin">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">TypeclassListSerializerMixin</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#TypeclassListSerializerMixin"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="Link 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>Shortened serializer for list views.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.TypeclassListSerializerMixin.shared_fields">
<span class="sig-name descname"><span class="pre">shared_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id',</span> <span class="pre">'db_key',</span> <span class="pre">'db_typeclass_path']</span></em><a class="headerlink" href="#evennia.web.api.serializers.TypeclassListSerializerMixin.shared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">ObjectDBSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer" title="Link 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">TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Serializing Objects.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultObject</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['db_location',</span> <span class="pre">'db_home',</span> <span class="pre">'contents',</span> <span class="pre">'exits',</span> <span class="pre">'nicks',</span> <span class="pre">'id',</span> <span class="pre">'db_key',</span> <span class="pre">'attributes',</span> <span class="pre">'db_typeclass_path',</span> <span class="pre">'aliases',</span> <span class="pre">'tags',</span> <span class="pre">'permissions']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer.get_exits">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_exits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.get_exits"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.get_exits" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of data from SimpleObjectDBSerializer</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectDBSerializer.get_contents">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_contents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectDBSerializer.get_contents"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectDBSerializer.get_contents" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of data from SimpleObjectDBSerializer</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectListSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">ObjectListSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectListSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Shortened representation for listings.]</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectListSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ObjectListSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectListSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultObject</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectListSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['db_location',</span> <span class="pre">'db_home',</span> <span class="pre">'id',</span> <span class="pre">'db_key',</span> <span class="pre">'db_typeclass_path']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ObjectListSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">AccountSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer" title="Link 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">TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>This uses the DefaultAccount object to have access to the sessions property</p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountSerializer.get_session_ids">
<em class="property"><span class="k"><span class="pre">static</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_session_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.get_session_ids" title="Link 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<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of session IDs</p>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultAccount</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['username',</span> <span class="pre">'session_ids',</span> <span class="pre">'nicks',</span> <span class="pre">'id',</span> <span class="pre">'db_key',</span> <span class="pre">'attributes',</span> <span class="pre">'db_typeclass_path',</span> <span class="pre">'aliases',</span> <span class="pre">'tags',</span> <span class="pre">'permissions']</span></em><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.AccountSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountListSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">AccountListSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountListSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>A shortened form for listing.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountListSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#AccountListSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountListSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.accounts.accounts.html#evennia.accounts.accounts.DefaultAccount" title="evennia.accounts.accounts.DefaultAccount"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultAccount</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountListSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['username',</span> <span class="pre">'id',</span> <span class="pre">'db_typeclass_path']</span></em><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.AccountListSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.AccountListSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptDBSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">ScriptDBSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptDBSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer" title="Link 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">TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Serializing Account.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptDBSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptDBSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptDBSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB" title="evennia.scripts.models.ScriptDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptDB</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptDBSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['db_interval',</span> <span class="pre">'db_persistent',</span> <span class="pre">'db_start_delay',</span> <span class="pre">'db_is_active',</span> <span class="pre">'db_repeats',</span> <span class="pre">'id',</span> <span class="pre">'db_key',</span> <span class="pre">'attributes',</span> <span class="pre">'db_typeclass_path',</span> <span class="pre">'aliases',</span> <span class="pre">'tags',</span> <span class="pre">'permissions']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptDBSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptListSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">ScriptListSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptListSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Shortened form for listing.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptListSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#ScriptListSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptListSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.scripts.models.html#evennia.scripts.models.ScriptDB" title="evennia.scripts.models.ScriptDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">ScriptDB</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptListSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['db_interval',</span> <span class="pre">'db_persistent',</span> <span class="pre">'db_start_delay',</span> <span class="pre">'db_is_active',</span> <span class="pre">'db_repeats',</span> <span class="pre">'id',</span> <span class="pre">'db_key',</span> <span class="pre">'db_typeclass_path']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.ScriptListSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">HelpSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer" title="Link 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">TypeclassSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Serializers Help entries (not a typeclass).</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry" title="evennia.help.models.HelpEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">HelpEntry</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id',</span> <span class="pre">'db_key',</span> <span class="pre">'db_help_category',</span> <span class="pre">'db_entrytext',</span> <span class="pre">'db_date_created',</span> <span class="pre">'tags',</span> <span class="pre">'aliases']</span></em><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.HelpSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpListSerializer">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">evennia.web.api.serializers.</span></span><span class="sig-name descname"><span class="pre">HelpListSerializer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpListSerializer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin" title="evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeclassListSerializerMixin</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSerializer</span></code></p>
<p>Shortened form for listings.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpListSerializer.Meta">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Meta</span></span><a class="reference internal" href="../_modules/evennia/web/api/serializers.html#HelpListSerializer.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta" title="Link 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="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpListSerializer.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta.model" title="Link to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.help.models.html#evennia.help.models.HelpEntry" title="evennia.help.models.HelpEntry"><code class="xref py py-class docutils literal notranslate"><span class="pre">HelpEntry</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpListSerializer.Meta.fields">
<span class="sig-name descname"><span class="pre">fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id',</span> <span class="pre">'db_key',</span> <span class="pre">'db_help_category',</span> <span class="pre">'db_date_created']</span></em><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta.fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.api.serializers.HelpListSerializer.Meta.read_only_fields">
<span class="sig-name descname"><span class="pre">read_only_fields</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['id']</span></em><a class="headerlink" href="#evennia.web.api.serializers.HelpListSerializer.Meta.read_only_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">evennia.web.api.serializers</a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AttributeSerializer"><code class="docutils literal notranslate"><span class="pre">AttributeSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AttributeSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">AttributeSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AttributeSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">AttributeSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AttributeSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">AttributeSerializer.Meta.fields</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AttributeSerializer.get_value_display"><code class="docutils literal notranslate"><span class="pre">AttributeSerializer.get_value_display()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TagSerializer"><code class="docutils literal notranslate"><span class="pre">TagSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.TagSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">TagSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.TagSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">TagSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TagSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">TagSerializer.Meta.fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.SimpleObjectDBSerializer"><code class="docutils literal notranslate"><span class="pre">SimpleObjectDBSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">SimpleObjectDBSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">SimpleObjectDBSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.SimpleObjectDBSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">SimpleObjectDBSerializer.Meta.fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin.shared_fields"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin.shared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_tags"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin.get_tags()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_aliases"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin.get_aliases()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_permissions"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin.get_permissions()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_attributes"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin.get_attributes()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassSerializerMixin.get_nicks"><code class="docutils literal notranslate"><span class="pre">TypeclassSerializerMixin.get_nicks()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin"><code class="docutils literal notranslate"><span class="pre">TypeclassListSerializerMixin</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.TypeclassListSerializerMixin.shared_fields"><code class="docutils literal notranslate"><span class="pre">TypeclassListSerializerMixin.shared_fields</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer.get_exits"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer.get_exits()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectDBSerializer.get_contents"><code class="docutils literal notranslate"><span class="pre">ObjectDBSerializer.get_contents()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectListSerializer"><code class="docutils literal notranslate"><span class="pre">ObjectListSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectListSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">ObjectListSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">ObjectListSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">ObjectListSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ObjectListSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">ObjectListSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer"><code class="docutils literal notranslate"><span class="pre">AccountSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer.get_session_ids"><code class="docutils literal notranslate"><span class="pre">AccountSerializer.get_session_ids()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">AccountSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">AccountSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">AccountSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">AccountSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountListSerializer"><code class="docutils literal notranslate"><span class="pre">AccountListSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountListSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">AccountListSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountListSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">AccountListSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountListSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">AccountListSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.AccountListSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">AccountListSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptDBSerializer"><code class="docutils literal notranslate"><span class="pre">ScriptDBSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">ScriptDBSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">ScriptDBSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">ScriptDBSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptDBSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">ScriptDBSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptListSerializer"><code class="docutils literal notranslate"><span class="pre">ScriptListSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptListSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">ScriptListSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">ScriptListSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">ScriptListSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.ScriptListSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">ScriptListSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpSerializer"><code class="docutils literal notranslate"><span class="pre">HelpSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">HelpSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">HelpSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">HelpSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">HelpSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpListSerializer"><code class="docutils literal notranslate"><span class="pre">HelpListSerializer</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpListSerializer.Meta"><code class="docutils literal notranslate"><span class="pre">HelpListSerializer.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpListSerializer.Meta.model"><code class="docutils literal notranslate"><span class="pre">HelpListSerializer.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpListSerializer.Meta.fields"><code class="docutils literal notranslate"><span class="pre">HelpListSerializer.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.api.serializers.HelpListSerializer.Meta.read_only_fields"><code class="docutils literal notranslate"><span class="pre">HelpListSerializer.Meta.read_only_fields</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.web.api.root.html"
title="previous chapter">evennia.web.api.root</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.web.api.tests.html"
title="next chapter">evennia.web.api.tests</a></p>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.web.api.serializers.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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="right" >
<a href="evennia.web.api.tests.html" title="evennia.web.api.tests"
>next</a> |</li>
<li class="right" >
<a href="evennia.web.api.root.html" title="evennia.web.api.root"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-4"><a href="evennia.web.html" >evennia.web</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.web.api.html" >evennia.web.api</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.api.serializers</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink