mirror of
https://github.com/evennia/evennia.git
synced 2026-03-26 17:56:32 +01:00
199 lines
No EOL
16 KiB
HTML
199 lines
No EOL
16 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>django.urls.conf — Evennia latest documentation</title>
|
|
<link rel="stylesheet" href="../../../_static/nature.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../../../_static/nature.css?v=245aff17" />
|
|
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
|
<script src="../../../_static/documentation_options.js?v=c6e86fd7"></script>
|
|
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<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 latest</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" accesskey="U">Module code</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">django.urls.conf</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
|
|
<div class="documentwrapper">
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper">
|
|
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</script><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>
|
|
</div>
|
|
</div>
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<h1>Source code for django.urls.conf</h1><div class="highlight"><pre>
|
|
<span></span><span class="sd">"""Functions for use in URLsconfs."""</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">functools</span><span class="w"> </span><span class="kn">import</span> <span class="n">partial</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">importlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">import_module</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.core.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">ImproperlyConfigured</span>
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">.resolvers</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
|
<span class="n">LocalePrefixPattern</span><span class="p">,</span>
|
|
<span class="n">RegexPattern</span><span class="p">,</span>
|
|
<span class="n">RoutePattern</span><span class="p">,</span>
|
|
<span class="n">URLPattern</span><span class="p">,</span>
|
|
<span class="n">URLResolver</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
|
|
|
|
<div class="viewcode-block" id="include">
|
|
<a class="viewcode-back" href="../../../api/evennia.web.website.urls.html#evennia.web.admin.urls.include">[docs]</a>
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">include</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="n">namespace</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="n">app_name</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">):</span>
|
|
<span class="c1"># Callable returning a namespace hint.</span>
|
|
<span class="k">try</span><span class="p">:</span>
|
|
<span class="n">urlconf_module</span><span class="p">,</span> <span class="n">app_name</span> <span class="o">=</span> <span class="n">arg</span>
|
|
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
|
<span class="k">if</span> <span class="n">namespace</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">ImproperlyConfigured</span><span class="p">(</span>
|
|
<span class="s2">"Cannot override the namespace for a dynamic module that "</span>
|
|
<span class="s2">"provides a namespace."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">raise</span> <span class="n">ImproperlyConfigured</span><span class="p">(</span>
|
|
<span class="s2">"Passing a </span><span class="si">%d</span><span class="s2">-tuple to include() is not supported. Pass a "</span>
|
|
<span class="s2">"2-tuple containing the list of patterns and app_name, and "</span>
|
|
<span class="s2">"provide the namespace argument to include() instead."</span> <span class="o">%</span> <span class="nb">len</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
|
|
<span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="c1"># No namespace hint - use manually provided namespace.</span>
|
|
<span class="n">urlconf_module</span> <span class="o">=</span> <span class="n">arg</span>
|
|
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">urlconf_module</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<span class="n">urlconf_module</span> <span class="o">=</span> <span class="n">import_module</span><span class="p">(</span><span class="n">urlconf_module</span><span class="p">)</span>
|
|
<span class="n">patterns</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">urlconf_module</span><span class="p">,</span> <span class="s2">"urlpatterns"</span><span class="p">,</span> <span class="n">urlconf_module</span><span class="p">)</span>
|
|
<span class="n">app_name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">urlconf_module</span><span class="p">,</span> <span class="s2">"app_name"</span><span class="p">,</span> <span class="n">app_name</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">namespace</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">app_name</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">ImproperlyConfigured</span><span class="p">(</span>
|
|
<span class="s2">"Specifying a namespace in include() without providing an app_name "</span>
|
|
<span class="s2">"is not supported. Set the app_name attribute in the included "</span>
|
|
<span class="s2">"module, or pass a 2-tuple containing the list of patterns and "</span>
|
|
<span class="s2">"app_name instead."</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="n">namespace</span> <span class="o">=</span> <span class="n">namespace</span> <span class="ow">or</span> <span class="n">app_name</span>
|
|
<span class="c1"># Make sure the patterns can be iterated through (without this, some</span>
|
|
<span class="c1"># testcases will break).</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">patterns</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
|
|
<span class="k">for</span> <span class="n">url_pattern</span> <span class="ow">in</span> <span class="n">patterns</span><span class="p">:</span>
|
|
<span class="n">pattern</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">url_pattern</span><span class="p">,</span> <span class="s2">"pattern"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">LocalePrefixPattern</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="n">ImproperlyConfigured</span><span class="p">(</span>
|
|
<span class="s2">"Using i18n_patterns in an included URLconf is not allowed."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">return</span> <span class="p">(</span><span class="n">urlconf_module</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span> <span class="n">namespace</span><span class="p">)</span></div>
|
|
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="nf">_path</span><span class="p">(</span><span class="n">route</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Pattern</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">django.views</span><span class="w"> </span><span class="kn">import</span> <span class="n">View</span>
|
|
|
|
<span class="k">if</span> <span class="n">kwargs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">kwargs</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
|
|
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"kwargs argument must be a dict, but got </span><span class="si">{</span><span class="n">kwargs</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">)):</span>
|
|
<span class="c1"># For include(...) processing.</span>
|
|
<span class="n">pattern</span> <span class="o">=</span> <span class="n">Pattern</span><span class="p">(</span><span class="n">route</span><span class="p">,</span> <span class="n">is_endpoint</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
|
<span class="n">urlconf_module</span><span class="p">,</span> <span class="n">app_name</span><span class="p">,</span> <span class="n">namespace</span> <span class="o">=</span> <span class="n">view</span>
|
|
<span class="k">return</span> <span class="n">URLResolver</span><span class="p">(</span>
|
|
<span class="n">pattern</span><span class="p">,</span>
|
|
<span class="n">urlconf_module</span><span class="p">,</span>
|
|
<span class="n">kwargs</span><span class="p">,</span>
|
|
<span class="n">app_name</span><span class="o">=</span><span class="n">app_name</span><span class="p">,</span>
|
|
<span class="n">namespace</span><span class="o">=</span><span class="n">namespace</span><span class="p">,</span>
|
|
<span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">callable</span><span class="p">(</span><span class="n">view</span><span class="p">):</span>
|
|
<span class="n">pattern</span> <span class="o">=</span> <span class="n">Pattern</span><span class="p">(</span><span class="n">route</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> <span class="n">is_endpoint</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">URLPattern</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">view</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
|
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">view</span><span class="p">,</span> <span class="n">View</span><span class="p">):</span>
|
|
<span class="n">view_cls_name</span> <span class="o">=</span> <span class="n">view</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
|
|
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
|
|
<span class="sa">f</span><span class="s2">"view must be a callable, pass </span><span class="si">{</span><span class="n">view_cls_name</span><span class="si">}</span><span class="s2">.as_view(), not "</span>
|
|
<span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">view_cls_name</span><span class="si">}</span><span class="s2">()."</span>
|
|
<span class="p">)</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
|
|
<span class="s2">"view must be a callable or a list/tuple in the case of include()."</span>
|
|
<span class="p">)</span>
|
|
|
|
|
|
<span class="n">path</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">_path</span><span class="p">,</span> <span class="n">Pattern</span><span class="o">=</span><span class="n">RoutePattern</span><span class="p">)</span>
|
|
<span class="n">re_path</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">_path</span><span class="p">,</span> <span class="n">Pattern</span><span class="o">=</span><span class="n">RegexPattern</span><span class="p">)</span>
|
|
</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 latest</a> »</li>
|
|
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">django.urls.conf</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |