[issue13073] message_body argument of HTTPConnection.endheaders is undocumented
New submission from Petri Lehtinen <petri@digip.org>: The argument is essential to avoid slowdown with delayed ACKs and the Nagle algorithm, so it should be documented. It was added when fixing issue 4336. I believe that it's new in Python 2.7. ---------- assignee: docs@python components: Documentation messages: 144676 nosy: docs@python, petri.lehtinen priority: normal severity: normal stage: needs patch status: open title: message_body argument of HTTPConnection.endheaders is undocumented type: behavior versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Changes by Senthil Kumaran <senthil@uthcode.com>: ---------- assignee: docs@python -> orsenthil nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Ben Hayden <hayden767@gmail.com> added the comment: I added in docs for the method from the actual method docstring from the http.client module. ---------- keywords: +patch nosy: +beardedp Added file: http://bugs.python.org/file23290/issue13073.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Senthil Kumaran <senthil@uthcode.com> added the comment: This is fixed the following changesets. changeset a3f2dba93743 changeset 1ed413b52af3 changeset 277688052c5a Thanks for the patch, Ben Hayden. ---------- resolution: -> fixed stage: needs patch -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Petri Lehtinen <petri@digip.org> added the comment: The 2.7 documentation should mention the version in which the argument was added. I believe it was 2.7. ---------- resolution: fixed -> status: closed -> open _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Ezio Melotti <ezio.melotti@gmail.com> added the comment: I also left some comments on the review page that should be addressed. ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Roundup Robot <devnull@psf.upfronthosting.co.za> added the comment: New changeset befa7b926aad by Senthil Kumaran in branch '3.2': Issue #13073 - Address the review comments made by Ezio. http://hg.python.org/cpython/rev/befa7b926aad New changeset a7b7ba225de7 by Senthil Kumaran in branch 'default': merge from 3.2. Issue #13073 - Address the review comments made by Ezio. http://hg.python.org/cpython/rev/a7b7ba225de7 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Roundup Robot <devnull@psf.upfronthosting.co.za> added the comment: New changeset 64fae6f7b64c by Senthil Kumaran in branch '2.7': Issue13073 - Address review comments and add versionchanged information in the docs. http://hg.python.org/cpython/rev/64fae6f7b64c ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Senthil Kumaran <senthil@uthcode.com> added the comment: I believe, I have addressed all the comments. Closing this report. ---------- resolution: -> fixed status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Éric Araujo <merwok@netwok.org> added the comment: It is IMO a source of confusion that the doc talk about a string instead of “a bytes object” (3.x) or “a string (str)” (2.x, unless unicode is supported too). ---------- nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
Senthil Kumaran <senthil@uthcode.com> added the comment: Yes, I agree. I think, it can be clarified at that point too. Because. in 2.7 the string is being checked and in 3.3 the message_body is checked if it's instance of bytes. But, I think, it should be carefully worded (aligned with how other socket message args are mentioned). ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue13073> _______________________________________
participants (6)
-
Ben Hayden -
Ezio Melotti
-
Petri Lehtinen
-
Roundup Robot
-
Senthil Kumaran
-
Éric Araujo