Table of Contents

Class: FieldStorage Zope-2.2.1-src/lib/python/ZPublisher/cgi.py

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.

Methods   
__getattr__
__getitem__
__init__
__len__
__repr__
has_key
keys
make_file
read_binary
read_lines
read_lines_to_eof
read_lines_to_outerboundary
read_multi
read_single
read_urlencoded
skip_lines
  __getattr__ 
__getattr__ ( self,  name )

Exceptions   
AttributeError
  __getitem__ 
__getitem__ ( self,  key )

Dictionary style indexing.

Exceptions   
KeyError
TypeError
  __init__ 
__init__ (
        self,
        fp=None,
        headers=None,
        outerboundary='',
        environ=os.environ,
        keep_blank_values=0,
        strict_parsing=0,
        )

  1. 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 inicates 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.

Exceptions   
ValueError
  __len__ 
__len__ ( self )

Dictionary style len(x) support.

  __repr__ 
__repr__ ( self )

Return a printable representation.

  has_key 
has_key ( self,  key )

Dictionary style has_key() method.

Exceptions   
TypeError
  keys 
keys ( self )

Dictionary style keys() method.

Exceptions   
TypeError
  make_file 
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 
read_binary ( self )

Internal: read binary data.

  read_lines 
read_lines ( self )

Internal: read lines until EOF or outerboundary.

  read_lines_to_eof 
read_lines_to_eof ( self )

Internal: read lines until EOF.

  read_lines_to_outerboundary 
read_lines_to_outerboundary ( self )

Internal: read lines until outerboundary.

  read_multi 
read_multi (
        self,
        environ,
        keep_blank_values,
        strict_parsing,
        )

Internal: read a part that is itself multipart.

  read_single 
read_single ( self )

Internal: read an atomic part.

  read_urlencoded 
read_urlencoded ( self )

Internal: read data in query string format.

  skip_lines 
skip_lines ( self )

Internal: skip lines until outer boundary if defined.


Table of Contents

This document was automatically generated on Mon Sep 4 07:33:06 2000 by HappyDoc version r0_6