Current File : //usr/share/doc/python3-routes/html/glossary.html
<!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>Glossary — Routes 2.5.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/classic.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Porting Routes to a WSGI Web Framework" href="porting.html" />
<link rel="prev" title="Routes Changelog" href="changes.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="porting.html" title="Porting Routes to a WSGI Web Framework"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="changes.html" title="Routes Changelog"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Routes 2.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Glossary</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="glossary">
<span id="id1"></span><h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1>
<dl class="glossary">
<dt id="term-component">component<a class="headerlink" href="#term-component" title="Permalink to this term">¶</a></dt><dd><p>A part of a URL delimited by slashes. The URL “/help/about” contains
two components: “help” and “about”.</p>
</dd>
<dt id="term-generation">generation<a class="headerlink" href="#term-generation" title="Permalink to this term">¶</a></dt><dd><p>The act of creating a URL based on a route name and/or variable values.
This is the opposite of matching. Finding a route by name is called
<em>named generation</em>. Finding a route without specifying a name is
called <em>nameless generation</em>.</p>
</dd>
<dt id="term-mapper">mapper<a class="headerlink" href="#term-mapper" title="Permalink to this term">¶</a></dt><dd><p>A container for routes. There is normally one mapper per application,
although nested subapplications might have their own mappers. A
mapper knows how to match routes and generate them.</p>
</dd>
<dt id="term-matching">matching<a class="headerlink" href="#term-matching" title="Permalink to this term">¶</a></dt><dd><p>The act of matching a given URL against a list of routes, and
returning the routing variables. See the <em>route</em> entry for an example.</p>
</dd>
<dt id="term-minimization">minimization<a class="headerlink" href="#term-minimization" title="Permalink to this term">¶</a></dt><dd><p>A deprecated feature which allowed short URLs to match long paths.
Details are in the <code class="docutils literal notranslate"><span class="pre">Backward</span> <span class="pre">Compatibility</span></code> section in the manual.</p>
</dd>
<dt id="term-route">route<a class="headerlink" href="#term-route" title="Permalink to this term">¶</a></dt><dd><p>A rule mapping a URL pattern to a dict of routing variables. For
instance, if the pattern is “/{controller}/{action}” and the requested
URL is “/help/about”, the resulting dict would be:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">"controller"</span><span class="p">:</span> <span class="s2">"help"</span><span class="p">,</span> <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"about"</span><span class="p">}</span>
</pre></div>
</div>
<p>Routes does not know what these variables mean; it simply returns them
to the application. Pylons would look for a <code class="docutils literal notranslate"><span class="pre">controllers/help.py</span></code>
module containing a <code class="docutils literal notranslate"><span class="pre">HelpController</span></code> class, and call its <code class="docutils literal notranslate"><span class="pre">about</span></code>
method. Other frameworks may do something different.</p>
<p>A route may have a name, used to identify the route.</p>
</dd>
<dt id="term-route-path">route path<a class="headerlink" href="#term-route-path" title="Permalink to this term">¶</a></dt><dd><p>The URL pattern in a route.</p>
</dd>
<dt id="term-routing-variables">routing variables<a class="headerlink" href="#term-routing-variables" title="Permalink to this term">¶</a></dt><dd><p>A dict of key-value pairs returned by matching. Variables defined in
the route path are called <em>path variables</em>; their values will be taken
from the URL. Variables defined outside the route path are called
<em>default variables</em>; their values are not affected by the URL.</p>
<p>The WSGI.org environment key for routing variables is
“wsgiorg.routing_args”. This manual does not use that term because it
can be confused with function arguments.</p>
</dd>
</dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="changes.html"
title="previous chapter">Routes Changelog</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="porting.html"
title="next chapter">Porting Routes to a WSGI Web Framework</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/glossary.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></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="porting.html" title="Porting Routes to a WSGI Web Framework"
>next</a> |</li>
<li class="right" >
<a href="changes.html" title="Routes Changelog"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Routes 2.5.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Glossary</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2005-2022, Ben Bangert, Mike Orr, and numerous contributers.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>
Mini Shell