Move GitHubError to exceptions module

sigmavirus24 · sigmavirus24 · commit 5eecc64a083d · 2014-08-24T14:34:44.000-05:00
Create new exceptions for better control over error handling
diff --git a/github3/exceptions.py b/github3/exceptions.py
@@ -0,0 +1,69 @@
+# -*- coding: utf-8 -*-
+"""All exceptions for the github3 library."""
+
+
+class GitHubError(Exception):
+
+    """The base exception class."""
+
+    def __init__(self, resp):
+        super(GitHubError, self).__init__(resp)
+        #: Response code that triggered the error
+        self.response = resp
+        self.code = resp.status_code
+        self.errors = []
+        try:
+            error = resp.json()
+            #: Message associated with the error
+            self.msg = error.get('message')
+            #: List of errors provided by GitHub
+            if error.get('errors'):
+                self.errors = error.get('errors')
+        except:  # Amazon S3 error
+            self.msg = resp.content or '[No message]'
+
+    def __repr__(self):
+        return '<GitHubError [{0}]>'.format(self.msg or self.code)
+
+    def __str__(self):
+        return '{0} {1}'.format(self.code, self.msg)
+
+    @property
+    def message(self):
+        """The actual message returned by the API."""
+        return self.msg
+
+
+class AuthenticationFailed(GitHubError):
+
+    """Exception class for 401 responses."""
+
+    pass
+
+
+class ForbiddenError(GitHubError):
+
+    """Exception class for 403 responses."""
+
+    pass
+
+
+class NotFoundError(GitHubError):
+
+    """Exception class for 404 responses."""
+
+    pass
+
+
+class InvalidRequestError(GitHubError):
+
+    """Exception class for 422 responses."""
+
+    pass
+
+
+class ServerError(GitHubError):
+
+    """Exception class for 5xx responses."""
+
+    pass
diff --git a/github3/models.py b/github3/models.py
@@ -10,11 +10,13 @@
 
 from json import dumps, loads
 from requests.compat import urlparse, is_py2
+from datetime import datetime
+from logging import getLogger
+
 from github3.decorators import requires_auth
+from github3.exceptions import GitHubError
 from github3.session import GitHubSession
 from github3.utils import UTC
-from datetime import datetime
-from logging import getLogger
 
 __timeformat__ = '%Y-%m-%dT%H:%M:%SZ'
 __logs__ = getLogger(__package__)
@@ -414,31 +416,3 @@ def _repr(self):
 
     def _update_(self, acct):
         self.__init__(acct, self.session)
-
-
-class GitHubError(Exception):
-    def __init__(self, resp):
-        super(GitHubError, self).__init__(resp)
-        #: Response code that triggered the error
-        self.response = resp
-        self.code = resp.status_code
-        self.errors = []
-        try:
-            error = resp.json()
-            #: Message associated with the error
-            self.msg = error.get('message')
-            #: List of errors provided by GitHub
-            if error.get('errors'):
-                self.errors = error.get('errors')
-        except:  # Amazon S3 error
-            self.msg = resp.content or '[No message]'
-
-    def __repr__(self):
-        return '<GitHubError [{0}]>'.format(self.msg or self.code)
-
-    def __str__(self):
-        return '{0} {1}'.format(self.code, self.msg)
-
-    @property
-    def message(self):
-        return self.msg
