Mercurial > cpython-lru_cache-weakref
annotate Doc/lib/libcgi.tex @ 24042:63fbbed10714 legacy-trunk
Simplify HTTPSConnection constructor.
See discussion in SF bug 458463.
| author | Jeremy Hylton <jeremy@alum.mit.edu> |
|---|---|
| date | Fri, 28 Jun 2002 23:38:14 +0000 |
| parents | 7c6094b18d16 |
| children | 64508a37a8d5 |
| rev | line source |
|---|---|
| 8918 | 1 \section{\module{cgi} --- |
| 2 Common Gateway Interface support.} | |
|
8716
760dcf197048
Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents:
8056
diff
changeset
|
3 \declaremodule{standard}{cgi} |
|
760dcf197048
Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents:
8056
diff
changeset
|
4 |
| 8918 | 5 \modulesynopsis{Common Gateway Interface support, used to interpret |
| 6 forms in server-side scripts.} | |
|
8716
760dcf197048
Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents:
8056
diff
changeset
|
7 |
| 2449 | 8 \indexii{WWW}{server} |
| 9 \indexii{CGI}{protocol} | |
| 10 \indexii{HTTP}{protocol} | |
| 11 \indexii{MIME}{headers} | |
| 12 \index{URL} | |
| 13 | |
|
2453
cdd3a721b40e
a few typographical changes (e.g. -- => ---) and lots of new stuff in the WWW chapter
Guido van Rossum <guido@python.org>
parents:
2449
diff
changeset
|
14 |
|
18574
346dcafc878b
Minor changes to match the style guide.
Fred Drake <fdrake@acm.org>
parents:
18411
diff
changeset
|
15 Support module for Common Gateway Interface (CGI) scripts.% |
|
7806
81f98188012e
Capitalize "Python" for consistency.
Fred Drake <fdrake@acm.org>
parents:
7712
diff
changeset
|
16 \index{Common Gateway Interface} |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
17 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
18 This module defines a number of utilities for use by CGI scripts |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
19 written in Python. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
20 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
21 \subsection{Introduction} |
|
8056
43e802c16a5b
Use shorter labels; using long labels creates problems on the Macintosh.
Fred Drake <fdrake@acm.org>
parents:
7806
diff
changeset
|
22 \nodename{cgi-intro} |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
23 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
24 A CGI script is invoked by an HTTP server, usually to process user |
|
9030
d3c067934c63
There is no <ISINPUT> element, just <ISINDEX>. ;-)
Fred Drake <fdrake@acm.org>
parents:
8918
diff
changeset
|
25 input submitted through an HTML \code{<FORM>} or \code{<ISINDEX>} element. |
| 2449 | 26 |
|
6788
ceabd50317e3
Mark file names with \file{} instead of \code{}.
Fred Drake <fdrake@acm.org>
parents:
6645
diff
changeset
|
27 Most often, CGI scripts live in the server's special \file{cgi-bin} |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
28 directory. The HTTP server places all sorts of information about the |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
29 request (such as the client's hostname, the requested URL, the query |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
30 string, and lots of other goodies) in the script's shell environment, |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
31 executes the script, and sends the script's output back to the client. |
| 2449 | 32 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
33 The script's input is connected to the client too, and sometimes the |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
34 form data is read this way; at other times the form data is passed via |
| 7663 | 35 the ``query string'' part of the URL. This module is intended |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
36 to take care of the different cases and provide a simpler interface to |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
37 the Python script. It also provides a number of utilities that help |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
38 in debugging scripts, and the latest addition is support for file |
| 7663 | 39 uploads from a form (if your browser supports it --- Grail 0.3 and |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
40 Netscape 2.0 do). |
| 2449 | 41 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
42 The output of a CGI script should consist of two sections, separated |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
43 by a blank line. The first section contains a number of headers, |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
44 telling the client what kind of data is following. Python code to |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
45 generate a minimal header section looks like this: |
| 2449 | 46 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
47 \begin{verbatim} |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
48 print "Content-Type: text/html" # HTML is following |
| 5818 | 49 print # blank line, end of headers |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
50 \end{verbatim} |
| 7663 | 51 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
52 The second section is usually HTML, which allows the client software |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
53 to display nicely formatted text with header, in-line images, etc. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
54 Here's Python code that prints a simple piece of HTML: |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
55 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
56 \begin{verbatim} |
| 5818 | 57 print "<TITLE>CGI script output</TITLE>" |
| 58 print "<H1>This is my first CGI script</H1>" | |
| 59 print "Hello, world!" | |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
60 \end{verbatim} |
| 7663 | 61 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
62 \subsection{Using the cgi module} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
63 \nodename{Using the cgi module} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
64 |
| 7663 | 65 Begin by writing \samp{import cgi}. Do not use \samp{from cgi import |
| 66 *} --- the module defines all sorts of names for its own use or for | |
| 67 backward compatibility that you don't want in your namespace. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
68 |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
69 When you write a new script, consider adding the line: |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
70 |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
71 \begin{verbatim} |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
72 import cgitb; cgitb.enable() |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
73 \end{verbatim} |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
74 |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
75 This activates a special exception handler that will display detailed |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
76 reports in the Web browser if any errors occur. If you'd rather not |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
77 show the guts of your program to users of your script, you can have |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
78 the reports saved to files instead, with a line like this: |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
79 |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
80 \begin{verbatim} |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
81 import cgitb; cgitb.enable(display=0, logdir="/tmp") |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
82 \end{verbatim} |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
83 |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
84 It's very helpful to use this feature during script development. |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
85 The reports produced by \refmodule{cgitb} provide information that |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
86 can save you a lot of time in tracking down bugs. You can always |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
87 remove the \code{cgitb} line later when you have tested your script |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
88 and are confident that it works correctly. |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
89 |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
90 To get at submitted form data, |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
91 it's best to use the \class{FieldStorage} class. The other classes |
| 7663 | 92 defined in this module are provided mostly for backward compatibility. |
| 93 Instantiate it exactly once, without arguments. This reads the form | |
| 94 contents from standard input or the environment (depending on the | |
| 95 value of various environment variables set according to the CGI | |
| 96 standard). Since it may consume standard input, it should be | |
| 97 instantiated only once. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
98 |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
99 The \class{FieldStorage} instance can be indexed like a Python |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
100 dictionary, and also supports the standard dictionary methods |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
101 \method{has_key()} and \method{keys()}. The built-in \function{len()} |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
102 is also supported. Form fields containing empty strings are ignored |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
103 and do not appear in the dictionary; to keep such values, provide |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
104 a true value for the the optional \var{keep_blank_values} keyword |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
105 parameter when creating the \class{FieldStorage} instance. |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
106 |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
107 For instance, the following code (which assumes that the |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
108 \mailheader{Content-Type} header and blank line have already been |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
109 printed) checks that the fields \code{name} and \code{addr} are both |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
110 set to a non-empty string: |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
111 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
112 \begin{verbatim} |
| 5818 | 113 form = cgi.FieldStorage() |
|
18338
5668a8550be4
Simplify an example based on comment from Thomas Holenstein <thomas@hex.ch>:
Fred Drake <fdrake@acm.org>
parents:
14196
diff
changeset
|
114 if not (form.has_key("name") and form.has_key("addr")): |
| 5818 | 115 print "<H1>Error</H1>" |
| 116 print "Please fill in the name and addr fields." | |
| 117 return | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
118 print "<p>name:", form["name"].value |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
119 print "<p>addr:", form["addr"].value |
| 5818 | 120 ...further form processing here... |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
121 \end{verbatim} |
| 7663 | 122 |
| 123 Here the fields, accessed through \samp{form[\var{key}]}, are | |
| 124 themselves instances of \class{FieldStorage} (or | |
| 125 \class{MiniFieldStorage}, depending on the form encoding). | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
126 The \member{value} attribute of the instance yields the string value |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
127 of the field. The \method{getvalue()} method returns this string value |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
128 directly; it also accepts an optional second argument as a default to |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
129 return if the requested key is not present. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
130 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
131 If the submitted form data contains more than one field with the same |
| 7663 | 132 name, the object retrieved by \samp{form[\var{key}]} is not a |
| 133 \class{FieldStorage} or \class{MiniFieldStorage} | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
134 instance but a list of such instances. Similarly, in this situation, |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
135 \samp{form.getvalue(\var{key})} would return a list of strings. |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
136 If you expect this possibility |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
137 (when your HTML form contains multiple fields with the same name), use |
|
23289
7c6094b18d16
Be more consistent, both internally and with recommended practice.
Fred Drake <fdrake@acm.org>
parents:
21504
diff
changeset
|
138 the \function{isinstance()} built-in function to determine whether you |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
139 have a single instance or a list of instances. For example, this |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
140 code concatenates any number of username fields, separated by |
| 7663 | 141 commas: |
| 2449 | 142 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
143 \begin{verbatim} |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
144 value = form.getvalue("username", "") |
|
23289
7c6094b18d16
Be more consistent, both internally and with recommended practice.
Fred Drake <fdrake@acm.org>
parents:
21504
diff
changeset
|
145 if isinstance(value, list): |
| 5818 | 146 # Multiple username fields specified |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
147 usernames = ",".join(value) |
| 5818 | 148 else: |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
149 # Single or no username field specified |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
150 usernames = value |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
151 \end{verbatim} |
| 7663 | 152 |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
153 If a field represents an uploaded file, accessing the value via the |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
154 \member{value} attribute or the \function{getvalue()} method reads the |
| 7663 | 155 entire file in memory as a string. This may not be what you want. |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
156 You can test for an uploaded file by testing either the \member{filename} |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
157 attribute or the \member{file} attribute. You can then read the data at |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
158 leisure from the \member{file} attribute: |
| 2449 | 159 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
160 \begin{verbatim} |
| 5818 | 161 fileitem = form["userfile"] |
| 162 if fileitem.file: | |
| 163 # It's an uploaded file; count lines | |
| 164 linecount = 0 | |
| 165 while 1: | |
| 166 line = fileitem.file.readline() | |
| 167 if not line: break | |
| 168 linecount = linecount + 1 | |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
169 \end{verbatim} |
| 7663 | 170 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
171 The file upload draft standard entertains the possibility of uploading |
| 7663 | 172 multiple files from one field (using a recursive |
| 173 \mimetype{multipart/*} encoding). When this occurs, the item will be | |
| 174 a dictionary-like \class{FieldStorage} item. This can be determined | |
| 175 by testing its \member{type} attribute, which should be | |
| 176 \mimetype{multipart/form-data} (or perhaps another MIME type matching | |
|
9903
1c4697080d07
Fix typo spotted by Jeff MacDonald <jam@ans.net>.
Fred Drake <fdrake@acm.org>
parents:
9030
diff
changeset
|
177 \mimetype{multipart/*}). In this case, it can be iterated over |
| 7663 | 178 recursively just like the top-level form object. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
179 |
| 7663 | 180 When a form is submitted in the ``old'' format (as the query string or |
| 181 as a single data part of type | |
| 182 \mimetype{application/x-www-form-urlencoded}), the items will actually | |
| 183 be instances of the class \class{MiniFieldStorage}. In this case, the | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
184 \member{list}, \member{file}, and \member{filename} attributes are |
|
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
185 always \code{None}. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
186 |
| 2449 | 187 |
|
19866
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
188 \subsection{Higher Level Interface} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
189 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
190 \versionadded{2.2} % XXX: Is this true ? |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
191 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
192 The previous section explains how to read CGI form data using the |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
193 \class{FieldStorage} class. This section describes a higher level |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
194 interface which was added to this class to allow one to do it in a |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
195 more readable and intuitive way. The interface doesn't make the |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
196 techniques described in previous sections obsolete --- they are still |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
197 useful to process file uploads efficiently, for example. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
198 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
199 The interface consists of two simple methods. Using the methods |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
200 you can process form data in a generic way, without the need to worry |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
201 whether only one or more values were posted under one name. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
202 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
203 In the previous section, you learned to write following code anytime |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
204 you expected a user to post more than one value under one name: |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
205 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
206 \begin{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
207 from types import ListType |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
208 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
209 item = form.getvalue("item") |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
210 if isinstance(item, ListType): |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
211 # The user is requesting more than one item. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
212 else: |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
213 # The user is requesting only one item. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
214 \end{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
215 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
216 This situation is common for example when a form contains a group of |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
217 multiple checkboxes with the same name: |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
218 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
219 \begin{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
220 <input type="checkbox" name="item" value="1" /> |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
221 <input type="checkbox" name="item" value="2" /> |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
222 \end{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
223 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
224 In most situations, however, there's only one form control with a |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
225 particular name in a form and then you expect and need only one value |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
226 associated with this name. So you write a script containing for |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
227 example this code: |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
228 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
229 \begin{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
230 user = form.getvalue("user").toupper() |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
231 \end{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
232 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
233 The problem with the code is that you should never expect that a |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
234 client will provide valid input to your scripts. For example, if a |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
235 curious user appends another \samp{user=foo} pair to the query string, |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
236 then the script would crash, because in this situation the |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
237 \code{getvalue("user")} method call returns a list instead of a |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
238 string. Calling the \method{toupper()} method on a list is not valid |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
239 (since lists do not have a method of this name) and results in an |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
240 \exception{AttributeError} exception. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
241 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
242 Therefore, the appropriate way to read form data values was to always |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
243 use the code which checks whether the obtained value is a single value |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
244 or a list of values. That's annoying and leads to less readable |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
245 scripts. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
246 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
247 A more convenient approach is to use the methods \method{getfirst()} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
248 and \method{getlist()} provided by this higher level interface. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
249 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
250 \begin{methoddesc}[FieldStorage]{getfirst}{name\optional{, default}} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
251 Thin method always returns only one value associated with form field |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
252 \var{name}. The method returns only the first value in case that |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
253 more values were posted under such name. Please note that the order |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
254 in which the values are received may vary from browser to browser |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
255 and should not be counted on. If no such form field or value exists |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
256 then the method returns the value specified by the optional |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
257 parameter \var{default}. This parameter defaults to \code{None} if |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
258 not specified. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
259 \end{methoddesc} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
260 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
261 \begin{methoddesc}[FieldStorage]{getlist}{name} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
262 This method always returns a list of values associated with form |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
263 field \var{name}. The method returns an empty list if no such form |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
264 field or value exists for \var{name}. It returns a list consisting |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
265 of one item if only one such value exists. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
266 \end{methoddesc} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
267 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
268 Using these methods you can write nice compact code: |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
269 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
270 \begin{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
271 import cgi |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
272 form = cgi.FieldStorage() |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
273 user = form.getfirst("user").toupper() # This way it's safe. |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
274 for item in form.getlist("item"): |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
275 do_something(item) |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
276 \end{verbatim} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
277 |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
278 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
279 \subsection{Old classes} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
280 |
| 7663 | 281 These classes, present in earlier versions of the \module{cgi} module, |
| 282 are still supported for backward compatibility. New applications | |
| 283 should use the \class{FieldStorage} class. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
284 |
| 7663 | 285 \class{SvFormContentDict} stores single value form content as |
| 286 dictionary; it assumes each field name occurs in the form only once. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
287 |
| 7663 | 288 \class{FormContentDict} stores multiple value form content as a |
| 289 dictionary (the form items are lists of values). Useful if your form | |
| 290 contains multiple fields with the same name. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
291 |
| 7663 | 292 Other classes (\class{FormContent}, \class{InterpFormContentDict}) are |
| 293 present for backwards compatibility with really old applications only. | |
| 294 If you still use these and would be inconvenienced when they | |
| 295 disappeared from a next version of this module, drop me a note. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
296 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
297 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
298 \subsection{Functions} |
|
4728
b218f294b726
(lib<all sorts of stuff>.tex):
Fred Drake <fdrake@acm.org>
parents:
4487
diff
changeset
|
299 \nodename{Functions in cgi module} |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
300 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
301 These are useful if you want more control, or if you want to employ |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
302 some of the algorithms implemented in this module in other |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
303 circumstances. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
304 |
|
19866
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
305 \begin{funcdesc}{parse}{fp\optional{, keep_blank_values\optional{, |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
306 strict_parsing}}} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
307 Parse a query in the environment or from a file (the file defaults |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
308 to \code{sys.stdin}). The \var{keep_blank_values} and |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
309 \var{strict_parsing} parameters are passed to \function{parse_qs()} |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
310 unchanged. |
| 2449 | 311 \end{funcdesc} |
| 312 | |
|
19866
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
313 \begin{funcdesc}{parse_qs}{qs\optional{, keep_blank_values\optional{, |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
314 strict_parsing}}} |
| 7663 | 315 Parse a query string given as a string argument (data of type |
|
10951
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
316 \mimetype{application/x-www-form-urlencoded}). Data are |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
317 returned as a dictionary. The dictionary keys are the unique query |
|
12223
e82e82b3b9ad
Merged changes from the 1.5.2p2 release.
Fred Drake <fdrake@acm.org>
parents:
10951
diff
changeset
|
318 variable names and the values are lists of values for each name. |
|
10951
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
319 |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
320 The optional argument \var{keep_blank_values} is |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
321 a flag indicating whether blank values in |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
322 URL encoded queries should be treated as blank strings. |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
323 A true value indicates that blanks should be retained as |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
324 blank strings. The default false value indicates that |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
325 blank values are to be ignored and treated as if they were |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
326 not included. |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
327 |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
328 The optional argument \var{strict_parsing} is a flag indicating what |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
329 to do with parsing errors. If false (the default), errors |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
330 are silently ignored. If true, errors raise a ValueError |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
331 exception. |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
332 \end{funcdesc} |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
333 |
|
19866
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
334 \begin{funcdesc}{parse_qsl}{qs\optional{, keep_blank_values\optional{, |
|
a34991b91008
Added documentation on the getfirst() and getlist() methods of the
Fred Drake <fdrake@acm.org>
parents:
19164
diff
changeset
|
335 strict_parsing}}} |
|
10951
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
336 Parse a query string given as a string argument (data of type |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
337 \mimetype{application/x-www-form-urlencoded}). Data are |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
338 returned as a list of name, value pairs. |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
339 |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
340 The optional argument \var{keep_blank_values} is |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
341 a flag indicating whether blank values in |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
342 URL encoded queries should be treated as blank strings. |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
343 A true value indicates that blanks should be retained as |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
344 blank strings. The default false value indicates that |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
345 blank values are to be ignored and treated as if they were |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
346 not included. |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
347 |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
348 The optional argument \var{strict_parsing} is a flag indicating what |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
349 to do with parsing errors. If false (the default), errors |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
350 are silently ignored. If true, errors raise a ValueError |
|
b6d3d17195dc
Patch by Jim Fulton to document the new parse_qls().
Guido van Rossum <guido@python.org>
parents:
9903
diff
changeset
|
351 exception. |
| 2449 | 352 \end{funcdesc} |
| 353 | |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7663
diff
changeset
|
354 \begin{funcdesc}{parse_multipart}{fp, pdict} |
| 7663 | 355 Parse input of type \mimetype{multipart/form-data} (for |
| 356 file uploads). Arguments are \var{fp} for the input file and | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
357 \var{pdict} for a dictionary containing other parameters in |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
358 the \mailheader{Content-Type} header. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
359 |
| 7663 | 360 Returns a dictionary just like \function{parse_qs()} keys are the |
| 361 field names, each value is a list of values for that field. This is | |
| 362 easy to use but not much good if you are expecting megabytes to be | |
| 363 uploaded --- in that case, use the \class{FieldStorage} class instead | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
364 which is much more flexible. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
365 |
| 7663 | 366 Note that this does not parse nested multipart parts --- use |
| 367 \class{FieldStorage} for that. | |
| 2449 | 368 \end{funcdesc} |
| 369 | |
|
6153
17a26f986007
Removed some colons that shouldn't be there (probably leftovers from
Guido van Rossum <guido@python.org>
parents:
5871
diff
changeset
|
370 \begin{funcdesc}{parse_header}{string} |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
371 Parse a MIME header (such as \mailheader{Content-Type}) into a main |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
372 value and a dictionary of parameters. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
373 \end{funcdesc} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
374 |
|
6153
17a26f986007
Removed some colons that shouldn't be there (probably leftovers from
Guido van Rossum <guido@python.org>
parents:
5871
diff
changeset
|
375 \begin{funcdesc}{test}{} |
| 7663 | 376 Robust test CGI script, usable as main program. |
| 377 Writes minimal HTTP headers and formats all information provided to | |
| 378 the script in HTML form. | |
| 2449 | 379 \end{funcdesc} |
| 380 | |
|
6153
17a26f986007
Removed some colons that shouldn't be there (probably leftovers from
Guido van Rossum <guido@python.org>
parents:
5871
diff
changeset
|
381 \begin{funcdesc}{print_environ}{} |
| 7663 | 382 Format the shell environment in HTML. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
383 \end{funcdesc} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
384 |
|
6153
17a26f986007
Removed some colons that shouldn't be there (probably leftovers from
Guido van Rossum <guido@python.org>
parents:
5871
diff
changeset
|
385 \begin{funcdesc}{print_form}{form} |
| 7663 | 386 Format a form in HTML. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
387 \end{funcdesc} |
| 2449 | 388 |
|
6153
17a26f986007
Removed some colons that shouldn't be there (probably leftovers from
Guido van Rossum <guido@python.org>
parents:
5871
diff
changeset
|
389 \begin{funcdesc}{print_directory}{} |
| 7663 | 390 Format the current directory in HTML. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
391 \end{funcdesc} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
392 |
|
6153
17a26f986007
Removed some colons that shouldn't be there (probably leftovers from
Guido van Rossum <guido@python.org>
parents:
5871
diff
changeset
|
393 \begin{funcdesc}{print_environ_usage}{} |
| 7663 | 394 Print a list of useful (used by CGI) environment variables in |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
395 HTML. |
| 2449 | 396 \end{funcdesc} |
| 397 | |
|
7712
0cbc9df882b6
Change "\," to just "," in function signatures. This is easier to maintain,
Fred Drake <fdrake@acm.org>
parents:
7663
diff
changeset
|
398 \begin{funcdesc}{escape}{s\optional{, quote}} |
| 7663 | 399 Convert the characters |
| 400 \character{\&}, \character{<} and \character{>} in string \var{s} to | |
| 401 HTML-safe sequences. Use this if you need to display text that might | |
| 402 contain such characters in HTML. If the optional flag \var{quote} is | |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
403 true, the double-quote character (\character{"}) is also translated; |
|
18411
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
404 this helps for inclusion in an HTML attribute value, as in \code{<A |
|
19164
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
405 HREF="...">}. If the value to be qouted might include single- or |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
406 double-quote characters, or both, consider using the |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
407 \function{quoteattr()} function in the \refmodule{xml.sax.saxutils} |
|
5d6b2c17ea2c
For the escape() function, added a reference to the quoteattrs() function
Fred Drake <fdrake@acm.org>
parents:
18574
diff
changeset
|
408 module instead. |
| 2449 | 409 \end{funcdesc} |
| 410 | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
411 |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
412 \subsection{Caring about security \label{cgi-security}} |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
413 |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
414 \indexii{CGI}{security} |
| 2449 | 415 |
|
18411
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
416 There's one important rule: if you invoke an external program (via the |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
417 \function{os.system()} or \function{os.popen()} functions. or others |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
418 with similar functionality), make very sure you don't pass arbitrary |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
419 strings received from the client to the shell. This is a well-known |
|
18574
346dcafc878b
Minor changes to match the style guide.
Fred Drake <fdrake@acm.org>
parents:
18411
diff
changeset
|
420 security hole whereby clever hackers anywhere on the Web can exploit a |
|
18411
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
421 gullible CGI script to invoke arbitrary shell commands. Even parts of |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
422 the URL or field names cannot be trusted, since the request doesn't |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
423 have to come from your form! |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
424 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
425 To be on the safe side, if you must pass a string gotten from a form |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
426 to a shell command, you should make sure the string contains only |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
427 alphanumeric characters, dashes, underscores, and periods. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
428 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
429 |
|
21062
bc02c3b09626
Clean up some markup cruft. A number of the macros that take no
Fred Drake <fdrake@acm.org>
parents:
19866
diff
changeset
|
430 \subsection{Installing your CGI script on a \UNIX\ system} |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
431 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
432 Read the documentation for your HTTP server and check with your local |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
433 system administrator to find the directory where CGI scripts should be |
|
6788
ceabd50317e3
Mark file names with \file{} instead of \code{}.
Fred Drake <fdrake@acm.org>
parents:
6645
diff
changeset
|
434 installed; usually this is in a directory \file{cgi-bin} in the server tree. |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
435 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
436 Make sure that your script is readable and executable by ``others''; the |
| 7663 | 437 \UNIX{} file mode should be \code{0755} octal (use \samp{chmod 0755 |
|
9903
1c4697080d07
Fix typo spotted by Jeff MacDonald <jam@ans.net>.
Fred Drake <fdrake@acm.org>
parents:
9030
diff
changeset
|
438 \var{filename}}). Make sure that the first line of the script contains |
| 7663 | 439 \code{\#!} starting in column 1 followed by the pathname of the Python |
| 440 interpreter, for instance: | |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
441 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
442 \begin{verbatim} |
| 5818 | 443 #!/usr/local/bin/python |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
444 \end{verbatim} |
| 7663 | 445 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
446 Make sure the Python interpreter exists and is executable by ``others''. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
447 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
448 Make sure that any files your script needs to read or write are |
| 7663 | 449 readable or writable, respectively, by ``others'' --- their mode |
| 450 should be \code{0644} for readable and \code{0666} for writable. This | |
| 451 is because, for security reasons, the HTTP server executes your script | |
| 452 as user ``nobody'', without any special privileges. It can only read | |
| 453 (write, execute) files that everybody can read (write, execute). The | |
| 454 current directory at execution time is also different (it is usually | |
| 455 the server's cgi-bin directory) and the set of environment variables | |
|
18574
346dcafc878b
Minor changes to match the style guide.
Fred Drake <fdrake@acm.org>
parents:
18411
diff
changeset
|
456 is also different from what you get when you log in. In particular, don't |
| 7663 | 457 count on the shell's search path for executables (\envvar{PATH}) or |
| 458 the Python module search path (\envvar{PYTHONPATH}) to be set to | |
| 459 anything interesting. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
460 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
461 If you need to load modules from a directory which is not on Python's |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
462 default module search path, you can change the path in your script, |
|
18411
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
463 before importing other modules. For example: |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
464 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
465 \begin{verbatim} |
| 5818 | 466 import sys |
| 467 sys.path.insert(0, "/usr/home/joe/lib/python") | |
| 468 sys.path.insert(0, "/usr/local/lib/python") | |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
469 \end{verbatim} |
| 7663 | 470 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
471 (This way, the directory inserted last will be searched first!) |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
472 |
| 7086 | 473 Instructions for non-\UNIX{} systems will vary; check your HTTP server's |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
474 documentation (it will usually have a section on CGI scripts). |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
475 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
476 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
477 \subsection{Testing your CGI script} |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
478 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
479 Unfortunately, a CGI script will generally not run when you try it |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
480 from the command line, and a script that works perfectly from the |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
481 command line may fail mysteriously when run from the server. There's |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
482 one reason why you should still test your script from the command |
|
7806
81f98188012e
Capitalize "Python" for consistency.
Fred Drake <fdrake@acm.org>
parents:
7712
diff
changeset
|
483 line: if it contains a syntax error, the Python interpreter won't |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
484 execute it at all, and the HTTP server will most likely send a cryptic |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
485 error to the client. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
486 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
487 Assuming your script has no syntax errors, yet it does not work, you |
| 7663 | 488 have no choice but to read the next section. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
489 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
490 |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
491 \subsection{Debugging CGI scripts} \indexii{CGI}{debugging} |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
492 |
| 7663 | 493 First of all, check for trivial installation errors --- reading the |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
494 section above on installing your CGI script carefully can save you a |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
495 lot of time. If you wonder whether you have understood the |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
496 installation procedure correctly, try installing a copy of this module |
|
6788
ceabd50317e3
Mark file names with \file{} instead of \code{}.
Fred Drake <fdrake@acm.org>
parents:
6645
diff
changeset
|
497 file (\file{cgi.py}) as a CGI script. When invoked as a script, the file |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
498 will dump its environment and the contents of the form in HTML form. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
499 Give it the right mode etc, and send it a request. If it's installed |
|
6788
ceabd50317e3
Mark file names with \file{} instead of \code{}.
Fred Drake <fdrake@acm.org>
parents:
6645
diff
changeset
|
500 in the standard \file{cgi-bin} directory, it should be possible to send it a |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
501 request by entering a URL into your browser of the form: |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
502 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
503 \begin{verbatim} |
| 5818 | 504 http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
505 \end{verbatim} |
| 7663 | 506 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
507 If this gives an error of type 404, the server cannot find the script |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
508 -- perhaps you need to install it in a different directory. If it |
|
18411
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
509 gives another error, there's an installation problem that |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
510 you should fix before trying to go any further. If you get a nicely |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
511 formatted listing of the environment and form content (in this |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
512 example, the fields should be listed as ``addr'' with value ``At Home'' |
|
6788
ceabd50317e3
Mark file names with \file{} instead of \code{}.
Fred Drake <fdrake@acm.org>
parents:
6645
diff
changeset
|
513 and ``name'' with value ``Joe Blow''), the \file{cgi.py} script has been |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
514 installed correctly. If you follow the same procedure for your own |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
515 script, you should now be able to debug it. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
516 |
| 7663 | 517 The next step could be to call the \module{cgi} module's |
| 518 \function{test()} function from your script: replace its main code | |
| 519 with the single statement | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
520 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
521 \begin{verbatim} |
| 5818 | 522 cgi.test() |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
523 \end{verbatim} |
| 7663 | 524 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
525 This should produce the same results as those gotten from installing |
|
6788
ceabd50317e3
Mark file names with \file{} instead of \code{}.
Fred Drake <fdrake@acm.org>
parents:
6645
diff
changeset
|
526 the \file{cgi.py} file itself. |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
527 |
|
18411
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
528 When an ordinary Python script raises an unhandled exception (for |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
529 whatever reason: of a typo in a module name, a file that can't be |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
530 opened, etc.), the Python interpreter prints a nice traceback and |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
531 exits. While the Python interpreter will still do this when your CGI |
|
eeb2e77c5bad
Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
Fred Drake <fdrake@acm.org>
parents:
18338
diff
changeset
|
532 script raises an exception, most likely the traceback will end up in |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
533 one of the HTTP server's log files, or be discarded altogether. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
534 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
535 Fortunately, once you have managed to get your script to execute |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
536 \emph{some} code, you can easily send tracebacks to the Web browser |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
537 using the \refmodule{cgitb} module. If you haven't done so already, |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
538 just add the line: |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
539 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
540 \begin{verbatim} |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
541 import cgitb; cgitb.enable() |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
542 \end{verbatim} |
| 7663 | 543 |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
544 to the top of your script. Then try running it again; when a |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
545 problem occurs, you should see a detailed report that will |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
546 likely make apparent the cause of the crash. |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
547 |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
548 If you suspect that there may be a problem in importing the |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
549 \refmodule{cgitb} module, you can use an even more robust approach |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
550 (which only uses built-in modules): |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
551 |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
552 \begin{verbatim} |
| 5818 | 553 import sys |
| 554 sys.stderr = sys.stdout | |
|
14196
41234ae95d2a
Closing patch #101120 -- After everyone agreed.
Moshe Zadka <moshez@math.huji.ac.il>
parents:
13625
diff
changeset
|
555 print "Content-Type: text/plain" |
| 5818 | 556 print |
| 557 ...your code here... | |
|
7277
bf4e790bd61a
Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents:
7086
diff
changeset
|
558 \end{verbatim} |
| 7663 | 559 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
560 This relies on the Python interpreter to print the traceback. The |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
561 content type of the output is set to plain text, which disables all |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
562 HTML processing. If your script works, the raw HTML will be displayed |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
563 by your client. If it raises an exception, most likely after the |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
564 first two lines have been printed, a traceback will be displayed. |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
565 Because no HTML interpretation is going on, the traceback will be |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
566 readable. |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
567 |
|
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
568 |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
569 \subsection{Common problems and solutions} |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
570 |
|
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
571 \begin{itemize} |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
572 \item Most HTTP servers buffer the output from CGI scripts until the |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
573 script is completed. This means that it is not possible to display a |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
574 progress report on the client's display while the script is running. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
575 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
576 \item Check the installation instructions above. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
577 |
| 7663 | 578 \item Check the HTTP server's log files. (\samp{tail -f logfile} in a |
| 579 separate window may be useful!) | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
580 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
581 \item Always check a script for syntax errors first, by doing something |
| 7663 | 582 like \samp{python script.py}. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
583 |
|
21504
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
584 \item If your script does not have any syntax errors, try adding |
|
a03b13be2f68
Re-commit Ping's patch to the cgi and cgitb documentation, using the
Fred Drake <fdrake@acm.org>
parents:
21062
diff
changeset
|
585 \samp{import cgitb; cgitb.enable()} to the top of the script. |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
586 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
587 \item When invoking external programs, make sure they can be found. |
| 7663 | 588 Usually, this means using absolute path names --- \envvar{PATH} is |
| 589 usually not set to a very useful value in a CGI script. | |
|
3856
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
590 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
591 \item When reading or writing external files, make sure they can be read |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
592 or written by every user on the system. |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
593 |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
594 \item Don't try to give a CGI script a set-uid mode. This doesn't work on |
|
5830ede4086c
Document the *new* cgi.py
Guido van Rossum <guido@python.org>
parents:
2581
diff
changeset
|
595 most systems, and is a security liability as well. |
|
2576
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
596 \end{itemize} |
|
f47bc5554418
mass changes; fix titles; add examples; correct typos; clarifications;
Guido van Rossum <guido@python.org>
parents:
2491
diff
changeset
|
597 |