cpython-lru_cache-weakref: Lib/cgi.py annotate

annotate Lib/cgi.py @ 4566:6403c94de50d legacy-trunk

Added safeguard against failure in __del__.

author	Guido van Rossum <guido@python.org>
date	Wed, 27 Nov 1996 19:39:58 +0000
parents	d90d7b541ada
children	73758db2f464

rev	line source
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1 #!/usr/local/bin/python
3106 c41a8e501973 handle missing QUERY_STRING Guido van Rossum <guido@python.org> parents: 2918 diff changeset	2
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	3 """Support module for CGI (Common Gateway Interface) scripts.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	4
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	5 This module defines a number of utilities for use by CGI scripts
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	6 written in Python.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	7
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	8
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	9 Introduction
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	10 ------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	11
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	12 A CGI script is invoked by an HTTP server, usually to process user
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	13 input submitted through an HTML <FORM> or <ISINPUT> element.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	14
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	15 Most often, CGI scripts live in the server's special cgi-bin
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	16 directory. The HTTP server places all sorts of information about the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	17 request (such as the client's hostname, the requested URL, the query
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	18 string, and lots of other goodies) in the script's shell environment,
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	19 executes the script, and sends the script's output back to the client.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	20
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	21 The script's input is connected to the client too, and sometimes the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	22 form data is read this way; at other times the form data is passed via
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	23 the "query string" part of the URL. This module (cgi.py) is intended
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	24 to take care of the different cases and provide a simpler interface to
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	25 the Python script. It also provides a number of utilities that help
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	26 in debugging scripts, and the latest addition is support for file
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	27 uploads from a form (if your browser supports it -- Grail 0.3 and
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	28 Netscape 2.0 do).
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	29
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	30 The output of a CGI script should consist of two sections, separated
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	31 by a blank line. The first section contains a number of headers,
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	32 telling the client what kind of data is following. Python code to
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	33 generate a minimal header section looks like this:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	34
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	35 print "Content-type: text/html" # HTML is following
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	36 print # blank line, end of headers
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	37
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	38 The second section is usually HTML, which allows the client software
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	39 to display nicely formatted text with header, in-line images, etc.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	40 Here's Python code that prints a simple piece of HTML:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	41
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	42 print "<TITLE>CGI script output</TITLE>"
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	43 print "<H1>This is my first CGI script</H1>"
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	44 print "Hello, world!"
3106 c41a8e501973 handle missing QUERY_STRING Guido van Rossum <guido@python.org> parents: 2918 diff changeset	45
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	46 (It may not be fully legal HTML according to the letter of the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	47 standard, but any browser will understand it.)
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	48
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	49
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	50 Using the cgi module
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	51 --------------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	52
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	53 Begin by writing "import cgi". Don't use "from cgi import *" -- the
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	54 module defines all sorts of names for its own use or for backward
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	55 compatibility that you don't want in your namespace.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	56
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	57 It's best to use the FieldStorage class. The other classes define in this
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	58 module are provided mostly for backward compatibility. Instantiate it
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	59 exactly once, without arguments. This reads the form contents from
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	60 standard input or the environment (depending on the value of various
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	61 environment variables set according to the CGI standard). Since it may
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	62 consume standard input, it should be instantiated only once.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	63
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	64 The FieldStorage instance can be accessed as if it were a Python
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	65 dictionary. For instance, the following code (which assumes that the
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	66 Content-type header and blank line have already been printed) checks that
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	67 the fields "name" and "addr" are both set to a non-empty string:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	68
3629 e54d39107249 capitalize H3 headers; add 'cgi.' prefix to example code Guido van Rossum <guido@python.org> parents: 3451 diff changeset	69 form = cgi.FieldStorage()
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	70 form_ok = 0
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	71 if form.has_key("name") and form.has_key("addr"):
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	72 if form["name"].value != "" and form["addr"].value != "":
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	73 form_ok = 1
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	74 if not form_ok:
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	75 print "<H1>Error</H1>"
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	76 print "Please fill in the name and addr fields."
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	77 return
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	78 ...further form processing here...
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	79
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	80 Here the fields, accessed through form[key], are themselves instances
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	81 of FieldStorage (or MiniFieldStorage, depending on the form encoding).
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	82
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	83 If the submitted form data contains more than one field with the same
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	84 name, the object retrieved by form[key] is not a (Mini)FieldStorage
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	85 instance but a list of such instances. If you expect this possibility
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	86 (i.e., when your HTML form comtains multiple fields with the same
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	87 name), use the type() function to determine whether you have a single
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	88 instance or a list of instances. For example, here's code that
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	89 concatenates any number of username fields, separated by commas:
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	90
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	91 username = form["username"]
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	92 if type(username) is type([]):
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	93 # Multiple username fields specified
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	94 usernames = ""
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	95 for item in username:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	96 if usernames:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	97 # Next item -- insert comma
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	98 usernames = usernames + "," + item.value
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	99 else:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	100 # First item -- don't insert comma
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	101 usernames = item.value
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	102 else:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	103 # Single username field specified
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	104 usernames = username.value
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	105
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	106 If a field represents an uploaded file, the value attribute reads the
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	107 entire file in memory as a string. This may not be what you want. You can
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	108 test for an uploaded file by testing either the filename attribute or the
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	109 file attribute. You can then read the data at leasure from the file
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	110 attribute:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	111
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	112 fileitem = form["userfile"]
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	113 if fileitem.file:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	114 # It's an uploaded file; count lines
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	115 linecount = 0
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	116 while 1:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	117 line = fileitem.file.readline()
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	118 if not line: break
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	119 linecount = linecount + 1
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	120
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	121 The file upload draft standard entertains the possibility of uploading
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	122 multiple files from one field (using a recursive multipart/*
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	123 encoding). When this occurs, the item will be a dictionary-like
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	124 FieldStorage item. This can be determined by testing its type
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	125 attribute, which should have the value "multipart/form-data" (or
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	126 perhaps another string beginning with "multipart/"). It this case, it
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	127 can be iterated over recursively just like the top-level form object.
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	128
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	129 When a form is submitted in the "old" format (as the query string or as a
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	130 single data part of type application/x-www-form-urlencoded), the items
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	131 will actually be instances of the class MiniFieldStorage. In this case,
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	132 the list, file and filename attributes are always None.
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	133
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	134
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	135 Old classes
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	136 -----------
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	137
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	138 These classes, present in earlier versions of the cgi module, are still
4486 3d43510b5e19 Fix truncated paragraph in doc string. Guido van Rossum <guido@python.org> parents: 4214 diff changeset	139 supported for backward compatibility. New applications should use the
3d43510b5e19 Fix truncated paragraph in doc string. Guido van Rossum <guido@python.org> parents: 4214 diff changeset	140 FieldStorage class.
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	141
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	142 SvFormContentDict: single value form content as dictionary; assumes each
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	143 field name occurs in the form only once.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	144
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	145 FormContentDict: multiple value form content as dictionary (the form
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	146 items are lists of values). Useful if your form contains multiple
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	147 fields with the same name.
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	148
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	149 Other classes (FormContent, InterpFormContentDict) are present for
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	150 backwards compatibility with really old applications only. If you still
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	151 use these and would be inconvenienced when they disappeared from a next
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	152 version of this module, drop me a note.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	153
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	154
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	155 Functions
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	156 ---------
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	157
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	158 These are useful if you want more control, or if you want to employ
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	159 some of the algorithms implemented in this module in other
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	160 circumstances.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	161
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	162 parse(fp, [environ, [keep_blank_values, [strict_parsing]]]): parse a
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	163 form into a Python dictionary.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	164
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	165 parse_qs(qs, [keep_blank_values, [strict_parsing]]): parse a query
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	166 string (data of type application/x-www-form-urlencoded).
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	167
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	168 parse_multipart(fp, pdict): parse input of type multipart/form-data (for
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	169 file uploads).
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	170
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	171 parse_header(string): parse a header like Content-type into a main
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	172 value and a dictionary of parameters.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	173
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	174 test(): complete test program.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	175
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	176 print_environ(): format the shell environment in HTML.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	177
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	178 print_form(form): format a form in HTML.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	179
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	180 print_environ_usage(): print a list of useful environment variables in
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	181 HTML.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	182
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	183 escape(): convert the characters "&", "<" and ">" to HTML-safe
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	184 sequences. Use this if you need to display text that might contain
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	185 such characters in HTML. To translate URLs for inclusion in the HREF
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	186 attribute of an <A> tag, use urllib.quote().
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	187
4214 688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	188 log(fmt, ...): write a line to a log file; see docs for initlog().
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	189
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	190
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	191 Caring about security
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	192 ---------------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	193
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	194 There's one important rule: if you invoke an external program (e.g.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	195 via the os.system() or os.popen() functions), make very sure you don't
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	196 pass arbitrary strings received from the client to the shell. This is
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	197 a well-known security hole whereby clever hackers anywhere on the web
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	198 can exploit a gullible CGI script to invoke arbitrary shell commands.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	199 Even parts of the URL or field names cannot be trusted, since the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	200 request doesn't have to come from your form!
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	201
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	202 To be on the safe side, if you must pass a string gotten from a form
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	203 to a shell command, you should make sure the string contains only
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	204 alphanumeric characters, dashes, underscores, and periods.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	205
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	206
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	207 Installing your CGI script on a Unix system
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	208 -------------------------------------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	209
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	210 Read the documentation for your HTTP server and check with your local
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	211 system administrator to find the directory where CGI scripts should be
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	212 installed; usually this is in a directory cgi-bin in the server tree.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	213
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	214 Make sure that your script is readable and executable by "others"; the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	215 Unix file mode should be 755 (use "chmod 755 filename"). Make sure
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	216 that the first line of the script contains "#!" starting in column 1
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	217 followed by the pathname of the Python interpreter, for instance:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	218
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	219 #!/usr/local/bin/python
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	220
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	221 Make sure the Python interpreter exists and is executable by "others".
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	222
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	223 Make sure that any files your script needs to read or write are
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	224 readable or writable, respectively, by "others" -- their mode should
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	225 be 644 for readable and 666 for writable. This is because, for
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	226 security reasons, the HTTP server executes your script as user
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	227 "nobody", without any special privileges. It can only read (write,
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	228 execute) files that everybody can read (write, execute). The current
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	229 directory at execution time is also different (it is usually the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	230 server's cgi-bin directory) and the set of environment variables is
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	231 also different from what you get at login. in particular, don't count
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	232 on the shell's search path for executables ($PATH) or the Python
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	233 module search path ($PYTHONPATH) to be set to anything interesting.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	234
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	235 If you need to load modules from a directory which is not on Python's
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	236 default module search path, you can change the path in your script,
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	237 before importing other modules, e.g.:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	238
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	239 import sys
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	240 sys.path.insert(0, "/usr/home/joe/lib/python")
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	241 sys.path.insert(0, "/usr/local/lib/python")
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	242
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	243 (This way, the directory inserted last will be searched first!)
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	244
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	245 Instructions for non-Unix systems will vary; check your HTTP server's
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	246 documentation (it will usually have a section on CGI scripts).
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	247
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	248
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	249 Testing your CGI script
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	250 -----------------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	251
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	252 Unfortunately, a CGI script will generally not run when you try it
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	253 from the command line, and a script that works perfectly from the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	254 command line may fail mysteriously when run from the server. There's
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	255 one reason why you should still test your script from the command
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	256 line: if it contains a syntax error, the python interpreter won't
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	257 execute it at all, and the HTTP server will most likely send a cryptic
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	258 error to the client.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	259
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	260 Assuming your script has no syntax errors, yet it does not work, you
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	261 have no choice but to read the next section:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	262
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	263
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	264 Debugging CGI scripts
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	265 ---------------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	266
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	267 First of all, check for trivial installation errors -- reading the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	268 section above on installing your CGI script carefully can save you a
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	269 lot of time. If you wonder whether you have understood the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	270 installation procedure correctly, try installing a copy of this module
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	271 file (cgi.py) as a CGI script. When invoked as a script, the file
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	272 will dump its environment and the contents of the form in HTML form.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	273 Give it the right mode etc, and send it a request. If it's installed
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	274 in the standard cgi-bin directory, it should be possible to send it a
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	275 request by entering a URL into your browser of the form:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	276
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	277 http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	278
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	279 If this gives an error of type 404, the server cannot find the script
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	280 -- perhaps you need to install it in a different directory. If it
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	281 gives another error (e.g. 500), there's an installation problem that
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	282 you should fix before trying to go any further. If you get a nicely
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	283 formatted listing of the environment and form content (in this
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	284 example, the fields should be listed as "addr" with value "At Home"
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	285 and "name" with value "Joe Blow"), the cgi.py script has been
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	286 installed correctly. If you follow the same procedure for your own
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	287 script, you should now be able to debug it.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	288
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	289 The next step could be to call the cgi module's test() function from
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	290 your script: replace its main code with the single statement
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	291
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	292 cgi.test()
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	293
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	294 This should produce the same results as those gotten from installing
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	295 the cgi.py file itself.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	296
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	297 When an ordinary Python script raises an unhandled exception
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	298 (e.g. because of a typo in a module name, a file that can't be opened,
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	299 etc.), the Python interpreter prints a nice traceback and exits.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	300 While the Python interpreter will still do this when your CGI script
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	301 raises an exception, most likely the traceback will end up in one of
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	302 the HTTP server's log file, or be discarded altogether.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	303
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	304 Fortunately, once you have managed to get your script to execute
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	305 some code, it is easy to catch exceptions and cause a traceback to
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	306 be printed. The test() function below in this module is an example.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	307 Here are the rules:
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	308
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	309 1. Import the traceback module (before entering the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	310 try-except!)
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	311
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	312 2. Make sure you finish printing the headers and the blank
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	313 line early
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	314
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	315 3. Assign sys.stderr to sys.stdout
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	316
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	317 3. Wrap all remaining code in a try-except statement
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	318
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	319 4. In the except clause, call traceback.print_exc()
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	320
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	321 For example:
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	322
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	323 import sys
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	324 import traceback
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	325 print "Content-type: text/html"
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	326 print
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	327 sys.stderr = sys.stdout
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	328 try:
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	329 ...your code here...
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	330 except:
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	331 print "\n\n<PRE>"
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	332 traceback.print_exc()
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	333
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	334 Notes: The assignment to sys.stderr is needed because the traceback
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	335 prints to sys.stderr. The print "\n\n<PRE>" statement is necessary to
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	336 disable the word wrapping in HTML.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	337
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	338 If you suspect that there may be a problem in importing the traceback
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	339 module, you can use an even more robust approach (which only uses
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	340 built-in modules):
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	341
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	342 import sys
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	343 sys.stderr = sys.stdout
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	344 print "Content-type: text/plain"
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	345 print
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	346 ...your code here...
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	347
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	348 This relies on the Python interpreter to print the traceback. The
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	349 content type of the output is set to plain text, which disables all
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	350 HTML processing. If your script works, the raw HTML will be displayed
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	351 by your client. If it raises an exception, most likely after the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	352 first two lines have been printed, a traceback will be displayed.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	353 Because no HTML interpretation is going on, the traceback will
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	354 readable.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	355
4214 688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	356 When all else fails, you may want to insert calls to log() to your
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	357 program or even to a copy of the cgi.py file. Note that this requires
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	358 you to set cgi.logfile to the name of a world-writable file before the
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	359 first call to log() is made!
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	360
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	361 Good luck!
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	362
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	363
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	364 Common problems and solutions
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	365 -----------------------------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	366
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	367 - Most HTTP servers buffer the output from CGI scripts until the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	368 script is completed. This means that it is not possible to display a
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	369 progress report on the client's display while the script is running.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	370
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	371 - Check the installation instructions above.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	372
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	373 - Check the HTTP server's log files. ("tail -f logfile" in a separate
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	374 window may be useful!)
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	375
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	376 - Always check a script for syntax errors first, by doing something
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	377 like "python script.py".
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	378
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	379 - When using any of the debugging techniques, don't forget to add
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	380 "import sys" to the top of the script.
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	381
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	382 - When invoking external programs, make sure they can be found.
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	383 Usually, this means using absolute path names -- $PATH is usually not
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	384 set to a very useful value in a CGI script.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	385
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	386 - When reading or writing external files, make sure they can be read
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	387 or written by every user on the system.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	388
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	389 - Don't try to give a CGI script a set-uid mode. This doesn't work on
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	390 most systems, and is a security liability as well.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	391
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	392
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	393 History
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	394 -------
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	395
3435 f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	396 Michael McLay started this module. Steve Majewski changed the
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	397 interface to SvFormContentDict and FormContentDict. The multipart
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	398 parsing was inspired by code submitted by Andreas Paepcke. Guido van
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	399 Rossum rewrote, reformatted and documented the module and is currently
f72050dd61a9 Reformatting only. Guido van Rossum <guido@python.org> parents: 3432 diff changeset	400 responsible for its maintenance.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	401
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	402
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	403 XXX The module is getting pretty heavy with all those docstrings.
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	404 Perhaps there should be a slimmed version that doesn't contain all those
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	405 backwards compatible and debugging classes and functions?
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	406
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	407 """
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	408
4144 efebf1c4eda2 Emacs font-lock de-bogo-kludgificocity Guido van Rossum <guido@python.org> parents: 4072 diff changeset	409 # " <== Emacs font-lock de-bogo-kludgificocity
efebf1c4eda2 Emacs font-lock de-bogo-kludgificocity Guido van Rossum <guido@python.org> parents: 4072 diff changeset	410
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	411 __version__ = "2.1"
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	412
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	413
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	414 # Imports
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	415 # =======
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	416
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	417 import string
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	418 import sys
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	419 import os
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	420
4214 688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	421
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	422 # Logging support
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	423 # ===============
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	424
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	425 logfile = "" # Filename to log to, if not empty
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	426 logfp = None # File object to log to, if not None
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	427
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	428 def initlog(*allargs):
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	429 """Write a log message, if there is a log file.
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	430
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	431 Even though this function is called initlog(), you should always
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	432 use log(); log is a variable that is set either to initlog
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	433 (initially), to dolog (once the log file has been opened), or to
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	434 nolog (when logging is disabled).
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	435
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	436 The first argument is a format string; the remaining arguments (if
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	437 any) are arguments to the % operator, so e.g.
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	438 log("%s: %s", "a", "b")
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	439 will write "a: b" to the log file, followed by a newline.
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	440
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	441 If the global logfp is not None, it should be a file object to
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	442 which log data is written.
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	443
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	444 If the global logfp is None, the global logfile may be a string
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	445 giving a filename to open, in append mode. This file should be
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	446 world writable!!! If the file can't be opened, logging is
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	447 silently disabled (since there is no safe place where we could
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	448 send an error message).
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	449
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	450 """
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	451 global logfp, log
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	452 if logfile and not logfp:
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	453 try:
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	454 logfp = open(logfile, "a")
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	455 except IOError:
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	456 pass
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	457 if not logfp:
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	458 log = nolog
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	459 else:
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	460 log = dolog
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	461 apply(log, allargs)
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	462
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	463 def dolog(fmt, *args):
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	464 """Write a log message to the log file. See initlog() for docs."""
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	465 logfp.write(fmt%args + "\n")
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	466
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	467 def nolog(*allargs):
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	468 """Dummy function, assigned to log when logging is disabled."""
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	469 pass
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	470
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	471 log = initlog # The current logging function
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	472
688d566cb15b Added logging support. Guido van Rossum <guido@python.org> parents: 4213 diff changeset	473
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	474 # Parsing functions
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	475 # =================
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	476
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	477 def parse(fp=None, environ=os.environ, keep_blank_values=0, strict_parsing=0):
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	478 """Parse a query in the environment or from a file (default stdin)
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	479
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	480 Arguments, all optional:
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	481
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	482 fp : file pointer; default: sys.stdin
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	483
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	484 environ : environment dictionary; default: os.environ
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	485
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	486 keep_blank_values: flag indicating whether blank values in
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	487 URL encoded forms should be treated as blank strings.
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	488 A true value inicates that blanks should be retained as
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	489 blank strings. The default false value indicates that
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	490 blank values are to be ignored and treated as if they were
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	491 not included.
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	492
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	493 strict_parsing: flag indicating what to do with parsing errors.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	494 If false (the default), errors are silently ignored.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	495 If true, errors raise a ValueError exception.
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	496 """
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	497 if not fp:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	498 fp = sys.stdin
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	499 if not environ.has_key('REQUEST_METHOD'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	500 environ['REQUEST_METHOD'] = 'GET' # For testing stand-alone
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	501 if environ['REQUEST_METHOD'] == 'POST':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	502 ctype, pdict = parse_header(environ['CONTENT_TYPE'])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	503 if ctype == 'multipart/form-data':
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	504 return parse_multipart(fp, pdict)
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	505 elif ctype == 'application/x-www-form-urlencoded':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	506 clength = string.atoi(environ['CONTENT_LENGTH'])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	507 qs = fp.read(clength)
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	508 else:
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	509 qs = '' # Unknown content-type
3958 b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	510 if environ.has_key('QUERY_STRING'):
b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	511 if qs: qs = qs + '&'
b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	512 qs = qs + environ['QUERY_STRING']
b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	513 elif sys.argv[1:]:
b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	514 if qs: qs = qs + '&'
b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	515 qs = qs + sys.argv[1]
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	516 environ['QUERY_STRING'] = qs # XXX Shouldn't, really
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	517 elif environ.has_key('QUERY_STRING'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	518 qs = environ['QUERY_STRING']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	519 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	520 if sys.argv[1:]:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	521 qs = sys.argv[1]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	522 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	523 qs = ""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	524 environ['QUERY_STRING'] = qs # XXX Shouldn't, really
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	525 return parse_qs(qs, keep_blank_values, strict_parsing)
2918 cfa9b3a84872 added parse_qs(query_string) Guido van Rossum <guido@python.org> parents: 2538 diff changeset	526
cfa9b3a84872 added parse_qs(query_string) Guido van Rossum <guido@python.org> parents: 2538 diff changeset	527
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	528 def parse_qs(qs, keep_blank_values=0, strict_parsing=0):
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	529 """Parse a query given as a string argument.
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	530
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	531 Arguments:
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	532
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	533 qs: URL-encoded query string to be parsed
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	534
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	535 keep_blank_values: flag indicating whether blank values in
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	536 URL encoded queries should be treated as blank strings.
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	537 A true value inicates that blanks should be retained as
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	538 blank strings. The default false value indicates that
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	539 blank values are to be ignored and treated as if they were
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	540 not included.
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	541
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	542 strict_parsing: flag indicating what to do with parsing errors.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	543 If false (the default), errors are silently ignored.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	544 If true, errors raise a ValueError exception.
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	545 """
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	546 import urllib, regsub
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	547 name_value_pairs = string.splitfields(qs, '&')
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	548 dict = {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	549 for name_value in name_value_pairs:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	550 nv = string.splitfields(name_value, '=')
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	551 if len(nv) != 2:
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	552 if strict_parsing:
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	553 raise ValueError, "bad query field: %s" % `name_value`
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	554 continue
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	555 name = nv[0]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	556 value = urllib.unquote(regsub.gsub('+', ' ', nv[1]))
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	557 if len(value) or keep_blank_values:
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	558 if dict.has_key (name):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	559 dict[name].append(value)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	560 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	561 dict[name] = [value]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	562 return dict
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	563
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	564
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	565 def parse_multipart(fp, pdict):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	566 """Parse multipart input.
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	567
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	568 Arguments:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	569 fp : input file
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	570 pdict: dictionary containing other parameters of conten-type header
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	571
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	572 Returns a dictionary just like parse_qs(): keys are the field names, each
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	573 value is a list of values for that field. This is easy to use but not
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	574 much good if you are expecting megabytes to be uploaded -- in that case,
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	575 use the FieldStorage class instead which is much more flexible. Note
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	576 that content-type is the raw, unparsed contents of the content-type
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	577 header.
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	578
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	579 XXX This does not parse nested multipart parts -- use FieldStorage for
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	580 that.
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	581
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	582 XXX This should really be subsumed by FieldStorage altogether -- no
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	583 point in having two implementations of the same parsing algorithm.
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	584
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	585 """
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	586 import mimetools
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	587 if pdict.has_key('boundary'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	588 boundary = pdict['boundary']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	589 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	590 boundary = ""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	591 nextpart = "--" + boundary
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	592 lastpart = "--" + boundary + "--"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	593 partdict = {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	594 terminator = ""
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	595
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	596 while terminator != lastpart:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	597 bytes = -1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	598 data = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	599 if terminator:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	600 # At start of next part. Read headers first.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	601 headers = mimetools.Message(fp)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	602 clength = headers.getheader('content-length')
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	603 if clength:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	604 try:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	605 bytes = string.atoi(clength)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	606 except string.atoi_error:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	607 pass
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	608 if bytes > 0:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	609 data = fp.read(bytes)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	610 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	611 data = ""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	612 # Read lines until end of part.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	613 lines = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	614 while 1:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	615 line = fp.readline()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	616 if not line:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	617 terminator = lastpart # End outer loop
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	618 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	619 if line[:2] == "--":
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	620 terminator = string.strip(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	621 if terminator in (nextpart, lastpart):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	622 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	623 lines.append(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	624 # Done with part.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	625 if data is None:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	626 continue
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	627 if bytes < 0:
3797 51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	628 if lines:
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	629 # Strip final line terminator
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	630 line = lines[-1]
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	631 if line[-2:] == "\r\n":
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	632 line = line[:-2]
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	633 elif line[-1:] == "\n":
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	634 line = line[:-1]
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	635 lines[-1] = line
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	636 data = string.joinfields(lines, "")
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	637 line = headers['content-disposition']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	638 if not line:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	639 continue
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	640 key, params = parse_header(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	641 if key != 'form-data':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	642 continue
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	643 if params.has_key('name'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	644 name = params['name']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	645 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	646 continue
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	647 if partdict.has_key(name):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	648 partdict[name].append(data)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	649 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	650 partdict[name] = [data]
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	651
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	652 return partdict
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	653
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	654
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	655 def parse_header(line):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	656 """Parse a Content-type like header.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	657
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	658 Return the main content-type and a dictionary of options.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	659
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	660 """
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	661 plist = map(string.strip, string.splitfields(line, ';'))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	662 key = string.lower(plist[0])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	663 del plist[0]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	664 pdict = {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	665 for p in plist:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	666 i = string.find(p, '=')
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	667 if i >= 0:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	668 name = string.lower(string.strip(p[:i]))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	669 value = string.strip(p[i+1:])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	670 if len(value) >= 2 and value[0] == value[-1] == '"':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	671 value = value[1:-1]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	672 pdict[name] = value
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	673 return key, pdict
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	674
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	675
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	676 # Classes for field storage
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	677 # =========================
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	678
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	679 class MiniFieldStorage:
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	680
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	681 """Like FieldStorage, for use when no file uploads are possible."""
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	682
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	683 # Dummy attributes
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	684 filename = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	685 list = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	686 type = None
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	687 file = None
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	688 type_options = {}
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	689 disposition = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	690 disposition_options = {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	691 headers = {}
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	692
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	693 def __init__(self, name, value):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	694 """Constructor from field name and value."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	695 from StringIO import StringIO
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	696 self.name = name
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	697 self.value = value
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	698 # self.file = StringIO(value)
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	699
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	700 def __repr__(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	701 """Return printable representation."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	702 return "MiniFieldStorage(%s, %s)" % (`self.name`, `self.value`)
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	703
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	704
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	705 class FieldStorage:
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	706
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	707 """Store a sequence of fields, reading multipart/form-data.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	708
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	709 This class provides naming, typing, files stored on disk, and
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	710 more. At the top level, it is accessible like a dictionary, whose
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	711 keys are the field names. (Note: None can occur as a field name.)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	712 The items are either a Python list (if there's multiple values) or
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	713 another FieldStorage or MiniFieldStorage object. If it's a single
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	714 object, it has the following attributes:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	715
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	716 name: the field name, if specified; otherwise None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	717
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	718 filename: the filename, if specified; otherwise None; this is the
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	719 client side filename, not the file name on which it is
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	720 stored (that's a temporary file you don't deal with)
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	721
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	722 value: the value as a string; for file uploads, this
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	723 transparently reads the file every time you request the value
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	724
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	725 file: the file(-like) object from which you can read the data;
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	726 None if the data is stored a simple string
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	727
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	728 type: the content-type, or None if not specified
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	729
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	730 type_options: dictionary of options specified on the content-type
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	731 line
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	732
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	733 disposition: content-disposition, or None if not specified
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	734
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	735 disposition_options: dictionary of corresponding options
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	736
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	737 headers: a dictionary(-like) object (sometimes rfc822.Message or a
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	738 subclass thereof) containing all headers
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	739
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	740 The class is subclassable, mostly for the purpose of overriding
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	741 the make_file() method, which is called internally to come up with
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	742 a file open for reading and writing. This makes it possible to
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	743 override the default choice of storing all files in a temporary
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	744 directory and unlinking them as soon as they have been opened.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	745
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	746 """
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	747
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	748 def __init__(self, fp=None, headers=None, outerboundary="",
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	749 environ=os.environ, keep_blank_values=0, strict_parsing=0):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	750 """Constructor. Read multipart/* until last part.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	751
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	752 Arguments, all optional:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	753
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	754 fp : file pointer; default: sys.stdin
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	755
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	756 headers : header dictionary-like object; default:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	757 taken from environ as per CGI spec
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	758
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	759 outerboundary : terminating multipart boundary
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	760 (for internal use only)
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	761
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	762 environ : environment dictionary; default: os.environ
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	763
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	764 keep_blank_values: flag indicating whether blank values in
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	765 URL encoded forms should be treated as blank strings.
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	766 A true value inicates that blanks should be retained as
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	767 blank strings. The default false value indicates that
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	768 blank values are to be ignored and treated as if they were
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	769 not included.
d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	770
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	771 strict_parsing: flag indicating what to do with parsing errors.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	772 If false (the default), errors are silently ignored.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	773 If true, errors raise a ValueError exception.
d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	774
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	775 """
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	776 method = None
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	777 self.keep_blank_values = keep_blank_values
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	778 self.strict_parsing = strict_parsing
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	779 if environ.has_key('REQUEST_METHOD'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	780 method = string.upper(environ['REQUEST_METHOD'])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	781 if not fp and method == 'GET':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	782 qs = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	783 if environ.has_key('QUERY_STRING'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	784 qs = environ['QUERY_STRING']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	785 from StringIO import StringIO
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	786 fp = StringIO(qs or "")
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	787 if headers is None:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	788 headers = {'content-type':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	789 "application/x-www-form-urlencoded"}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	790 if headers is None:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	791 headers = {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	792 if environ.has_key('CONTENT_TYPE'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	793 headers['content-type'] = environ['CONTENT_TYPE']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	794 if environ.has_key('CONTENT_LENGTH'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	795 headers['content-length'] = environ['CONTENT_LENGTH']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	796 self.fp = fp or sys.stdin
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	797 self.headers = headers
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	798 self.outerboundary = outerboundary
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	799
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	800 # Process content-disposition header
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	801 cdisp, pdict = "", {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	802 if self.headers.has_key('content-disposition'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	803 cdisp, pdict = parse_header(self.headers['content-disposition'])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	804 self.disposition = cdisp
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	805 self.disposition_options = pdict
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	806 self.name = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	807 if pdict.has_key('name'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	808 self.name = pdict['name']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	809 self.filename = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	810 if pdict.has_key('filename'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	811 self.filename = pdict['filename']
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	812
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	813 # Process content-type header
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	814 ctype, pdict = "text/plain", {}
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	815 if self.headers.has_key('content-type'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	816 ctype, pdict = parse_header(self.headers['content-type'])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	817 self.type = ctype
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	818 self.type_options = pdict
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	819 self.innerboundary = ""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	820 if pdict.has_key('boundary'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	821 self.innerboundary = pdict['boundary']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	822 clen = -1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	823 if self.headers.has_key('content-length'):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	824 try:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	825 clen = string.atoi(self.headers['content-length'])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	826 except:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	827 pass
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	828 self.length = clen
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	829
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	830 self.list = self.file = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	831 self.done = 0
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	832 self.lines = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	833 if ctype == 'application/x-www-form-urlencoded':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	834 self.read_urlencoded()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	835 elif ctype[:10] == 'multipart/':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	836 self.read_multi()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	837 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	838 self.read_single()
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	839
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	840 def __repr__(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	841 """Return a printable representation."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	842 return "FieldStorage(%s, %s, %s)" % (
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	843 `self.name`, `self.filename`, `self.value`)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	844
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	845 def __getattr__(self, name):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	846 if name != 'value':
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	847 raise AttributeError, name
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	848 if self.file:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	849 self.file.seek(0)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	850 value = self.file.read()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	851 self.file.seek(0)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	852 elif self.list is not None:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	853 value = self.list
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	854 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	855 value = None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	856 return value
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	857
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	858 def __getitem__(self, key):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	859 """Dictionary style indexing."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	860 if self.list is None:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	861 raise TypeError, "not indexable"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	862 found = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	863 for item in self.list:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	864 if item.name == key: found.append(item)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	865 if not found:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	866 raise KeyError, key
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	867 if len(found) == 1:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	868 return found[0]
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	869 else:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	870 return found
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	871
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	872 def keys(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	873 """Dictionary style keys() method."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	874 if self.list is None:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	875 raise TypeError, "not indexable"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	876 keys = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	877 for item in self.list:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	878 if item.name not in keys: keys.append(item.name)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	879 return keys
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	880
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	881 def has_key(self, key):
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	882 """Dictionary style has_key() method."""
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	883 if self.list is None:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	884 raise TypeError, "not indexable"
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	885 for item in self.list:
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	886 if item.name == key: return 1
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	887 return 0
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	888
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	889 def read_urlencoded(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	890 """Internal: read data in query string format."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	891 qs = self.fp.read(self.length)
4534 d90d7b541ada Added 'strict_parsing' option to all parsing functions. This causes a Guido van Rossum <guido@python.org> parents: 4486 diff changeset	892 dict = parse_qs(qs, self.keep_blank_values, self.strict_parsing)
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	893 self.list = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	894 for key, valuelist in dict.items():
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	895 for value in valuelist:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	896 self.list.append(MiniFieldStorage(key, value))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	897 self.skip_lines()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	898
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	899 def read_multi(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	900 """Internal: read a part that is itself multipart."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	901 import rfc822
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	902 self.list = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	903 part = self.__class__(self.fp, {}, self.innerboundary)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	904 # Throw first part away
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	905 while not part.done:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	906 headers = rfc822.Message(self.fp)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	907 part = self.__class__(self.fp, headers, self.innerboundary)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	908 self.list.append(part)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	909 self.skip_lines()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	910
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	911 def read_single(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	912 """Internal: read an atomic part."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	913 if self.length >= 0:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	914 self.read_binary()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	915 self.skip_lines()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	916 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	917 self.read_lines()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	918 self.file.seek(0)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	919
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	920 bufsize = 8*1024 # I/O buffering size for copy to file
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	921
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	922 def read_binary(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	923 """Internal: read binary data."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	924 self.file = self.make_file('b')
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	925 todo = self.length
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	926 if todo >= 0:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	927 while todo > 0:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	928 data = self.fp.read(min(todo, self.bufsize))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	929 if not data:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	930 self.done = -1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	931 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	932 self.file.write(data)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	933 todo = todo - len(data)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	934
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	935 def read_lines(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	936 """Internal: read lines until EOF or outerboundary."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	937 self.file = self.make_file('')
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	938 if self.outerboundary:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	939 self.read_lines_to_outerboundary()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	940 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	941 self.read_lines_to_eof()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	942
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	943 def read_lines_to_eof(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	944 """Internal: read lines until EOF."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	945 while 1:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	946 line = self.fp.readline()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	947 if not line:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	948 self.done = -1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	949 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	950 self.lines.append(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	951 self.file.write(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	952
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	953 def read_lines_to_outerboundary(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	954 """Internal: read lines until outerboundary."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	955 next = "--" + self.outerboundary
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	956 last = next + "--"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	957 delim = ""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	958 while 1:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	959 line = self.fp.readline()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	960 if not line:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	961 self.done = -1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	962 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	963 self.lines.append(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	964 if line[:2] == "--":
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	965 strippedline = string.strip(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	966 if strippedline == next:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	967 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	968 if strippedline == last:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	969 self.done = 1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	970 break
4213 e31b4defad5b Fixed embarrassing logic bug in read_lines_to_outerboundary(). Guido van Rossum <guido@python.org> parents: 4144 diff changeset	971 odelim = delim
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	972 if line[-2:] == "\r\n":
3797 51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	973 delim = "\r\n"
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	974 line = line[:-2]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	975 elif line[-1] == "\n":
3797 51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	976 delim = "\n"
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	977 line = line[:-1]
3797 51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	978 else:
51a7c8fe7c7b Remove all CRLF -> LF translation for file uploads, since we cannot Guido van Rossum <guido@python.org> parents: 3794 diff changeset	979 delim = ""
4213 e31b4defad5b Fixed embarrassing logic bug in read_lines_to_outerboundary(). Guido van Rossum <guido@python.org> parents: 4144 diff changeset	980 self.file.write(odelim + line)
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	981
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	982 def skip_lines(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	983 """Internal: skip lines until outer boundary if defined."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	984 if not self.outerboundary or self.done:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	985 return
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	986 next = "--" + self.outerboundary
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	987 last = next + "--"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	988 while 1:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	989 line = self.fp.readline()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	990 if not line:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	991 self.done = -1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	992 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	993 self.lines.append(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	994 if line[:2] == "--":
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	995 strippedline = string.strip(line)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	996 if strippedline == next:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	997 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	998 if strippedline == last:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	999 self.done = 1
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1000 break
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1001
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1002 def make_file(self, binary):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1003 """Overridable: return a readable & writable file.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1004
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1005 The file will be used as follows:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1006 - data is written to it
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1007 - seek(0)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1008 - data is read from it
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1009
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1010 The 'binary' argument is 'b' if the file should be created in
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1011 binary mode (on non-Unix systems), '' otherwise.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1012
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1013 This version opens a temporary file for reading and writing,
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1014 and immediately deletes (unlinks) it. The trick (on Unix!) is
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1015 that the file can still be used, but it can't be opened by
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1016 another process, and it will automatically be deleted when it
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1017 is closed or when the current process terminates.
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1018
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1019 If you want a more permanent file, you derive a class which
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1020 overrides this method. If you want a visible temporary file
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1021 that is nevertheless automatically deleted when the script
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1022 terminates, try defining a __del__ method in a derived class
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1023 which unlinks the temporary files you have created.
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1024
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1025 """
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1026 import tempfile
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1027 tfn = tempfile.mktemp()
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1028 f = open(tfn, "w%s+" % binary)
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1029 os.unlink(tfn)
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1030 return f
3437 d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	1031
d70149202c93 Added FieldStorage class, which stores parts in files. Guido van Rossum <guido@python.org> parents: 3435 diff changeset	1032
3447 db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1033 # Backwards Compatibility Classes
db76fd390f74 Change to use real temporary files instead of StringIO. Correct and Guido van Rossum <guido@python.org> parents: 3446 diff changeset	1034 # ===============================
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1035
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1036 class FormContentDict:
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1037 """Basic (multiple values per field) form content as dictionary.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1038
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1039 form = FormContentDict()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1040
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1041 form[key] -> [value, value, ...]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1042 form.has_key(key) -> Boolean
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1043 form.keys() -> [key, key, ...]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1044 form.values() -> [[val, val, ...], [val, val, ...], ...]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1045 form.items() -> [(key, [val, val, ...]), (key, [val, val, ...]), ...]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1046 form.dict == {key: [val, val, ...], ...}
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1047
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1048 """
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	1049 def __init__(self, environ=os.environ):
3958 b86c80448d35 For method=POST, append a query string from the environment or from Guido van Rossum <guido@python.org> parents: 3797 diff changeset	1050 self.dict = parse(environ=environ)
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1051 self.query_string = environ['QUERY_STRING']
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1052 def __getitem__(self,key):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1053 return self.dict[key]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1054 def keys(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1055 return self.dict.keys()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1056 def has_key(self, key):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1057 return self.dict.has_key(key)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1058 def values(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1059 return self.dict.values()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1060 def items(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1061 return self.dict.items()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1062 def __len__( self ):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1063 return len(self.dict)
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1064
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1065
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1066 class SvFormContentDict(FormContentDict):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1067 """Strict single-value expecting form content as dictionary.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1068
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1069 IF you only expect a single value for each field, then form[key]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1070 will return that single value. It will raise an IndexError if
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1071 that expectation is not true. IF you expect a field to have
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1072 possible multiple values, than you can use form.getlist(key) to
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1073 get all of the values. values() and items() are a compromise:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1074 they return single strings where there is a single value, and
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1075 lists of strings otherwise.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1076
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1077 """
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1078 def __getitem__(self, key):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1079 if len(self.dict[key]) > 1:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1080 raise IndexError, 'expecting a single value'
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1081 return self.dict[key][0]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1082 def getlist(self, key):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1083 return self.dict[key]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1084 def values(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1085 lis = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1086 for each in self.dict.values():
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1087 if len( each ) == 1 :
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1088 lis.append(each[0])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1089 else: lis.append(each)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1090 return lis
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1091 def items(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1092 lis = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1093 for key,value in self.dict.items():
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1094 if len(value) == 1 :
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1095 lis.append((key, value[0]))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1096 else: lis.append((key, value))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1097 return lis
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1098
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1099
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1100 class InterpFormContentDict(SvFormContentDict):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1101 """This class is present for backwards compatibility only."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1102 def __getitem__( self, key ):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1103 v = SvFormContentDict.__getitem__( self, key )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1104 if v[0] in string.digits+'+-.' :
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1105 try: return string.atoi( v )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1106 except ValueError:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1107 try: return string.atof( v )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1108 except ValueError: pass
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1109 return string.strip(v)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1110 def values( self ):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1111 lis = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1112 for key in self.keys():
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1113 try:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1114 lis.append( self[key] )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1115 except IndexError:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1116 lis.append( self.dict[key] )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1117 return lis
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1118 def items( self ):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1119 lis = []
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1120 for key in self.keys():
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1121 try:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1122 lis.append( (key, self[key]) )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1123 except IndexError:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1124 lis.append( (key, self.dict[key]) )
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1125 return lis
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1126
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1127
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1128 class FormContent(FormContentDict):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1129 """This class is present for backwards compatibility only."""
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1130 def values(self, key):
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1131 if self.dict.has_key(key) :return self.dict[key]
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1132 else: return None
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1133 def indexed_value(self, key, location):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1134 if self.dict.has_key(key):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1135 if len (self.dict[key]) > location:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1136 return self.dict[key][location]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1137 else: return None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1138 else: return None
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1139 def value(self, key):
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1140 if self.dict.has_key(key): return self.dict[key][0]
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1141 else: return None
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1142 def length(self, key):
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1143 return len(self.dict[key])
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1144 def stripped(self, key):
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1145 if self.dict.has_key(key): return string.strip(self.dict[key][0])
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1146 else: return None
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1147 def pars(self):
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1148 return self.dict
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1149
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1150
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1151 # Test/debug code
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1152 # ===============
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1153
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	1154 def test(environ=os.environ):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1155 """Robust test CGI script, usable as main program.
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1156
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1157 Write minimal HTTP headers and dump all information provided to
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1158 the script in HTML form.
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1159
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1160 """
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1161 import traceback
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1162 print "Content-type: text/html"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1163 print
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1164 sys.stderr = sys.stdout
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1165 try:
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1166 form = FieldStorage() # Replace with other classes to test those
623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1167 print_form(form)
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	1168 print_environ(environ)
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1169 print_directory()
3451 5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1170 print_arguments()
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1171 print_environ_usage()
4072 f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1172 def f():
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1173 exec "testing print_exception() -- <I>italics?</I>"
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1174 def g(f=f):
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1175 f()
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1176 print "<H3>What follows is a test, not an actual exception:</H3>"
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1177 g()
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1178 except:
4072 f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1179 print_exception()
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1180
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1181 def print_exception(type=None, value=None, tb=None, limit=None):
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1182 if type is None:
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1183 type, value, tb = sys.exc_type, sys.exc_value, sys.exc_traceback
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1184 import traceback
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1185 print
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1186 print "<H3>Traceback (innermost last):</H3>"
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1187 list = traceback.format_tb(tb, limit) + \
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1188 traceback.format_exception_only(type, value)
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1189 print "<PRE>%s<B>%s</B></PRE>" % (
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1190 escape(string.join(list[:-1], "")),
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1191 escape(list[-1]),
f66562536f11 Added print_exception() convenience function. Guido van Rossum <guido@python.org> parents: 3958 diff changeset	1192 )
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1193
3794 d1c47f4f1541 Changes by Jim Fulton: pass environ around as arg; Guido van Rossum <guido@python.org> parents: 3630 diff changeset	1194 def print_environ(environ=os.environ):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1195 """Dump the shell environment as HTML."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1196 keys = environ.keys()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1197 keys.sort()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1198 print
3629 e54d39107249 capitalize H3 headers; add 'cgi.' prefix to example code Guido van Rossum <guido@python.org> parents: 3451 diff changeset	1199 print "<H3>Shell Environment:</H3>"
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1200 print "<DL>"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1201 for key in keys:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1202 print "<DT>", escape(key), "<DD>", escape(environ[key])
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1203 print "</DL>"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1204 print
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1205
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1206 def print_form(form):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1207 """Dump the contents of a form as HTML."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1208 keys = form.keys()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1209 keys.sort()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1210 print
3629 e54d39107249 capitalize H3 headers; add 'cgi.' prefix to example code Guido van Rossum <guido@python.org> parents: 3451 diff changeset	1211 print "<H3>Form Contents:</H3>"
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1212 print "<DL>"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1213 for key in keys:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1214 print "<DT>" + escape(key) + ":",
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1215 value = form[key]
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1216 print "<i>" + escape(`type(value)`) + "</i>"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1217 print "<DD>" + escape(`value`)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1218 print "</DL>"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1219 print
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1220
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1221 def print_directory():
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1222 """Dump the current directory as HTML."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1223 print
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1224 print "<H3>Current Working Directory:</H3>"
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1225 try:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1226 pwd = os.getcwd()
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1227 except os.error, msg:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1228 print "os.error:", escape(str(msg))
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1229 else:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1230 print escape(pwd)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1231 print
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1232
3451 5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1233 def print_arguments():
5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1234 print
3629 e54d39107249 capitalize H3 headers; add 'cgi.' prefix to example code Guido van Rossum <guido@python.org> parents: 3451 diff changeset	1235 print "<H3>Command Line Arguments:</H3>"
3451 5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1236 print
5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1237 print sys.argv
5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1238 print
5abbc9b5fdf0 Added print_arguments() function. Guido van Rossum <guido@python.org> parents: 3447 diff changeset	1239
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1240 def print_environ_usage():
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1241 """Dump a list of environment variables used by CGI as HTML."""
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1242 print """
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1243 <H3>These environment variables could have been set:</H3>
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1244 <UL>
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1245 <LI>AUTH_TYPE
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1246 <LI>CONTENT_LENGTH
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1247 <LI>CONTENT_TYPE
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1248 <LI>DATE_GMT
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1249 <LI>DATE_LOCAL
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1250 <LI>DOCUMENT_NAME
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1251 <LI>DOCUMENT_ROOT
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1252 <LI>DOCUMENT_URI
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1253 <LI>GATEWAY_INTERFACE
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1254 <LI>LAST_MODIFIED
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1255 <LI>PATH
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1256 <LI>PATH_INFO
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1257 <LI>PATH_TRANSLATED
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1258 <LI>QUERY_STRING
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1259 <LI>REMOTE_ADDR
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1260 <LI>REMOTE_HOST
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1261 <LI>REMOTE_IDENT
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1262 <LI>REMOTE_USER
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1263 <LI>REQUEST_METHOD
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1264 <LI>SCRIPT_NAME
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1265 <LI>SERVER_NAME
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1266 <LI>SERVER_PORT
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1267 <LI>SERVER_PROTOCOL
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1268 <LI>SERVER_ROOT
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1269 <LI>SERVER_SOFTWARE
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1270 </UL>
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1271 In addition, HTTP headers sent by the server may be passed in the
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1272 environment as well. Here are some common variable names:
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1273 <UL>
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1274 <LI>HTTP_ACCEPT
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1275 <LI>HTTP_CONNECTION
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1276 <LI>HTTP_HOST
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1277 <LI>HTTP_PRAGMA
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1278 <LI>HTTP_REFERER
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1279 <LI>HTTP_USER_AGENT
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1280 </UL>
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1281 """
4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1282
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1283
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1284 # Utilities
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1285 # =========
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1286
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1287 def escape(s):
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1288 """Replace special characters '&', '<' and '>' by SGML entities."""
3446 623ba9bdeb22 Considerable documentation changes and a few import rearrangements. Guido van Rossum <guido@python.org> parents: 3444 diff changeset	1289 import regsub
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1290 s = regsub.gsub("&", "&", s) # Must be done first!
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1291 s = regsub.gsub("<", "<", s)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1292 s = regsub.gsub(">", ">", s)
e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1293 return s
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1294
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1295
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1296 # Invoke mainline
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1297 # ===============
2135 4f90b474beec new files Guido van Rossum <guido@python.org> parents: diff changeset	1298
3432 6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1299 # Call test() when this file is run as a script (not imported as a module)
6abc75ec6d29 File upload and revamped documentation. Guido van Rossum <guido@python.org> parents: 3106 diff changeset	1300 if __name__ == '__main__':
3444 e76ca34d48f3 Reformatted with 4-space indentation. Added some quick docs to the Guido van Rossum <guido@python.org> parents: 3437 diff changeset	1301 test()

Mercurial > cpython-lru_cache-weakref

annotate Lib/cgi.py @ 4566:6403c94de50d legacy-trunk