/usr/share/doc/python-pecan-doc/html/pecan_routing.html is in python-pecan-doc 1.2.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | <!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="Content-Type" content="text/html; charset=utf-8" />
<title>pecan.routing – Pecan Routing — Pecan 1.2.1 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.2.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pecan.secure – Pecan Secure Controllers" href="pecan_secure.html" />
<link rel="prev" title="pecan.rest – Pecan REST Controller" href="pecan_rest.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="pecan_secure.html" title="pecan.secure – Pecan Secure Controllers"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pecan_rest.html" title="pecan.rest – Pecan REST Controller"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Pecan 1.2.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pecan-routing-pecan-routing">
<span id="pecan-routing"></span><h1><a class="reference internal" href="#module-pecan.routing" title="pecan.routing"><code class="xref py py-mod docutils literal"><span class="pre">pecan.routing</span></code></a> – Pecan Routing<a class="headerlink" href="#pecan-routing-pecan-routing" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="#module-pecan.routing" title="pecan.routing"><code class="xref py py-mod docutils literal"><span class="pre">pecan.routing</span></code></a> module is the basis for all object-dispatch
routing in Pecan.</p>
<span class="target" id="module-pecan.routing"></span><dl class="function">
<dt id="pecan.routing.lookup_controller">
<code class="descclassname">pecan.routing.</code><code class="descname">lookup_controller</code><span class="sig-paren">(</span><em>obj</em>, <em>remainder</em>, <em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.routing.lookup_controller" title="Permalink to this definition">¶</a></dt>
<dd><p>Traverses the requested url path and returns the appropriate controller
object, including default routes.</p>
<p>Handles common errors gracefully.</p>
</dd></dl>
<dl class="function">
<dt id="pecan.routing.find_object">
<code class="descclassname">pecan.routing.</code><code class="descname">find_object</code><span class="sig-paren">(</span><em>obj</em>, <em>remainder</em>, <em>notfound_handlers</em>, <em>request</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.routing.find_object" title="Permalink to this definition">¶</a></dt>
<dd><p>‘Walks’ the url path in search of an action for which a controller is
implemented and returns that controller object along with what’s left
of the remainder.</p>
</dd></dl>
<dl class="function">
<dt id="pecan.routing.route">
<code class="descclassname">pecan.routing.</code><code class="descname">route</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.routing.route" title="Permalink to this definition">¶</a></dt>
<dd><p>This function is used to define an explicit route for a path segment.</p>
<p>You generally only want to use this in situations where your desired path
segment is not a valid Python variable/function name.</p>
<p>For example, if you wanted to be able to route to:</p>
<p>/path/with-dashes/</p>
<p>…the following is invalid Python syntax:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Controller</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">with</span><span class="o">-</span><span class="n">dashes</span> <span class="o">=</span> <span class="n">SubController</span><span class="p">()</span>
</pre></div>
</div>
<p>…so you would instead define the route explicitly:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">Controller</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">pass</span>
<span class="n">pecan</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="n">Controller</span><span class="p">,</span> <span class="s1">'with-dashes'</span><span class="p">,</span> <span class="n">SubController</span><span class="p">())</span>
</pre></div>
</div>
</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="pecan_rest.html"
title="previous chapter"><code class="docutils literal"><span class="pre">pecan.rest</span></code> – Pecan <code class="docutils literal"><span class="pre">REST</span></code> Controller</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pecan_secure.html"
title="next chapter"><code class="docutils literal"><span class="pre">pecan.secure</span></code> – Pecan Secure Controllers</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pecan_routing.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pecan_secure.html" title="pecan.secure – Pecan Secure Controllers"
>next</a> |</li>
<li class="right" >
<a href="pecan_rest.html" title="pecan.rest – Pecan REST Controller"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Pecan 1.2.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, Jonathan LaCour.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
</div>
</body>
</html>
|