File: pyapi-util-funcs.html

package info (click to toggle)
libapache2-mod-python 3.2.10-4
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 2,476 kB
  • ctags: 2,034
  • sloc: ansic: 5,218; python: 5,195; makefile: 282; sh: 270; lex: 246
file content (187 lines) | stat: -rw-r--r-- 7,652 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="modpython.css" type='text/css'>
<link rel="first" href="modpython.html" title='Mod_python Manual'>
<link rel='contents' href='contents.html' title="Contents">
<link rel='index' href='genindex.html' title='Index'>
<link rel='last' href='about.html' title='About this document...'>
<link rel='help' href='about.html' title='About this document...'>
<LINK REL="prev" href="pyapi-util-fstor-fld.html">
<LINK REL="parent" href="pyapi-util.html">
<LINK REL="next" href="pyapi-cookie.html">
<meta name='aesop' content='information'>
<META NAME="description" CONTENT="Other functions">
<META NAME="keywords" CONTENT="modpython">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<title>4.6.4 Other functions</title>
</head>
<body>
<DIV CLASS="navigation">
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><a rel="prev" title="4.6.3 Field class" 
  href="pyapi-util-fstor-fld.html"><img src='previous.gif'
  border='0' height='32'  alt='Previous Page' width='32'></A></td>
<td><a rel="parent" title="4.6 util - Miscellaneous" 
  href="pyapi-util.html"><img src='up.gif'
  border='0' height='32'  alt='Up One Level' width='32'></A></td>
<td><a rel="next" title="4.7 Cookie - HTTP" 
  href="pyapi-cookie.html"><img src='next.gif'
  border='0' height='32'  alt='Next Page' width='32'></A></td>
<td align="center" width="100%">Mod_python Manual</td>
<td><a rel="contents" title="Table of Contents" 
  href="contents.html"><img src='contents.gif'
  border='0' height='32'  alt='Contents' width='32'></A></td>
<td><img src='blank.gif'
  border='0' height='32'  alt='' width='32'></td>
<td><a rel="index" title="Index" 
  href="genindex.html"><img src='index.gif'
  border='0' height='32'  alt='Index' width='32'></A></td>
</tr></table>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="pyapi-util-fstor-fld.html">4.6.3 Field class</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="pyapi-util.html">4.6 util - Miscellaneous</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pyapi-cookie.html">4.7 Cookie - HTTP</A>
<br><hr>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION006640000000000000000">&nbsp;</A>
<BR>
4.6.4 Other functions
</H2>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><a name="l2h-203"><tt class="function">parse_qs</tt></a></b>(</nobr></td>
  <td><var>qs</var><big>[</big><var>, keep_blank_values, strict_parsing</var><big>]</big>)</td></tr></table>
<dd>

<P>
This function is functionally equivalent to the standard library
  <tt class="module">cgi</tt> <tt class="function">parse_qs</tt>, except that it is written in C and is
  much faster. 

<P>
Parse a query string given as a string argument (data of type
  <span class="mimetype">application/x-www-form-urlencoded</span>).  Data are
  returned as a dictionary.  The dictionary keys are the unique query
  variable names and the values are lists of values for each name.

<P>
The optional argument <var>keep_blank_values</var> is a flag indicating
  whether blank values in URL encoded queries should be treated as blank
  strings.  A true value indicates that blanks should be retained as
  blank strings.  The default false value indicates that blank values
  are to be ignored and treated as if they were not included.

<P>
<div class="note"><b class="label">Note:</b>
The <var>strict_parsing</var> argument is not yet implemented.
  </div>

<P>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><a name="l2h-204"><tt class="function">parse_qsl</tt></a></b>(</nobr></td>
  <td><var>qs</var><big>[</big><var>, keep_blank_values, strict_parsing</var><big>]</big>)</td></tr></table>
<dd>

<P>
This function is functionally equivalent to the standard library
  <tt class="module">cgi</tt> <tt class="function">parse_qsl</tt>, except that it is written in C and is
  much faster. 

<P>
Parse a query string given as a string argument (data of type
  <span class="mimetype">application/x-www-form-urlencoded</span>).  Data are
  returned as a list of name, value pairs.

<P>
The optional argument <var>keep_blank_values</var> is a flag indicating
  whether blank values in URL encoded queries should be treated as blank
  strings.  A true value indicates that blanks should be retained as
  blank strings.  The default false value indicates that blank values
  are to be ignored and treated as if they were not included.

<P>
<div class="note"><b class="label">Note:</b>
The <var>strict_parsing</var> argument is not yet implemented.
  </div>

<P>
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><a name="l2h-205"><tt class="function">redirect</tt></a></b>(</nobr></td>
  <td><var>req, location</var><big>[</big><var>, permanent=0, text=None</var><big>]</big>)</td></tr></table>
<dd>
  This is a convenience function to redirect the browser to another
  location. When <var>permanent</var> is true, <tt class="constant">MOVED_PERMANENTLY</tt>
  status is sent to the client, otherwise it is
  <tt class="constant">MOVED_TEMPORARILY</tt>. A short text is sent to the browser
  informing that the document has moved (for those rare browsers that
  do not support redirection); this text can be overridden by
  supplying a <var>text</var> string.

<P>
If this function is called after the headers have already been sent,
  an <tt class="exception">IOError</tt> is raised.

<P>
This function raises <tt class="exception">apache.SERVER_RETURN</tt> exception to
  abandon any further processing of the handle. If you do not want
  this, you can wrap the call to <tt class="function">redirect</tt> in a try/except
  block catching the <tt class="exception">apache.SERVER_RETURN</tt>.
</dl>

<P>

<DIV CLASS="navigation">
<p><hr>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><a rel="prev" title="4.6.3 Field class" 
  rel="prev" title="4.6.3 Field class" 
  href="pyapi-util-fstor-fld.html"><img src='previous.gif'
  border='0' height='32'  alt='Previous Page' width='32'></A></td>
<td><a rel="parent" title="4.6 util - Miscellaneous" 
  rel="parent" title="4.6 util - Miscellaneous" 
  href="pyapi-util.html"><img src='up.gif'
  border='0' height='32'  alt='Up One Level' width='32'></A></td>
<td><a rel="next" title="4.7 Cookie - HTTP" 
  rel="next" title="4.7 Cookie - HTTP" 
  href="pyapi-cookie.html"><img src='next.gif'
  border='0' height='32'  alt='Next Page' width='32'></A></td>
<td align="center" width="100%">Mod_python Manual</td>
<td><a rel="contents" title="Table of Contents" 
  rel="contents" title="Table of Contents" 
  href="contents.html"><img src='contents.gif'
  border='0' height='32'  alt='Contents' width='32'></A></td>
<td><img src='blank.gif'
  border='0' height='32'  alt='' width='32'></td>
<td><a rel="index" title="Index" 
  rel="index" title="Index" 
  href="genindex.html"><img src='index.gif'
  border='0' height='32'  alt='Index' width='32'></A></td>
</tr></table>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="pyapi-util-fstor-fld.html">4.6.3 Field class</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="pyapi-util.html">4.6 util - Miscellaneous</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pyapi-cookie.html">4.7 Cookie - HTTP</A>
<hr>
<span class="release-info">Release 3.2.10, documentation updated on July 19, 2006.</span>
</DIV>
<!--End of Navigation Panel-->

</BODY>
</HTML>