Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-30 20:47:17 +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

28
docs/1.0-dev/api/evennia.server.validators.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.server.validators &#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.server.validators</a></li>
</ul>
</div>
@ -36,20 +38,20 @@
<div class="section" id="module-evennia.server.validators">
<span id="evennia-server-validators"></span><h1>evennia.server.validators<a class="headerlink" href="#module-evennia.server.validators" title="Permalink to this headline"></a></h1>
<dl class="class">
<dl class="py class">
<dt id="evennia.server.validators.EvenniaUsernameAvailabilityValidator">
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.validators.</code><code class="sig-name descname">EvenniaUsernameAvailabilityValidator</code><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaUsernameAvailabilityValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaUsernameAvailabilityValidator" 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>Checks to make sure a given username is not taken or otherwise reserved.</p>
</dd></dl>
<dl class="class">
<dl class="py class">
<dt id="evennia.server.validators.EvenniaPasswordValidator">
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.validators.</code><code class="sig-name descname">EvenniaPasswordValidator</code><span class="sig-paren">(</span><em class="sig-param">regex=&quot;^[\w. &#64;+\-',]+$&quot;, policy=&quot;Password should contain a mix of letters, spaces, digits and &#64;/./+/-/_/'/, only.&quot;</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">evennia.server.validators.</code><code class="sig-name descname">EvenniaPasswordValidator</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">regex</span><span class="o">=</span><span class="default_value">&quot;^[\\w. &#64;+\\-',]+$&quot;</span></em>, <em class="sig-param"><span class="n">policy</span><span class="o">=</span><span class="default_value">&quot;Password should contain a mix of letters, spaces, digits and &#64;/./+/-/_/'/, only.&quot;</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator" 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="method">
<dl class="py method">
<dt id="evennia.server.validators.EvenniaPasswordValidator.__init__">
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">regex=&quot;^[\\w. &#64;+\\-',]+$&quot;, policy=&quot;Password should contain a mix of letters, spaces, digits and &#64;/./+/-/_/'/, only.&quot;</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator.__init__" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">regex</span><span class="o">=</span><span class="default_value">&quot;^[\\w. &#64;+\\-',]+$&quot;</span></em>, <em class="sig-param"><span class="n">policy</span><span class="o">=</span><span class="default_value">&quot;Password should contain a mix of letters, spaces, digits and &#64;/./+/-/_/'/, only.&quot;</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator.__init__" title="Permalink to this definition"></a></dt>
<dd><p>Constructs a standard Django password validator.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@ -61,9 +63,9 @@
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.server.validators.EvenniaPasswordValidator.validate">
<code class="sig-name descname">validate</code><span class="sig-paren">(</span><em class="sig-param">password</em>, <em class="sig-param">user=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator.validate" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">validate</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">password</span></em>, <em class="sig-param"><span class="n">user</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator.validate" title="Permalink to this definition"></a></dt>
<dd><p>Validates a password string to make sure it meets predefined Evennia
acceptable character policy.</p>
<dl class="field-list simple">
@ -84,7 +86,7 @@ acceptable character policy.</p>
</dl>
</dd></dl>
<dl class="method">
<dl class="py method">
<dt id="evennia.server.validators.EvenniaPasswordValidator.get_help_text">
<code class="sig-name descname">get_help_text</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/server/validators.html#EvenniaPasswordValidator.get_help_text"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.server.validators.EvenniaPasswordValidator.get_help_text" title="Permalink to this definition"></a></dt>
<dd><p>Returns a user-facing explanation of the password policy defined
@ -101,6 +103,7 @@ by this validator.</p>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
@ -145,12 +148,13 @@ by this validator.</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.server.validators</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>