chore: Further tear out the compat module

Author: C0rn3j

README.rst

@@ -66,6 +66,5 @@ Contributions have been made by:
 License
 *******
 
-This library is released under the simplified BSD license except for the file
-``musicbrainzngs/compat.py`` which is licensed under the ISC license.
+This library is released under the simplified BSD license.
 See COPYING for details.

musicbrainzngs/caa.py

@@ -10,8 +10,10 @@
     ]
 
 import json
+from urllib.parse import urlunparse
+from urllib.request import HTTPHandler, build_opener
 
-from musicbrainzngs import compat, musicbrainz
+from musicbrainzngs import musicbrainz
 from musicbrainzngs.util import _unicode
 
 hostname = "coverartarchive.org"
@@ -52,7 +54,7 @@ def _caa_request(mbid, imageid=None, size=None, entitytype="release"):
         path.append("%s-%s" % (imageid, size))
     elif imageid:
         path.append(imageid)
-    url = compat.urlunparse((
+    url = urlunparse((
         'https' if https else 'http',
         hostname,
         '/%s' % '/'.join(path),
@@ -63,10 +65,10 @@ def _caa_request(mbid, imageid=None, size=None, entitytype="release"):
     musicbrainz._log.debug("GET request for %s" % (url, ))
 
     # Set up HTTP request handler and URL opener.
-    httpHandler = compat.HTTPHandler(debuglevel=0)
+    httpHandler = HTTPHandler(debuglevel=0)
     handlers = [httpHandler]
 
-    opener = compat.build_opener(*handlers)
+    opener = build_opener(*handlers)
 
     # Make request.
     req = musicbrainz._MusicbrainzHttpRequest("GET", url, None)

musicbrainzngs/compat.py

@@ -1,5 +1 @@
-from http.client import BadStatusLine, HTTPException
-from io import StringIO
-from urllib.error import HTTPError, URLError
-from urllib.parse import quote_plus, urlencode, urlunparse
-from urllib.request import HTTPDigestAuthHandler, HTTPHandler, HTTPPasswordMgr, Request, build_opener
+from urllib.request import build_opener

musicbrainzngs/musicbrainz.py

@@ -18,7 +18,8 @@
 
 from musicbrainzngs import mbxml
 from musicbrainzngs import util
-from musicbrainzngs import compat
+from urllib.parse import urlencode, urlunparse
+from urllib.request import HTTPDigestAuthHandler, HTTPHandler, HTTPPasswordMgr, Request, build_opener
 
 _version = "0.7.1"
 _log = logging.getLogger("musicbrainzngs")
@@ -421,7 +422,7 @@ def __call__(self, *args, **kwargs):
             return self.fun(*args, **kwargs)
 
 # From pymb2
-class _RedirectPasswordMgr(compat.HTTPPasswordMgr):
+class _RedirectPasswordMgr(HTTPPasswordMgr):
 	def __init__(self):
 		self._realms = { }
 
@@ -436,13 +437,13 @@ def add_password(self, realm, uri, username, password):
 		# ignoring the uri parameter intentionally
 		self._realms[realm] = (username, password)
 
-class _DigestAuthHandler(compat.HTTPDigestAuthHandler):
+class _DigestAuthHandler(HTTPDigestAuthHandler):
     def get_authorization (self, req, chal):
         qop = chal.get ('qop', None)
         if qop and ',' in qop and 'auth' in qop.split (','):
             chal['qop'] = 'auth'
 
-        return compat.HTTPDigestAuthHandler.get_authorization (self, req, chal)
+        return HTTPDigestAuthHandler.get_authorization (self, req, chal)
 
     def _encode_utf8(self, msg):
         """The MusicBrainz server also accepts UTF-8 encoded passwords."""
@@ -467,10 +468,10 @@ def get_algorithm_impls(self, algorithm):
         KD = lambda s, d: H("%s:%s" % (s, d))
         return H, KD
 
-class _MusicbrainzHttpRequest(compat.Request):
+class _MusicbrainzHttpRequest(Request):
 	""" A custom request handler that allows DELETE and PUT"""
 	def __init__(self, method, url, data=None):
-		compat.Request.__init__(self, url, data)
+		Request.__init__(self, url, data)
 		allowed_m = ["GET", "POST", "DELETE", "PUT"]
 		if method not in allowed_m:
 			raise ValueError("invalid method: %s" % method)
@@ -501,7 +502,7 @@ def _safe_read(opener, req, body=None, max_retries=_max_retries, retry_delay_del
 				f = opener.open(req)
 			return f.read()
 
-		except compat.HTTPError as exc:
+		except HTTPError as exc:
 			if exc.code in (400, 404, 411):
 				# Bad request, not found, etc.
 				raise ResponseError(cause=exc)
@@ -515,13 +516,13 @@ def _safe_read(opener, req, body=None, max_retries=_max_retries, retry_delay_del
 				# retrying for now.
 				_log.info("unknown HTTP error %i" % exc.code)
 			last_exc = exc
-		except compat.BadStatusLine as exc:
+		except BadStatusLine as exc:
 			_log.info("bad status line")
 			last_exc = exc
-		except compat.HTTPException as exc:
+		except HTTPException as exc:
 			_log.info("miscellaneous HTTP exception: %s" % str(exc))
 			last_exc = exc
-		except compat.URLError as exc:
+		except URLError as exc:
 			if isinstance(exc.reason, socket.error):
 				code = exc.reason.errno
 				if code == 104: # "Connection reset by peer."
@@ -646,18 +647,18 @@ def _mb_request(path, method='GET', auth_required=AUTH_NO,
 
     # Construct the full URL for the request, including hostname and
     # query string.
-    url = compat.urlunparse((
+    url = urlunparse((
         'https' if https else 'http',
         hostname,
         '/ws/2/%s' % path,
         '',
-        compat.urlencode(newargs),
+        urlencode(newargs),
         ''
     ))
     _log.debug("%s request for %s" % (method, url))
 
     # Set up HTTP request handler and URL opener.
-    httpHandler = compat.HTTPHandler(debuglevel=0)
+    httpHandler = HTTPHandler(debuglevel=0)
     handlers = [httpHandler]
 
     # Add credentials if required.
@@ -679,7 +680,7 @@ def _mb_request(path, method='GET', auth_required=AUTH_NO,
         authHandler.add_password("musicbrainz.org", (), user, password)
         handlers.append(authHandler)
 
-    opener = compat.build_opener(*handlers)
+    opener = build_opener(*handlers)
 
     # Make request.
     req = _MusicbrainzHttpRequest(method, url, data)

musicbrainzngs/util.py

@@ -6,8 +6,7 @@
 import locale
 import sys
 import xml.etree.ElementTree as ET
-
-from . import compat
+from io import StringIO
 
 
 def _unicode(string, encoding=None):
@@ -39,6 +38,6 @@ def bytes_to_elementtree(bytes_or_file):
 
 	s = _unicode(s, "utf-8")
 
-	f = compat.StringIO(s)
+	f = StringIO(s)
 	tree = ET.ElementTree(file=f)
 	return tree

test/_common.py

@@ -6,7 +6,6 @@
 from urllib.request import OpenerDirector
 
 import musicbrainzngs
-from musicbrainzngs import compat
 
 
 class FakeOpener(OpenerDirector):

test/test_caa.py

@@ -1,7 +1,8 @@
 import unittest
+from urllib.error import HTTPError
 
 import musicbrainzngs
-from musicbrainzngs import caa, compat
+from musicbrainzngs import caa
 from musicbrainzngs.musicbrainz import _version
 from test import _common
 
@@ -32,7 +33,7 @@ def test_get_release_group_list(self):
     def test_list_none(self):
         """ When CAA gives a 404 error, pass it through."""
 
-        exc = compat.HTTPError("", 404, "", "", _common.StringIO.StringIO(""))
+        exc = HTTPError("", 404, "", "", _common.StringIO.StringIO(""))
         self.opener = _common.FakeOpener(exception=musicbrainzngs.ResponseError(cause=exc))
         musicbrainzngs.compat.build_opener = lambda *args: self.opener
         try:
@@ -42,7 +43,7 @@ def test_list_none(self):
             self.assertEqual(e.cause.code, 404)
 
     def test_list_baduuid(self):
-        exc = compat.HTTPError("", 400, "", "", _common.StringIO.StringIO(""))
+        exc = HTTPError("", 400, "", "", _common.StringIO.StringIO(""))
         self.opener = _common.FakeOpener(exception=musicbrainzngs.ResponseError(cause=exc))
         musicbrainzngs.compat.build_opener = lambda *args: self.opener
         try:

test/test_collection.py

@@ -1,7 +1,7 @@
 import unittest
+from urllib.error import HTTPError
 
 import musicbrainzngs
-from musicbrainzngs import compat
 from test import _common
 
 
@@ -79,7 +79,7 @@ def local_mb_request(path, method='GET',
     def test_no_collection(self):
         """ If a collection doesn't exist, you get a 404 """
 
-        exc = compat.HTTPError("", 404, "", "", _common.StringIO.StringIO(""))
+        exc = HTTPError("", 404, "", "", _common.StringIO.StringIO(""))
         self.opener = _common.FakeOpener(exception=musicbrainzngs.ResponseError(cause=exc))
         musicbrainzngs.compat.build_opener = lambda *args: self.opener
         try:
@@ -92,7 +92,7 @@ def test_private_collection(self):
         """ If you ask for a collection that is private, you should
         get a 401"""
 
-        exc = compat.HTTPError("", 401, "", "", _common.StringIO.StringIO(""))
+        exc = HTTPError("", 401, "", "", _common.StringIO.StringIO(""))
         self.opener = _common.FakeOpener(exception=musicbrainzngs.AuthenticationError(cause=exc))
         musicbrainzngs.compat.build_opener = lambda *args: self.opener
         try:

test/test_search.py

@@ -1,4 +1,5 @@
 import unittest
+from urllib.parse import quote_plus
 
 import musicbrainzngs
 from test import _common
@@ -26,7 +27,7 @@ def test_search_annotations(self):
         # TODO: We escape special characters and then urlencode all query parameters, which may
         # not be necessary, but MusicBrainz accepts it and appears to return the same value as without
         expected_query = r'entity:(bdb24cb5\-404b\-4f60\-bba4\-7b730325ae47)'
-        expected = 'https://musicbrainz.org/ws/2/annotation/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/annotation/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -39,7 +40,7 @@ def test_search_artists(self):
 
         musicbrainzngs.search_artists(artist="Dynamo Go")
         expected_query = 'artist:(dynamo go)'
-        expected = 'https://musicbrainz.org/ws/2/artist/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/artist/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -52,7 +53,7 @@ def test_search_events(self):
 
         musicbrainzngs.search_events(event="woodstock")
         expected_query = 'event:(woodstock)'
-        expected = 'https://musicbrainz.org/ws/2/event/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/event/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -65,7 +66,7 @@ def test_search_labels(self):
 
         musicbrainzngs.search_labels(label="Waysafe")
         expected_query = 'label:(waysafe)'
-        expected = 'https://musicbrainz.org/ws/2/label/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/label/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -78,7 +79,7 @@ def test_search_places(self):
 
         musicbrainzngs.search_places(place="Fillmore")
         expected_query = 'place:(fillmore)'
-        expected = 'https://musicbrainz.org/ws/2/place/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/place/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -91,7 +92,7 @@ def test_search_releases(self):
 
         musicbrainzngs.search_releases(release="Affordable Pop Music")
         expected_query = 'release:(affordable pop music)'
-        expected = 'https://musicbrainz.org/ws/2/release/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/release/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -104,7 +105,7 @@ def test_search_release_groups(self):
 
         musicbrainzngs.search_release_groups(releasegroup="Affordable Pop Music")
         expected_query = 'releasegroup:(affordable pop music)'
-        expected = 'https://musicbrainz.org/ws/2/release-group/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/release-group/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -117,7 +118,7 @@ def test_search_recordings(self):
 
         musicbrainzngs.search_recordings(recording="Thief of Hearts")
         expected_query = 'recording:(thief of hearts)'
-        expected = 'https://musicbrainz.org/ws/2/recording/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/recording/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field
@@ -130,7 +131,7 @@ def test_search_works(self):
 
         musicbrainzngs.search_works(work="Fountain City")
         expected_query = 'work:(fountain city)'
-        expected = 'https://musicbrainz.org/ws/2/work/?query=%s' % musicbrainzngs.compat.quote_plus(expected_query)
+        expected = 'https://musicbrainz.org/ws/2/work/?query=%s' % quote_plus(expected_query)
         self.assertEqual(expected, self.opener.get_url())
 
         # Invalid query field