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
|
<!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>paste.recursive – internal requests — Paste v1.7.5 documentation</title>
<link rel="stylesheet" href="../_static/default.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.7.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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="top" title="Paste v1.7.5 documentation" href="../index.html" />
<link rel="stylesheet" type="text/css"
href="../_static/paste.css.html">
</head>
<body>
<div class="related">
<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><a href="../index.html">Paste v1.7.5 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-paste.recursive">
<span id="paste-recursive-internal-requests"></span><h1><a class="reference internal" href="#module-paste.recursive"><tt class="xref py py-mod docutils literal"><span class="pre">paste.recursive</span></tt></a> – internal requests<a class="headerlink" href="#module-paste.recursive" title="Permalink to this headline">¶</a></h1>
<p>Middleware to make internal requests and forward requests internally.</p>
<p>When applied, several keys are added to the environment that will allow
you to trigger recursive redirects and forwards.</p>
<blockquote>
<dl class="docutils">
<dt>paste.recursive.include:</dt>
<dd>When you call
<tt class="docutils literal"><span class="pre">environ['paste.recursive.include'](new_path_info)</span></tt> a response
will be returned. The response has a <tt class="docutils literal"><span class="pre">body</span></tt> attribute, a
<tt class="docutils literal"><span class="pre">status</span></tt> attribute, and a <tt class="docutils literal"><span class="pre">headers</span></tt> attribute.</dd>
<dt>paste.recursive.script_name:</dt>
<dd>The <tt class="docutils literal"><span class="pre">SCRIPT_NAME</span></tt> at the point that recursive lives. Only
paths underneath this path can be redirected to.</dd>
<dt>paste.recursive.old_path_info:</dt>
<dd>A list of previous <tt class="docutils literal"><span class="pre">PATH_INFO</span></tt> values from previous redirects.</dd>
</dl>
</blockquote>
<p>Raise <tt class="docutils literal"><span class="pre">ForwardRequestException(new_path_info)</span></tt> to do a forward
(aborting the current request).</p>
<div class="section" id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="paste.recursive.RecursiveMiddleware">
<em class="property">class </em><tt class="descclassname">paste.recursive.</tt><tt class="descname">RecursiveMiddleware</tt><big>(</big><em>application</em>, <em>global_conf=None</em><big>)</big><a class="headerlink" href="#paste.recursive.RecursiveMiddleware" title="Permalink to this definition">¶</a></dt>
<dd><p>A WSGI middleware that allows for recursive and forwarded calls.
All these calls go to the same ‘application’, but presumably that
application acts differently with different URLs. The forwarded
URLs must be relative to this container.</p>
<p>Interface is entirely through the <tt class="docutils literal"><span class="pre">paste.recursive.forward</span></tt> and
<tt class="docutils literal"><span class="pre">paste.recursive.include</span></tt> environmental keys.</p>
</dd></dl>
<dl class="function">
<dt id="paste.recursive.ForwardRequestException">
<tt class="descclassname">paste.recursive.</tt><tt class="descname">ForwardRequestException</tt><big>(</big><em>url=None</em>, <em>environ={}</em>, <em>factory=None</em>, <em>path_info=None</em><big>)</big><a class="headerlink" href="#paste.recursive.ForwardRequestException" title="Permalink to this definition">¶</a></dt>
<dd><p>Used to signal that a request should be forwarded to a different location.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">url</span></tt></dt>
<dd>The URL to forward to starting with a <tt class="docutils literal"><span class="pre">/</span></tt> and relative to
<tt class="docutils literal"><span class="pre">RecursiveMiddleware</span></tt>. URL fragments can also contain query strings
so <tt class="docutils literal"><span class="pre">/error?code=404</span></tt> would be a valid URL fragment.</dd>
<dt><tt class="docutils literal"><span class="pre">environ</span></tt></dt>
<dd>An altertative WSGI environment dictionary to use for the forwarded
request. If specified is used <em>instead</em> of the <tt class="docutils literal"><span class="pre">url_fragment</span></tt></dd>
<dt><tt class="docutils literal"><span class="pre">factory</span></tt></dt>
<dd>If specifed <tt class="docutils literal"><span class="pre">factory</span></tt> is used instead of <tt class="docutils literal"><span class="pre">url</span></tt> or <tt class="docutils literal"><span class="pre">environ</span></tt>.
<tt class="docutils literal"><span class="pre">factory</span></tt> is a callable that takes a WSGI application object
as the first argument and returns an initialised WSGI middleware
which can alter the forwarded response.</dd>
</dl>
<p>Basic usage (must have <tt class="docutils literal"><span class="pre">RecursiveMiddleware</span></tt> present) :</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">paste.recursive</span> <span class="kn">import</span> <span class="n">ForwardRequestException</span>
<span class="k">def</span> <span class="nf">app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="k">if</span> <span class="n">environ</span><span class="p">[</span><span class="s">'PATH_INFO'</span><span class="p">]</span> <span class="o">==</span> <span class="s">'/hello'</span><span class="p">:</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">"200 OK"</span><span class="p">,</span> <span class="p">[(</span><span class="s">'Content-type'</span><span class="p">,</span> <span class="s">'text/plain'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'Hello World!'</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">environ</span><span class="p">[</span><span class="s">'PATH_INFO'</span><span class="p">]</span> <span class="o">==</span> <span class="s">'/error'</span><span class="p">:</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">"404 Not Found"</span><span class="p">,</span> <span class="p">[(</span><span class="s">'Content-type'</span><span class="p">,</span> <span class="s">'text/plain'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'Page not found'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ForwardRequestException</span><span class="p">(</span><span class="s">'/error'</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">paste.recursive</span> <span class="kn">import</span> <span class="n">RecursiveMiddleware</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">RecursiveMiddleware</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
</pre></div>
</div>
<p>If you ran this application and visited <tt class="docutils literal"><span class="pre">/hello</span></tt> you would get a
<tt class="docutils literal"><span class="pre">Hello</span> <span class="pre">World!</span></tt> message. If you ran the application and visited
<tt class="docutils literal"><span class="pre">/not_found</span></tt> a <tt class="docutils literal"><span class="pre">ForwardRequestException</span></tt> would be raised and the caught
by the <tt class="docutils literal"><span class="pre">RecursiveMiddleware</span></tt>. The <tt class="docutils literal"><span class="pre">RecursiveMiddleware</span></tt> would then
return the headers and response from the <tt class="docutils literal"><span class="pre">/error</span></tt> URL but would display
a <tt class="docutils literal"><span class="pre">404</span> <span class="pre">Not</span> <span class="pre">found</span></tt> status message.</p>
<p>You could also specify an <tt class="docutils literal"><span class="pre">environ</span></tt> dictionary instead of a url. Using
the same example as before:</p>
<div class="highlight-python"><pre>def app(environ, start_response):
... same as previous example ...
else:
new_environ = environ.copy()
new_environ['PATH_INFO'] = '/error'
raise ForwardRequestException(environ=new_environ)</pre>
</div>
<p>Finally, if you want complete control over every aspect of the forward you
can specify a middleware factory. For example to keep the old status code
but use the headers and resposne body from the forwarded response you might
do this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">paste.recursive</span> <span class="kn">import</span> <span class="n">ForwardRequestException</span>
<span class="kn">from</span> <span class="nn">paste.recursive</span> <span class="kn">import</span> <span class="n">RecursiveMiddleware</span>
<span class="kn">from</span> <span class="nn">paste.errordocument</span> <span class="kn">import</span> <span class="n">StatusKeeper</span>
<span class="k">def</span> <span class="nf">app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="k">if</span> <span class="n">environ</span><span class="p">[</span><span class="s">'PATH_INFO'</span><span class="p">]</span> <span class="o">==</span> <span class="s">'/hello'</span><span class="p">:</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">"200 OK"</span><span class="p">,</span> <span class="p">[(</span><span class="s">'Content-type'</span><span class="p">,</span> <span class="s">'text/plain'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'Hello World!'</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">environ</span><span class="p">[</span><span class="s">'PATH_INFO'</span><span class="p">]</span> <span class="o">==</span> <span class="s">'/error'</span><span class="p">:</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">"404 Not Found"</span><span class="p">,</span> <span class="p">[(</span><span class="s">'Content-type'</span><span class="p">,</span> <span class="s">'text/plain'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'Page not found'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">factory</span><span class="p">(</span><span class="n">app</span><span class="p">):</span>
<span class="k">return</span> <span class="n">StatusKeeper</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">status</span><span class="o">=</span><span class="s">'404 Not Found'</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="s">'/error'</span><span class="p">)</span>
<span class="k">raise</span> <span class="n">ForwardRequestException</span><span class="p">(</span><span class="n">factory</span><span class="o">=</span><span class="n">factory</span><span class="p">)</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">RecursiveMiddleware</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="http://pythonpaste.org/" class="invisible-link">Python Paste</a></h3>
<ul>
<li><a href="http://trac.pythonpaste.org">Issue tracker</a></li>
<li><a href="http://pythonpaste.org/">Paste core</a></li>
<li><a href="http://pythonpaste.org/webob/">WebOb</a></li>
<li><a href="http://pythonpaste.org/deploy/">Paste Deploy</a></li>
<li><a href="http://pythonpaste.org/script/">Paste Script</a></li>
<li><a href="http://pythonpaste.org/webtest/">WebTest</a></li>
<li><a href="http://pythonpaste.org/scripttest/">ScriptType</a></li>
<li><a href="http://pythonpaste.org/initools/">INITools</a></li>
<li><a href="http://pythonpaste.org/tempita/">Tempita</a></li>
<li><a href="http://pythonpaste.org/waitforit/">WaitForIt</a></li>
<li><a href="http://pythonpaste.org/wphp/">WPHP</a></li>
<li><a href="http://pythonpaste.org/wsgifilter/">WSGIFilter</a></li>
<li><a href="http://pythonpaste.org/wsgiproxy/">WSGIProxy</a></li>
</ul>
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><tt class="docutils literal"><span class="pre">paste.recursive</span></tt> – internal requests</a><ul>
<li><a class="reference internal" href="#module-contents">Module Contents</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/recursive.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<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><a href="../index.html">Paste v1.7.5 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008, Ian Bicking.
Last updated on Sep 14, 2010.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>
|
