Issue #13211: Add .reason attribute to HTTPError to implement parent class (URLError) interface.

jaraco · jaraco · commit aa204dbe9c83 · 2011-11-07T10:50:32.000-05:00
diff --git a/Lib/test/test_urllib2.py b/Lib/test/test_urllib2.py
@@ -1409,6 +1409,17 @@ def test_url_fragment(self):
         req = Request(url)
         self.assertEqual(req.get_full_url(), url)
 
+def test_HTTPError_interface():
+    """
+    Issue 13211 reveals that HTTPError didn't implement the URLError
+    interface even though HTTPError is a subclass of URLError.
+
+    >>> err = urllib.error.HTTPError(msg='something bad happened', url=None, code=None, hdrs=None, fp=None)
+    >>> assert hasattr(err, 'reason')
+    >>> err.reason
+    'something bad happened'
+    """
+
 def test_main(verbose=None):
     from test import test_urllib2
     support.run_doctest(test_urllib2, verbose)
diff --git a/Lib/urllib/error.py b/Lib/urllib/error.py
@@ -52,6 +52,12 @@ def __init__(self, url, code, msg, hdrs, fp):
     def __str__(self):
         return 'HTTP Error %s: %s' % (self.code, self.msg)
 
+    # since URLError specifies a .reason attribute, HTTPError should also
+    #  provide this attribute. See issue13211 for discussion.
+    @property
+    def reason(self):
+        return self.msg
+
 # exception raised when downloaded size does not match content-length
 class ContentTooShortError(URLError):
     def __init__(self, message, content):
