evennia/docs/latest/api/evennia.contrib.base_systems.ingame_python.tests.html
Evennia docbuilder action 24e4b7fdbd Updated HTML docs.
2023-12-20 22:47:51 +00:00

301 lines
No EOL
23 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.contrib.base_systems.ingame_python.tests &#8212; Evennia latest 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.contrib.base_systems.ingame_python.typeclasses" href="evennia.contrib.base_systems.ingame_python.typeclasses.html" />
<link rel="prev" title="evennia.contrib.base_systems.ingame_python.scripts" href="evennia.contrib.base_systems.ingame_python.scripts.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.contrib.base_systems.ingame_python.typeclasses.html" title="evennia.contrib.base_systems.ingame_python.typeclasses"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.scripts.html" title="evennia.contrib.base_systems.ingame_python.scripts"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.ingame_python.html" accesskey="U">evennia.contrib.base_systems.ingame_python</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.tests</a></li>
</ul>
</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.contrib.base_systems.ingame_python.scripts.html"
title="previous chapter">evennia.contrib.base_systems.ingame_python.scripts</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.contrib.base_systems.ingame_python.typeclasses.html"
title="next chapter">evennia.contrib.base_systems.ingame_python.typeclasses</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.contrib.base_systems.ingame_python.tests.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/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>Doc Versions</h3>
<ul>
<li><a href="evennia.contrib.base_systems.ingame_python.tests.html">latest (main branch)</a></li>
<li><a href="../../3.x/index.html">v3.0.0 branch (outdated)</a></li>
<li><a href="../../2.x/index.html">v2.0.0 branch (outdated)</a></li>
<li><a href="../../1.x/index.html">v1.0.0 branch (outdated)</a></li>
<li><a href="../../0.x/index.html">v0.9.5 branch (outdated)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.contrib.base_systems.ingame_python.tests">
<span id="evennia-contrib-base-systems-ingame-python-tests"></span><h1>evennia.contrib.base_systems.ingame_python.tests<a class="headerlink" href="#module-evennia.contrib.base_systems.ingame_python.tests" title="Permalink to this headline"></a></h1>
<p>Module containing the test cases for the in-game Python system.</p>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.tests.</code><code class="sig-name descname">TestEventHandler</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaTest" title="evennia.utils.test_resources.BaseEvenniaTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaTest</span></code></a></p>
<p>Test cases of the event handler to add, edit or delete events.</p>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.setUp">
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Create the event handler.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.tearDown">
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.tearDown" title="Permalink to this definition"></a></dt>
<dd><p>Stop the event handler.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_start">
<code class="sig-name descname">test_start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_start" title="Permalink to this definition"></a></dt>
<dd><p>Simply make sure the handler runs with proper initial values.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_add_validation">
<code class="sig-name descname">test_add_validation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_add_validation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_add_validation" title="Permalink to this definition"></a></dt>
<dd><p>Add a callback while needing validation.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit">
<code class="sig-name descname">test_edit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_edit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit" title="Permalink to this definition"></a></dt>
<dd><p>Test editing a callback.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit_validation">
<code class="sig-name descname">test_edit_validation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_edit_validation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_edit_validation" title="Permalink to this definition"></a></dt>
<dd><p>Edit a callback when validation isnt automatic.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_del">
<code class="sig-name descname">test_del</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_del"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_del" title="Permalink to this definition"></a></dt>
<dd><p>Try to delete a callback.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_accept">
<code class="sig-name descname">test_accept</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_accept" title="Permalink to this definition"></a></dt>
<dd><p>Accept an callback.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_call">
<code class="sig-name descname">test_call</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_call" title="Permalink to this definition"></a></dt>
<dd><p>Test to call amore complex callback.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_handler">
<code class="sig-name descname">test_handler</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestEventHandler.test_handler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestEventHandler.test_handler" title="Permalink to this definition"></a></dt>
<dd><p>Test the object handler.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.tests.</code><code class="sig-name descname">TestCmdCallback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaCommandTest" title="evennia.utils.test_resources.BaseEvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaCommandTest</span></code></a></p>
<p>Test the &#64;callback command.</p>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.setUp">
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Create the callback handler.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.tearDown">
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.tearDown" title="Permalink to this definition"></a></dt>
<dd><p>Stop the callback handler.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_list">
<code class="sig-name descname">test_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_list" title="Permalink to this definition"></a></dt>
<dd><p>Test listing callbacks with different rights.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_add">
<code class="sig-name descname">test_add</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_add" title="Permalink to this definition"></a></dt>
<dd><p>Test to add an callback.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_del">
<code class="sig-name descname">test_del</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_del"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_del" title="Permalink to this definition"></a></dt>
<dd><p>Add and remove an callback.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_lock">
<code class="sig-name descname">test_lock</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_lock"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_lock" title="Permalink to this definition"></a></dt>
<dd><p>Test the lock of multiple editing.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_accept">
<code class="sig-name descname">test_accept</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestCmdCallback.test_accept"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestCmdCallback.test_accept" title="Permalink to this definition"></a></dt>
<dd><p>Accept an callback.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks">
<em class="property">class </em><code class="sig-prename descclassname">evennia.contrib.base_systems.ingame_python.tests.</code><code class="sig-name descname">TestDefaultCallbacks</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">methodName</span><span class="o">=</span><span class="default_value">'runTest'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="evennia.utils.test_resources.html#evennia.utils.test_resources.BaseEvenniaCommandTest" title="evennia.utils.test_resources.BaseEvenniaCommandTest"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.utils.test_resources.BaseEvenniaCommandTest</span></code></a></p>
<p>Test the default callbacks.</p>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.setUp">
<code class="sig-name descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Create the callback handler.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.tearDown">
<code class="sig-name descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.tearDown" title="Permalink to this definition"></a></dt>
<dd><p>Stop the callback handler.</p>
</dd></dl>
<dl class="py method">
<dt id="evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.test_exit">
<code class="sig-name descname">test_exit</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/contrib/base_systems/ingame_python/tests.html#TestDefaultCallbacks.test_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.contrib.base_systems.ingame_python.tests.TestDefaultCallbacks.test_exit" title="Permalink to this definition"></a></dt>
<dd><p>Test the callbacks of an exit.</p>
</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.contrib.base_systems.ingame_python.typeclasses.html" title="evennia.contrib.base_systems.ingame_python.typeclasses"
>next</a> |</li>
<li class="right" >
<a href="evennia.contrib.base_systems.ingame_python.scripts.html" title="evennia.contrib.base_systems.ingame_python.scripts"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</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.contrib.html" >evennia.contrib</a> &#187;</li>
<li class="nav-item nav-item-5"><a href="evennia.contrib.base_systems.html" >evennia.contrib.base_systems</a> &#187;</li>
<li class="nav-item nav-item-6"><a href="evennia.contrib.base_systems.ingame_python.html" >evennia.contrib.base_systems.ingame_python</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.contrib.base_systems.ingame_python.tests</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>