evennia/docs/2.x/api/evennia.web.admin.accounts.html

537 lines
45 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
2023-10-19 20:22:27 +00:00
<title>evennia.web.admin.accounts &#8212; Evennia 2.x documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="evennia.web.admin.attributes" href="evennia.web.admin.attributes.html" />
<link rel="prev" title="evennia.web.admin" href="evennia.web.admin.html" />
</head><body>
2023-10-19 20:22:27 +00:00
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.web.admin.attributes.html" title="evennia.web.admin.attributes"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.web.admin.html" title="evennia.web.admin"
accesskey="P">previous</a> |</li>
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</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.admin.html" accesskey="U">evennia.web.admin</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.accounts</a></li>
</ul>
2023-06-10 08:53:19 +00:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.web.admin.html"
title="previous chapter">evennia.web.admin</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.web.admin.attributes.html"
title="next chapter">evennia.web.admin.attributes</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.web.admin.accounts.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
2023-10-19 20:22:27 +00:00
<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>
2023-10-19 20:22:27 +00:00
<h3>Doc Versions</h3>
<ul>
2023-10-19 20:22:27 +00:00
<li><a href="evennia.web.admin.accounts.html">2.x (main branch)</a></li>
2022-11-15 20:29:38 +00:00
<ul>
2023-10-19 20:22:27 +00:00
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
2022-11-15 20:29:38 +00:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.web.admin.accounts">
<span id="evennia-web-admin-accounts"></span><h1>evennia.web.admin.accounts<a class="headerlink" href="#module-evennia.web.admin.accounts" title="Permalink to this headline"></a></h1>
<dl class="py class">
<dt id="evennia.web.admin.accounts.AccountChangeForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountChangeForm</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/admin/accounts.html#AccountChangeForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm" 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.UserChangeForm</span></code></p>
<p>Modify the accountdb class.</p>
<dl class="py class">
<dt id="evennia.web.admin.accounts.AccountChangeForm.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountChangeForm.Meta.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.Meta.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountChangeForm.Meta.fields">
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.Meta.fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountChangeForm.clean_username">
<code class="sig-name descname">clean_username</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.clean_username"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.clean_username" title="Permalink to this definition"></a></dt>
<dd><p>Clean the username and check its existence.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountChangeForm.__init__">
<code class="sig-name descname">__init__</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/admin/accounts.html#AccountChangeForm.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Tweak some fields dynamically.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountChangeForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': &lt;django.forms.fields.DateTimeField object&gt;, 'db_attributes': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_is_bot': &lt;django.forms.fields.BooleanField object&gt;, 'db_is_connected': &lt;django.forms.fields.BooleanField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_tags': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;, 'email': &lt;django.forms.fields.EmailField object&gt;, 'first_name': &lt;django.forms.fields.CharField object&gt;, 'groups': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'is_active': &lt;django.forms.fields.BooleanField object&gt;, 'is_staff': &lt;django.forms.fields.BooleanField object&gt;, 'is_superuser': &lt;django.forms.fields.BooleanField object&gt;, 'last_login': &lt;django.forms.fields.DateTimeField object&gt;, 'last_name': &lt;django.forms.fields.CharField object&gt;, 'password': &lt;django.contrib.auth.forms.ReadOnlyPasswordHashField object&gt;, 'user_permissions': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'username': &lt;django.forms.fields.RegexField object&gt;}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountChangeForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;, 'is_superuser': &lt;django.forms.fields.BooleanField object&gt;, 'password': &lt;django.contrib.auth.forms.ReadOnlyPasswordHashField object&gt;, 'username': &lt;django.forms.fields.RegexField object&gt;}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountChangeForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountChangeForm.media" title="Permalink 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 id="evennia.web.admin.accounts.AccountCreationForm">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountCreationForm</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/admin/accounts.html#AccountCreationForm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm" 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>Create a new AccountDB instance.</p>
<dl class="py class">
<dt id="evennia.web.admin.accounts.AccountCreationForm.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm.Meta"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountCreationForm.Meta.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.Meta.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.accounts.models.html#evennia.accounts.models.AccountDB" title="evennia.accounts.models.AccountDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountCreationForm.Meta.fields">
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.Meta.fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountCreationForm.clean_username">
<code class="sig-name descname">clean_username</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm.clean_username"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.clean_username" title="Permalink to this definition"></a></dt>
<dd><p>Cleanup username.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountCreationForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'date_joined': &lt;django.forms.fields.DateTimeField object&gt;, 'db_attributes': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_is_bot': &lt;django.forms.fields.BooleanField object&gt;, 'db_is_connected': &lt;django.forms.fields.BooleanField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_tags': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.CharField object&gt;, 'email': &lt;django.forms.fields.EmailField object&gt;, 'first_name': &lt;django.forms.fields.CharField object&gt;, 'groups': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'is_active': &lt;django.forms.fields.BooleanField object&gt;, 'is_staff': &lt;django.forms.fields.BooleanField object&gt;, 'is_superuser': &lt;django.forms.fields.BooleanField object&gt;, 'last_login': &lt;django.forms.fields.DateTimeField object&gt;, 'last_name': &lt;django.forms.fields.CharField object&gt;, 'password': &lt;django.forms.fields.CharField object&gt;, 'password1': &lt;django.forms.fields.CharField object&gt;, 'password2': &lt;django.forms.fields.CharField object&gt;, 'user_permissions': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'username': &lt;django.forms.fields.RegexField object&gt;}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountCreationForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {'password1': &lt;django.forms.fields.CharField object&gt;, 'password2': &lt;django.forms.fields.CharField object&gt;, 'username': &lt;django.forms.fields.RegexField object&gt;}</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountCreationForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountCreationForm.media" title="Permalink 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 id="evennia.web.admin.accounts.AccountTagInline">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountTagInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountTagInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.tags.html#evennia.web.admin.tags.TagInline" title="evennia.web.admin.tags.TagInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.tags.TagInline</span></code></a></p>
<p>Inline Account Tags.</p>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountTagInline.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB_db_tags</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountTagInline.related_field">
<code class="sig-name descname">related_field</code><em class="property"> = 'accountdb'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline.related_field" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountTagInline.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountTagInline.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.admin.accounts.AccountAttributeInline">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountAttributeInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAttributeInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.web.admin.attributes.html#evennia.web.admin.attributes.AttributeInline" title="evennia.web.admin.attributes.AttributeInline"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.attributes.AttributeInline</span></code></a></p>
<p>Inline Account Attributes.</p>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAttributeInline.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.accounts.models.AccountDB_db_attributes</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAttributeInline.related_field">
<code class="sig-name descname">related_field</code><em class="property"> = 'accountdb'</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline.related_field" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAttributeInline.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAttributeInline.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">ObjectPuppetInline</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent_model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.admin.options.StackedInline</span></code></p>
<p>Inline creation of puppet-Object in Account.</p>
<dl class="py class">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm">
<em class="property">class </em><code class="sig-name descname">ObjectCreateForm</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="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.forms.models.ModelForm</span></code></p>
<p>This form details the look of the fields.</p>
<dl class="py class">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta">
<em class="property">class </em><code class="sig-name descname">Meta</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.fields">
<code class="sig-name descname">fields</code><em class="property"> = '__all__'</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
</dd></dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.__init__">
<code class="sig-name descname">__init__</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="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Tweak some fields dynamically.</p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.base_fields">
<code class="sig-name descname">base_fields</code><em class="property"> = {'db_account': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_attributes': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_destination': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_home': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_location': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_sessid': &lt;django.forms.fields.CharField object&gt;, 'db_tags': &lt;django.forms.models.ModelMultipleChoiceField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;}</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.base_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.declared_fields">
<code class="sig-name descname">declared_fields</code><em class="property"> = {'db_cmdset_storage': &lt;django.forms.fields.CharField object&gt;, 'db_destination': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_home': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_key': &lt;django.forms.fields.CharField object&gt;, 'db_location': &lt;django.forms.models.ModelChoiceField object&gt;, 'db_lock_storage': &lt;django.forms.fields.CharField object&gt;, 'db_typeclass_path': &lt;django.forms.fields.ChoiceField object&gt;}</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.declared_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.media" title="Permalink 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 attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.verbose_name">
<code class="sig-name descname">verbose_name</code><em class="property"> = 'Puppeted Object'</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.verbose_name" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.model">
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.model" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.objects.models.html#evennia.objects.models.ObjectDB" title="evennia.objects.models.ObjectDB"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.models.ObjectDB</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.view_on_site">
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.view_on_site" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.show_change_link">
<code class="sig-name descname">show_change_link</code><em class="property"> = True</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.show_change_link" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.form">
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.form" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="evennia.web.admin.objects.html#evennia.web.admin.objects.ObjectCreateForm" title="evennia.web.admin.objects.ObjectCreateForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.admin.objects.ObjectCreateForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.fieldsets">
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('db_key', 'db_typeclass_path'), ('db_location', 'db_home', 'db_destination'), 'db_cmdset_storage', 'db_lock_storage'), 'description': 'Object currently puppeted by the account (note that this will go away if account logs out or unpuppets)'}),)</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.fieldsets" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.extra">
<code class="sig-name descname">extra</code><em class="property"> = 0</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.extra" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.readonly_fields">
<code class="sig-name descname">readonly_fields</code><em class="property"> = ('db_key', 'db_typeclass_path', 'db_destination', 'db_location', 'db_home', 'db_account', 'db_cmdset_storage', 'db_lock_storage')</em><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.readonly_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.has_add_permission">
<code class="sig-name descname">has_add_permission</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline.has_add_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.has_add_permission" title="Permalink to this definition"></a></dt>
<dd><p>Return True if the given request has permission to add an object.
Can be overridden by the user in subclasses.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.has_delete_permission">
<code class="sig-name descname">has_delete_permission</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline.has_delete_permission"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.has_delete_permission" title="Permalink to this definition"></a></dt>
2023-12-02 22:36:16 +00:00
<dd><p>Return True if the given request has permission to delete the given
Django model instance, the default implementation doesnt examine the
<strong>obj</strong> parameter.</p>
<p>Can be overridden by the user in subclasses. In such case it should
return True if the given request has permission to delete the <strong>obj</strong>
model instance. If <strong>obj</strong> is None, this should return True if the given
request has permission to delete <em>any</em> object of the given type.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.ObjectPuppetInline.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.ObjectPuppetInline.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.web.admin.accounts.AccountAdmin">
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.admin.accounts.</code><code class="sig-name descname">AccountAdmin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">model</span></em>, <em class="sig-param"><span class="n">admin_site</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin" 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.admin.UserAdmin</span></code></p>
<p>This is the main creation screen for Users/accounts</p>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.list_display">
<code class="sig-name descname">list_display</code><em class="property"> = ('id', 'username', 'is_staff', 'is_superuser', 'db_typeclass_path', 'db_date_created')</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.list_display" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.list_display_links">
<code class="sig-name descname">list_display_links</code><em class="property"> = ('id', 'username')</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.list_display_links" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.form">
<code class="sig-name descname">form</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.form" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.accounts.AccountChangeForm" title="evennia.web.admin.accounts.AccountChangeForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountChangeForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.add_form">
<code class="sig-name descname">add_form</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.add_form" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#evennia.web.admin.accounts.AccountCreationForm" title="evennia.web.admin.accounts.AccountCreationForm"><code class="xref py py-class docutils literal notranslate"><span class="pre">AccountCreationForm</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.search_fields">
<code class="sig-name descname">search_fields</code><em class="property"> = ['=id', '^username', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.search_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.ordering">
<code class="sig-name descname">ordering</code><em class="property"> = ['-db_date_created', 'id']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.ordering" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.list_filter">
<code class="sig-name descname">list_filter</code><em class="property"> = ['is_superuser', 'is_staff', 'db_typeclass_path']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.list_filter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.inlines">
<code class="sig-name descname">inlines</code><em class="property"> = [&lt;class 'evennia.web.admin.accounts.AccountTagInline'&gt;, &lt;class 'evennia.web.admin.accounts.AccountAttributeInline'&gt;]</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.inlines" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.readonly_fields">
<code class="sig-name descname">readonly_fields</code><em class="property"> = ['db_date_created', 'serialized_string', 'puppeted_objects']</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.readonly_fields" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.view_on_site">
<code class="sig-name descname">view_on_site</code><em class="property"> = False</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.view_on_site" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.fieldsets">
<code class="sig-name descname">fieldsets</code><em class="property"> = ((None, {'fields': (('username', 'db_typeclass_path'), 'password', 'email', 'db_date_created', 'db_lock_storage', 'db_cmdset_storage', 'puppeted_objects', 'serialized_string')}), ('Admin/Website properties', {'fields': (('first_name', 'last_name'), 'last_login', 'date_joined', 'is_active', 'is_staff', 'is_superuser', 'user_permissions', 'groups'), 'description': '&lt;i&gt;Used by the website/Django admin. Except for `superuser status`, the permissions are not used in-game.&lt;/i&gt;'}))</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.fieldsets" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="evennia.web.admin.accounts.AccountAdmin.add_fieldsets">
<code class="sig-name descname">add_fieldsets</code><em class="property"> = ((None, {'fields': ('username', 'password1', 'password2', 'email'), 'description': '&lt;i&gt;These account details are shared by the admin system and the game.&lt;/i&gt;'}),)</em><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.add_fieldsets" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.serialized_string">
<code class="sig-name descname">serialized_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.serialized_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.serialized_string" title="Permalink to this definition"></a></dt>
<dd><p>Get the serialized version of the object.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.puppeted_objects">
<code class="sig-name descname">puppeted_objects</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">obj</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.puppeted_objects"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.puppeted_objects" title="Permalink to this definition"></a></dt>
<dd><p>Get any currently puppeted objects (read only list)</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.get_form">
<code class="sig-name descname">get_form</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span><span class="o">=</span><span class="default_value">None</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/admin/accounts.html#AccountAdmin.get_form"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.get_form" title="Permalink to this definition"></a></dt>
<dd><p>Overrides help texts.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.user_change_password">
<code class="sig-name descname">user_change_password</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">id</span></em>, <em class="sig-param"><span class="n">form_url</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.user_change_password"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.user_change_password" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.save_model">
<code class="sig-name descname">save_model</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">form</span></em>, <em class="sig-param"><span class="n">change</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.save_model"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.save_model" title="Permalink to this definition"></a></dt>
<dd><p>Custom save actions.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>request</strong> (<em>Request</em>) Incoming request.</p></li>
<li><p><strong>obj</strong> (<em>Object</em>) Object to save.</p></li>
<li><p><strong>form</strong> (<em>Form</em>) Related form instance.</p></li>
<li><p><strong>change</strong> (<em>bool</em>) False if this is a new save and not an update.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.response_add">
<code class="sig-name descname">response_add</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="n">obj</span></em>, <em class="sig-param"><span class="n">post_url_continue</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.response_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.response_add" title="Permalink to this definition"></a></dt>
<dd><p>Determine the HttpResponse for the add_view stage. It mostly defers to
its superclass implementation but is customized because the User model
has a slightly different workflow.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.web.admin.accounts.AccountAdmin.media">
<em class="property">property </em><code class="sig-name descname">media</code><a class="headerlink" href="#evennia.web.admin.accounts.AccountAdmin.media" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="evennia.web.admin.attributes.html" title="evennia.web.admin.attributes"
>next</a> |</li>
<li class="right" >
<a href="evennia.web.admin.html" title="evennia.web.admin"
>previous</a> |</li>
2023-10-19 20:22:27 +00:00
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</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.admin.html" >evennia.web.admin</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.web.admin.accounts</a></li>
</ul>
</div>
2023-10-19 20:22:27 +00:00
<div class="footer" role="contentinfo">
2023-10-19 20:22:27 +00:00
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>