Update urllib.parse.__all__

[vadmium]

BPO	23411
Nosy	@freddrake, @orsenthil, @berkerpeksag, @vadmium, @serhiy-storchaka
Files	urllib.parse-all.patch urllib.parse-all.v2.patch

^{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/serhiy-storchaka'
closed_at = <Date 2015-04-07.16:09:57.244>
created_at = <Date 2015-02-08.11:38:46.813>
labels = ['type-bug', 'library']
title = 'Update urllib.parse.__all__'
updated_at = <Date 2015-04-07.16:09:57.243>
user = 'https://github.com/vadmium'

bugs.python.org fields:

activity = <Date 2015-04-07.16:09:57.243>
actor = 'serhiy.storchaka'
assignee = 'serhiy.storchaka'
closed = True
closed_date = <Date 2015-04-07.16:09:57.244>
closer = 'serhiy.storchaka'
components = ['Library (Lib)']
creation = <Date 2015-02-08.11:38:46.813>
creator = 'martin.panter'
dependencies = []
files = ['38045', '38751']
hgrepos = []
issue_num = 23411
keywords = ['patch']
message_count = 9.0
messages = ['235556', '235558', '236885', '236914', '238775', '238782', '239662', '239669', '240216']
nosy_count = 6.0
nosy_names = ['fdrake', 'orsenthil', 'python-dev', 'berker.peksag', 'martin.panter', 'serhiy.storchaka']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue23411'
versions = ['Python 3.5']

[vadmium]

+"DefragResult", "ParseResult", "SplitResult",
+"DefragResultBytes", "ParseResultBytes", "SplitResultBytes"]

Also adds test case.

[orsenthil]

Thanks for the tests. Reviewed the patch and looks good to me.

[serhiy-storchaka]

Exposed classes are the types of results returned by urllib.parse functions. It is very unlikely that they will be directly used by the user. I see the only benefit of adding these class to __all__ that they will become visible for pydoc. Is it worth to apply the patch to maintained releases or to 3.5 only?

[vadmium]

For what it’s worth, I have used the the SplitResult class directly to build URLs from components, and to get at the hostname:port parsing functionality, as described in bpo-23416. As well as pydoc, I notice when things are missing from __all__ when I try to do “from <module> import *” to experiment in the interactive interpreter. Though I’m not fussed if this only goes into 3.5.

[serhiy-storchaka]

These classes were introduced by Fred in bpo-624325. Is it intentional that they were not added to __all__ Fred?

[berkerpeksag]

*Result and *ResultBytes classes are documented at https://docs.python.org/3/library/urllib.parse.html#urllib.parse.DefragResult

+1 for adding them to __all__.

[vadmium]

urllib.parse-all.v2.patch removes indentation from a blank line and merges recent changes to avoid a potential conflict.

[serhiy-storchaka]

I think it would be safer not commit this patch in 3.4 and 2.7. The patch LGTM.

[python-dev]

New changeset a48e76252952 by Serhiy Storchaka in branch 'default':
Issue bpo-23411: Added DefragResult, ParseResult, SplitResult, DefragResultBytes,
https://hg.python.org/cpython/rev/a48e76252952