mirror of
https://github.com/evennia/evennia.git
synced 2026-03-20 14:56:30 +01:00
332 lines
No EOL
16 KiB
HTML
332 lines
No EOL
16 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>evennia.web.utils package — Evennia 1.0-dev documentation</title>
|
||
|
||
|
||
|
||
|
||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="index" title="Index"
|
||
href="../genindex.html"/>
|
||
<link rel="search" title="Search" href="../search.html"/>
|
||
<link rel="top" title="Evennia 1.0-dev documentation" href="../index.html"/>
|
||
|
||
|
||
<script src="../_static/js/modernizr.min.js"></script>
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav" role="document">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search">
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home"> Evennia
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
|
||
<!-- Local TOC -->
|
||
<div class="local-toc"><ul>
|
||
<li><a class="reference internal" href="#">evennia.web.utils package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.utils.backends">evennia.web.utils.backends module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.utils.general_context">evennia.web.utils.general_context module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.utils.middleware">evennia.web.utils.middleware module</a></li>
|
||
<li><a class="reference internal" href="#module-evennia.web.utils.tests">evennia.web.utils.tests module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">Evennia</a>
|
||
|
||
</nav>
|
||
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="../index.html">Docs</a> »</li>
|
||
|
||
<li>evennia.web.utils package</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
<a href="../_sources/api/evennia.web.utils.rst.txt" rel="nofollow"> View page source</a>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="module-evennia.web.utils">
|
||
<span id="evennia-web-utils-package"></span><h1>evennia.web.utils package<a class="headerlink" href="#module-evennia.web.utils" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="submodules">
|
||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
<div class="section" id="module-evennia.web.utils.backends">
|
||
<span id="evennia-web-utils-backends-module"></span><h2>evennia.web.utils.backends module<a class="headerlink" href="#module-evennia.web.utils.backends" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="evennia.web.utils.backends.CaseInsensitiveModelBackend">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.backends.</code><code class="sig-name descname">CaseInsensitiveModelBackend</code><a class="reference internal" href="../_modules/evennia/web/utils/backends.html#CaseInsensitiveModelBackend"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.backends.CaseInsensitiveModelBackend" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.backends.ModelBackend</span></code></p>
|
||
<p>By default ModelBackend does case _sensitive_ username
|
||
authentication, which isn’t what is generally expected. This
|
||
backend supports case insensitive username authentication.</p>
|
||
<dl class="method">
|
||
<dt id="evennia.web.utils.backends.CaseInsensitiveModelBackend.authenticate">
|
||
<code class="sig-name descname">authenticate</code><span class="sig-paren">(</span><em class="sig-param">request</em>, <em class="sig-param">username=None</em>, <em class="sig-param">password=None</em>, <em class="sig-param">autologin=None</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/backends.html#CaseInsensitiveModelBackend.authenticate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.backends.CaseInsensitiveModelBackend.authenticate" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Custom authenticate with bypass for auto-logins</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>request</strong> (<em>Request</em>) – Request object.</p></li>
|
||
<li><p><strong>username</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of user to authenticate.</p></li>
|
||
<li><p><strong>password</strong> (<em>str</em><em>, </em><em>optional</em>) – Password of user</p></li>
|
||
<li><p><strong>autologin</strong> (<em>Account</em><em>, </em><em>optional</em>) – If given, assume this is
|
||
an already authenticated account and bypass authentication.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.utils.general_context">
|
||
<span id="evennia-web-utils-general-context-module"></span><h2>evennia.web.utils.general_context module<a class="headerlink" href="#module-evennia.web.utils.general_context" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="function">
|
||
<dt id="evennia.web.utils.general_context.general_context">
|
||
<code class="sig-prename descclassname">evennia.web.utils.general_context.</code><code class="sig-name descname">general_context</code><span class="sig-paren">(</span><em class="sig-param">request</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/general_context.html#general_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.general_context.general_context" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns common Evennia-related context stuff, which
|
||
is automatically added to context of all views.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="evennia.web.utils.general_context.set_game_name_and_slogan">
|
||
<code class="sig-prename descclassname">evennia.web.utils.general_context.</code><code class="sig-name descname">set_game_name_and_slogan</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/general_context.html#set_game_name_and_slogan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.general_context.set_game_name_and_slogan" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets global variables GAME_NAME and GAME_SLOGAN which are used by
|
||
general_context.</p>
|
||
<p class="rubric">Notes</p>
|
||
<p>This function is used for unit testing the values of the globals.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="evennia.web.utils.general_context.set_webclient_settings">
|
||
<code class="sig-prename descclassname">evennia.web.utils.general_context.</code><code class="sig-name descname">set_webclient_settings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/general_context.html#set_webclient_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.general_context.set_webclient_settings" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>As with set_game_name_and_slogan above, this sets global variables pertaining
|
||
to webclient settings.</p>
|
||
<p class="rubric">Notes</p>
|
||
<p>Used for unit testing.</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.utils.middleware">
|
||
<span id="evennia-web-utils-middleware-module"></span><h2>evennia.web.utils.middleware module<a class="headerlink" href="#module-evennia.web.utils.middleware" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.middleware.</code><code class="sig-name descname">SharedLoginMiddleware</code><span class="sig-paren">(</span><em class="sig-param">get_response</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware" 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>Handle the shared login between website and webclient.</p>
|
||
<dl class="method">
|
||
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware.__init__">
|
||
<code class="sig-name descname">__init__</code><span class="sig-paren">(</span><em class="sig-param">get_response</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware.__init__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware.__init__" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login">
|
||
<em class="property">classmethod </em><code class="sig-name descname">make_shared_login</code><span class="sig-paren">(</span><em class="sig-param">request</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/middleware.html#SharedLoginMiddleware.make_shared_login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.middleware.SharedLoginMiddleware.make_shared_login" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-evennia.web.utils.tests">
|
||
<span id="evennia-web-utils-tests-module"></span><h2>evennia.web.utils.tests module<a class="headerlink" href="#module-evennia.web.utils.tests" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="evennia.web.utils.tests.TestGeneralContext">
|
||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.utils.tests.</code><code class="sig-name descname">TestGeneralContext</code><span class="sig-paren">(</span><em class="sig-param">methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.test.testcases.TestCase</span></code></p>
|
||
<dl class="attribute">
|
||
<dt id="evennia.web.utils.tests.TestGeneralContext.maxDiff">
|
||
<code class="sig-name descname">maxDiff</code><em class="property"> = None</em><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.maxDiff" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.utils.tests.TestGeneralContext.test_general_context">
|
||
<code class="sig-name descname">test_general_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext.test_general_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.test_general_context" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.utils.tests.TestGeneralContext.test_set_game_name_and_slogan">
|
||
<code class="sig-name descname">test_set_game_name_and_slogan</code><span class="sig-paren">(</span><em class="sig-param">mock_get_version</em>, <em class="sig-param">mock_settings</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext.test_set_game_name_and_slogan"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.test_set_game_name_and_slogan" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="evennia.web.utils.tests.TestGeneralContext.test_set_webclient_settings">
|
||
<code class="sig-name descname">test_set_webclient_settings</code><span class="sig-paren">(</span><em class="sig-param">mock_settings</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/utils/tests.html#TestGeneralContext.test_set_webclient_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.utils.tests.TestGeneralContext.test_set_webclient_settings" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2020, The Evennia developer community.
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> and ❤️ using a custom <a href="https://github.com/LinxiFan/Sphinx-theme">theme</a> based on <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
var DOCUMENTATION_OPTIONS = {
|
||
URL_ROOT:'../',
|
||
VERSION:'1.0-dev',
|
||
COLLAPSE_INDEX:false,
|
||
FILE_SUFFIX:'.html',
|
||
HAS_SOURCE: true,
|
||
SOURCELINK_SUFFIX: '.txt'
|
||
};
|
||
</script>
|
||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.StickyNav.enable();
|
||
});
|
||
</script>
|
||
|
||
|
||
</body>
|
||
</html> |