Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-07 00:45:22 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/latest/api/evennia.web.website.forms.html

468 lines
43 KiB
HTML
Raw Normal View History

Updated HTML docs.
2025-08-15 18:14:21 +00:00
<!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.website.forms &#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.website.tests" href="evennia.web.website.tests.html" />
<link rel="prev" title="evennia.web.website" href="evennia.web.website.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.website.tests.html" title="evennia.web.website.tests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.web.website.html" title="evennia.web.website"
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.website.html" accesskey="U">evennia.web.website</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.website.forms</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.web.website.forms">
<span id="evennia-web-website-forms"></span><h1>evennia.web.website.forms<a class="headerlink" href="#module-evennia.web.website.forms" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.EvenniaForm">
<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.website.forms.</span></span><span class="sig-name descname"><span class="pre">EvenniaForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_id='id_%s'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_class=&lt;class</span> <span class="pre">'django.forms.utils.ErrorList'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label_suffix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_permitted=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_order=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_required_attribute=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renderer=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bound_field_class=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#EvenniaForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Form</span></code></p>
<p>This is a stock Django form, but modified so that all values provided
through it are escaped (sanitized). Validation is performed by the fields
you define in the form.</p>
<p>This has little to do with Evennia itself and is more general web security-
related.</p>
<p><a class="reference external" href="https://www.owasp.org/index.php/Input_Validation_Cheat_Sheet#Goals_of_Input_Validation">https://www.owasp.org/index.php/Input_Validation_Cheat_Sheet#Goals_of_Input_Validation</a></p>
<dl class="py method">
<dt class="sig sig-object py" id="evennia.web.website.forms.EvenniaForm.clean">
<span class="sig-name descname"><span class="pre">clean</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#EvenniaForm.clean"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.clean" title="Link to this definition"></a></dt>
<dd><p>Django hook. Performed on form submission.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><em>cleaned (dict)</em> – Dictionary of key:value pairs submitted on the form.</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.EvenniaForm.base_fields">
<span class="sig-name descname"><span class="pre">base_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">{}</span></em><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.base_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.EvenniaForm.declared_fields">
<span class="sig-name descname"><span class="pre">declared_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">{}</span></em><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.declared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.website.forms.EvenniaForm.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.media" title="Link to this definition"></a></dt>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.AccountForm">
<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.website.forms.</span></span><span class="sig-name descname"><span class="pre">AccountForm</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/website/forms.html#AccountForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.AccountForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">UserCreationForm</span></code></p>
<p>This is a generic Django form tailored to the Account model.</p>
<p>In this incarnation it does not allow getting/setting of attributes, only
core User model fields (username, email, password).</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.AccountForm.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/website/forms.html#AccountForm.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.AccountForm.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>
<p>This is a Django construct that provides additional configuration to
the form.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.AccountForm.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.website.forms.AccountForm.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.website.forms.AccountForm.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">'email')</span></em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.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.website.forms.AccountForm.Meta.field_classes">
<span class="sig-name descname"><span class="pre">field_classes</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">&lt;class</span> <span class="pre">'django.contrib.auth.forms.UsernameField'&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.Meta.field_classes" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.AccountForm.base_fields">
<span class="sig-name descname"><span class="pre">base_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">{'email':</span> <span class="pre">&lt;django.forms.fields.EmailField</span> <span class="pre">object&gt;,</span> <span class="pre">'password1':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'password2':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'username':</span> <span class="pre">&lt;django.contrib.auth.forms.UsernameField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.base_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.AccountForm.declared_fields">
<span class="sig-name descname"><span class="pre">declared_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">{'email':</span> <span class="pre">&lt;django.forms.fields.EmailField</span> <span class="pre">object&gt;,</span> <span class="pre">'password1':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'password2':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.declared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.website.forms.AccountForm.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.website.forms.AccountForm.media" title="Link to this definition"></a></dt>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.ObjectForm">
<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.website.forms.</span></span><span class="sig-name descname"><span class="pre">ObjectForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_id='id_%s'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_class=&lt;class</span> <span class="pre">'django.forms.utils.ErrorList'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label_suffix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_permitted=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_required_attribute=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renderer=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#ObjectForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.ObjectForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.forms.EvenniaForm" title="evennia.web.website.forms.EvenniaForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">EvenniaForm</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ModelForm</span></code></p>
<p>This is a Django form for generic Evennia Objects that allows modification
of attributes when called from a descendent of ObjectUpdate or ObjectCreate
views.</p>
<p>It defines no fields by default; you have to do that by extending this class
and defining what fields you want to be recorded. See the CharacterForm for
a simple example of how to do this.</p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.ObjectForm.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/website/forms.html#ObjectForm.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.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>
<p>This is a Django construct that provides additional configuration to
the form.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.ObjectForm.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.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.website.forms.ObjectForm.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></em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.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.website.forms.ObjectForm.Meta.labels">
<span class="sig-name descname"><span class="pre">labels</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">'Name'}</span></em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.Meta.labels" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.ObjectForm.base_fields">
<span class="sig-name descname"><span class="pre">base_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">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.base_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.ObjectForm.declared_fields">
<span class="sig-name descname"><span class="pre">declared_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">{}</span></em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.declared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.website.forms.ObjectForm.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.media" title="Link to this definition"></a></dt>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm">
<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.website.forms.</span></span><span class="sig-name descname"><span class="pre">CharacterForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_id='id_%s'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_class=&lt;class</span> <span class="pre">'django.forms.utils.ErrorList'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label_suffix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_permitted=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_required_attribute=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renderer=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#CharacterForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.CharacterForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.forms.ObjectForm" title="evennia.web.website.forms.ObjectForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">ObjectForm</span></code></a></p>
<p>This is a Django form for Evennia Character objects.</p>
<p>Since Evennia characters only have one attribute by default, this form only
defines a field for that single attribute. The names of fields you define should
correspond to their names as stored in the dbhandler; you can display
‘prettier’ versions of the fieldname on the form using the ‘label’ kwarg.</p>
<p>The basic field types are CharFields and IntegerFields, which let you enter
text and numbers respectively. IntegerFields have some neat validation tricks
they can do, like mandating values fall within a certain range.</p>
<p>For example, a complete “age” field (which stores its value to
<strong>character.db.age</strong> might look like:</p>
<dl class="simple">
<dt>age = forms.IntegerField(</dt><dd><p>label=”Your Age”,
min_value=18, max_value=9000,
help_text=”Years since your birth.”)</p>
</dd>
</dl>
<p>Default input fields are generic single-line text boxes. You can control what
sort of input field users will see by specifying a “widget.” An example of
this is used for the ‘desc’ field to show a Textarea box instead of a Textbox.</p>
<p>For help in building out your form, please see:
<a class="reference external" href="https://docs.djangoproject.com/en/4.1/topics/forms/#building-a-form-in-django">https://docs.djangoproject.com/en/4.1/topics/forms/#building-a-form-in-django</a></p>
<p>For more information on fields and their capabilities, see:
<a class="reference external" href="https://docs.djangoproject.com/en/4.1/ref/forms/fields/">https://docs.djangoproject.com/en/4.1/ref/forms/fields/</a></p>
<p>For more on widgets, see:
<a class="reference external" href="https://docs.djangoproject.com/en/4.1/ref/forms/widgets/">https://docs.djangoproject.com/en/4.1/ref/forms/widgets/</a></p>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm.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/website/forms.html#CharacterForm.Meta"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.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>
<p>This is a Django construct that provides additional configuration to
the form.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm.Meta.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.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.DefaultCharacter" title="evennia.objects.objects.DefaultCharacter"><code class="xref py py-class docutils literal notranslate"><span class="pre">DefaultCharacter</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm.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></em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.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.website.forms.CharacterForm.Meta.labels">
<span class="sig-name descname"><span class="pre">labels</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">'Name'}</span></em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.Meta.labels" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm.base_fields">
<span class="sig-name descname"><span class="pre">base_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">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'desc':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.base_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm.declared_fields">
<span class="sig-name descname"><span class="pre">declared_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">{'desc':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.declared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterForm.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.media" title="Link to this definition"></a></dt>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterUpdateForm">
<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.website.forms.</span></span><span class="sig-name descname"><span class="pre">CharacterUpdateForm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auto_id='id_%s'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">initial=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_class=&lt;class</span> <span class="pre">'django.forms.utils.ErrorList'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label_suffix=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">empty_permitted=False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">instance=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_required_attribute=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renderer=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#CharacterUpdateForm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#evennia.web.website.forms.CharacterForm" title="evennia.web.website.forms.CharacterForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">CharacterForm</span></code></a></p>
<p>This is a Django form for updating Evennia Character objects.</p>
<p>By default it is the same as the CharacterForm, but if there are circumstances
in which you don’t want to let players edit all the same attributes they had
access to during creation, you can redefine this form with those fields you do
wish to allow.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterUpdateForm.base_fields">
<span class="sig-name descname"><span class="pre">base_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">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;,</span> <span class="pre">'desc':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm.base_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterUpdateForm.declared_fields">
<span class="sig-name descname"><span class="pre">declared_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">{'desc':</span> <span class="pre">&lt;django.forms.fields.CharField</span> <span class="pre">object&gt;}</span></em><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm.declared_fields" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="evennia.web.website.forms.CharacterUpdateForm.media">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media</span></span><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm.media" title="Link to this definition"></a></dt>
<dd><p>Return all media required to render the widgets on this form.</p>
</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.website.forms</a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.EvenniaForm"><code class="docutils literal notranslate"><span class="pre">EvenniaForm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.EvenniaForm.clean"><code class="docutils literal notranslate"><span class="pre">EvenniaForm.clean()</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.EvenniaForm.base_fields"><code class="docutils literal notranslate"><span class="pre">EvenniaForm.base_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.EvenniaForm.declared_fields"><code class="docutils literal notranslate"><span class="pre">EvenniaForm.declared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.EvenniaForm.media"><code class="docutils literal notranslate"><span class="pre">EvenniaForm.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm"><code class="docutils literal notranslate"><span class="pre">AccountForm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.Meta"><code class="docutils literal notranslate"><span class="pre">AccountForm.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.Meta.model"><code class="docutils literal notranslate"><span class="pre">AccountForm.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.Meta.fields"><code class="docutils literal notranslate"><span class="pre">AccountForm.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.Meta.field_classes"><code class="docutils literal notranslate"><span class="pre">AccountForm.Meta.field_classes</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.base_fields"><code class="docutils literal notranslate"><span class="pre">AccountForm.base_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.declared_fields"><code class="docutils literal notranslate"><span class="pre">AccountForm.declared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.AccountForm.media"><code class="docutils literal notranslate"><span class="pre">AccountForm.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm"><code class="docutils literal notranslate"><span class="pre">ObjectForm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.Meta"><code class="docutils literal notranslate"><span class="pre">ObjectForm.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.Meta.model"><code class="docutils literal notranslate"><span class="pre">ObjectForm.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.Meta.fields"><code class="docutils literal notranslate"><span class="pre">ObjectForm.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.Meta.labels"><code class="docutils literal notranslate"><span class="pre">ObjectForm.Meta.labels</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.base_fields"><code class="docutils literal notranslate"><span class="pre">ObjectForm.base_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.declared_fields"><code class="docutils literal notranslate"><span class="pre">ObjectForm.declared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.ObjectForm.media"><code class="docutils literal notranslate"><span class="pre">ObjectForm.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm"><code class="docutils literal notranslate"><span class="pre">CharacterForm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.Meta"><code class="docutils literal notranslate"><span class="pre">CharacterForm.Meta</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.Meta.model"><code class="docutils literal notranslate"><span class="pre">CharacterForm.Meta.model</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.Meta.fields"><code class="docutils literal notranslate"><span class="pre">CharacterForm.Meta.fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.Meta.labels"><code class="docutils literal notranslate"><span class="pre">CharacterForm.Meta.labels</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.base_fields"><code class="docutils literal notranslate"><span class="pre">CharacterForm.base_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.declared_fields"><code class="docutils literal notranslate"><span class="pre">CharacterForm.declared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterForm.media"><code class="docutils literal notranslate"><span class="pre">CharacterForm.media</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterUpdateForm"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateForm</span></code></a><ul>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterUpdateForm.base_fields"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateForm.base_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterUpdateForm.declared_fields"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateForm.declared_fields</span></code></a></li>
<li><a class="reference internal" href="#evennia.web.website.forms.CharacterUpdateForm.media"><code class="docutils literal notranslate"><span class="pre">CharacterUpdateForm.media</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.web.website.html"
title="previous chapter">evennia.web.website</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.web.website.tests.html"
title="next chapter">evennia.web.website.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.website.forms.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>
Updated HTML docs.
2026-02-15 18:13:08 +00:00
<li>
<a href="https://www.evennia.com/docs/6.x/index.html">v6.0.0 branch (outdated)</a>
</li>
Updated HTML docs.
2025-08-15 18:14:21 +00:00
<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.website.tests.html" title="evennia.web.website.tests"
>next</a> |</li>
<li class="right" >
<a href="evennia.web.website.html" title="evennia.web.website"
>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.website.html" >evennia.web.website</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.website.forms</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 Copy permalink