Skip to content

httplib.HTTPMessage undocumented #47678

Closed

Description

@ThomasH
mannequin
BPO 3428
Nosy @birkenfeld, @orsenthil, @devdanzin, @ipatrol

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2010-06-28.10:58:42.241>
created_at = <Date 2008-07-22.17:09:00.506>
labels = ['easy', 'type-bug', 'docs']
title = 'httplib.HTTPMessage undocumented'
updated_at = <Date 2010-06-29.13:29:45.136>
user = 'https://bugs.python.org/ThomasH'

bugs.python.org fields:

activity = <Date 2010-06-29.13:29:45.136>
actor = 'orsenthil'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2010-06-28.10:58:42.241>
closer = 'orsenthil'
components = ['Documentation']
creation = <Date 2008-07-22.17:09:00.506>
creator = 'ThomasH'
dependencies = []
files = []
hgrepos = []
issue_num = 3428
keywords = ['easy']
message_count = 7.0
messages = ['70155', '108813', '108820', '108837', '108844', '108865', '108904']
nosy_count = 5.0
nosy_names = ['georg.brandl', 'orsenthil', 'ajaksu2', 'ThomasH', 'ipatrol']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue3428'
versions = ['Python 2.6']

Activity

  1. ThomasH commented on Jul 22, 2008

    ThomasHmannequin
    MannequinAuthor

    The httplib.HTTPMessage class needs documentation; it is missing from
    the package documentation entirely. Instances of this class are e.g.
    returned by the urllib.urlopen().info() method.

  2. added
    docsDocumentation in the Doc dir
    and removed
    docsDocumentation in the Doc dir
    on Sep 24, 2008
  3. ipatrol commented on Jun 28, 2010

    ipatrolmannequin
    Mannequin

    This is still not fixed. Also, it would be nice to add the response code in somewhere as I don't see it in the stdlib epydoc pages

  4. orsenthil commented on Jun 28, 2010

    @orsenthil
    Member

    Fixed in r82322 and r82323.

    Actually urllib.urlopen.info method return a mimetools.Message instance and a HTTPMessage instance is used within httplib only. It is more internal purposes to deal with headers with add_continue like methods is required.

    ipatrol, the return codes of HTTP is documented in the httplib documentation.

  5. ipatrol commented on Jun 28, 2010

    ipatrolmannequin
    Mannequin

    What about urllib2? It's explicitly mentioned as the return value of .info()

  6. orsenthil commented on Jun 28, 2010

    @orsenthil
    Member

    That was a Documentation mistake. Thanks for pointing out.
    Corrected it in revision 82334 and merged to other branches.

  7. ThomasH commented on Jun 28, 2010

    ThomasHmannequin
    MannequinAuthor

    Actually urllib.urlopen.info method return a mimetools.Message instance

    But the urllib.rst documentation is still flawed:

    "The :meth:`info` method returns an instance of the class :class:`httplib.HTTPMessage`"

    (http://svn.python.org/view/python/trunk/Doc/library/urllib.rst?revision=81775&view=markup)

  8. orsenthil commented on Jun 29, 2010

    @orsenthil
    Member

    On Mon, Jun 28, 2010 at 08:51:58PM +0000, ThomasH wrote:

    But the urllib.rst documentation is still flawed:

    Fixed now in the r82363. Did a find and grep on all instances of
    HTTPMessage and verified that it is only at proper places now.

    Thanks for pointing out.

  9. transferred this issue fromon Apr 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc direasytype-bugAn unexpected behavior, bug, or error

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions