Updating the raise style used in the rtm library Im using

[doneit] / src / rtm_api.py

diff --git a/src/rtm_api.py b/src/rtm_api.py
index 720c0d2..d275831 100644 (file)
--- a/src/rtm_api.py
+++ b/src/rtm_api.py
@@ -53,7 +53,7 @@ class AuthStateMachine(object):
 
        def dataReceived(self, state, datum):
                if state not in self.states:
-                       raise RTMError, "Invalid state <%s>" % state
+                       raise RTMError("Invalid state <%s>" % state)
                self.data[state] = datum
 
        def get(self, state):
@@ -91,37 +91,86 @@ class RTMapi(object):
                warnings.warn("Performing download of %s" % url, stacklevel=5)
                return urllib2.urlopen(url)
 
-       def get(self, **params):
-               "Get the XML response for the passed `params`."
-               params['api_key'] = self._apiKey
-               params['format'] = 'json'
-               params['api_sig'] = self._sign(params)
+       @staticmethod
+       def read_by_length(connection, timeout):
+               # It appears that urllib uses the non-blocking variant of file objects
+               # which means reads might not always be complete, so grabbing as much
+               # of the data as possible with a sleep in between to give it more time
+               # to grab data.
+               contentLengthField = "Content-Length"
+               assert contentLengthField in connection.info(), "Connection didn't provide content length info"
+               specifiedLength = int(connection.info()["Content-Length"])
 
-               connection = self.open_url(SERVICE_URL, params)
+               actuallyRead = 0
+               chunks = []
 
+               chunk = connection.read()
+               actuallyRead += len(chunk)
+               chunks.append(chunk)
+               while 0 < timeout and actuallyRead < specifiedLength:
+                       time.sleep(1)
+                       timeout -= 1
+                       chunk = connection.read()
+                       actuallyRead += len(chunk)
+                       chunks.append(chunk)
+
+               json = "".join(chunks)
+
+               if "Content-Length" in connection.info():
+                       assert len(json) == int(connection.info()["Content-Length"]), "The packet header promised %s of data but only was able to read %s of data" % (
+                               connection.info()["Content-Length"],
+                               len(json),
+                       )
+
+               return json
+
+       @staticmethod
+       def read_by_guess(connection, timeout):
                # It appears that urllib uses the non-blocking variant of file objects
                # which means reads might not always be complete, so grabbing as much
                # of the data as possible with a sleep in between to give it more time
                # to grab data.
+
                chunks = []
+
                chunk = connection.read()
-               while chunk:
-                       chunks.append(chunk)
+               chunks.append(chunk)
+               while chunk and 0 < timeout:
                        time.sleep(1)
+                       timeout -= 1
                        chunk = connection.read()
+                       chunks.append(chunk)
+
                json = "".join(chunks)
+
                if "Content-Length" in connection.info():
                        assert len(json) == int(connection.info()["Content-Length"]), "The packet header promised %s of data but only was able to read %s of data" % (
-                               len(json),
                                connection.info()["Content-Length"],
+                               len(json),
                        )
 
+               return json
+
+       def get(self, **params):
+               "Get the XML response for the passed `params`."
+               params['api_key'] = self._apiKey
+               params['format'] = 'json'
+               params['api_sig'] = self._sign(params)
+
+               connection = self.open_url(SERVICE_URL, params)
+               json = self.read_by_guess(connection, 5)
+               # json = self.read_by_length(connection, 5)
+
                data = DottedDict('ROOT', parse_json(json))
                rsp = data.rsp
 
                if rsp.stat == 'fail':
-                       raise RTMAPIError, 'API call failed - %s (%s)' % (
-                               rsp.err.msg, rsp.err.code)
+                       raise RTMAPIError(
+                               'API call failed - %s (%s)' % (
+                                       rsp.err.msg,
+                                       rsp.err.code,
+                               )
+                       )
                else:
                        return rsp
 
@@ -161,7 +210,7 @@ class RTMAPICategory(object):
 
        def __getattr__(self, attr):
                if attr not in self._methods:
-                       raise AttributeError, 'No such attribute: %s' % attr
+                       raise AttributeError('No such attribute: %s' % attr)
 
                rargs, oargs = self._methods[attr]
                if self._prefix == 'tasksNotes':
@@ -176,7 +225,7 @@ class RTMAPICategory(object):
                # Sanity checks
                for requiredArg in rargs:
                        if requiredArg not in params:
-                               raise TypeError, 'Required parameter (%s) missing' % requiredArg
+                               raise TypeError('Required parameter (%s) missing' % requiredArg)
 
                for param in params:
                        if param not in rargs + oargs: