[issue1172] Documentation for done attribute of FieldStorage class
Sean Reifschneider added the comment: Patch looks good to me. Fred? Comments on should I do more fixes: Just straight documentation changes are, in my experience, fairly likely to be processed quickly. Changes to the code may take quite a lot more discussion. Smaller, individual patches are likely to be taken much more than large mega patches that change many things. So, my recommendation would be to do individual efforts: Fix the current documentation, fix XXX fix me parts, do enhancements. I understand where you're coming from, I spent a full day implementing string.rsplit() including documentation, only to have it languish for around a year before other people re-opening the rejected submission finally got it accepted. However, python definitely benefits from the attention. Sometimes things do get dropped, because of other commitments from the maintainers. Assign your issue that has been ignored to me and I'll take a look at it. -- assignee: - fdrake keywords: +patch nosy: +fdrake, jafo priority: - normal versions: +Python 2.6 __ Tracker [EMAIL PROTECTED] http://bugs.python.org/issue1172 __ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue1172] Documentation for done attribute of FieldStorage class
Fred L. Drake, Jr. added the comment: Looks good to me too. This should be committed. -- assignee: fdrake - jafo resolution: - accepted versions: +Python 2.5, Python 3.0 __ Tracker [EMAIL PROTECTED] http://bugs.python.org/issue1172 __ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue1172] Documentation for done attribute of FieldStorage class
Bob Kline added the comment: Thanks for the very quick follow-up. I may be shooting myself in the foot here, but Sean's encouragement about getting patches to the actual code lead me to wonder if it might be better to go straight for the optimal solution here. As I implied in my original message for this issue, there are approaches for exposing the ability to detect failure which would be more straightforward than testing for field.done == -1. A step in the right direction might be an attribute named something like 'incomplete' (True|False). Or perhaps an access method? Based on my more recent experience with getting code patches accepted, I had settled on just documenting the existing code more fully as a minimal solution, but if Sean's more optimistic advice is justified, I'd be happy to wait a little longer for a cleaner solution (and to pitch in for the work to create it, if that's appropriate). I know I have more than one bit of Python code I wrote years ago for situations similar to this where if I had to do it over again I would have thrown an exception, and maybe that's the right thing to do here, with an optional argument to the constructor which suppresses the exception. Perhaps Guido might want to weigh in with his own preferences (this is his code, and he's still listed as the current maintainer of the module). But I'd rather have the documentation patch for the existing code than nothing at all. Cheers, Bob __ Tracker [EMAIL PROTECTED] http://bugs.python.org/issue1172 __ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue1172] Documentation for done attribute of FieldStorage class
Sean Reifschneider added the comment: Committed in trunk revision 58199 Committed in 25-maint revision 58200 Committed in py3k revision 58201 -- status: open - closed __ Tracker [EMAIL PROTECTED] http://bugs.python.org/issue1172 __ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue1172] Documentation for done attribute of FieldStorage class
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 [EMAIL PROTECTED] http://bugs.python.org/issue1172 __--- cgi.rst 2007-09-17 13:40:51.0 -0400 +++ cgi.rst-20070917 2007-09-17 14:57:00.0 -0400 @@ -147,6 +147,11 @@ if not line: break linecount = linecount + 1 +If an error is encountered when obtaining the contents of an uploaded file +(for example, when the user interrupts the form submission by clicking on +a Back or Cancel button) the :attr:`done` attribute of the object for the +field will be set to the value -1. + The file upload draft standard entertains the possibility of uploading multiple files from one field (using a recursive :mimetype:`multipart/\*` encoding). When this occurs, the item will be a dictionary-like :class:`FieldStorage` item. ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
