Update some of the cmdline to support API 1.1.

[z_archive/twitter.git] / twitter / api.py

diff --git a/twitter/api.py b/twitter/api.py
index 8c4379d11560a2a40b3a13f93d2a1dc46d5cb04e..0ebc814e1954d5881dfefbdf65393cbc77d9a5d2 100644 (file)
--- a/twitter/api.py
+++ b/twitter/api.py
@@ -10,16 +10,19 @@ try:
 except ImportError:
     from io import BytesIO as StringIO
 
-from twitter.twitter_globals import POST_ACTIONS
-from twitter.auth import NoAuth
+from .twitter_globals import POST_ACTIONS
+from .auth import NoAuth
 
 import re
 import gzip
 
 try:
-    import json
+    import http.client as http_client
 except ImportError:
-    import simplejson as json
+    import httplib as http_client
+
+import json
+
 
 class _DEFAULT(object):
     pass
@@ -41,12 +44,18 @@ class TwitterHTTPError(TwitterError):
         self.uri = uri
         self.format = format
         self.uriparts = uriparts
-        if self.e.headers['Content-Encoding'] == 'gzip':
-            buf = StringIO(self.e.fp.read())
+        try:
+            data = self.e.fp.read()
+        except http_client.IncompleteRead as e:
+            # can't read the error text
+            # let's try some of it
+            data = e.partial
+        if self.e.headers.get('Content-Encoding') == 'gzip':
+            buf = StringIO(data)
             f = gzip.GzipFile(fileobj=buf)
             self.response_data = f.read()
         else:
-            self.response_data = self.e.fp.read()
+            self.response_data = data
 
     def __str__(self):
         fmt = ("." + self.format) if self.format else ""
@@ -79,7 +88,7 @@ class TwitterResponse(object):
     @property
     def rate_limit_limit(self):
         """
-        Remaining requests in the current rate-limit.
+        The rate limit ceiling for that given request.
         """
         return int(self.headers.get('X-Rate-Limit-Limit', "0"))
 
@@ -96,6 +105,8 @@ def wrap_response(response, headers):
     if response_typ is bool:
         # HURF DURF MY NAME IS PYTHON AND I CAN'T SUBCLASS bool.
         response_typ = int
+    elif response_typ is str:
+        return response
 
     class WrappedTwitterResponse(response_typ, TwitterResponse):
         __doc__ = TwitterResponse.__doc__
@@ -106,7 +117,6 @@ def wrap_response(response, headers):
         def __new__(cls, response, headers):
             return response_typ.__new__(cls, response)
 
-
     return WrappedTwitterResponse(response, headers)
 
 
@@ -168,6 +178,9 @@ class TwitterCall(object):
         if _id:
             kwargs['id'] = _id
 
+        # If an _timeout is specified in kwargs, use it
+        _timeout = kwargs.pop('_timeout', None)
+
         secure_str = ''
         if self.secure:
             secure_str = 's'
@@ -186,22 +199,29 @@ class TwitterCall(object):
                 body = None
             else:
                 body = arg_data.encode('utf8')
+
         req = urllib_request.Request(uriBase, body, headers)
-        return self._handle_response(req, uri, arg_data)
+        return self._handle_response(req, uri, arg_data, _timeout)
 
-    def _handle_response(self, req, uri, arg_data):
+    def _handle_response(self, req, uri, arg_data, _timeout=None):
+        kwargs = {}
+        if _timeout:
+            kwargs['timeout'] = _timeout
         try:
-            handle = urllib_request.urlopen(req)
+            handle = urllib_request.urlopen(req, **kwargs)
             if handle.headers['Content-Type'] in ['image/jpeg', 'image/png']:
                 return handle
-            elif handle.info().get('Content-Encoding') == 'gzip':
+            try:
+                data = handle.read()
+            except http_client.IncompleteRead as e:
+                # Even if we don't get all the bytes we should have there
+                # may be a complete response in e.partial
+                data = e.partial
+            if handle.info().get('Content-Encoding') == 'gzip':
                 # Handle gzip decompression
-                buf = StringIO(handle.read())
+                buf = StringIO(data)
                 f = gzip.GzipFile(fileobj=buf)
                 data = f.read()
-            else:
-                data = handle.read()
-
             if "json" == self.format:
                 res = json.loads(data.decode('utf8'))
                 return wrap_response(res, handle.headers)
@@ -231,8 +251,8 @@ class Twitter(TwitterCall):
         t = Twitter(
             auth=OAuth(token, token_key, con_secret, con_secret_key)))
 
-        # Get the public timeline
-        t.statuses.public_timeline()
+        # Get your "home" timeline
+        t.statuses.home_timeline()
 
         # Get a particular friend's timeline
         t.statuses.friends_timeline(id="billybob")
@@ -256,16 +276,19 @@ class Twitter(TwitterCall):
         # into the middle of a call. You can also use replacement:
         t.user.list.members(user="tamtar", list="things-that-are-rad")
 
+        # An *optional* `_timeout` parameter can also be used for API
+        # calls which take much more time than normal or twitter stops
+        # responding for some reasone
+        t.users.lookup(
+            screen_name=','.join(A_LIST_OF_100_SCREEN_NAMES), \
+            _timeout=1)
 
-    Searching Twitter::
 
-        twitter_search = Twitter(domain="search.twitter.com")
 
-        # Find the latest search trends
-        twitter_search.trends()
+    Searching Twitter::
 
-        # Search for the latest News on #gaza
-        twitter_search.search(q="#gaza")
+        # Search for the latest tweets about #pycon
+        t.search.tweets(q="#pycon")
 
 
     Using the data returned
@@ -274,7 +297,7 @@ class Twitter(TwitterCall):
     Twitter API calls return decoded JSON. This is converted into
     a bunch of Python lists, dicts, ints, and strings. For example::
 
-        x = twitter.statuses.public_timeline()
+        x = twitter.statuses.home_timeline()
 
         # The first 'tweet' in the timeline
         x[0]
@@ -327,10 +350,7 @@ class Twitter(TwitterCall):
             raise ValueError("Unknown data format '%s'" %(format))
 
         if api_version is _DEFAULT:
-            if domain == 'api.twitter.com':
-                api_version = '1.1'
-            else:
-                api_version = None
+            api_version = '1.1'
 
         uriparts = ()
         if api_version: