[issue27485] urllib.splitport -- is it official or not?

[STINNER Victor]

STINNER Victor  added the comment:

Follow-up: I created bpo-45084 to remove these undocumented and deprecated 
functions in Python 3.11.

--
nosy: +vstinner

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Jason R. Coombs]

Jason R. Coombs  added the comment:

Please refer to issue35891 for a description of an important use-case broken by 
the planned removal of splituser.

--
nosy: +jason.coombs

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Serhiy Storchaka]

Change by Serhiy Storchaka :


--
stage: patch review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:


New changeset 867b825830b9b0baff791c9bcda57bba3809722a by Serhiy Storchaka 
(Cheryl Sabella) in branch 'master':
bpo-27485: Change urlparse tests to use private methods. (GH-7070)
https://github.com/python/cpython/commit/867b825830b9b0baff791c9bcda57bba3809722a


--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Guido van Rossum]

Change by Guido van Rossum :


--
nosy:  -gvanrossum

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Cheryl Sabella]

Cheryl Sabella  added the comment:

Serhiy,

Thanks for finding this.  I've submitted a PR to fix the tests.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Cheryl Sabella]

Change by Cheryl Sabella :


--
keywords: +patch
pull_requests: +6699
stage: resolved -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Serhiy Storchaka]

Serhiy Storchaka  added the comment:

This change made test_urlparse failing when ran with -We. Or just producing a 
lot of warnings in the default mode.

==
ERROR: test_splitattr (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1113, in 
test_splitattr
self.assertEqual(splitattr('/path;attr1=value1;attr2=value2'),
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 1103, in splitattr
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splitattr() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splithost (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1006, in 
test_splithost
self.assertEqual(splithost('//www.example.org:80/foo/bar/baz.html'),
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 977, in splithost
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splithost() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splitnport (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1077, in 
test_splitnport
self.assertEqual(splitnport('parrot:88'), ('parrot', 88))
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 1049, in 
splitnport
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splitnport() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splitpasswd (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1050, in 
test_splitpasswd
self.assertEqual(splitpasswd('user:ab'), ('user', 'ab'))
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 1013, in 
splitpasswd
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splitpasswd() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splitport (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1066, in 
test_splitport
self.assertEqual(splitport('parrot:88'), ('parrot', '88'))
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 1026, in splitport
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splitport() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splitquery (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1091, in 
test_splitquery
self.assertEqual(splitquery('http://python.org/fake?foo=bar'),
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 1073, in 
splitquery
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splitquery() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splittag (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 1101, in 
test_splittag
self.assertEqual(splittag('http://example.com?foo=bar#baz'),
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", line 1088, in splittag
DeprecationWarning, stacklevel=2)
DeprecationWarning: urllib.parse.splittag() is deprecated as of 3.8, use 
urllib.parse.urlparse() instead

==
ERROR: test_splittype (test.test_urlparse.Utility_Tests)
--
Traceback (most recent call last):
  File "/home/serhiy/py/cpython-gc/Lib/test/test_urlparse.py", line 998, in 
test_splittype
self.assertEqual(splittype('type:opaquestring'), ('type', 'opaquestring'))
  File "/home/serhiy/py/cpython-gc/Lib/urllib/parse.py", 

[issue27485] urllib.splitport -- is it official or not?

[Łukasz Langa]

Łukasz Langa  added the comment:

Thanks! This is now fixed for Python 3.8 \o/

--
resolution:  -> fixed
stage:  -> resolved
status: open -> closed
versions: +Python 3.8 -Python 2.7, Python 3.5, Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Łukasz Langa]

Łukasz Langa  added the comment:


New changeset 0250de48199552cdaed5a4fe44b3f9cdb5325363 by Łukasz Langa (Cheryl 
Sabella) in branch 'master':
bpo-27485: Rename and deprecate undocumented functions in urllib.parse (GH-2205)
https://github.com/python/cpython/commit/0250de48199552cdaed5a4fe44b3f9cdb5325363


--
nosy: +lukasz.langa

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Cheryl Sabella]

Cheryl Sabella added the comment:

Martin, thank you for the information and for pointing out those other related 
issues.  It makes sense to separate the security or bug issues from this change.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Cheryl Sabella]

Changes by Cheryl Sabella :


--
pull_requests: +2249

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Martin Panter]

Martin Panter added the comment:

I don't think it is worth changing the implementations to be in terms of 
urlsplit or urlparse. This is proposed for splithost in 
, but I suspect it would change 
the behaviour in some corner cases. See Issue 22852 for some deficiencies with 
urlsplit.

3. Change existing usage to the internal _split functions, unless there is a 
reason (bug or security problem) to make further changes.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Cheryl Sabella]

Cheryl Sabella added the comment:

Thank you.

>From my understanding, urllib didn't officially supported the split* functions 
>(splittype, splithost, splitport, splinport, splituser, splitpasswd, 
>splitattr, splitquery, splitvalue, splittag) even though they were migrated to 
>urllib.parse.  The 2.7 documentation recommended using urlparse and stated 
>that these split* functions would not be exposed in Python 3, but they are.

The proposal would be as Senthil suggested - to raise a DeprecationWarning if 
the current names are used and to rename them with a single underscore (to 
_split*).

However, I did have some questions.  
1. With the DeprecationWarning for the current function names, should the 
return value be a call to the _split* function or should it call 
urlparse/urlsplit?
2. Some of the return values from these split* functions can be different than 
urlsplit, as Martin showed in msg270215.  It seems that the return values 
should remain the same for now, but would the differences need to be 
documented? 
3. These functions are used in requests.py.  Should they be changed to use the 
_split* functions or changed to use urlparse?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Brett Cannon]

Brett Cannon added the comment:

Go for it, Cheryl!

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Guido van Rossum]

Guido van Rossum added the comment:

Skimming the issue I can't even figure out what the task is -- Cheryl, I 
suppose you have, could you post a brief summary of your plan here?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Cheryl Sabella]

Cheryl Sabella added the comment:

Would it be OK for me to work on this?

--
nosy: +csabella

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Senthil Kumaran]

Senthil Kumaran added the comment:

I think that we use encourage everyone to use the higher level functions like 
urlparse() or urlsplit() and then get the .port from the named tuple result.

Two things to do.

1. Update that Note the documentation which states a false statement that those 
helper functions are not exposed in urllib.parse

2. Raise a DeprecationWarning and rename them to _splitport()

--
nosy: +orsenthil
versions:  -Python 3.2, Python 3.3, Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Brett Cannon]

Brett Cannon added the comment:

Probably a rename is good. Question then becomes whether the old names should 
raise an DeprecationWarning for a release?

--
nosy: +brett.cannon

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Guido van Rossum]

Guido van Rossum added the comment:

Aha. I see you are referring to this note in the 2.7 docs for urllib:

urllib also exposes certain utility functions like splittype, splithost and
others parsing URL into various components. But it is recommended to use
:mod:`urlparse` for parsing URLs rather than using these functions directly.
Python 3 does not expose these helper functions from :mod:`urllib.parse`
module.

This is somewhat ironic because those functions still exist in urllib.parse.

I've rewritten my code using your suggestions of using urllib.parse.urlparse().

Shall we just close this issue or is there still an action item? (Maybe 
actually delete those functions whose deletion has been promised so long ago, 
or at least rename them to _splitport() etc.?)

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Martin Panter]

Martin Panter added the comment:

Previous discussion: Issue 1722, Issue 11009.

In Python 2, most of the split- functions _have_ been in urllib.__all__ since 
revision 5d68afc5227c (2.1). Also, since revision c3656dca65e7 (Issue 1722, 
2.7.4), the RST documentation does mention that at least some of them are 
deprecated in favour of the “urlparse” module. However there are no index 
entries, and splitport() is not mentioned by name.

In Python 3, these functions wandered into urllib.parse. There is no RST 
documentation, and the functions are not in __all__ (which was added for Issue 
13287 in 3.3).

I think you can use the documented urllib.parse API instead of splitport(), but 
it is borderline unwieldy:

>>> netloc = "[::1]:80"
>>> urllib.parse.splitport(netloc)  # [Brackets] kept!
('[::1]', '80')
>>> split = urlsplit("//" + netloc); (split.hostname, split.port)
('::1', 80)
>>> split = SplitResult("", netloc, path="", query="", fragment=""); 
>>> (split.hostname, split.port)
('::1', 80)

I opened Issue 23416 with a suggestion that would make SplitResult a bit 
simpler to use here. But maybe it makes the implementation too complicated.

I don’t think the non-split-names (Quoter, etc) are in much doubt. They were 
never in __all__.

--
nosy: +martin.panter

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

splitport() doesn't work with IPv6 ("[::1]", see issue18191), nor with 
authority ("user:passw...@example.com"). Note that there is a almost duplicate 
function splitnport(). The existence of two similar functions that behave 
differently in corner cases looks confusing. And seems splitport() and 
splitnport() not always used correctly internally (see issue20271).

--
nosy: +serhiy.storchaka

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue27485] urllib.splitport -- is it official or not?

[Guido van Rossum]

New submission from Guido van Rossum:

I've seen and written some code that uses urllib.splitport() [1], but it's not 
in the export list, nor in the docs. However I see no easy other way to perform 
the same function. Should we make it official, or get rid of it? It's used 
internally in urllib/request.py [2]. There's a test for it in test_urlparse.py 
[3], but another test [4] also acknowledges that it's "undocumented" (which 
suggests that the author of that test didn't know what to do with it either).

Same question for the others in that list [4]:
'splitattr', 'splithost', 'splitnport', 'splitpasswd',
'splitport', 'splitquery', 'splittag', 'splittype', 'splituser',
'splitvalue',
'Quoter', 'ResultBase', 'clear_cache', 'to_bytes', 'unwrap',

References:
[1] https://hg.python.org/cpython/file/tip/Lib/urllib/parse.py#l956
[2] https://hg.python.org/cpython/file/tip/Lib/urllib/request.py#l106
[3] https://hg.python.org/cpython/file/tip/Lib/test/test_urlparse.py#l1015
[4] https://hg.python.org/cpython/file/tip/Lib/test/test_urlparse.py#l946

--
messages: 270193
nosy: gvanrossum
priority: normal
severity: normal
status: open
title: urllib.splitport -- is it official or not?
versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com