<spanid="evennia-web-admin-accounts"></span><h1>evennia.web.admin.accounts<aclass="headerlink"href="#module-evennia.web.admin.accounts"title="Permalink to this headline">¶</a></h1>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.admin.accounts.</code><codeclass="sig-name descname">AccountChangeForm</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountChangeForm"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">Meta</code><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.Meta"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountChangeForm.Meta"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountChangeForm.Meta.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="evennia.accounts.models.html#evennia.accounts.models.AccountDB"title="evennia.accounts.models.AccountDB"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.accounts.models.AccountDB</span></code></a></p>
<codeclass="sig-name descname">fields</code><emclass="property"> = '__all__'</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountChangeForm.Meta.fields"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">clean_username</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.clean_username"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountChangeForm.__init__"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountChangeForm.__init__"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="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>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.admin.accounts.</code><codeclass="sig-name descname">AccountCreationForm</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountCreationForm"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">Meta</code><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm.Meta"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountCreationForm.Meta"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountCreationForm.Meta.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="evennia.accounts.models.html#evennia.accounts.models.AccountDB"title="evennia.accounts.models.AccountDB"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.accounts.models.AccountDB</span></code></a></p>
<codeclass="sig-name descname">fields</code><emclass="property"> = '__all__'</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountCreationForm.Meta.fields"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">clean_username</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountCreationForm.clean_username"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountCreationForm.clean_username"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="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>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.admin.accounts.</code><codeclass="sig-name descname">AccountTagInline</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent_model</span></em>, <emclass="sig-param"><spanclass="n">admin_site</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountTagInline"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountTagInline"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountTagInline.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.accounts.models.AccountDB_db_tags</span></code></p>
<codeclass="sig-name descname">related_field</code><emclass="property"> = 'accountdb'</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountTagInline.related_field"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountTagInline.media"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.admin.accounts.</code><codeclass="sig-name descname">AccountAttributeInline</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent_model</span></em>, <emclass="sig-param"><spanclass="n">admin_site</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAttributeInline"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAttributeInline"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAttributeInline.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.accounts.models.AccountDB_db_attributes</span></code></p>
<codeclass="sig-name descname">related_field</code><emclass="property"> = 'accountdb'</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAttributeInline.related_field"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAttributeInline.media"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.admin.accounts.</code><codeclass="sig-name descname">ObjectPuppetInline</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">parent_model</span></em>, <emclass="sig-param"><spanclass="n">admin_site</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">ObjectCreateForm</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-name descname">Meta</code><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">fields</code><emclass="property"> = '__all__'</em><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.fields"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.Meta.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="evennia.objects.models.html#evennia.objects.models.ObjectDB"title="evennia.objects.models.ObjectDB"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.objects.models.ObjectDB</span></code></a></p>
<codeclass="sig-name descname">__init__</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.ObjectCreateForm.__init__"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="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>
<codeclass="sig-name descname">verbose_name</code><emclass="property"> = 'Puppeted Object'</em><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.verbose_name"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">model</code><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.model"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="evennia.objects.models.html#evennia.objects.models.ObjectDB"title="evennia.objects.models.ObjectDB"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.objects.models.ObjectDB</span></code></a></p>
<codeclass="sig-name descname">view_on_site</code><emclass="property"> = False</em><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.view_on_site"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">show_change_link</code><emclass="property"> = True</em><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.show_change_link"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">form</code><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.form"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="evennia.web.admin.objects.html#evennia.web.admin.objects.ObjectCreateForm"title="evennia.web.admin.objects.ObjectCreateForm"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">evennia.web.admin.objects.ObjectCreateForm</span></code></a></p>
<codeclass="sig-name descname">fieldsets</code><emclass="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><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.fieldsets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">extra</code><emclass="property"> = 0</em><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.extra"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">has_add_permission</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">request</span></em>, <emclass="sig-param"><spanclass="n">obj</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline.has_add_permission"><spanclass="viewcode-link">[source]</span></a><aclass="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.
<codeclass="sig-name descname">has_delete_permission</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">request</span></em>, <emclass="sig-param"><spanclass="n">obj</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#ObjectPuppetInline.has_delete_permission"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.has_delete_permission"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.web.admin.accounts.ObjectPuppetInline.media"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="py class">
<dtid="evennia.web.admin.accounts.AccountAdmin">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.web.admin.accounts.</code><codeclass="sig-name descname">AccountAdmin</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">model</span></em>, <emclass="sig-param"><spanclass="n">admin_site</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_display_links</code><emclass="property"> = ('id', 'username')</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.list_display_links"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">form</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.form"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="#evennia.web.admin.accounts.AccountChangeForm"title="evennia.web.admin.accounts.AccountChangeForm"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountChangeForm</span></code></a></p>
<codeclass="sig-name descname">add_form</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.add_form"title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <aclass="reference internal"href="#evennia.web.admin.accounts.AccountCreationForm"title="evennia.web.admin.accounts.AccountCreationForm"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountCreationForm</span></code></a></p>
<codeclass="sig-name descname">search_fields</code><emclass="property"> = ['=id', '^username', 'db_typeclass_path']</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.search_fields"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">ordering</code><emclass="property"> = ['-db_date_created', 'id']</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.ordering"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">list_filter</code><emclass="property"> = ['is_superuser', 'is_staff', 'db_typeclass_path']</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.list_filter"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">inlines</code><emclass="property"> = [<class 'evennia.web.admin.accounts.AccountTagInline'>, <class 'evennia.web.admin.accounts.AccountAttributeInline'>]</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.inlines"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">readonly_fields</code><emclass="property"> = ['db_date_created', 'serialized_string', 'puppeted_objects']</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.readonly_fields"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">view_on_site</code><emclass="property"> = False</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.view_on_site"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">fieldsets</code><emclass="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': '<i>Used by the website/Django admin. Except for `superuser status`, the permissions are not used in-game.</i>'}))</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.fieldsets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">add_fieldsets</code><emclass="property"> = ((None, {'fields': ('username', 'password1', 'password2', 'email'), 'description': '<i>These account details are shared by the admin system and the game.</i>'}),)</em><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.add_fieldsets"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">serialized_string</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.serialized_string"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="sig-name descname">puppeted_objects</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">obj</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.puppeted_objects"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="sig-name descname">get_form</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">request</span></em>, <emclass="sig-param"><spanclass="n">obj</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.get_form"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.get_form"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">user_change_password</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">request</span></em>, <emclass="sig-param"><spanclass="n">id</span></em>, <emclass="sig-param"><spanclass="n">form_url</span><spanclass="o">=</span><spanclass="default_value">''</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.user_change_password"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.user_change_password"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">save_model</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">request</span></em>, <emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">form</span></em>, <emclass="sig-param"><spanclass="n">change</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.save_model"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.save_model"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">response_add</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">request</span></em>, <emclass="sig-param"><spanclass="n">obj</span></em>, <emclass="sig-param"><spanclass="n">post_url_continue</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/web/admin/accounts.html#AccountAdmin.response_add"><spanclass="viewcode-link">[source]</span></a><aclass="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
<emclass="property">property </em><codeclass="sig-name descname">media</code><aclass="headerlink"href="#evennia.web.admin.accounts.AccountAdmin.media"title="Permalink to this definition">¶</a></dt>