mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 16:26:30 +01:00
Updated HTML docs
This commit is contained in:
parent
8357af22ee
commit
87191ef0c4
599 changed files with 5455 additions and 5223 deletions
|
|
@ -42,20 +42,20 @@
|
|||
<span></span><span class="c1"># Note that we import as `DjangoRequestFactory` and `DjangoClient` in order</span>
|
||||
<span class="c1"># to make it harder for the user to import the wrong thing without realizing.</span>
|
||||
<span class="kn">import</span> <span class="nn">io</span>
|
||||
<span class="kn">from</span> <span class="nn">importlib</span> <span class="k">import</span> <span class="n">import_module</span>
|
||||
<span class="kn">from</span> <span class="nn">importlib</span> <span class="kn">import</span> <span class="n">import_module</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="k">import</span> <span class="n">settings</span>
|
||||
<span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="k">import</span> <span class="n">ImproperlyConfigured</span>
|
||||
<span class="kn">from</span> <span class="nn">django.core.handlers.wsgi</span> <span class="k">import</span> <span class="n">WSGIHandler</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test</span> <span class="k">import</span> <span class="n">override_settings</span><span class="p">,</span> <span class="n">testcases</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test.client</span> <span class="k">import</span> <span class="n">Client</span> <span class="k">as</span> <span class="n">DjangoClient</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test.client</span> <span class="k">import</span> <span class="n">ClientHandler</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test.client</span> <span class="k">import</span> <span class="n">RequestFactory</span> <span class="k">as</span> <span class="n">DjangoRequestFactory</span>
|
||||
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="k">import</span> <span class="n">force_bytes</span>
|
||||
<span class="kn">from</span> <span class="nn">django.utils.http</span> <span class="k">import</span> <span class="n">urlencode</span>
|
||||
<span class="kn">from</span> <span class="nn">django.conf</span> <span class="kn">import</span> <span class="n">settings</span>
|
||||
<span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="kn">import</span> <span class="n">ImproperlyConfigured</span>
|
||||
<span class="kn">from</span> <span class="nn">django.core.handlers.wsgi</span> <span class="kn">import</span> <span class="n">WSGIHandler</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test</span> <span class="kn">import</span> <span class="n">override_settings</span><span class="p">,</span> <span class="n">testcases</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test.client</span> <span class="kn">import</span> <span class="n">Client</span> <span class="k">as</span> <span class="n">DjangoClient</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test.client</span> <span class="kn">import</span> <span class="n">ClientHandler</span>
|
||||
<span class="kn">from</span> <span class="nn">django.test.client</span> <span class="kn">import</span> <span class="n">RequestFactory</span> <span class="k">as</span> <span class="n">DjangoRequestFactory</span>
|
||||
<span class="kn">from</span> <span class="nn">django.utils.encoding</span> <span class="kn">import</span> <span class="n">force_bytes</span>
|
||||
<span class="kn">from</span> <span class="nn">django.utils.http</span> <span class="kn">import</span> <span class="n">urlencode</span>
|
||||
|
||||
<span class="kn">from</span> <span class="nn">rest_framework.compat</span> <span class="k">import</span> <span class="n">coreapi</span><span class="p">,</span> <span class="n">requests</span>
|
||||
<span class="kn">from</span> <span class="nn">rest_framework.settings</span> <span class="k">import</span> <span class="n">api_settings</span>
|
||||
<span class="kn">from</span> <span class="nn">rest_framework.compat</span> <span class="kn">import</span> <span class="n">coreapi</span><span class="p">,</span> <span class="n">requests</span>
|
||||
<span class="kn">from</span> <span class="nn">rest_framework.settings</span> <span class="kn">import</span> <span class="n">api_settings</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">force_authenticate</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">token</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
||||
|
|
@ -69,7 +69,7 @@
|
|||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">getheaders</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">MockOriginalResponse</span><span class="p">:</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">headers</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">headers</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">msg</span> <span class="o">=</span> <span class="n">HeaderDict</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">closed</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
|
||||
|
|
@ -84,7 +84,7 @@
|
|||
<span class="sd"> A transport adapter for `requests`, that makes requests via the</span>
|
||||
<span class="sd"> Django WSGI app, rather than making actual HTTP requests over the network.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">WSGIHandler</span><span class="p">()</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">factory</span> <span class="o">=</span> <span class="n">DjangoRequestFactory</span><span class="p">()</span>
|
||||
|
||||
|
|
@ -144,7 +144,7 @@
|
|||
<span class="k">pass</span>
|
||||
|
||||
<span class="k">class</span> <span class="nc">RequestsClient</span><span class="p">(</span><span class="n">requests</span><span class="o">.</span><span class="n">Session</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
<span class="n">adapter</span> <span class="o">=</span> <span class="n">DjangoTestAdapter</span><span class="p">()</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">mount</span><span class="p">(</span><span class="s1">'http://'</span><span class="p">,</span> <span class="n">adapter</span><span class="p">)</span>
|
||||
|
|
@ -162,7 +162,7 @@
|
|||
|
||||
<span class="k">if</span> <span class="n">coreapi</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">class</span> <span class="nc">CoreAPIClient</span><span class="p">(</span><span class="n">coreapi</span><span class="o">.</span><span class="n">Client</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_session</span> <span class="o">=</span> <span class="n">RequestsClient</span><span class="p">()</span>
|
||||
<span class="n">kwargs</span><span class="p">[</span><span class="s1">'transports'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="n">coreapi</span><span class="o">.</span><span class="n">transports</span><span class="o">.</span><span class="n">HTTPTransport</span><span class="p">(</span><span class="n">session</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">session</span><span class="p">)]</span>
|
||||
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
|
@ -180,7 +180,7 @@
|
|||
<span class="n">renderer_classes_list</span> <span class="o">=</span> <span class="n">api_settings</span><span class="o">.</span><span class="n">TEST_REQUEST_RENDERER_CLASSES</span>
|
||||
<span class="n">default_format</span> <span class="o">=</span> <span class="n">api_settings</span><span class="o">.</span><span class="n">TEST_REQUEST_DEFAULT_FORMAT</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enforce_csrf_checks</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">defaults</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enforce_csrf_checks</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">defaults</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">enforce_csrf_checks</span> <span class="o">=</span> <span class="n">enforce_csrf_checks</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">renderer_classes</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
<span class="k">for</span> <span class="bp">cls</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">renderer_classes_list</span><span class="p">:</span>
|
||||
|
|
@ -284,7 +284,7 @@
|
|||
<span class="sd"> on the outgoing requests.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_force_user</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_force_token</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
||||
|
|
@ -297,7 +297,7 @@
|
|||
|
||||
|
||||
<span class="k">class</span> <span class="nc">APIClient</span><span class="p">(</span><span class="n">APIRequestFactory</span><span class="p">,</span> <span class="n">DjangoClient</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enforce_csrf_checks</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">defaults</span><span class="p">):</span>
|
||||
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">enforce_csrf_checks</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">defaults</span><span class="p">):</span>
|
||||
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">**</span><span class="n">defaults</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handler</span> <span class="o">=</span> <span class="n">ForceAuthClientHandler</span><span class="p">(</span><span class="n">enforce_csrf_checks</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_credentials</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue