root/site_resources/oldapi/cgi.FieldStorage-class.html

Revision 1733, 27.3 kB (checked in by kevin, 2 years ago)

various resources used for building the site

Line 
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3           "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6   <title>cgi.FieldStorage</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8 </head>
9 <body bgcolor="white" text="black" link="blue" vlink="#204080"
10       alink="#204080">
11
12 <!-- =========== START OF NAVBAR =========== -->
13 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14   <tr valign="center">
15     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
16     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
17     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
18     <th class="navbar" align="right" width="100%">
19       <table border="0" cellpadding="0" cellspacing="0">
20       <tr><th class="navbar" align="center">
21         <p class="nomargin">
22           <a class="navbar" target="_top" href="http://www.turbogears.org">TurboGears</a>
23       </p></th></tr></table>
24     </th>
25   </tr>
26 </table>
27 <table width="100%" cellpadding="0" cellspacing="0">
28   <tr valign="top">
29     <td width="100%">
30       <font size="-1"><b class="breadcrumbs">
31         Module&nbsp;cgi ::
32         Class&nbsp;FieldStorage
33       </b></font></br>
34     </td>
35     <td><table cellpadding="0" cellspacing="0">
36       <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="cgi.FieldStorage-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
37     </table></td>
38 </tr></table>
39
40 <!-- =========== START OF CLASS DESCRIPTION =========== -->
41 <h2 class="class">Class FieldStorage</h2>
42
43 <hr/>
44
45 <pre class="literalblock">
46 Store a sequence of fields, reading multipart/form-data.
47
48 This class provides naming, typing, files stored on disk, and
49 more.  At the top level, it is accessible like a dictionary, whose
50 keys are the field names.  (Note: None can occur as a field name.)
51 The items are either a Python list (if there's multiple values) or
52 another FieldStorage or MiniFieldStorage object.  If it's a single
53 object, it has the following attributes:
54
55 name: the field name, if specified; otherwise None
56
57 filename: the filename, if specified; otherwise None; this is the
58     client side filename, *not* the file name on which it is
59     stored (that's a temporary file you don't deal with)
60
61 value: the value as a *string*; for file uploads, this
62     transparently reads the file every time you request the value
63
64 file: the file(-like) object from which you can read the data;
65     None if the data is stored a simple string
66
67 type: the content-type, or None if not specified
68
69 type_options: dictionary of options specified on the content-type
70     line
71
72 disposition: content-disposition, or None if not specified
73
74 disposition_options: dictionary of corresponding options
75
76 headers: a dictionary(-like) object (sometimes rfc822.Message or a
77     subclass thereof) containing *all* headers
78
79 The class is subclassable, mostly for the purpose of overriding
80 the make_file() method, which is called internally to come up with
81 a file open for reading and writing.  This makes it possible to
82 override the default choice of storing all files in a temporary
83 directory and unlinking them as soon as they have been opened.
84 </pre>
85 <hr/>
86
87
88 <!-- =========== START OF METHOD SUMMARY =========== -->
89 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
90 <tr bgcolor="#70b0f0" class="summary">
91   <th colspan="2">Method Summary</th></tr>
92 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
93   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
94           <span class=summary-sig-arg>fp</span>,
95           <span class=summary-sig-arg>headers</span>,
96           <span class=summary-sig-arg>outerboundary</span>,
97           <span class=summary-sig-arg>environ</span>,
98           <span class=summary-sig-arg>keep_blank_values</span>,
99           <span class=summary-sig-arg>strict_parsing</span>)</span></code>
100  <a href="source/cgi-module.html#417" class="source">[source]</a>
101 <br />
102 Constructor.</td></tr>
103 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
104   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#__contains__" class="summary-sig-name"><code>__contains__</code></a>(<span class=summary-sig-arg>self</span>,
105           <span class=summary-sig-arg>key</span>)</span></code>
106  <a href="source/cgi-module.html#615" class="source">[source]</a>
107 <br />
108 Dictionary style __contains__ method.</td></tr>
109 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
110   <td><code><a name="__getattr__"></a><span class="summary-sig"><span class="summary-sig-name">__getattr__</span>(<span class=summary-sig-arg>self</span>,
111           <span class=summary-sig-arg>name</span>)</span></code>
112  <a href="source/cgi-module.html#538" class="source">[source]</a>
113 </td></tr>
114 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
115   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class=summary-sig-arg>self</span>,
116           <span class=summary-sig-arg>key</span>)</span></code>
117  <a href="source/cgi-module.html#551" class="source">[source]</a>
118 <br />
119 Dictionary style indexing.</td></tr>
120 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
121   <td><code><a name="__iter__"></a><span class="summary-sig"><span class="summary-sig-name">__iter__</span>(<span class=summary-sig-arg>self</span>)</span></code>
122  <a href="source/cgi-module.html#535" class="source">[source]</a>
123 </td></tr>
124 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
125   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#__len__" class="summary-sig-name"><code>__len__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
126  <a href="source/cgi-module.html#623" class="source">[source]</a>
127 <br />
128 Dictionary style len(x) support.</td></tr>
129 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
130   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
131  <a href="source/cgi-module.html#530" class="source">[source]</a>
132 <br />
133 Return a printable representation.</td></tr>
134 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
135   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#getfirst" class="summary-sig-name"><code>getfirst</code></a>(<span class=summary-sig-arg>self</span>,
136           <span class=summary-sig-arg>key</span>,
137           <span class=summary-sig-arg>default</span>)</span></code>
138  <a href="source/cgi-module.html#576" class="source">[source]</a>
139 <br />
140 Return the first value received.</td></tr>
141 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
142   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#getlist" class="summary-sig-name"><code>getlist</code></a>(<span class=summary-sig-arg>self</span>,
143           <span class=summary-sig-arg>key</span>)</span></code>
144  <a href="source/cgi-module.html#587" class="source">[source]</a>
145 <br />
146 Return list of received values.</td></tr>
147 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
148   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#getvalue" class="summary-sig-name"><code>getvalue</code></a>(<span class=summary-sig-arg>self</span>,
149           <span class=summary-sig-arg>key</span>,
150           <span class=summary-sig-arg>default</span>)</span></code>
151  <a href="source/cgi-module.html#565" class="source">[source]</a>
152 <br />
153 Dictionary style get() method, including 'value' lookup.</td></tr>
154 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
155   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#has_key" class="summary-sig-name"><code>has_key</code></a>(<span class=summary-sig-arg>self</span>,
156           <span class=summary-sig-arg>key</span>)</span></code>
157  <a href="source/cgi-module.html#607" class="source">[source]</a>
158 <br />
159 Dictionary style has_key() method.</td></tr>
160 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
161   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#keys" class="summary-sig-name"><code>keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
162  <a href="source/cgi-module.html#598" class="source">[source]</a>
163 <br />
164 Dictionary style keys() method.</td></tr>
165 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
166   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#make_file" class="summary-sig-name"><code>make_file</code></a>(<span class=summary-sig-arg>self</span>,
167           <span class=summary-sig-arg>binary</span>)</span></code>
168  <a href="source/cgi-module.html#751" class="source">[source]</a>
169 <br />
170 Overridable: return a readable &amp; writable file.</td></tr>
171 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
172   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_binary" class="summary-sig-name"><code>read_binary</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
173  <a href="source/cgi-module.html#666" class="source">[source]</a>
174 <br />
175 Internal: read binary data.</td></tr>
176 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
177   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_lines" class="summary-sig-name"><code>read_lines</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
178  <a href="source/cgi-module.html#679" class="source">[source]</a>
179 <br />
180 Internal: read lines until EOF or outerboundary.</td></tr>
181 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
182   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_lines_to_eof" class="summary-sig-name"><code>read_lines_to_eof</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
183  <a href="source/cgi-module.html#695" class="source">[source]</a>
184 <br />
185 Internal: read lines until EOF.</td></tr>
186 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
187   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_lines_to_outerboundary" class="summary-sig-name"><code>read_lines_to_outerboundary</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
188  <a href="source/cgi-module.html#704" class="source">[source]</a>
189 <br />
190 Internal: read lines until outerboundary.</td></tr>
191 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
192   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_multi" class="summary-sig-name"><code>read_multi</code></a>(<span class=summary-sig-arg>self</span>,
193           <span class=summary-sig-arg>environ</span>,
194           <span class=summary-sig-arg>keep_blank_values</span>,
195           <span class=summary-sig-arg>strict_parsing</span>)</span></code>
196  <a href="source/cgi-module.html#638" class="source">[source]</a>
197 <br />
198 Internal: read a part that is itself multipart.</td></tr>
199 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
200   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_single" class="summary-sig-name"><code>read_single</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
201  <a href="source/cgi-module.html#655" class="source">[source]</a>
202 <br />
203 Internal: read an atomic part.</td></tr>
204 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
205   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#read_urlencoded" class="summary-sig-name"><code>read_urlencoded</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
206  <a href="source/cgi-module.html#627" class="source">[source]</a>
207 <br />
208 Internal: read data in query string format.</td></tr>
209 <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
210   <td><code><span class="summary-sig"><a href="cgi.FieldStorage-class.html#skip_lines" class="summary-sig-name"><code>skip_lines</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
211  <a href="source/cgi-module.html#732" class="source">[source]</a>
212 <br />
213 Internal: skip lines until outer boundary if defined.</td></tr>
214 </table><br />
215
216
217 <!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
218 <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
219 <tr bgcolor="#70b0f0" class="summary">
220   <th colspan="2">Class Variable Summary</th></tr>
221 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
222 <td><b><a href="cgi.FieldStorage-class.html#bufsize"><code>bufsize</code></a></b> = <span title="8192">8192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
223 <tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
224 <td><b><a href="cgi.FieldStorage-class.html#FieldStorageClass"><code>FieldStorageClass</code></a></b> = <span title="None">None&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span></td></tr>
225 </table><br />
226
227
228 <!-- =========== START OF METHOD DETAILS =========== -->
229 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
230 <tr bgcolor="#70b0f0" class="details">
231   <th colspan="2">Method Details</th></tr>
232 </table>
233
234 <a name="__init__"></a>
235 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
236   <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
237           <span class=sig-arg>fp</span>=<span class=sig-default>None</span>,
238           <span class=sig-arg>headers</span>=<span class=sig-default>None</span>,
239           <span class=sig-arg>outerboundary</span>=<span class=sig-default>''</span>,
240           <span class=sig-arg>environ</span>=<span class=sig-default>{'TERM':&nbsp;'vt100',&nbsp;'SHELL':&nbsp;'/bin/bash',&nbsp;'SHLVL':&nbsp;'2',&nbsp;'SE...</span>,
241           <span class=sig-arg>keep_blank_values</span>=<span class=sig-default>0</span>,
242           <span class=sig-arg>strict_parsing</span>=<span class=sig-default>0</span>)</span>
243     <br /><i>(Constructor)</i>
244  <a href="source/cgi-module.html#417" class="source">[source]</a>  </h3>
245 <pre class="literalblock">
246 Constructor.  Read multipart/* until last part.
247
248 Arguments, all optional:
249
250 fp              : file pointer; default: sys.stdin
251     (not used when the request method is GET)
252
253 headers         : header dictionary-like object; default:
254     taken from environ as per CGI spec
255
256 outerboundary   : terminating multipart boundary
257     (for internal use only)
258
259 environ         : environment dictionary; default: os.environ
260
261 keep_blank_values: flag indicating whether blank values in
262     URL encoded forms should be treated as blank strings.
263     A true value indicates that blanks should be retained as
264     blank strings.  The default false value indicates that
265     blank values are to be ignored and treated as if they were
266     not included.
267
268 strict_parsing: flag indicating what to do with parsing errors.
269     If false (the default), errors are silently ignored.
270     If true, errors raise a ValueError exception.
271 </pre>
272   <dl><dt></dt><dd>
273   </dd></dl>
274 </td></tr></table>
275
276 <a name="__contains__"></a>
277 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
278   <h3><span class="sig"><span class="sig-name">__contains__</span>(<span class=sig-arg>self</span>,
279           <span class=sig-arg>key</span>)</span>
280     <br /><i>(In operator)</i>
281  <a href="source/cgi-module.html#615" class="source">[source]</a>  </h3>
282   Dictionary style __contains__ method.
283   <dl><dt></dt><dd>
284   </dd></dl>
285 </td></tr></table>
286
287 <a name="__getitem__"></a>
288 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
289   <h3><span class="sig"><span class="sig-name">__getitem__</span>(<span class=sig-arg>self</span>,
290           <span class=sig-arg>key</span>)</span>
291     <br /><i>(Indexing operator)</i>
292  <a href="source/cgi-module.html#551" class="source">[source]</a>  </h3>
293   Dictionary style indexing.
294   <dl><dt></dt><dd>
295   </dd></dl>
296 </td></tr></table>
297
298 <a name="__len__"></a>
299 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
300   <h3><span class="sig"><span class="sig-name">__len__</span>(<span class=sig-arg>self</span>)</span>
301     <br /><i>(Length operator)</i>
302  <a href="source/cgi-module.html#623" class="source">[source]</a>  </h3>
303   Dictionary style len(x) support.
304   <dl><dt></dt><dd>
305   </dd></dl>
306 </td></tr></table>
307
308 <a name="__repr__"></a>
309 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
310   <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span>
311     <br /><i>(Representation operator)</i>
312  <a href="source/cgi-module.html#530" class="source">[source]</a>  </h3>
313   Return a printable representation.
314   <dl><dt></dt><dd>
315   </dd></dl>
316 </td></tr></table>
317
318 <a name="getfirst"></a>
319 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
320   <h3><span class="sig"><span class="sig-name">getfirst</span>(<span class=sig-arg>self</span>,
321           <span class=sig-arg>key</span>,
322           <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>
323  <a href="source/cgi-module.html#576" class="source">[source]</a>  </h3>
324   Return the first value received.
325   <dl><dt></dt><dd>
326   </dd></dl>
327 </td></tr></table>
328
329 <a name="getlist"></a>
330 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
331   <h3><span class="sig"><span class="sig-name">getlist</span>(<span class=sig-arg>self</span>,
332           <span class=sig-arg>key</span>)</span>
333  <a href="source/cgi-module.html#587" class="source">[source]</a>  </h3>
334   Return list of received values.
335   <dl><dt></dt><dd>
336   </dd></dl>
337 </td></tr></table>
338
339 <a name="getvalue"></a>
340 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
341   <h3><span class="sig"><span class="sig-name">getvalue</span>(<span class=sig-arg>self</span>,
342           <span class=sig-arg>key</span>,
343           <span class=sig-arg>default</span>=<span class=sig-default>None</span>)</span>
344  <a href="source/cgi-module.html#565" class="source">[source]</a>  </h3>
345   Dictionary style get() method, including 'value' lookup.
346   <dl><dt></dt><dd>
347   </dd></dl>
348 </td></tr></table>
349
350 <a name="has_key"></a>
351 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
352   <h3><span class="sig"><span class="sig-name">has_key</span>(<span class=sig-arg>self</span>,
353           <span class=sig-arg>key</span>)</span>
354  <a href="source/cgi-module.html#607" class="source">[source]</a>  </h3>
355   Dictionary style has_key() method.
356   <dl><dt></dt><dd>
357   </dd></dl>
358 </td></tr></table>
359
360 <a name="keys"></a>
361 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
362   <h3><span class="sig"><span class="sig-name">keys</span>(<span class=sig-arg>self</span>)</span>
363  <a href="source/cgi-module.html#598" class="source">[source]</a>  </h3>
364   Dictionary style keys() method.
365   <dl><dt></dt><dd>
366   </dd></dl>
367 </td></tr></table>
368
369 <a name="make_file"></a>
370 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
371   <h3><span class="sig"><span class="sig-name">make_file</span>(<span class=sig-arg>self</span>,
372           <span class=sig-arg>binary</span>=<span class=sig-default>None</span>)</span>
373  <a href="source/cgi-module.html#751" class="source">[source]</a>  </h3>
374 <pre class="literalblock">
375 Overridable: return a readable &amp; writable file.
376
377 The file will be used as follows:
378 - data is written to it
379 - seek(0)
380 - data is read from it
381
382 The 'binary' argument is unused -- the file is always opened
383 in binary mode.
384
385 This version opens a temporary file for reading and writing,
386 and immediately deletes (unlinks) it.  The trick (on Unix!) is
387 that the file can still be used, but it can't be opened by
388 another process, and it will automatically be deleted when it
389 is closed or when the current process terminates.
390
391 If you want a more permanent file, you derive a class which
392 overrides this method.  If you want a visible temporary file
393 that is nevertheless automatically deleted when the script
394 terminates, try defining a __del__ method in a derived class
395 which unlinks the temporary files you have created.
396 </pre>
397   <dl><dt></dt><dd>
398   </dd></dl>
399 </td></tr></table>
400
401 <a name="read_binary"></a>
402 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
403   <h3><span class="sig"><span class="sig-name">read_binary</span>(<span class=sig-arg>self</span>)</span>
404  <a href="source/cgi-module.html#666" class="source">[source]</a>  </h3>
405   Internal: read binary data.
406   <dl><dt></dt><dd>
407   </dd></dl>
408 </td></tr></table>
409
410 <a name="read_lines"></a>
411 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
412   <h3><span class="sig"><span class="sig-name">read_lines</span>(<span class=sig-arg>self</span>)</span>
413  <a href="source/cgi-module.html#679" class="source">[source]</a>  </h3>
414   Internal: read lines until EOF or outerboundary.
415   <dl><dt></dt><dd>
416   </dd></dl>
417 </td></tr></table>
418
419 <a name="read_lines_to_eof"></a>
420 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
421   <h3><span class="sig"><span class="sig-name">read_lines_to_eof</span>(<span class=sig-arg>self</span>)</span>
422  <a href="source/cgi-module.html#695" class="source">[source]</a>  </h3>
423   Internal: read lines until EOF.
424   <dl><dt></dt><dd>
425   </dd></dl>
426 </td></tr></table>
427
428 <a name="read_lines_to_outerboundary"></a>
429 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
430   <h3><span class="sig"><span class="sig-name">read_lines_to_outerboundary</span>(<span class=sig-arg>self</span>)</span>
431  <a href="source/cgi-module.html#704" class="source">[source]</a>  </h3>
432   Internal: read lines until outerboundary.
433   <dl><dt></dt><dd>
434   </dd></dl>
435 </td></tr></table>
436
437 <a name="read_multi"></a>
438 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
439   <h3><span class="sig"><span class="sig-name">read_multi</span>(<span class=sig-arg>self</span>,
440           <span class=sig-arg>environ</span>,
441           <span class=sig-arg>keep_blank_values</span>,
442           <span class=sig-arg>strict_parsing</span>)</span>
443  <a href="source/cgi-module.html#638" class="source">[source]</a>  </h3>
444   Internal: read a part that is itself multipart.
445   <dl><dt></dt><dd>
446   </dd></dl>
447 </td></tr></table>
448
449 <a name="read_single"></a>
450 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
451   <h3><span class="sig"><span class="sig-name">read_single</span>(<span class=sig-arg>self</span>)</span>
452  <a href="source/cgi-module.html#655" class="source">[source]</a>  </h3>
453   Internal: read an atomic part.
454   <dl><dt></dt><dd>
455   </dd></dl>
456 </td></tr></table>
457
458 <a name="read_urlencoded"></a>
459 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
460   <h3><span class="sig"><span class="sig-name">read_urlencoded</span>(<span class=sig-arg>self</span>)</span>
461  <a href="source/cgi-module.html#627" class="source">[source]</a>  </h3>
462   Internal: read data in query string format.
463   <dl><dt></dt><dd>
464   </dd></dl>
465 </td></tr></table>
466
467 <a name="skip_lines"></a>
468 <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
469   <h3><span class="sig"><span class="sig-name">skip_lines</span>(<span class=sig-arg>self</span>)</span>
470  <a href="source/cgi-module.html#732" class="source">[source]</a>  </h3>
471   Internal: skip lines until outer boundary if defined.
472   <dl><dt></dt><dd>
473   </dd></dl>
474 </td></tr></table>
475 <br />
476
477
478 <!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
479 <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
480 <tr bgcolor="#70b0f0" class="details">
481   <th colspan="2">Class Variable Details</th></tr>
482 </table>
483 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
484 <a name="bufsize"></a>
485 <h3>bufsize</h3>
486 <dl>
487   <dt></dt>
488   <dd>
489     <dl>
490       <dt><b>Type:</b></dt>
491       <dd>
492           <code>int</code>
493
494       </dd>
495 <span title="8192">      <dt><b>Value:</b></dt>
496       <dd><table><tr><td>
497 <pre class="variable">
498 8192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</pre>
499         </td></tr></table></dd>
500 </span>    </dl>
501   </dd>
502 </dl></td></tr></table>
503 <table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
504 <a name="FieldStorageClass"></a>
505 <h3>FieldStorageClass</h3>
506 <dl>
507   <dt></dt>
508   <dd>
509     <dl>
510       <dt><b>Type:</b></dt>
511       <dd>
512           <code>NoneType</code>
513
514       </dd>
515 <span title="None">      <dt><b>Value:</b></dt>
516       <dd><table><tr><td>