Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-04 06:57:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-10-15 01:31:30 +02:00
parent dc00b6bf65
commit edf9ca4c4b
1252 changed files with 40437 additions and 27044 deletions
Download patch file Download diff file Expand all files Collapse all files

95
docs/1.0-dev/api/evennia.web.website.forms.html
View file

@ -1,9 +1,10 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.web.website.forms &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@ -25,7 +26,8 @@
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.website.forms</a></li>
</ul>
</div>
@ -36,7 +38,7 @@
<div class="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="Permalink to this headline"></a></h1>
<dl class="class">
<dl class="py class">
<dt id="evennia.web.website.forms.EvenniaForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.forms.</code><code class="sig-name descname">EvenniaForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=&lt;class 'django.forms.utils.ErrorList'&gt;</em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">field_order=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#EvenniaForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.forms.forms.Form</span></code></p>
@ -46,7 +48,7 @@ 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="method">
<dl class="py method">
<dt id="evennia.web.website.forms.EvenniaForm.clean">
<code class="sig-name descname">clean</code><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">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.clean" title="Permalink to this definition"></a></dt>
<dd><p>Django hook. Performed on form submission.</p>
@ -57,72 +59,74 @@ related.</p>
</dl>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.EvenniaForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {}</em><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.EvenniaForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {}</em><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.web.website.forms.EvenniaForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.website.forms.EvenniaForm.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.web.website.forms.AccountForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.forms.</code><code class="sig-name descname">AccountForm</code><span class="sig-paren">(</span><em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#AccountForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.AccountForm" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.forms.</code><code class="sig-name descname">AccountForm</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#AccountForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.AccountForm" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.forms.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="class">
<dl class="py class">
<dt id="evennia.web.website.forms.AccountForm.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/website/forms.html#AccountForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.AccountForm.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This is a Django construct that provides additional configuration to
the form.</p>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.AccountForm.Meta.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.forms.AccountForm.Meta.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">typeclasses.accounts.Account</span></code></p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.AccountForm.Meta.fields">
<code class="sig-name descname">fields</code><em class="property"> = ('username', 'email')</em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.Meta.fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.AccountForm.Meta.field_classes">
<code class="sig-name descname">field_classes</code><em class="property"> = {'username': &lt;class 'django.contrib.auth.forms.UsernameField'&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.Meta.field_classes" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.AccountForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'email': &lt;django.forms.fields.EmailField object&gt;, 'password1': &lt;django.forms.fields.CharField object&gt;, 'password2': &lt;django.forms.fields.CharField object&gt;, 'username': &lt;django.contrib.auth.forms.UsernameField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.AccountForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {'email': &lt;django.forms.fields.EmailField object&gt;, 'password1': &lt;django.forms.fields.CharField object&gt;, 'password2': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.AccountForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.web.website.forms.AccountForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.website.forms.AccountForm.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.web.website.forms.ObjectForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.forms.</code><code class="sig-name descname">ObjectForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=&lt;class 'django.forms.utils.ErrorList'&gt;</em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#ObjectForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.ObjectForm" title="Permalink 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">evennia.web.website.forms.EvenniaForm</span></code></a>, <code class="xref py py-class docutils literal notranslate"><span class="pre">django.forms.models.ModelForm</span></code></p>
@ -132,48 +136,49 @@ 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="class">
<dl class="py class">
<dt id="evennia.web.website.forms.ObjectForm.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/website/forms.html#ObjectForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This is a Django construct that provides additional configuration to
the form.</p>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.ObjectForm.Meta.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.Meta.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">typeclasses.objects.Object</span></code></p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.ObjectForm.Meta.fields">
<code class="sig-name descname">fields</code><em class="property"> = ('db_key',)</em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.Meta.fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.ObjectForm.Meta.labels">
<code class="sig-name descname">labels</code><em class="property"> = {'db_key': 'Name'}</em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.Meta.labels" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.ObjectForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_key': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.ObjectForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {}</em><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.web.website.forms.ObjectForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.website.forms.ObjectForm.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.web.website.forms.CharacterForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.forms.</code><code class="sig-name descname">CharacterForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=&lt;class 'django.forms.utils.ErrorList'&gt;</em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#CharacterForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.CharacterForm" title="Permalink 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">evennia.web.website.forms.ObjectForm</span></code></a></p>
@ -202,48 +207,49 @@ this is used for the ‘desc’ field to show a Textarea box instead of a Textbo
<a class="reference external" href="https://docs.djangoproject.com/en/1.11/ref/forms/fields/">https://docs.djangoproject.com/en/1.11/ref/forms/fields/</a></p>
<p>For more on widgets, see:
<a class="reference external" href="https://docs.djangoproject.com/en/1.11/ref/forms/widgets/">https://docs.djangoproject.com/en/1.11/ref/forms/widgets/</a></p>
<dl class="class">
<dl class="py class">
<dt id="evennia.web.website.forms.CharacterForm.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/website/forms.html#CharacterForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This is a Django construct that provides additional configuration to
the form.</p>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterForm.Meta.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.Meta.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">typeclasses.characters.Character</span></code></p>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterForm.Meta.fields">
<code class="sig-name descname">fields</code><em class="property"> = ('db_key',)</em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.Meta.fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterForm.Meta.labels">
<code class="sig-name descname">labels</code><em class="property"> = {'db_key': 'Name'}</em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.Meta.labels" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_key': &lt;django.forms.fields.CharField object&gt;, 'desc': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {'desc': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.web.website.forms.CharacterForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.website.forms.CharacterForm.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.web.website.forms.CharacterUpdateForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.forms.</code><code class="sig-name descname">CharacterUpdateForm</code><span class="sig-paren">(</span><em class="sig-param">data=None</em>, <em class="sig-param">files=None</em>, <em class="sig-param">auto_id='id_%s'</em>, <em class="sig-param">prefix=None</em>, <em class="sig-param">initial=None</em>, <em class="sig-param">error_class=&lt;class 'django.forms.utils.ErrorList'&gt;</em>, <em class="sig-param">label_suffix=None</em>, <em class="sig-param">empty_permitted=False</em>, <em class="sig-param">instance=None</em>, <em class="sig-param">use_required_attribute=None</em>, <em class="sig-param">renderer=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/forms.html#CharacterUpdateForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm" title="Permalink 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">evennia.web.website.forms.CharacterForm</span></code></a></p>
@ -252,26 +258,28 @@ the form.</p>
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="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterUpdateForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_key': &lt;django.forms.fields.CharField object&gt;, 'desc': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dl class="py attribute">
<dt id="evennia.web.website.forms.CharacterUpdateForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {'desc': &lt;django.forms.fields.CharField object&gt;}</em><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.web.website.forms.CharacterUpdateForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.website.forms.CharacterUpdateForm.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dd><p>Return all media required to render the widgets on this form.</p>
</dd></dl>
</dd></dl>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -316,12 +324,13 @@ wish to allow.</p>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</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 2020, The Evennia developer community.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>