bpo-27485: Rename and deprecate undocumented functions in urllib.parse

Author: csabella

Lib/lib2to3/fixes/fix_urllib.py

@@ -16,9 +16,9 @@
                      "pathname2url", "url2pathname"]),
                 ("urllib.parse",
                     ["quote", "quote_plus", "unquote", "unquote_plus",
-                     "urlencode", "_splitattr", "_splithost", "_splitnport",
-                     "_splitpasswd", "_splitport", "_splitquery", "_splittag",
-                     "_splittype", "_splituser", "_splitvalue", ]),
+                     "urlencode", "splitattr", "splithost", "splitnport",
+                     "splitpasswd", "splitport", "splitquery", "splittag",
+                     "splittype", "splituser", "splitvalue", ]),
                 ("urllib.error",
                     ["ContentTooShortError"])],
            "urllib2" : [

Lib/test/test_urlparse.py

@@ -994,15 +994,15 @@ class Utility_Tests(unittest.TestCase):
     # In Python 2 this test class was in test_urllib.
 
     def test_splittype(self):
-        splittype = urllib.parse._splittype
+        splittype = urllib.parse.splittype
         self.assertEqual(splittype('type:opaquestring'), ('type', 'opaquestring'))
         self.assertEqual(splittype('opaquestring'), (None, 'opaquestring'))
         self.assertEqual(splittype(':opaquestring'), (None, ':opaquestring'))
         self.assertEqual(splittype('type:'), ('type', ''))
         self.assertEqual(splittype('type:opaque:string'), ('type', 'opaque:string'))
 
     def test_splithost(self):
-        splithost = urllib.parse._splithost
+        splithost = urllib.parse.splithost
         self.assertEqual(splithost('//www.example.org:80/foo/bar/baz.html'),
                          ('www.example.org:80', '/foo/bar/baz.html'))
         self.assertEqual(splithost('//www.example.org:80'),
@@ -1031,7 +1031,7 @@ def test_splithost(self):
                          ('example.net', '/file#'))
 
     def test_splituser(self):
-        splituser = urllib.parse._splituser
+        splituser = urllib.parse.splituser
         self.assertEqual(splituser('User:[email protected]:080'),
                          ('User:Pass', 'www.python.org:080'))
         self.assertEqual(splituser('@www.python.org:080'),
@@ -1046,7 +1046,7 @@ def test_splituser(self):
     def test_splitpasswd(self):
         # Some of the password examples are not sensible, but it is added to
         # confirming to RFC2617 and addressing issue4675.
-        splitpasswd = urllib.parse._splitpasswd
+        splitpasswd = urllib.parse.splitpasswd
         self.assertEqual(splitpasswd('user:ab'), ('user', 'ab'))
         self.assertEqual(splitpasswd('user:a\nb'), ('user', 'a\nb'))
         self.assertEqual(splitpasswd('user:a\tb'), ('user', 'a\tb'))
@@ -1062,7 +1062,7 @@ def test_splitpasswd(self):
         self.assertEqual(splitpasswd(':ab'), ('', 'ab'))
 
     def test_splitport(self):
-        splitport = urllib.parse._splitport
+        splitport = urllib.parse.splitport
         self.assertEqual(splitport('parrot:88'), ('parrot', '88'))
         self.assertEqual(splitport('parrot'), ('parrot', None))
         self.assertEqual(splitport('parrot:'), ('parrot', None))
@@ -1073,7 +1073,7 @@ def test_splitport(self):
         self.assertEqual(splitport(':88'), ('', '88'))
 
     def test_splitnport(self):
-        splitnport = urllib.parse._splitnport
+        splitnport = urllib.parse.splitnport
         self.assertEqual(splitnport('parrot:88'), ('parrot', 88))
         self.assertEqual(splitnport('parrot'), ('parrot', -1))
         self.assertEqual(splitnport('parrot', 55), ('parrot', 55))
@@ -1087,7 +1087,7 @@ def test_splitnport(self):
     def test_splitquery(self):
         # Normal cases are exercised by other tests; ensure that we also
         # catch cases with no port specified (testcase ensuring coverage)
-        splitquery = urllib.parse._splitquery
+        splitquery = urllib.parse.splitquery
         self.assertEqual(splitquery('http://python.org/fake?foo=bar'),
                          ('http://python.org/fake', 'foo=bar'))
         self.assertEqual(splitquery('http://python.org/fake?foo=bar?'),
@@ -1097,7 +1097,7 @@ def test_splitquery(self):
         self.assertEqual(splitquery('?foo=bar'), ('', 'foo=bar'))
 
     def test_splittag(self):
-        splittag = urllib.parse._splittag
+        splittag = urllib.parse.splittag
         self.assertEqual(splittag('http://example.com?foo=bar#baz'),
                          ('http://example.com?foo=bar', 'baz'))
         self.assertEqual(splittag('http://example.com?foo=bar#'),
@@ -1109,7 +1109,7 @@ def test_splittag(self):
                          ('http://example.com?foo=bar#baz', 'boo'))
 
     def test_splitattr(self):
-        splitattr = urllib.parse._splitattr
+        splitattr = urllib.parse.splitattr
         self.assertEqual(splitattr('/path;attr1=value1;attr2=value2'),
                          ('/path', ['attr1=value1', 'attr2=value2']))
         self.assertEqual(splitattr('/path;'), ('/path', ['']))
@@ -1120,105 +1120,105 @@ def test_splitattr(self):
     def test_splitvalue(self):
         # Normal cases are exercised by other tests; test pathological cases
         # with no key/value pairs. (testcase ensuring coverage)
-        splitvalue = urllib.parse._splitvalue
+        splitvalue = urllib.parse.splitvalue
         self.assertEqual(splitvalue('foo=bar'), ('foo', 'bar'))
         self.assertEqual(splitvalue('foo='), ('foo', ''))
         self.assertEqual(splitvalue('=bar'), ('', 'bar'))
         self.assertEqual(splitvalue('foobar'), ('foobar', None))
         self.assertEqual(splitvalue('foo=bar=baz'), ('foo', 'bar=baz'))
 
     def test_to_bytes(self):
-        result = urllib.parse._to_bytes('http://www.python.org')
+        result = urllib.parse.to_bytes('http://www.python.org')
         self.assertEqual(result, 'http://www.python.org')
         self.assertRaises(UnicodeError, urllib.parse._to_bytes,
                           'http://www.python.org/medi\u00e6val')
 
     def test_unwrap(self):
-        url = urllib.parse._unwrap('<URL:type://host/path>')
+        url = urllib.parse.unwrap('<URL:type://host/path>')
         self.assertEqual(url, 'type://host/path')
 
 
 class DeprecationTest(unittest.TestCase):
 
     def test_splittype_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splittype()
+            urllib.parse.splittype('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splittype() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splithost_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splithost()
+            urllib.parse.splithost('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splithost() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splituser_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splituser()
+            urllib.parse.splituser('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splituser() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splitpasswd_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splitpasswd()
+            urllib.parse.splitpasswd('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splitpasswd() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splitport_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splitport()
+            urllib.parse.splitport('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splitport() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splitnport_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splitnport()
+            urllib.parse.splitnport('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splitnport() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splitquery_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splitquery()
+            urllib.parse.splitquery('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splitquery() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splittag_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splittag()
+            urllib.parse.splittag('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splittag() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splitattr_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splitattr()
+            urllib.parse.splitattr('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splitattr() is deprecated as of 3.7, '
                          'use urllib.parse.urlparse() instead')
 
     def test_splitvalue_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.splitvalue()
+            urllib.parse.splitvalue('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.splitvalue() is deprecated as of 3.7, '
-                         'use urllib.parse.urlparse() instead')
+                         'use urllib.parse.parse_qsl() instead')
 
     def test_to_bytes_deprecation(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.to_bytes()
+            urllib.parse.to_bytes('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.to_bytes() is deprecated as of 3.7')
 
     def test_unwrap(self):
         with self.assertWarns(DeprecationWarning) as cm:
-            urllib.parse.unwrap()
+            urllib.parse.unwrap('')
         self.assertEqual(str(cm.warning),
                          'urllib.parse.unwrap() is deprecated as of 3.7')
 

Lib/urllib/parse.py

@@ -289,7 +289,7 @@ def _hostinfo(self):
 """
 
 _ParseResultBase.__doc__ = """
-ParseResult(scheme, netloc, path, params,  query, fragment)
+ParseResult(scheme, netloc, path, params, query, fragment)
 
 A 6-tuple that contains components of a parsed URL.
 """
@@ -915,7 +915,7 @@ def urlencode(query, doseq=False, safe='', encoding=None, errors=None,
     return '&'.join(l)
 
 
-def to_bytes(url=''):
+def to_bytes(url):
     warnings.warn("urllib.parse.to_bytes() is deprecated as of 3.7",
                   DeprecationWarning, stacklevel=2)
     return _to_bytes(url)
@@ -935,7 +935,7 @@ def _to_bytes(url):
     return url
 
 
-def unwrap(url=''):
+def unwrap(url):
     warnings.warn("urllib.parse.unwrap() is deprecated as of 3.7",
                   DeprecationWarning, stacklevel=2)
     return _unwrap(url)
@@ -950,7 +950,7 @@ def _unwrap(url):
     return url
 
 
-def splittype(url=''):
+def splittype(url):
     warnings.warn("urllib.parse.splittype() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
@@ -971,7 +971,7 @@ def _splittype(url):
     return None, url
 
 
-def splithost(url=''):
+def splithost(url):
     warnings.warn("urllib.parse.splithost() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
@@ -994,11 +994,11 @@ def _splithost(url):
     return None, url
 
 
-def splituser(url=''):
+def splituser(host):
     warnings.warn("urllib.parse.splituser() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
-    return _splituser(url)
+    return _splituser(host)
 
 
 def _splituser(host):
@@ -1007,11 +1007,11 @@ def _splituser(host):
     return (user if delim else None), host
 
 
-def splitpasswd(url=''):
+def splitpasswd(user):
     warnings.warn("urllib.parse.splitpasswd() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
-    return _splitpasswd(url)
+    return _splitpasswd(user)
 
 
 def _splitpasswd(user):
@@ -1020,11 +1020,11 @@ def _splitpasswd(user):
     return user, (passwd if delim else None)
 
 
-def splitport(url=''):
+def splitport(host):
     warnings.warn("urllib.parse.splitport() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
-    return _splitport(url)
+    return _splitport(host)
 
 
 # splittag('/path#tag') --> '/path', 'tag'
@@ -1043,11 +1043,11 @@ def _splitport(host):
     return host, None
 
 
-def splitnport(url=''):
+def splitnport(host, defport=-1):
     warnings.warn("urllib.parse.splitnport() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
-    return _splitnport(url)
+    return _splitnport(host, defport)
 
 
 def _splitnport(host, defport=-1):
@@ -1067,7 +1067,7 @@ def _splitnport(host, defport=-1):
     return host, defport
 
 
-def splitquery(url=''):
+def splitquery(url):
     warnings.warn("urllib.parse.splitquery() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
@@ -1082,7 +1082,7 @@ def _splitquery(url):
     return url, None
 
 
-def splittag(url=''):
+def splittag(url):
     warnings.warn("urllib.parse.splittag() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
@@ -1097,7 +1097,7 @@ def _splittag(url):
     return url, None
 
 
-def splitattr(url=''):
+def splitattr(url):
     warnings.warn("urllib.parse.splitattr() is deprecated as of 3.7, "
                   "use urllib.parse.urlparse() instead",
                   DeprecationWarning, stacklevel=2)
@@ -1111,11 +1111,11 @@ def _splitattr(url):
     return words[0], words[1:]
 
 
-def splitvalue(url=''):
+def splitvalue(attr):
     warnings.warn("urllib.parse.splitvalue() is deprecated as of 3.7, "
-                  "use urllib.parse.urlparse() instead",
+                  "use urllib.parse.parse_qsl() instead",
                   DeprecationWarning, stacklevel=2)
-    return _splitvalue(url)
+    return _splitvalue(attr)
 
 
 def _splitvalue(attr):