cgi (version 2.5)
index
/usr/lib/python2.1/cgi.py

Support module for CGI (Common Gateway Interface) scripts.
 
This module defines a number of utilities for use by CGI scripts
written in Python.

 
Modules
            
UserDict
mimetools
os
rfc822
sys
urllib

 
Classes
            
FieldStorage
MiniFieldStorage
UserDict.UserDict
FormContentDict
FormContent
SvFormContentDict
InterpFormContentDict

 
class FieldStorage
      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
 
/get.cgi/ 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.
 
  
__getattr__(self, name)
__getitem__(self, key)
Dictionary style indexing.
__init__(self, fp=None, headers=None, outerboundary='', environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''}, keep_blank_values=0, strict_parsing=0)
Constructor.  Read multipart/* until last part.
 
Arguments, all optional:
 
fp              : file pointer; default: sys.stdin
    (not used when the request method is GET)
 
headers         : header dictionary-like object; default:
    taken from environ as per CGI spec
 
outerboundary   : terminating multipart boundary
    (for internal use only)
 
environ         : environment dictionary; default: os.environ
 
keep_blank_values: flag indicating whether blank values in
    URL encoded forms 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.
 
strict_parsing: flag indicating what to do with parsing errors.
    If false (the default), errors are silently ignored.
    If true, errors raise a ValueError exception.
__len__(self)
Dictionary style len(x) support.
__repr__(self)
Return a printable representation.
getvalue(self, key, default=None)
Dictionary style get() method, including 'value' lookup.
has_key(self, key)
Dictionary style has_key() method.
keys(self)
Dictionary style keys() method.
make_file(self, 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
 
The 'binary' argument is unused -- the file is always opened
in binary mode.
 
This 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(self)
Internal: read binary data.
read_lines(self)
Internal: read lines until EOF or outerboundary.
read_lines_to_eof(self)
Internal: read lines until EOF.
read_lines_to_outerboundary(self)
Internal: read lines until outerboundary.
read_multi(self, environ, keep_blank_values, strict_parsing)
Internal: read a part that is itself multipart.
read_single(self)
Internal: read an atomic part.
read_urlencoded(self)
Internal: read data in query string format.
skip_lines(self)
Internal: skip lines until outer boundary if defined.

 
class FormContent(FormContentDict)
      This class is present for backwards compatibility only.
 
  
__cmp__(self, dict) from UserDict.UserDict
__delitem__(self, key) from UserDict.UserDict
__getitem__(self, key) from UserDict.UserDict
__init__(self, environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''}) from FormContentDict
__len__(self) from UserDict.UserDict
__repr__(self) from UserDict.UserDict
__setitem__(self, key, item) from UserDict.UserDict
clear(self) from UserDict.UserDict
copy(self) from UserDict.UserDict
get(self, key, failobj=None) from UserDict.UserDict
has_key(self, key) from UserDict.UserDict
indexed_value(self, key, location)
items(self) from UserDict.UserDict
keys(self) from UserDict.UserDict
length(self, key)
pars(self)
popitem(self) from UserDict.UserDict
setdefault(self, key, failobj=None) from UserDict.UserDict
stripped(self, key)
update(self, dict) from UserDict.UserDict
value(self, key)
values(self, key)

 
class FormContentDict(UserDict.UserDict)
      Form content as dictionary with a list of values per field.
 
form = FormContentDict()
 
form[key] -> [value, value, ...]
form.has_key(key) -> Boolean
form.keys() -> [key, key, ...]
form.values() -> [[val, val, ...], [val, val, ...], ...]
form.items() ->  [(key, [val, val, ...]), (key, [val, val, ...]), ...]
form.dict == {key: [val, val, ...], ...}
 
  
__cmp__(self, dict) from UserDict.UserDict
__delitem__(self, key) from UserDict.UserDict
__getitem__(self, key) from UserDict.UserDict
__init__(self, environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''})
__len__(self) from UserDict.UserDict
__repr__(self) from UserDict.UserDict
__setitem__(self, key, item) from UserDict.UserDict
clear(self) from UserDict.UserDict
copy(self) from UserDict.UserDict
get(self, key, failobj=None) from UserDict.UserDict
has_key(self, key) from UserDict.UserDict
items(self) from UserDict.UserDict
keys(self) from UserDict.UserDict
popitem(self) from UserDict.UserDict
setdefault(self, key, failobj=None) from UserDict.UserDict
update(self, dict) from UserDict.UserDict
values(self) from UserDict.UserDict

 
class InterpFormContentDict(SvFormContentDict)
      This class is present for backwards compatibility only.
 
  
__cmp__(self, dict) from UserDict.UserDict
__delitem__(self, key) from UserDict.UserDict
__getitem__(self, key)
__init__(self, environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''}) from FormContentDict
__len__(self) from UserDict.UserDict
__repr__(self) from UserDict.UserDict
__setitem__(self, key, item) from UserDict.UserDict
clear(self) from UserDict.UserDict
copy(self) from UserDict.UserDict
get(self, key, failobj=None) from UserDict.UserDict
getlist(self, key) from SvFormContentDict
has_key(self, key) from UserDict.UserDict
items(self)
keys(self) from UserDict.UserDict
popitem(self) from UserDict.UserDict
setdefault(self, key, failobj=None) from UserDict.UserDict
update(self, dict) from UserDict.UserDict
values(self)

 
class MiniFieldStorage
      Like FieldStorage, for use when no file uploads are possible.
 
  
__init__(self, name, value)
Constructor from field name and value.
__repr__(self)
Return printable representation.

 
class SvFormContentDict(FormContentDict)
      Form content as dictionary expecting a single value per field.
 
If you only expect a single value for each field, then form[key]
will return that single value.  It will raise an IndexError if
that expectation is not true.  If you expect a field to have
possible multiple values, than you can use form.getlist(key) to
get all of the values.  values() and items() are a compromise:
they return single strings where there is a single value, and
lists of strings otherwise.
 
  
__cmp__(self, dict) from UserDict.UserDict
__delitem__(self, key) from UserDict.UserDict
__getitem__(self, key)
__init__(self, environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''}) from FormContentDict
__len__(self) from UserDict.UserDict
__repr__(self) from UserDict.UserDict
__setitem__(self, key, item) from UserDict.UserDict
clear(self) from UserDict.UserDict
copy(self) from UserDict.UserDict
get(self, key, failobj=None) from UserDict.UserDict
getlist(self, key)
has_key(self, key) from UserDict.UserDict
items(self)
keys(self) from UserDict.UserDict
popitem(self) from UserDict.UserDict
setdefault(self, key, failobj=None) from UserDict.UserDict
update(self, dict) from UserDict.UserDict
values(self)

 
Functions
            
dolog(fmt, *args)
Write a log message to the log file.  See initlog() for docs.
escape(s, quote=None)
Replace special characters '&', '<' and '>' by SGML entities.
initlog(*allargs)
Write a log message, if there is a log file.
 
Even though this function is called initlog(), you should always
use log(); log is a variable that is set either to initlog
(initially), to dolog (once the log file has been opened), or to
nolog (when logging is disabled).
 
The first argument is a format string; the remaining arguments (if
any) are arguments to the % operator, so e.g.
    log("%s: %s", "a", "b")
will write "a: b" to the log file, followed by a newline.
 
If the global logfp is not None, it should be a file object to
which log data is written.
 
If the global logfp is None, the global logfile may be a string
giving a filename to open, in append mode.  This file should be
world writable!!!  If the file can't be opened, logging is
silently disabled (since there is no safe place where we could
send an error message).
log = initlog(*allargs)
Write a log message, if there is a log file.
 
Even though this function is called initlog(), you should always
use log(); log is a variable that is set either to initlog
(initially), to dolog (once the log file has been opened), or to
nolog (when logging is disabled).
 
The first argument is a format string; the remaining arguments (if
any) are arguments to the % operator, so e.g.
    log("%s: %s", "a", "b")
will write "a: b" to the log file, followed by a newline.
 
If the global logfp is not None, it should be a file object to
which log data is written.
 
If the global logfp is None, the global logfile may be a string
giving a filename to open, in append mode.  This file should be
world writable!!!  If the file can't be opened, logging is
silently disabled (since there is no safe place where we could
send an error message).
nolog(*allargs)
Dummy function, assigned to log when logging is disabled.
parse(fp=None, environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''}, keep_blank_values=0, strict_parsing=0)
Parse a query in the environment or from a file (default stdin)
 
Arguments, all optional:
 
fp              : file pointer; default: sys.stdin
 
environ         : environment dictionary; default: os.environ
 
keep_blank_values: flag indicating whether blank values in
    URL encoded forms 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.
 
strict_parsing: flag indicating what to do with parsing errors.
    If false (the default), errors are silently ignored.
    If true, errors raise a ValueError exception.
parse_header(line)
Parse a Content-type like header.
 
Return the main content-type and a dictionary of options.
parse_multipart(fp, pdict)
Parse multipart input.
 
Arguments:
fp   : input file
pdict: dictionary containing other parameters of conten-type header
 
Returns a dictionary just like parse_qs(): keys are the field names, each
value is a list of values for that field.  This is easy to use but not
much good if you are expecting megabytes to be uploaded -- in that case,
use the FieldStorage class instead which is much more flexible.  Note
that content-type is the raw, unparsed contents of the content-type
header.
 
XXX This does not parse nested multipart parts -- use FieldStorage for
that.
 
XXX This should really be subsumed by FieldStorage altogether -- no
point in having two implementations of the same parsing algorithm.
parse_qs(qs, keep_blank_values=0, strict_parsing=0)
Parse a query given as a string argument.
 
Arguments:
 
qs: URL-encoded query string to be parsed
 
keep_blank_values: 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.
 
strict_parsing: flag indicating what to do with parsing errors.
    If false (the default), errors are silently ignored.
    If true, errors raise a ValueError exception.
parse_qsl(qs, keep_blank_values=0, strict_parsing=0)
Parse a query given as a string argument.
 
Arguments:
 
qs: URL-encoded query string to be parsed
 
keep_blank_values: 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.
 
strict_parsing: flag indicating what to do with parsing errors. If
    false (the default), errors are silently ignored. If true,
    errors raise a ValueError exception.
 
Returns a list, as G-d intended.
print_arguments()
print_directory()
Dump the current directory as HTML.
print_environ(environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''})
Dump the shell environment as HTML.
print_environ_usage()
Dump a list of environment variables used by CGI as HTML.
print_exception(type=None, value=None, tb=None, limit=None)
print_form(form)
Dump the contents of a form as HTML.
test(environ={'MACHTYPE': 'i386-redhat-linux-gnu', 'MAIL': '/..._COLORS': '', 'HISTSIZE': '1000', 'USERNAME': ''})
Robust test CGI script, usable as main program.
 
Write minimal HTTP headers and dump all information provided to
the script in HTML form.

 
Data
             __all__ = ['MiniFieldStorage', 'FieldStorage', 'FormContentDict', 'SvFormContentDict', 'InterpFormContentDict', 'FormContent', 'parse', 'parse_qs', 'parse_qsl', 'parse_multipart', 'parse_header', 'print_exception', 'print_environ', 'print_form', 'print_directory', 'print_arguments', 'print_environ_usage', 'escape']
__file__ = '/usr/lib/python2.1/cgi.pyc'
__name__ = 'cgi'
__version__ = '2.5'
logfile = ''
logfp = None
maxlen = 0