Skip to content

Undocumented urllib functions #46063

Closed
Closed

Description

@warsaw
BPO 1722
Nosy @warsaw, @birkenfeld, @terryjreedy, @orsenthil, @ezio-melotti

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 = None
closed_at = <Date 2013-05-02.12:53:36.990>
created_at = <Date 2008-01-02.18:31:39.573>
labels = ['easy', 'type-feature', 'docs']
title = 'Undocumented urllib functions'
updated_at = <Date 2013-05-02.12:53:36.989>
user = 'https://github.com/warsaw'

bugs.python.org fields:

activity = <Date 2013-05-02.12:53:36.989>
actor = 'orsenthil'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-05-02.12:53:36.990>
closer = 'orsenthil'
components = ['Documentation']
creation = <Date 2008-01-02.18:31:39.573>
creator = 'barry'
dependencies = []
files = []
hgrepos = []
issue_num = 1722
keywords = ['easy']
message_count = 7.0
messages = ['59102', '59483', '59577', '113210', '188014', '188263', '188264']
nosy_count = 8.0
nosy_names = ['barry', 'georg.brandl', 'terry.reedy', 'orsenthil', 'ezio.melotti', 'docs@python', 'python-dev', 'plasticgap']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'needs patch'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1722'
versions = ['Python 2.7']

Activity

  1. added
    docsDocumentation in the Doc dir
    on Jan 2, 2008
  2. warsaw commented on Jan 2, 2008

    @warsaw
    MemberAuthor

    urllib.splithost() and .splittype() are included in urllib's __all__ but
    are not documented in urllib's module documentation. They are used
    quite extensively in the module so they should be documented

  3. birkenfeld commented on Jan 7, 2008

    @birkenfeld
    Member

    There are quite a lot more functions in __all__, more than 10 split*
    functions... should they all be documented?

    Also, isn't urlparse meant to do such tasks?

  4. orsenthil commented on Jan 9, 2008

    @orsenthil
    Member

    Georg Brandl added the comment:

    There are quite a lot more functions in __all__, more than 10 split*
    functions... should they all be documented?

    Also, isn't urlparse meant to do such tasks?

    I agree. I too feel that not everything in the __all__ list should be
    documented. And in this specific case of splithost, it is more appropriate for
    the user to use urlparse.

  5. terryjreedy commented on Aug 7, 2010

    @terryjreedy
    Member

    When internal functions lack '_', perhaps the doc should say "xys,uie, and ooe are intentionally undocumented internal functions." Otherwise, how is one supposed to know?

  6. plasticgap commented on Apr 28, 2013

    plasticgapmannequin
    Mannequin

    This has been fixed in trunk, the split* methods have documentation and appear in the module docs.

    See:
    >>> help('urllib')
  7. python-dev commented on May 2, 2013

    python-devmannequin
    Mannequin

    New changeset c3656dca65e7 by Senthil Kumaran in branch '2.7':
    \bpo-1722 - Add a note on urllib helper functions like splittype, splithost etc.
    http://hg.python.org/cpython/rev/c3656dca65e7

  8. orsenthil commented on May 2, 2013

    @orsenthil
    Member

    I had added a note in the documentation c3656dca65e7 conveying that splittype, splithost should not be relied upon, and urlparse should be used for parsing. Also, Python3 does not include these in __all__ - It is in Python2 for backwards compatibility purposes. It is not possible provide deprecation warning to things we leave off from __all__ from subsequent versions of python.
    I consider this request as resolved. Thanks!

  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

No one assigned

    Labels

    docsDocumentation in the Doc direasytype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions