python-pecan-doc 1.2.1-2 / usr / share / doc / python-pecan-doc / html / pecan_core.html

This file is indexed.

/usr/share/doc/python-pecan-doc/html/pecan_core.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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!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.core – Pecan Core &#8212; 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.commands – Pecan Commands" href="pecan_commands.html" />
    <link rel="prev" title="Example Application: Simple AJAX" href="simple_ajax.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_commands.html" title="pecan.commands – Pecan Commands"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="simple_ajax.html" title="Example Application: Simple AJAX"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Pecan 1.2.1 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="pecan-core-pecan-core">
<span id="pecan-core"></span><h1><a class="reference internal" href="#module-pecan.core" title="pecan.core"><code class="xref py py-mod docutils literal"><span class="pre">pecan.core</span></code></a> – Pecan Core<a class="headerlink" href="#pecan-core-pecan-core" title="Permalink to this headline"></a></h1>
<p>The <a class="reference internal" href="#module-pecan.core" title="pecan.core"><code class="xref py py-mod docutils literal"><span class="pre">pecan.core</span></code></a> module is the base module for creating and extending
Pecan. The core logic for processing HTTP requests and responses lives
here.</p>
<span class="target" id="module-pecan.core"></span><dl class="class">
<dt id="pecan.core.Pecan">
<em class="property">class </em><code class="descclassname">pecan.core.</code><code class="descname">Pecan</code><span class="sig-paren">(</span><em>*args</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.core.Pecan" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">pecan.core.PecanBase</span></code></p>
<p>Pecan application object. Generally created using <code class="docutils literal"><span class="pre">pecan.make_app</span></code>,
rather than being created manually.</p>
<p>Creates a Pecan application instance, which is a WSGI application.</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>root</strong> – A string representing a root controller object (e.g.,
“myapp.controller.root.RootController”)</li>
<li><strong>default_renderer</strong> – The default template rendering engine to use.
Defaults to mako.</li>
<li><strong>template_path</strong> – A relative file system path (from the project root)
where template files live.  Defaults to ‘templates’.</li>
<li><strong>hooks</strong> – A callable which returns a list of
<a class="reference internal" href="pecan_hooks.html#pecan.hooks.PecanHook" title="pecan.hooks.PecanHook"><code class="xref py py-class docutils literal"><span class="pre">pecan.hooks.PecanHook</span></code></a></li>
<li><strong>custom_renderers</strong> – Custom renderer objects, as a dictionary keyed
by engine name.</li>
<li><strong>extra_template_vars</strong> – Any variables to inject into the template
namespace automatically.</li>
<li><strong>force_canonical</strong> – A boolean indicating if this project should
require canonical URLs.</li>
<li><strong>guess_content_type_from_ext</strong> – A boolean indicating if this project
should use the extension in the URL for guessing
the content type to return.</li>
<li><strong>use_context_locals</strong> – When <cite>True</cite>, <cite>pecan.request</cite> and
<cite>pecan.response</cite> will be available as
thread-local references.</li>
<li><strong>request_cls</strong> – Can be used to specify a custom <cite>pecan.request</cite> object.
Defaults to <cite>pecan.Request</cite>.</li>
<li><strong>response_cls</strong> – Can be used to specify a custom <cite>pecan.response</cite>
object.  Defaults to <cite>pecan.Response</cite>.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="pecan.core.abort">
<code class="descclassname">pecan.core.</code><code class="descname">abort</code><span class="sig-paren">(</span><em>status_code</em>, <em>detail=''</em>, <em>headers=None</em>, <em>comment=None</em>, <em>**kw</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.core.abort" title="Permalink to this definition"></a></dt>
<dd><p>Raise an HTTP status code, as specified. Useful for returning status
codes like 401 Unauthorized or 403 Forbidden.</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>status_code</strong> – The HTTP status code as an integer.</li>
<li><strong>detail</strong> – The message to send along, as a string.</li>
<li><strong>headers</strong> – A dictionary of headers to send along with the response.</li>
<li><strong>comment</strong> – A comment to include in the response.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="pecan.core.load_app">
<code class="descclassname">pecan.core.</code><code class="descname">load_app</code><span class="sig-paren">(</span><em>config</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.core.load_app" title="Permalink to this definition"></a></dt>
<dd><p>Used to load a <code class="docutils literal"><span class="pre">Pecan</span></code> application and its environment based on passed
configuration.</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>config</strong> – Can be a dictionary containing configuration, a string which
represents a (relative) configuration filename</td>
</tr>
</tbody>
</table>
<p>returns a pecan.Pecan object</p>
</dd></dl>

<dl class="function">
<dt id="pecan.core.override_template">
<code class="descclassname">pecan.core.</code><code class="descname">override_template</code><span class="sig-paren">(</span><em>template</em>, <em>content_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.core.override_template" title="Permalink to this definition"></a></dt>
<dd><p>Call within a controller to override the template that is used in
your response.</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> – a valid path to a template file, just as you would specify
in an <code class="docutils literal"><span class="pre">&#64;expose</span></code>.</li>
<li><strong>content_type</strong> – a valid MIME type to use for the response.func_closure</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="pecan.core.redirect">
<code class="descclassname">pecan.core.</code><code class="descname">redirect</code><span class="sig-paren">(</span><em>location=None</em>, <em>internal=False</em>, <em>code=None</em>, <em>headers={}</em>, <em>add_slash=False</em>, <em>request=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.core.redirect" title="Permalink to this definition"></a></dt>
<dd><p>Perform a redirect, either internal or external. An internal redirect
performs the redirect server-side, while the external redirect utilizes
an HTTP 302 status code.</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>location</strong> – The HTTP location to redirect to.</li>
<li><strong>internal</strong> – A boolean indicating whether the redirect should be
internal.</li>
<li><strong>code</strong> – The HTTP status code to use for the redirect. Defaults to 302.</li>
<li><strong>headers</strong> – Any HTTP headers to send with the response, as a
dictionary.</li>
<li><strong>request</strong> – The <code class="xref py py-class docutils literal"><span class="pre">pecan.Request</span></code> instance to use.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="pecan.core.render">
<code class="descclassname">pecan.core.</code><code class="descname">render</code><span class="sig-paren">(</span><em>template</em>, <em>namespace</em>, <em>app=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pecan.core.render" title="Permalink to this definition"></a></dt>
<dd><p>Render the specified template using the Pecan rendering framework
with the specified template namespace as a dictionary. Useful in a
controller where you have no template specified in the <code class="docutils literal"><span class="pre">&#64;expose</span></code>.</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 your template, as you would specify in
<code class="docutils literal"><span class="pre">&#64;expose</span></code>.</li>
<li><strong>namespace</strong> – The namespace to use for rendering the template, as a
dictionary.</li>
<li><strong>app</strong> – The instance of <code class="xref py py-class docutils literal"><span class="pre">pecan.Pecan</span></code> to use</li>
</ul>
</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="simple_ajax.html"
                        title="previous chapter">Example Application: Simple AJAX</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="pecan_commands.html"
                        title="next chapter"><code class="docutils literal"><span class="pre">pecan.commands</span></code> – Pecan Commands</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/pecan_core.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_commands.html" title="pecan.commands – Pecan Commands"
             >next</a> |</li>
        <li class="right" >
          <a href="simple_ajax.html" title="Example Application: Simple AJAX"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Pecan 1.2.1 documentation</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2018, Jonathan LaCour.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.6.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.