<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Glossary — Routes 2.4.1 documentation</title> <link rel="stylesheet" href="_static/classic.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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> <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="<no title>" href="todo.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="porting.html" title="Porting Routes to a WSGI Web Framework" accesskey="N">next</a> |</li> <li class="right" > <a href="todo.html" title="<no title>" accesskey="P">previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">Routes 2.4.1 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="glossary"> <span id="id1"></span><h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1> <dl class="glossary docutils"> <dt id="term-component">component</dt> <dd>A part of a URL delimited by slashes. The URL “/help/about” contains two components: “help” and “about”.</dd> <dt id="term-generation">generation</dt> <dd>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>.</dd> <dt id="term-mapper">mapper</dt> <dd>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.</dd> <dt id="term-matching">matching</dt> <dd>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.</dd> <dt id="term-minimization">minimization</dt> <dd>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.</dd> <dt id="term-route">route</dt> <dd><p class="first">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 class="last">A route may have a name, used to identify the route.</p> </dd> <dt id="term-route-path">route path</dt> <dd>The URL pattern in a route.</dd> <dt id="term-routing-variables">routing variables</dt> <dd><p class="first">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 class="last">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> </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="todo.html" title="previous chapter"><no title></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>Quick search</h3> <div class="searchformwrapper"> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <script type="text/javascript">$('#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="porting.html" title="Porting Routes to a WSGI Web Framework" >next</a> |</li> <li class="right" > <a href="todo.html" title="<no title>" >previous</a> |</li> <li class="nav-item nav-item-0"><a href="index.html">Routes 2.4.1 documentation</a> »</li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2005-2017, Ben Bangert, Mike Orr, and numerous contributers. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3. </div> </body> </html>