/usr/share/doc/python-paste-doc/html/modules/request.html is in python-paste-doc 2.0.3+dfsg-4ubuntu1.
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 | <!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 1.7.5.1 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.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="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
<link rel="stylesheet" type="text/css"
href="../_static/paste.css.html">
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<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" title="paste.request"><code class="xref py py-mod docutils literal"><span class="pre">paste.request</span></code></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>
<div><ul class="simple">
<li>get_cookies(environ)</li>
<li>parse_querystring(environ)</li>
<li>parse_formvars(environ, include_get_vars=True)</li>
<li><dl class="first docutils">
<dt>construct_url(environ, with_query_string=True, with_path_info=True,</dt>
<dd>script_name=None, path_info=None, querystring=None)</dd>
</dl>
</li>
<li>path_info_split(path_info)</li>
<li>path_info_pop(environ)</li>
<li>resolve_relative_url(url, environ)</li>
</ul>
</div></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">
<code class="descclassname">paste.request.</code><code class="descname">get_cookies</code><span class="sig-paren">(</span><em>environ</em><span class="sig-paren">)</span><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">
<code class="descclassname">paste.request.</code><code class="descname">get_cookie_dict</code><span class="sig-paren">(</span><em>environ</em><span class="sig-paren">)</span><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 <code class="docutils literal"><span class="pre">get_cookies</span></code> this returns a dictionary, not a
<code class="docutils literal"><span class="pre">SimpleCookie</span></code> object. For incoming cookies a dictionary fully
represents the information. Like <code class="docutils literal"><span class="pre">get_cookies</span></code> this caches and
checks the cache.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.parse_querystring">
<code class="descclassname">paste.request.</code><code class="descname">parse_querystring</code><span class="sig-paren">(</span><em>environ</em><span class="sig-paren">)</span><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 <code class="docutils literal"><span class="pre">[(name,</span> <span class="pre">value)]</span></code>.
Caches this value in case parse_querystring is called again
for the same request.</p>
<p>You can pass the result to <code class="docutils literal"><span class="pre">dict()</span></code>, 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">
<code class="descclassname">paste.request.</code><code class="descname">parse_formvars</code><span class="sig-paren">(</span><em>environ</em>, <em>include_get_vars=True</em>, <em>encoding=None</em>, <em>errors=None</em><span class="sig-paren">)</span><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 <code class="docutils literal"><span class="pre">include_get_vars</span></code> 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 <code class="docutils literal"><span class="pre">FieldStorage</span></code> instances.</p>
<p>If the request was not a normal form request (e.g., a POST with an
XML body) then <code class="docutils literal"><span class="pre">environ['wsgi.input']</span></code> won’t be read.</p>
</dd></dl>
<dl class="function">
<dt id="paste.request.construct_url">
<code class="descclassname">paste.request.</code><code class="descname">construct_url</code><span class="sig-paren">(</span><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><span class="sig-paren">)</span><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">
<code class="descclassname">paste.request.</code><code class="descname">path_info_split</code><span class="sig-paren">(</span><em>path_info</em><span class="sig-paren">)</span><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">
<code class="descclassname">paste.request.</code><code class="descname">path_info_pop</code><span class="sig-paren">(</span><em>environ</em><span class="sig-paren">)</span><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-default"><div class="highlight"><pre><span></span><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="s1">'SCRIPT_NAME'</span><span class="p">:</span> <span class="n">script_name</span><span class="p">,</span> <span class="s1">'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="nb">print</span><span class="p">(</span><span class="s1">'SCRIPT_NAME=</span><span class="si">%r</span><span class="s1">; PATH_INFO=</span><span class="si">%r</span><span class="s1">; returns=</span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="p">(</span>
<span class="gp">... </span> <span class="n">env</span><span class="p">[</span><span class="s1">'SCRIPT_NAME'</span><span class="p">],</span> <span class="n">env</span><span class="p">[</span><span class="s1">'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="s1">'/foo'</span><span class="p">,</span> <span class="s1">'/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="s1">'/foo/bar'</span><span class="p">,</span> <span class="s1">''</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="s1">'/foo/bar'</span><span class="p">,</span> <span class="s1">'/'</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="s1">''</span><span class="p">,</span> <span class="s1">'/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="s1">''</span><span class="p">,</span> <span class="s1">'//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">
<code class="descclassname">paste.request.</code><code class="descname">resolve_relative_url</code><span class="sig-paren">(</span><em>url</em>, <em>environ</em><span class="sig-paren">)</span><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><code class="descclassname">paste.request.</code><code class="descname">EnvironHeaders</code><span class="sig-paren">(</span><em>environ</em><span class="sig-paren">)</span><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" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="http://pythonpaste.org/" class="invisible-link">Python Paste</a></h3>
<ul>
<li><a href="https://bitbucket.org/ianb/pastescript/issues/">Issue tracker</a></li>
<li><a href="http://pythonpaste.org/">Paste core</a></li>
<li><a href="http://webob.org/">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://webtest.pythonpaste.org/">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="#"><code class="docutils literal"><span class="pre">paste.request</span></code> – Utility functions for the WSGI environment</a><ul>
<li><a class="reference internal" href="#module-contents">Module Contents</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/modules/request.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="footer">
©2017, Ian Bicking.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="../_sources/modules/request.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|