[New-bugs-announce] [issue1172] Documentation for done attribute of FieldStorage class

[Bob Kline]

New submission from Bob Kline:

I have attached a patch which adds partial documentation for the done
attribute of the cgi.FieldStorage class.  This addition is needed in
order to make it safe to rely on the current behavior of the class,
which sets this attribute to the value -1 when an uploaded file from a
CGI form does not arrive intact.

If I have sufficient free time to do so at some point in the future, I
would like to submit a more extensive modification for the module's
documentation, using a format which matches that used for most of the
other modules (that is, including documentation of all of the methods
and attributes intended for public use), and I'd be inclined to modify
the cgi.py module itself, to use a less opaque approach for conveying
the failure than the 'done' attribute.  I'd want some indication that
there was a reasonable chance that if I were to invest the work on this
improvement the results would actually be used (I see my latest patch
for the module has been languishing in the 'ignored' pile for over a
year).  If anyone else is doing some overhaul work in this area, please
speak up so we don't end up with duplication of effort.

I would think that this module would be one of the most commonly used in
the entire Python library, and would thus warrant careful maintenance
(including addressing all of the "XXX let's fix this ..." comments.

Cheers!

----------
components: Documentation
files: cgi.rst.diff
messages: 55975
nosy: bkline
severity: normal
status: open
title: Documentation for done attribute of FieldStorage class
type: rfe

__________________________________
Tracker <report at bugs.python.org>
<http://bugs.python.org/issue1172>
__________________________________
-------------- next part --------------
A non-text attachment was scrubbed...
Name: cgi.rst.diff
Type: text/x-patch
Size: 701 bytes
Desc: not available
Url : http://mail.python.org/pipermail/new-bugs-announce/attachments/20070917/8ec71105/attachment.bin