Merge pull request #247 from aoberoi/responseparseerror

adds new SlackClientError and ResponseParseError types

Author: aoberoi

slackclient/client.py

@@ -5,6 +5,7 @@
 import traceback
 
 from .server import Server
+from .exceptions import ParseResponseError
 
 
 class SlackClient(object):
@@ -84,7 +85,11 @@ def api_call(self, method, timeout=None, **kwargs):
 
             See here for more information on responses: https://api.slack.com/web
         '''
-        result = json.loads(self.server.api_call(method, timeout=timeout, **kwargs))
+        response_body = self.server.api_call(method, timeout=timeout, **kwargs)
+        try:
+            result = json.loads(response_body)
+        except ValueError as json_decode_error:
+            raise ParseResponseError(response_body, json_decode_error)
         if self.server:
             if method == 'im.open':
                 if "ok" in result and result["ok"]:

slackclient/exceptions.py

@@ -0,0 +1,23 @@
+class SlackClientError(Exception):
+    """
+    Base exception for all errors raised by the SlackClient library
+    """
+    def __init__(self, msg=None):
+        if msg is None:
+            # default error message
+            msg = "An error occurred in the SlackClient library"
+        super(SlackClientError, self).__init__(msg)
+
+
+class ParseResponseError(SlackClientError, ValueError):
+    """
+    Error raised when responses to Web API methods cannot be parsed as valid JSON
+    """
+    def __init__(self, response_body, original_exception):
+        super(ParseResponseError, self).__init__(
+            "Slack API response body could not be parsed: {0}. Original exception: {1}".format(
+                response_body, original_exception
+            )
+        )
+        self.response_body = response_body
+        self.original_exception = original_exception

slackclient/server.py

@@ -3,6 +3,7 @@
 from .channel import Channel
 from .user import User
 from .util import SearchList, SearchDict
+from .exceptions import SlackClientError
 from ssl import SSLError
 
 from websocket import create_connection
@@ -256,14 +257,18 @@ def api_call(self, method, timeout=None, **kwargs):
         '''
         return self.api_requester.do(self.token, method, kwargs, timeout=timeout).text
 
+# TODO: Move the error types defined below into the .exceptions namespace. This would be a semver
+# major change because any clients already referencing these types in order to catch them
+# specifically would need to deal with the symbol names changing.
 
-class SlackConnectionError(Exception):
+
+class SlackConnectionError(SlackClientError):
     def __init__(self, message='', reply=None):
         super(SlackConnectionError, self).__init__(message)
         self.reply = reply
 
 
-class SlackLoginError(Exception):
+class SlackLoginError(SlackClientError):
     def __init__(self, message='', reply=None):
         super(SlackLoginError, self).__init__(message)
         self.reply = reply