/usr/share/doc/python-pecan-doc/html/pecan_decorators.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 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | <!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.decorators – Pecan Decorators — 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.deploy – Pecan Deploy" href="pecan_deploy.html" />
<link rel="prev" title="pecan.configuration – Pecan Configuration Engine" href="pecan_configuration.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_deploy.html" title="pecan.deploy – Pecan Deploy"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pecan_configuration.html" title="pecan.configuration – Pecan Configuration Engine"
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-decorators-pecan-decorators">
<span id="pecan-decorators"></span><h1><a class="reference internal" href="#module-pecan.decorators" title="pecan.decorators"><code class="xref py py-mod docutils literal"><span class="pre">pecan.decorators</span></code></a> – Pecan Decorators<a class="headerlink" href="#pecan-decorators-pecan-decorators" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="#module-pecan.decorators" title="pecan.decorators"><code class="xref py py-mod docutils literal"><span class="pre">pecan.decorators</span></code></a> module includes useful decorators for
creating Pecan applications.</p>
<span class="target" id="module-pecan.decorators"></span><dl class="function">
<dt id="pecan.decorators.expose">
<code class="descclassname">pecan.decorators.</code><code class="descname">expose</code><span class="sig-paren">(</span><em>template=None</em>, <em>generic=False</em>, <em>route=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.decorators.expose" title="Permalink to this definition">¶</a></dt>
<dd><p>Decorator used to flag controller methods as being “exposed” for
access via HTTP, and to configure that access.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>template</strong> – The path to a template, relative to the base template
directory. Can also be passed a string representing
a special or custom renderer, such as <code class="docutils literal"><span class="pre">'json'</span></code> for
<a class="reference internal" href="templates.html#expose-json"><span class="std std-ref">The JSON Renderer</span></a>.</li>
<li><strong>content_type</strong> – The content-type to use for this template.</li>
<li><strong>generic</strong> – A boolean which flags this as a “generic” controller,
which uses generic functions based upon
<code class="docutils literal"><span class="pre">functools.singledispatch</span></code> generic functions. Allows you
to split a single controller into multiple paths based upon
HTTP method.</li>
<li><strong>route</strong> – The name of the path segment to match (excluding
separator characters, like <cite>/</cite>). Defaults to the name of
the function itself, but this can be used to resolve paths
which are not valid Python function names, e.g., if you
wanted to route a function to <a href="#id1"><span class="problematic" id="id2">`</span></a>some-special-path’.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pecan.decorators.transactional">
<code class="descclassname">pecan.decorators.</code><code class="descname">transactional</code><span class="sig-paren">(</span><em>ignore_redirects=True</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.decorators.transactional" title="Permalink to this definition">¶</a></dt>
<dd><p>If utilizing the <a class="reference internal" href="pecan_hooks.html#module-pecan.hooks" title="pecan.hooks"><code class="xref py py-mod docutils literal"><span class="pre">pecan.hooks</span></code></a> <code class="docutils literal"><span class="pre">TransactionHook</span></code>, allows you
to flag a controller method or class as being wrapped in a transaction,
regardless of HTTP method.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ignore_redirects</strong> – Indicates if the hook should ignore redirects
for this controller or not.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pecan.decorators.accept_noncanonical">
<code class="descclassname">pecan.decorators.</code><code class="descname">accept_noncanonical</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.decorators.accept_noncanonical" title="Permalink to this definition">¶</a></dt>
<dd><p>Flags a controller method as accepting non-canoncial URLs.</p>
</dd></dl>
<dl class="function">
<dt id="pecan.decorators.after_commit">
<code class="descclassname">pecan.decorators.</code><code class="descname">after_commit</code><span class="sig-paren">(</span><em>action</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.decorators.after_commit" title="Permalink to this definition">¶</a></dt>
<dd><p>If utilizing the <a class="reference internal" href="pecan_hooks.html#module-pecan.hooks" title="pecan.hooks"><code class="xref py py-mod docutils literal"><span class="pre">pecan.hooks</span></code></a> <code class="docutils literal"><span class="pre">TransactionHook</span></code>, allows you
to flag a controller method to perform a callable action after the
commit is successfully issued.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>action</strong> – The callable to call after the commit is successfully
issued.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pecan.decorators.after_rollback">
<code class="descclassname">pecan.decorators.</code><code class="descname">after_rollback</code><span class="sig-paren">(</span><em>action</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.decorators.after_rollback" title="Permalink to this definition">¶</a></dt>
<dd><p>If utilizing the <a class="reference internal" href="pecan_hooks.html#module-pecan.hooks" title="pecan.hooks"><code class="xref py py-mod docutils literal"><span class="pre">pecan.hooks</span></code></a> <code class="docutils literal"><span class="pre">TransactionHook</span></code>, allows you
to flag a controller method to perform a callable action after the
rollback is successfully issued.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>action</strong> – The callable to call after the rollback is successfully
issued.</td>
</tr>
</tbody>
</table>
</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_configuration.html"
title="previous chapter"><code class="docutils literal"><span class="pre">pecan.configuration</span></code> – Pecan Configuration Engine</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pecan_deploy.html"
title="next chapter"><code class="docutils literal"><span class="pre">pecan.deploy</span></code> – Pecan Deploy</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pecan_decorators.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_deploy.html" title="pecan.deploy – Pecan Deploy"
>next</a> |</li>
<li class="right" >
<a href="pecan_configuration.html" title="pecan.configuration – Pecan Configuration Engine"
>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>
|