Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-28 02:36:32 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/_modules/evennia/utils/validatorfuncs.html
Evennia docbuilder action fd31020c21 Updated HTML docs.
2022-11-15 20:29:38 +00:00

389 lines
No EOL
47 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>evennia.utils.validatorfuncs &#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" />
</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="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="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.utils.validatorfuncs</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><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="validatorfuncs.html">1.0-dev (develop branch)</a></li>
<ul>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for evennia.utils.validatorfuncs</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Contains all the validation functions.</span>
<span class="sd">All validation functions must have a checker (probably a session) and entry arg.</span>
<span class="sd">They can employ more paramters at your leisure.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">datetime</span> <span class="k">as</span> <span class="nn">_dt</span>
<span class="kn">import</span> <span class="nn">re</span> <span class="k">as</span> <span class="nn">_re</span>
<span class="kn">import</span> <span class="nn">pytz</span> <span class="k">as</span> <span class="nn">_pytz</span>
<span class="kn">from</span> <span class="nn">django.utils.translation</span> <span class="kn">import</span> <span class="n">gettext</span> <span class="k">as</span> <span class="n">_</span>
<span class="kn">from</span> <span class="nn">evennia.utils.ansi</span> <span class="kn">import</span> <span class="n">strip_ansi</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">string_partial_matching</span> <span class="k">as</span> <span class="n">_partial</span>
<span class="kn">from</span> <span class="nn">evennia.utils.utils</span> <span class="kn">import</span> <span class="n">validate_email_address</span>
<span class="n">_TZ_DICT</span> <span class="o">=</span> <span class="p">{</span><span class="nb">str</span><span class="p">(</span><span class="n">tz</span><span class="p">):</span> <span class="n">_pytz</span><span class="o">.</span><span class="n">timezone</span><span class="p">(</span><span class="n">tz</span><span class="p">)</span> <span class="k">for</span> <span class="n">tz</span> <span class="ow">in</span> <span class="n">_pytz</span><span class="o">.</span><span class="n">common_timezones</span><span class="p">}</span>
<div class="viewcode-block" id="text"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.text">[docs]</a><span class="k">def</span> <span class="nf">text</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Text&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;Input could not be converted to text (</span><span class="si">{err}</span><span class="s2">)&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">err</span><span class="o">=</span><span class="n">err</span><span class="p">))</span></div>
<div class="viewcode-block" id="color"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.color">[docs]</a><span class="k">def</span> <span class="nf">color</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Color&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> The color should be just a color character, so &#39;r&#39; if red color is desired.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;Nothing entered for a </span><span class="si">{option_key}</span><span class="s2">!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">))</span>
<span class="n">test_str</span> <span class="o">=</span> <span class="n">strip_ansi</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;|</span><span class="si">{</span><span class="n">entry</span><span class="si">}</span><span class="s2">|n&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">test_str</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;&#39;</span><span class="si">{entry}</span><span class="s2">&#39; is not a valid </span><span class="si">{option_key}</span><span class="s2">.&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">entry</span><span class="o">=</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">entry</span></div>
<div class="viewcode-block" id="datetime"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.datetime">[docs]</a><span class="k">def</span> <span class="nf">datetime</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Datetime&quot;</span><span class="p">,</span> <span class="n">account</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">from_tz</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Process a datetime string in standard forms while accounting for the</span>
<span class="sd"> inputer&#39;s timezone. Always returns a result in UTC.</span>
<span class="sd"> Args:</span>
<span class="sd"> entry (str): A date string from a user.</span>
<span class="sd"> option_key (str): Name to display this datetime as.</span>
<span class="sd"> account (AccountDB): The Account performing this lookup. Unless `from_tz` is provided,</span>
<span class="sd"> the account&#39;s timezone option will be used.</span>
<span class="sd"> from_tz (pytz.timezone): An instance of a pytz timezone object from the</span>
<span class="sd"> user. If not provided, tries to use the timezone option of `account`.</span>
<span class="sd"> If neither one is provided, defaults to UTC.</span>
<span class="sd"> Returns:</span>
<span class="sd"> datetime in UTC.</span>
<span class="sd"> Raises:</span>
<span class="sd"> ValueError: If encountering a malformed timezone, date string or other format error.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;No </span><span class="si">{option_key}</span><span class="s2"> entered!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">))</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">from_tz</span><span class="p">:</span>
<span class="n">from_tz</span> <span class="o">=</span> <span class="n">_pytz</span><span class="o">.</span><span class="n">UTC</span>
<span class="k">if</span> <span class="n">account</span><span class="p">:</span>
<span class="n">acct_tz</span> <span class="o">=</span> <span class="n">account</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;timezone&quot;</span><span class="p">,</span> <span class="s2">&quot;UTC&quot;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">from_tz</span> <span class="o">=</span> <span class="n">_pytz</span><span class="o">.</span><span class="n">timezone</span><span class="p">(</span><span class="n">acct_tz</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Timezone string &#39;</span><span class="si">{acct_tz}</span><span class="s2">&#39; is not a valid timezone (</span><span class="si">{err}</span><span class="s2">)&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">acct_tz</span><span class="o">=</span><span class="n">acct_tz</span><span class="p">,</span> <span class="n">err</span><span class="o">=</span><span class="n">err</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">from_tz</span> <span class="o">=</span> <span class="n">_pytz</span><span class="o">.</span><span class="n">UTC</span>
<span class="n">utc</span> <span class="o">=</span> <span class="n">_pytz</span><span class="o">.</span><span class="n">UTC</span>
<span class="n">now</span> <span class="o">=</span> <span class="n">_dt</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">utc</span><span class="p">)</span>
<span class="n">cur_year</span> <span class="o">=</span> <span class="n">now</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y&quot;</span><span class="p">)</span>
<span class="n">split_time</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">split_time</span><span class="p">)</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<span class="n">entry</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">cur_year</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">split_time</span><span class="p">)</span> <span class="o">==</span> <span class="mi">4</span><span class="p">:</span>
<span class="n">entry</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="n">split_time</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">{option_key}</span><span class="s2"> must be entered in a 24-hour format such as: </span><span class="si">{timeformat}</span><span class="s2">&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">,</span> <span class="n">timeformat</span><span class="o">=</span><span class="n">now</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%b </span><span class="si">%d</span><span class="s2"> %H:%M&quot;</span><span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">local</span> <span class="o">=</span> <span class="n">_dt</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="s2">&quot;%b </span><span class="si">%d</span><span class="s2"> %H:%M %Y&quot;</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">{option_key}</span><span class="s2"> must be entered in a 24-hour format such as: </span><span class="si">{timeformat}</span><span class="s2">&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">,</span> <span class="n">timeformat</span><span class="o">=</span><span class="n">now</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%b </span><span class="si">%d</span><span class="s2"> %H:%M&quot;</span><span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="n">local_tz</span> <span class="o">=</span> <span class="n">from_tz</span><span class="o">.</span><span class="n">localize</span><span class="p">(</span><span class="n">local</span><span class="p">)</span>
<span class="k">return</span> <span class="n">local_tz</span><span class="o">.</span><span class="n">astimezone</span><span class="p">(</span><span class="n">utc</span><span class="p">)</span></div>
<div class="viewcode-block" id="duration"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.duration">[docs]</a><span class="k">def</span> <span class="nf">duration</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Duration&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Take a string and derive a datetime timedelta from it.</span>
<span class="sd"> Args:</span>
<span class="sd"> entry (string): This is a string from user-input. The intended format is, for example:</span>
<span class="sd"> &quot;5d 2w 90s&quot; for &#39;five days, two weeks, and ninety seconds.&#39; Invalid sections are</span>
<span class="sd"> ignored.</span>
<span class="sd"> option_key (str): Name to display this query as.</span>
<span class="sd"> Returns:</span>
<span class="sd"> timedelta</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">time_string</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">)</span>
<span class="n">seconds</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">minutes</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">hours</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">days</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">weeks</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">for</span> <span class="n">interval</span> <span class="ow">in</span> <span class="n">time_string</span><span class="p">:</span>
<span class="k">if</span> <span class="n">_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[\d]+s$&quot;</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
<span class="n">seconds</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;s&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[\d]+m$&quot;</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
<span class="n">minutes</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;m&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[\d]+h$&quot;</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
<span class="n">hours</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;h&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[\d]+d$&quot;</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
<span class="n">days</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;d&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[\d]+w$&quot;</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
<span class="n">weeks</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;w&quot;</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">_re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;^[\d]+y$&quot;</span><span class="p">,</span> <span class="n">interval</span><span class="p">):</span>
<span class="n">days</span> <span class="o">+=</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">&quot;y&quot;</span><span class="p">))</span> <span class="o">*</span> <span class="mi">365</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Could not convert section &#39;</span><span class="si">{interval}</span><span class="s2">&#39; to a </span><span class="si">{option_key}</span><span class="s2">.&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">interval</span><span class="o">=</span><span class="n">interval</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">_dt</span><span class="o">.</span><span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">hours</span><span class="p">,</span> <span class="n">weeks</span><span class="p">)</span></div>
<div class="viewcode-block" id="future"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.future">[docs]</a><span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Future Datetime&quot;</span><span class="p">,</span> <span class="n">from_tz</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">time</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="p">,</span> <span class="n">from_tz</span><span class="o">=</span><span class="n">from_tz</span><span class="p">)</span>
<span class="k">if</span> <span class="n">time</span> <span class="o">&lt;</span> <span class="n">_dt</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">tzinfo</span><span class="o">=</span><span class="n">_dt</span><span class="o">.</span><span class="n">timezone</span><span class="o">.</span><span class="n">utc</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;That </span><span class="si">{option_key}</span><span class="s2"> is in the past! Must give a Future datetime!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">time</span></div>
<div class="viewcode-block" id="signed_integer"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.signed_integer">[docs]</a><span class="k">def</span> <span class="nf">signed_integer</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Signed Integer&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Must enter a whole number for </span><span class="si">{option_key}</span><span class="s2">!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">num</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Could not convert &#39;</span><span class="si">{entry}</span><span class="s2">&#39; to a whole &quot;</span> <span class="s2">&quot;number for </span><span class="si">{option_key}</span><span class="s2">!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">entry</span><span class="o">=</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">num</span></div>
<div class="viewcode-block" id="positive_integer"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.positive_integer">[docs]</a><span class="k">def</span> <span class="nf">positive_integer</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Positive Integer&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">num</span> <span class="o">=</span> <span class="n">signed_integer</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">num</span> <span class="o">&gt;=</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Must enter a whole number greater than 0 for </span><span class="si">{option_key}</span><span class="s2">!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">num</span></div>
<div class="viewcode-block" id="unsigned_integer"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.unsigned_integer">[docs]</a><span class="k">def</span> <span class="nf">unsigned_integer</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Unsigned Integer&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">num</span> <span class="o">=</span> <span class="n">signed_integer</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">num</span> <span class="o">&gt;=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">{option_key}</span><span class="s2"> must be a whole number greater than &quot;</span> <span class="s2">&quot;or equal to 0!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">num</span></div>
<div class="viewcode-block" id="boolean"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.boolean">[docs]</a><span class="k">def</span> <span class="nf">boolean</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;True/False&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Simplest check in computer logic, right? This will take user input to flick the switch on or off</span>
<span class="sd"> Args:</span>
<span class="sd"> entry (str): A value such as True, On, Enabled, Disabled, False, 0, or 1.</span>
<span class="sd"> option_key (str): What kind of Boolean we are setting. What Option is this for?</span>
<span class="sd"> Returns:</span>
<span class="sd"> Boolean</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">error</span> <span class="o">=</span> <span class="n">_</span><span class="p">(</span><span class="s2">&quot;Must enter a true/false input for </span><span class="si">{option_key}</span><span class="s2">. Accepts </span><span class="si">{alternatives}</span><span class="s2">.&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">,</span> <span class="n">alternatives</span><span class="o">=</span><span class="s2">&quot;0/1, True/False, On/Off, Yes/No, Enabled/Disabled&quot;</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
<span class="n">entry</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">if</span> <span class="n">entry</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;1&quot;</span><span class="p">,</span> <span class="s2">&quot;TRUE&quot;</span><span class="p">,</span> <span class="s2">&quot;ON&quot;</span><span class="p">,</span> <span class="s2">&quot;ENABLED&quot;</span><span class="p">,</span> <span class="s2">&quot;ENABLE&quot;</span><span class="p">,</span> <span class="s2">&quot;YES&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">if</span> <span class="n">entry</span> <span class="ow">in</span> <span class="p">(</span><span class="s2">&quot;0&quot;</span><span class="p">,</span> <span class="s2">&quot;FALSE&quot;</span><span class="p">,</span> <span class="s2">&quot;OFF&quot;</span><span class="p">,</span> <span class="s2">&quot;DISABLED&quot;</span><span class="p">,</span> <span class="s2">&quot;DISABLE&quot;</span><span class="p">,</span> <span class="s2">&quot;NO&quot;</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error</span><span class="p">)</span></div>
<div class="viewcode-block" id="timezone"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.timezone">[docs]</a><span class="k">def</span> <span class="nf">timezone</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Timezone&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Takes user input as string, and partial matches a Timezone.</span>
<span class="sd"> Args:</span>
<span class="sd"> entry (str): The name of the Timezone.</span>
<span class="sd"> option_key (str): What this Timezone is used for.</span>
<span class="sd"> Returns:</span>
<span class="sd"> A PYTZ timezone.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;No </span><span class="si">{option_key}</span><span class="s2"> entered!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">))</span>
<span class="n">found</span> <span class="o">=</span> <span class="n">_partial</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">_TZ_DICT</span><span class="o">.</span><span class="n">keys</span><span class="p">()),</span> <span class="n">entry</span><span class="p">,</span> <span class="n">ret_index</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">found</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;That matched: </span><span class="si">{matches}</span><span class="s2">. Please be more specific!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">matches</span><span class="o">=</span><span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">found</span><span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">found</span><span class="p">:</span>
<span class="k">return</span> <span class="n">_TZ_DICT</span><span class="p">[</span><span class="n">found</span><span class="p">[</span><span class="mi">0</span><span class="p">]]</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Could not find timezone &#39;</span><span class="si">{entry}</span><span class="s2">&#39; for </span><span class="si">{option_key}</span><span class="s2">!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">entry</span><span class="o">=</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span>
<span class="p">)</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="email"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.email">[docs]</a><span class="k">def</span> <span class="nf">email</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;Email Address&quot;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;Email address field empty!&quot;</span><span class="p">))</span>
<span class="n">valid</span> <span class="o">=</span> <span class="n">validate_email_address</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">valid</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;That isn&#39;t a valid </span><span class="si">{option_key}</span><span class="s2">!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">))</span>
<span class="k">return</span> <span class="n">entry</span></div>
<div class="viewcode-block" id="lock"><a class="viewcode-back" href="../../../api/evennia.utils.validatorfuncs.html#evennia.utils.validatorfuncs.lock">[docs]</a><span class="k">def</span> <span class="nf">lock</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">option_key</span><span class="o">=</span><span class="s2">&quot;locks&quot;</span><span class="p">,</span> <span class="n">access_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">entry</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;No </span><span class="si">{option_key}</span><span class="s2"> entered to set!&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">option_key</span><span class="o">=</span><span class="n">option_key</span><span class="p">))</span>
<span class="k">for</span> <span class="n">locksetting</span> <span class="ow">in</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;;&quot;</span><span class="p">):</span>
<span class="n">access_type</span><span class="p">,</span> <span class="n">lockfunc</span> <span class="o">=</span> <span class="n">locksetting</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;:&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">access_type</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;Must enter an access type!&quot;</span><span class="p">))</span>
<span class="k">if</span> <span class="n">access_options</span><span class="p">:</span>
<span class="k">if</span> <span class="n">access_type</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">access_options</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="n">_</span><span class="p">(</span><span class="s2">&quot;Access type must be one of: </span><span class="si">{alternatives}</span><span class="s2">&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">alternatives</span><span class="o">=</span><span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">access_options</span><span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">lockfunc</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">_</span><span class="p">(</span><span class="s2">&quot;Lock func not entered.&quot;</span><span class="p">))</span>
<span class="k">return</span> <span class="n">entry</span></div>
</pre></div>
</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="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="../../index.html" >Module code</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../../evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.utils.validatorfuncs</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2022, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink