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
|
<!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.request – Utility functions for the WSGI environment — 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.request">
<span id="paste-request-utility-functions-for-the-wsgi-environment"></span><h1><a class="reference internal" href="#module-paste.request"><tt class="xref py py-mod docutils literal"><span class="pre">paste.request</span></tt></a> – Utility functions for the WSGI environment<a class="headerlink" href="#module-paste.request" title="Permalink to this headline">¶</a></h1>
<p>This module provides helper routines with work directly on a WSGI
environment to solve common requirements.</p>
<blockquote>
<ul>
<li><p class="first">get_cookies(environ)</p>
</li>
<li><p class="first">parse_querystring(environ)</p>
</li>
<li><p class="first">parse_formvars(environ, include_get_vars=True)</p>
</li>
<li><dl class="first docutils">
<dt>construct_url(environ, with_query_string=True, with_path_info=True,</dt>
<dd><p class="first last">script_name=None, path_info=None, querystring=None)</p>
</dd>
</dl>
</li>
<li><p class="first">path_info_split(path_info)</p>
</li>
<li><p class="first">path_info_pop(environ)</p>
</li>
<li><p class="first">resolve_relative_url(url, environ)</p>
</li>
</ul>
</blockquote>
<div class="section" id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="paste.request.get_cookies">
<tt class="descclassname">paste.request.</tt><tt class="descname">get_cookies</tt><big>(</big><em>environ</em><big>)</big><a class="headerlink" href="#paste.request.get_cookies" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a cookie object (which is a dictionary-like object) from the
request environment; caches this value in case get_cookies is
called again for the same request.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.get_cookie_dict">
<tt class="descclassname">paste.request.</tt><tt class="descname">get_cookie_dict</tt><big>(</big><em>environ</em><big>)</big><a class="headerlink" href="#paste.request.get_cookie_dict" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a <em>plain</em> dictionary of cookies as found in the request.</p>
<p>Unlike <tt class="docutils literal"><span class="pre">get_cookies</span></tt> this returns a dictionary, not a
<tt class="docutils literal"><span class="pre">SimpleCookie</span></tt> object. For incoming cookies a dictionary fully
represents the information. Like <tt class="docutils literal"><span class="pre">get_cookies</span></tt> this caches and
checks the cache.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.parse_querystring">
<tt class="descclassname">paste.request.</tt><tt class="descname">parse_querystring</tt><big>(</big><em>environ</em><big>)</big><a class="headerlink" href="#paste.request.parse_querystring" title="Permalink to this definition">¶</a></dt>
<dd><p>Parses a query string into a list like <tt class="docutils literal"><span class="pre">[(name,</span> <span class="pre">value)]</span></tt>.
Caches this value in case parse_querystring is called again
for the same request.</p>
<p>You can pass the result to <tt class="docutils literal"><span class="pre">dict()</span></tt>, but be aware that keys that
appear multiple times will be lost (only the last value will be
preserved).</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.parse_formvars">
<tt class="descclassname">paste.request.</tt><tt class="descname">parse_formvars</tt><big>(</big><em>environ</em>, <em>include_get_vars=True</em><big>)</big><a class="headerlink" href="#paste.request.parse_formvars" title="Permalink to this definition">¶</a></dt>
<dd><p>Parses the request, returning a MultiDict of form variables.</p>
<p>If <tt class="docutils literal"><span class="pre">include_get_vars</span></tt> is true then GET (query string) variables
will also be folded into the MultiDict.</p>
<p>All values should be strings, except for file uploads which are
left as <tt class="docutils literal"><span class="pre">FieldStorage</span></tt> instances.</p>
<p>If the request was not a normal form request (e.g., a POST with an
XML body) then <tt class="docutils literal"><span class="pre">environ['wsgi.input']</span></tt> won’t be read.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.construct_url">
<tt class="descclassname">paste.request.</tt><tt class="descname">construct_url</tt><big>(</big><em>environ</em>, <em>with_query_string=True</em>, <em>with_path_info=True</em>, <em>script_name=None</em>, <em>path_info=None</em>, <em>querystring=None</em><big>)</big><a class="headerlink" href="#paste.request.construct_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Reconstructs the URL from the WSGI environment.</p>
<p>You may override SCRIPT_NAME, PATH_INFO, and QUERYSTRING with
the keyword arguments.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.path_info_split">
<tt class="descclassname">paste.request.</tt><tt class="descname">path_info_split</tt><big>(</big><em>path_info</em><big>)</big><a class="headerlink" href="#paste.request.path_info_split" title="Permalink to this definition">¶</a></dt>
<dd><p>Splits off the first segment of the path. Returns (first_part,
rest_of_path). first_part can be None (if PATH_INFO is empty), ‘’
(if PATH_INFO is ‘/’), or a name without any /’s. rest_of_path
can be ‘’ or a string starting with /.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.path_info_pop">
<tt class="descclassname">paste.request.</tt><tt class="descname">path_info_pop</tt><big>(</big><em>environ</em><big>)</big><a class="headerlink" href="#paste.request.path_info_pop" title="Permalink to this definition">¶</a></dt>
<dd><p>‘Pops’ off the next segment of PATH_INFO, pushing it onto
SCRIPT_NAME, and returning that segment.</p>
<p>For instance:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">call_it</span><span class="p">(</span><span class="n">script_name</span><span class="p">,</span> <span class="n">path_info</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">env</span> <span class="o">=</span> <span class="p">{</span><span class="s">'SCRIPT_NAME'</span><span class="p">:</span> <span class="n">script_name</span><span class="p">,</span> <span class="s">'PATH_INFO'</span><span class="p">:</span> <span class="n">path_info</span><span class="p">}</span>
<span class="gp">... </span> <span class="n">result</span> <span class="o">=</span> <span class="n">path_info_pop</span><span class="p">(</span><span class="n">env</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">print</span> <span class="s">'SCRIPT_NAME=</span><span class="si">%r</span><span class="s">; PATH_INFO=</span><span class="si">%r</span><span class="s">; returns=</span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span>
<span class="gp">... </span> <span class="n">env</span><span class="p">[</span><span class="s">'SCRIPT_NAME'</span><span class="p">],</span> <span class="n">env</span><span class="p">[</span><span class="s">'PATH_INFO'</span><span class="p">],</span> <span class="n">result</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">call_it</span><span class="p">(</span><span class="s">'/foo'</span><span class="p">,</span> <span class="s">'/bar'</span><span class="p">)</span>
<span class="go">SCRIPT_NAME='/foo/bar'; PATH_INFO=''; returns='bar'</span>
<span class="gp">>>> </span><span class="n">call_it</span><span class="p">(</span><span class="s">'/foo/bar'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
<span class="go">SCRIPT_NAME='/foo/bar'; PATH_INFO=''; returns=None</span>
<span class="gp">>>> </span><span class="n">call_it</span><span class="p">(</span><span class="s">'/foo/bar'</span><span class="p">,</span> <span class="s">'/'</span><span class="p">)</span>
<span class="go">SCRIPT_NAME='/foo/bar/'; PATH_INFO=''; returns=''</span>
<span class="gp">>>> </span><span class="n">call_it</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="s">'/1/2/3'</span><span class="p">)</span>
<span class="go">SCRIPT_NAME='/1'; PATH_INFO='/2/3'; returns='1'</span>
<span class="gp">>>> </span><span class="n">call_it</span><span class="p">(</span><span class="s">''</span><span class="p">,</span> <span class="s">'//1/2'</span><span class="p">)</span>
<span class="go">SCRIPT_NAME='//1'; PATH_INFO='/2'; returns='1'</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="paste.request.resolve_relative_url">
<tt class="descclassname">paste.request.</tt><tt class="descname">resolve_relative_url</tt><big>(</big><em>url</em>, <em>environ</em><big>)</big><a class="headerlink" href="#paste.request.resolve_relative_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Resolve the given relative URL as being relative to the
location represented by the environment. This can be used
for redirecting to a relative path. Note: if url is already
absolute, this function will (intentionally) have no effect
on it.</p>
</dd></dl>
<dl class="class">
<dt id="paste.request.EnvironHeaders">
<em class="property">class </em><tt class="descclassname">paste.request.</tt><tt class="descname">EnvironHeaders</tt><big>(</big><em>environ</em><big>)</big><a class="headerlink" href="#paste.request.EnvironHeaders" title="Permalink to this definition">¶</a></dt>
<dd><p>An object that represents the headers as present in a
WSGI environment.</p>
<p>This object is a wrapper (with no internal state) for a WSGI
request object, representing the CGI-style HTTP_* keys as a
dictionary. Because a CGI environment can only hold one value for
each key, this dictionary is single-valued (unlike outgoing
headers).</p>
</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.request</span></tt> – Utility functions for the WSGI environment</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/request.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>
|
