Store a sequence of fields, reading multipart/form-data.
This class provides naming, typing, files stored on disk, and more. At the top level, it is accessible like a dictionary, whose keys are the field names. (Note: None can occur as a field name.) The items are either a Python list (if there's multiple values) or another FieldStorage or MiniFieldStorage object. If it's a single object, it has the following attributes:
name: the field name, if specified; otherwise None
filename: the filename, if specified; otherwise None; this is the client side filename, not the file name on which it is stored (that's a temporary file you don't deal with)
value: the value as a string; for file uploads, this transparently reads the file every time you request the value
file: the file(-like) object from which you can read the data; None if the data is stored a simple string
type: the content-type, or None if not specified
type_options: dictionary of options specified on the content-type line
disposition: content-disposition, or None if not specified
disposition_options: dictionary of corresponding options
headers: a dictionary(-like) object (sometimes rfc822.Message or a subclass thereof) containing all headers
The class is subclassable, mostly for the purpose of overriding the make_file() method, which is called internally to come up with a file open for reading and writing. This makes it possible to override the default choice of storing all files in a temporary directory and unlinking them as soon as they have been opened.
There are no base classes.
There are no implemented interfaces.
FieldStorageClass
(type: NoneType
)
None
bufsize
(type:
int
)
8192
getfirst(key, default=None)
Return the first value received.
getlist(key)
Return list of received values.
getvalue(key, default=None)
Dictionary style get() method, including value
lookup.
has_key(key)
Dictionary style has_key() method.
keys()
Dictionary style keys() method.
make_file(binary=None)
Overridable: return a readable & writable file.
The file will be used as follows: - data is written to it - seek(0) - data is read from it
binary
argument is unusedThis version opens a temporary file for reading and writing, and immediately deletes (unlinks) it. The trick (on Unix!) is that the file can still be used, but it can't be opened by another process, and it will automatically be deleted when it is closed or when the current process terminates.
If you want a more permanent file, you derive a class which overrides this method. If you want a visible temporary file that is nevertheless automatically deleted when the script terminates, try defining a __del__ method in a derived class which unlinks the temporary files you have created.
read_binary()
Internal: read binary data.
read_lines()
Internal: read lines until EOF or outerboundary.
read_lines_to_eof()
Internal: read lines until EOF.
read_lines_to_outerboundary()
Internal: read lines until outerboundary.
read_multi(environ, keep_blank_values, strict_parsing)
Internal: read a part that is itself multipart.
read_single()
Internal: read an atomic part.
read_urlencoded()
Internal: read data in query string format.
skip_lines()
Internal: skip lines until outer boundary if defined.