Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 22:36:31 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/api/evennia.server.validators.html

203 lines
11 KiB
HTML
Raw Normal View History

Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
<!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/" />
<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" />
<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.server.webserver" href="evennia.server.webserver.html" />
<link rel="prev" title="evennia.server.throttle" href="evennia.server.throttle.html" />
</head><body>
<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.server.webserver.html" title="evennia.server.webserver"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.server.throttle.html" title="evennia.server.throttle"
accesskey="P">previous</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-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.server.html" accesskey="U">evennia.server</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.validators</a></li>
</ul>
<div class="develop">develop branch</div>
</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.server.throttle.html"
title="previous chapter">evennia.server.throttle</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.server.webserver.html"
title="next chapter">evennia.server.webserver</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.server.validators.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/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>
<h3>Versions</h3>
<ul>
<li><a href="evennia.server.validators.html">1.0-dev (develop branch)</a></li>
Updated HTML docs.
2022-11-15 20:29:38 +00:00
<ul>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<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="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="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"><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="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"><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>
<dd class="field-odd"><ul class="simple">
<li><p><strong>regex</strong> (<em>str</em>) – Regex pattern of valid characters to allow.</p></li>
<li><p><strong>policy</strong> (<em>str</em>) – Brief explanation of what the defined regex permits.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<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"><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">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>password</strong> (<em>str</em>) – Password to validate</p></li>
<li><p><strong>user</strong> (<em>None</em>) – Unused argument but required by Django</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p><em>None (None)</em> –</p>
<dl class="simple">
<dt>None if password successfully validated,</dt><dd><p>raises ValidationError otherwise.</p>
</dd>
</dl>
</p>
</dd>
</dl>
</dd></dl>
<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
by this validator.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><em>text (str)</em> – Explanation of password policy.</p>
</dd>
</dl>
</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.server.webserver.html" title="evennia.server.webserver"
>next</a> |</li>
<li class="right" >
<a href="evennia.server.throttle.html" title="evennia.server.throttle"
>previous</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-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.server.html" >evennia.server</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server.validators</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
Updated HTML docs.
2022-11-15 19:52:44 +00:00
&#169; Copyright 2022, The Evennia developer community.
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130.
2022-11-14 22:43:45 +01:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue Copy permalink