<!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>Routes Documentation — 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="Introduction" href="introduction.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="introduction.html" title="Introduction"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">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="routes-documentation">
<h1>Routes Documentation<a class="headerlink" href="#routes-documentation" title="Permalink to this headline">¶</a></h1>
<p>Routes is a Python re-implementation of the Rails routes system for mapping URLs to application actions, and conversely to generate URLs. Routes makes it easy to create pretty and concise URLs that are RESTful with little effort.</p>
<p>Routes allows conditional matching based on domain, cookies, HTTP method, or a custom function. Sub-domain support is built in. Routes comes with an extensive unit test suite.</p>
<p>Current features:</p>
<ul class="simple">
<li>Sophisticated route lookup and URL generation</li>
<li>Named routes</li>
<li>Redirect routes</li>
<li>Wildcard paths before and after static parts</li>
<li>Sub-domain support built-in</li>
<li>Conditional matching based on domain, cookies, HTTP method (RESTful), and more</li>
<li>Easily extensible utilizing custom condition functions and route generation
functions</li>
<li>Extensive unit tests</li>
</ul>
<div class="section" id="installing">
<h2>Installing<a class="headerlink" href="#installing" title="Permalink to this headline">¶</a></h2>
<p>Routes can be easily installed with pip or easy_install:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ easy_install routes
</pre></div>
</div>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Setup a mapper</span>
<span class="kn">from</span> <span class="nn">routes</span> <span class="kn">import</span> <span class="n">Mapper</span>
<span class="nb">map</span> <span class="o">=</span> <span class="n">Mapper</span><span class="p">()</span>
<span class="nb">map</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s2">"/error/{action}/{id}"</span><span class="p">,</span> <span class="n">controller</span><span class="o">=</span><span class="s2">"error"</span><span class="p">)</span>
<span class="nb">map</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s2">"home"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">,</span> <span class="n">controller</span><span class="o">=</span><span class="s2">"main"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"index"</span><span class="p">)</span>
<span class="c1"># Match a URL, returns a dict or None if no match</span>
<span class="n">result</span> <span class="o">=</span> <span class="nb">map</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s1">'/error/myapp/4'</span><span class="p">)</span>
<span class="c1"># result == {'controller': 'error', 'action': 'myapp', 'id': '4'}</span>
</pre></div>
</div>
</div>
<div class="section" id="source">
<h2>Source<a class="headerlink" href="#source" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference external" href="http://github.com/bbangert/routes">routes source can be found on GitHub</a>.</p>
</div>
<div class="section" id="bugs-support">
<h2>Bugs/Support<a class="headerlink" href="#bugs-support" title="Permalink to this headline">¶</a></h2>
<p>Bug’s can be reported on the <a class="reference external" href="https://github.com/bbangert/routes/issues">github issue tracker</a>. Note that routes is in maintenance
mode so bug reports are unlikely to be worked on, pull requests will be applied
if submitted with tests.</p>
</div>
<div class="section" id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="setting_up.html">Setting up routes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#magic-path-info">Magic path_info</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#conditions">Conditions</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#wildcard-routes">Wildcard routes</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#format-extensions">Format extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#submappers">Submappers</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#submapper-helpers">Submapper helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="setting_up.html#adding-routes-from-a-nested-application">Adding routes from a nested application</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="generating.html">Generation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="generating.html#generating-routes-based-on-the-current-url">Generating routes based on the current URL</a></li>
<li class="toctree-l2"><a class="reference internal" href="generating.html#generation-only-routes-aka-static-routes">Generation-only routes (aka. static routes)</a></li>
<li class="toctree-l2"><a class="reference internal" href="generating.html#filter-functions">Filter functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="generating.html#generating-urls-with-subdomains">Generating URLs with subdomains</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="restful.html">RESTful services</a><ul>
<li class="toctree-l2"><a class="reference internal" href="restful.html#resource-options">Resource options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="uni_redirect_rest.html">Unicode, Redirects, and More</a><ul>
<li class="toctree-l2"><a class="reference internal" href="uni_redirect_rest.html#unicode">Unicode</a></li>
<li class="toctree-l2"><a class="reference internal" href="uni_redirect_rest.html#redirect-routes">Redirect Routes</a></li>
<li class="toctree-l2"><a class="reference internal" href="uni_redirect_rest.html#printing">Printing</a></li>
<li class="toctree-l2"><a class="reference internal" href="uni_redirect_rest.html#introspection">Introspection</a></li>
<li class="toctree-l2"><a class="reference internal" href="uni_redirect_rest.html#other">Other</a></li>
<li class="toctree-l2"><a class="reference internal" href="uni_redirect_rest.html#backward-compatibility">Backward compatibility</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Routes Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-2-4-0-january-1-2017">Release 2.4.0 (January 1, 2017)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-2-3-1-march-30-2016">Release 2.3.1 (March 30, 2016)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-2-3-march-28-2016">Release 2.3 (March 28, 2016)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-2-2-july-21-2015">Release 2.2 (July 21, 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-2-1-january-17-2015">Release 2.1 (January 17, 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-2-0-november-17-2013">Release 2.0 (November 17, 2013)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-13-march-12-2012">Release 1.13 (March 12, 2012)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-12-3-june-5-2010">Release 1.12.3 (June 5, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-12-2-may-5-2010">Release 1.12.2 (May 5, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-12-1-march-11-2010">Release 1.12.1 (March 11, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-12-february-28-2010">Release 1.12 (February 28, 2010)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-11-september-28-2009">Release 1.11 (September 28, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-10-3-february-8-2009">Release 1.10.3 (February 8, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-10-2-january-11-2009">Release 1.10.2 (January 11, 2009)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-10-1-september-27-2008">Release 1.10.1 (September 27, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-10-september-24-2008">Release 1.10 (September 24, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-9-2-july-8-2008">Release 1.9.2 (July 8, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-9-1-june-28-2008">Release 1.9.1 (June 28, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-9-june-12-2008">Release 1.9 (June 12, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-8-march-28-2008">Release 1.8 (March 28, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-7-3-may-28th-2008">Release 1.7.3 (May 28th, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-7-2-feb-27th-2008">Release 1.7.2 (Feb. 27th, 2008)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-7-1-nov-16th-2007">Release 1.7.1 (Nov. 16th, 2007)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-7-june-8th-2007">Release 1.7 (June 8th, 2007)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-6-3-april-10th-2007">Release 1.6.3 (April 10th, 2007)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-6-2-jan-5-2007">Release 1.6.2 (Jan. 5, 2007)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-6-1-dec-29-2006">Release 1.6.1 (Dec. 29, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-6-dec-14th-2006">Release 1.6 (Dec. 14th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-5-2-oct-16th-2006">Release 1.5.2 (Oct. 16th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-5-1-oct-4th-2006">Release 1.5.1 (Oct. 4th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-5-sept-19th-2006">Release 1.5 (Sept. 19th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-4-1-sept-6th-2006">Release 1.4.1 (Sept. 6th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-4-july-21-2006">Release 1.4 (July 21, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-3-2-april-30th-2006">Release 1.3.2 (April 30th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-3-1-april-4th-2006">Release 1.3.1 (April 4th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-3-feb-25th-2006">Release 1.3 (Feb. 25th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-2-feb-17th-2006">Release 1.2 (Feb. 17th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-1-jan-13th-2006">Release 1.1 (Jan. 13th, 2006)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-2-dec-30th-2005">Release 1.0.2 (Dec. 30th, 2005)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-1-dec-18th-2005">Release 1.0.1 (Dec. 18th, 2005)</a></li>
<li class="toctree-l2"><a class="reference internal" href="changes.html#release-1-0-nov-21st-2005">Release 1.0 (Nov. 21st, 2005)</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="porting.html">Porting Routes to a WSGI Web Framework</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="glossary.html#glossary"><span class="std std-ref">Glossary</span></a></li>
</ul>
<div class="section" id="module-listing">
<h3>Module Listing<a class="headerlink" href="#module-listing" title="Permalink to this headline">¶</a></h3>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/index.html">Routes Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/routes.html"><code class="docutils literal notranslate"><span class="pre">routes</span></code> – Routes Common Classes and Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/mapper.html"><code class="docutils literal notranslate"><span class="pre">routes.mapper</span></code> – Mapper and Sub-Mapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/route.html"><code class="docutils literal notranslate"><span class="pre">routes.route</span></code> – Route</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/middleware.html"><code class="docutils literal notranslate"><span class="pre">routes.middleware</span></code> – Routes WSGI Middleware</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/util.html"><code class="docutils literal notranslate"><span class="pre">routes.util</span></code> – URL Generator and utility functions</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Routes Documentation</a><ul>
<li><a class="reference internal" href="#installing">Installing</a></li>
<li><a class="reference internal" href="#example">Example</a></li>
<li><a class="reference internal" href="#source">Source</a></li>
<li><a class="reference internal" href="#bugs-support">Bugs/Support</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a><ul>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a><ul>
<li><a class="reference internal" href="#module-listing">Module Listing</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="introduction.html"
title="next chapter">Introduction</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.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="introduction.html" title="Introduction"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">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>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f57b2cbc6bd4a90f10089095b1f7fb88
>
files
>
80
