<spanid="evennia-accounts-manager"></span><h1>evennia.accounts.manager<aclass="headerlink"href="#module-evennia.accounts.manager"title="Permalink to this headline">¶</a></h1>
<p>The managers for the custom Account object and permissions.</p>
<dlclass="py class">
<dtid="evennia.accounts.manager.AccountManager">
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.accounts.manager.</code><codeclass="sig-name descname">AccountManager</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/accounts/manager.html#AccountManager"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountManager"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.accounts.manager.</code><codeclass="sig-name descname">AccountDBManager</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/accounts/manager.html#AccountDBManager"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">num_total_accounts</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.num_total_accounts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.num_total_accounts"title="Permalink to this definition">¶</a></dt>
<dd><p>Get total number of accounts.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>count (int)</em>– The total number of registered accounts.</p>
<codeclass="sig-name descname">get_connected_accounts</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.get_connected_accounts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.get_connected_accounts"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_recently_created_accounts</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">days</span><spanclass="o">=</span><spanclass="default_value">7</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.get_recently_created_accounts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.get_recently_created_accounts"title="Permalink to this definition">¶</a></dt>
<dd><p>Get accounts recently created.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>days</strong> (<em>int</em><em>, </em><em>optional</em>) – How many days in the past “recently” means.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>accounts (list)</em>– The Accounts created the last <strong>days</strong> interval.</p>
<codeclass="sig-name descname">get_recently_connected_accounts</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">days</span><spanclass="o">=</span><spanclass="default_value">7</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.get_recently_connected_accounts"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.get_recently_connected_accounts"title="Permalink to this definition">¶</a></dt>
<dd><p>Get accounts recently connected to the game.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>days</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of days backwards to check</p>
<codeclass="sig-name descname">get_account_from_email</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">uemail</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.get_account_from_email"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.get_account_from_email"title="Permalink to this definition">¶</a></dt>
<dd><p>Search account by
Returns an account object based on email address.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>uemail</strong> (<em>str</em>) – An email address to search for.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>account (Account)</em>– A found account, if found.</p>
<codeclass="sig-name descname">get_account_from_uid</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">uid</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.get_account_from_uid"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.get_account_from_uid"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">get_account_from_name</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">uname</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.get_account_from_name"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.get_account_from_name"title="Permalink to this definition">¶</a></dt>
<dd><p>Get account object based on name.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><p><strong>uname</strong> (<em>str</em>) – The Account name to search for.</p>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>account (Account)</em>– The found account.</p>
<codeclass="sig-name descname">search_account</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">ostring</span></em>, <emclass="sig-param"><spanclass="n">exact</span><spanclass="o">=</span><spanclass="default_value">True</span></em>, <emclass="sig-param"><spanclass="n">typeclass</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.search_account"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.search_account"title="Permalink to this definition">¶</a></dt>
<dd><p>Searches for a particular account by name or
database id.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ostring</strong> (<em>str</em><em> or </em><em>int</em>) – A key string or database id.</p></li>
<li><p><strong>exact</strong> (<em>bool</em><em>, </em><em>optional</em>) – Only valid for string matches. If
<codeclass="sig-name descname">create_account</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">key</span></em>, <emclass="sig-param"><spanclass="n">email</span></em>, <emclass="sig-param"><spanclass="n">password</span></em>, <emclass="sig-param"><spanclass="n">typeclass</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">is_superuser</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">locks</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">permissions</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">tags</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">attributes</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">report_to</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/accounts/manager.html#AccountDBManager.create_account"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.create_account"title="Permalink to this definition">¶</a></dt>
<dd><p>This creates a new account.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>key</strong> (<em>str</em>) – The account’s name. This should be unique.</p></li>
<li><p><strong>email</strong> (<em>str</em><em> or </em><em>None</em>) – Email on valid <aclass="reference external"href="mailto:addr%40addr.domain">addr<span>@</span>addr<span>.</span>domain</a> form. If
the empty string, will be set to None.</p></li>
<li><p><strong>password</strong> (<em>str</em>) – Password in cleartext.</p></li>
</ul>
</dd>
<dtclass="field-even">Keyword Arguments</dt>
<ddclass="field-even"><ulclass="simple">
<li><p><strong>typeclass</strong> (<em>str</em>) – The typeclass to use for the account.</p></li>
<li><p><strong>is_superuser</strong> (<em>bool</em>) – Whether or not this account is to be a superuser</p></li>
<li><p><strong>permission</strong> (<aclass="reference internal"href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list"title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a>) – List of permission strings.</p></li>
<li><p><strong>tags</strong> (<aclass="reference internal"href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list"title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a>) – List of Tags on form <strong>(key, category[, data])</strong></p></li>
<li><p><strong>attributes</strong> (<aclass="reference internal"href="evennia.contrib.game_systems.barter.barter.html#evennia.contrib.game_systems.barter.barter.TradeHandler.list"title="evennia.contrib.game_systems.barter.barter.TradeHandler.list"><em>list</em></a>) – List of Attributes on form
<strong>(key, value [, category, [,lockstring [, default_pass]]])</strong></p></li>
<li><p><strong>report_to</strong> (<em>Object</em>) – An object with a msg() method to report
errors to. If not given, errors will be logged.</p></li>
</ul>
</dd>
<dtclass="field-odd">Returns</dt>
<ddclass="field-odd"><p><em>Account</em>– The newly created Account.</p>
</dd>
<dtclass="field-even">Raises</dt>
<ddclass="field-even"><p><strong>ValueError</strong>– If <strong>key</strong> already exists in database.</p>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>Usually only the server admin should need to be superuser, all
other access levels can be handled with more fine-grained
permissions or groups. A superuser bypasses all lock checking
operations and is thus not suitable for play-testing the game.</p>
<codeclass="sig-name descname">account_search</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">ostring</span></em>, <emclass="sig-param"><spanclass="n">exact</span><spanclass="o">=</span><spanclass="default_value">True</span></em>, <emclass="sig-param"><spanclass="n">typeclass</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.accounts.manager.AccountDBManager.account_search"title="Permalink to this definition">¶</a></dt>
<dd><p>Searches for a particular account by name or
database id.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>ostring</strong> (<em>str</em><em> or </em><em>int</em>) – A key string or database id.</p></li>
<li><p><strong>exact</strong> (<em>bool</em><em>, </em><em>optional</em>) – Only valid for string matches. If
