X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/8ac8f6bb94866160116f5419ba8899ff787e877c..0a24ba9ece4445032c2fcdccf0264065b062eb5f:/twitter/api.py diff --git a/twitter/api.py b/twitter/api.py index 6cfc650..0ebc814 100644 --- a/twitter/api.py +++ b/twitter/api.py @@ -5,13 +5,24 @@ except ImportError: import urllib2 as urllib_request import urllib2 as urllib_error -from twitter.twitter_globals import POST_ACTIONS -from twitter.auth import NoAuth +try: + from cStringIO import StringIO +except ImportError: + from io import BytesIO as StringIO + +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 @@ -33,13 +44,26 @@ class TwitterHTTPError(TwitterError): self.uri = uri self.format = format self.uriparts = uriparts + 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 = data def __str__(self): + fmt = ("." + self.format) if self.format else "" return ( - "Twitter sent status %i for URL: %s.%s using parameters: " + "Twitter sent status %i for URL: %s%s using parameters: " "(%s)\ndetails: %s" %( - self.e.code, self.uri, self.format, self.uriparts, - self.e.fp.read())) + self.e.code, self.uri, fmt, self.uriparts, + self.response_data)) class TwitterResponse(object): """ @@ -49,7 +73,7 @@ class TwitterResponse(object): `headers` gives you access to the response headers as an httplib.HTTPHeaders instance. You can do - `response.headers.getheader('h')` to retrieve a header. + `response.headers.get('h')` to retrieve a header. """ def __init__(self, headers): self.headers = headers @@ -59,14 +83,21 @@ class TwitterResponse(object): """ Remaining requests in the current rate-limit. """ - return int(self.headers.getheader('X-RateLimit-Remaining')) + return int(self.headers.get('X-Rate-Limit-Remaining', "0")) + + @property + def rate_limit_limit(self): + """ + The rate limit ceiling for that given request. + """ + return int(self.headers.get('X-Rate-Limit-Limit', "0")) @property def rate_limit_reset(self): """ Time in UTC epoch seconds when the rate limit will reset. """ - return int(self.headers.getheader('X-RateLimit-Reset')) + return int(self.headers.get('X-Rate-Limit-Reset', "0")) def wrap_response(response, headers): @@ -74,16 +105,19 @@ 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__ - def __init__(self, response): - if response_typ is not int: - response_typ.__init__(self, response) + def __init__(self, response, headers): + response_typ.__init__(self, response) TwitterResponse.__init__(self, headers) + def __new__(cls, response, headers): + return response_typ.__new__(cls, response) - return WrappedTwitterResponse(response) + return WrappedTwitterResponse(response, headers) @@ -124,11 +158,13 @@ class TwitterCall(object): uriparts.append(str(kwargs.pop(uripart, uripart))) uri = '/'.join(uriparts) - method = "GET" - for action in POST_ACTIONS: - if uri.endswith(action): - method = "POST" - break + method = kwargs.pop('_method', None) + if not method: + method = "GET" + for action in POST_ACTIONS: + if re.search("%s(/\d+)?$" % action, uri): + method = "POST" + break # If an id kwarg is present and there is no id to fill in in # the list of uriparts, assume the id goes at the end. @@ -136,6 +172,15 @@ class TwitterCall(object): if id: uri += "/%s" %(id) + # If an _id kwarg is present, this is treated as id as a CGI + # param. + _id = kwargs.pop('_id', None) + 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' @@ -145,7 +190,7 @@ class TwitterCall(object): uriBase = "http%s://%s/%s%s%s" %( secure_str, self.domain, uri, dot, self.format) - headers = {} + headers = {'Accept-Encoding': 'gzip'} if self.auth: headers.update(self.auth.generate_headers()) arg_data = self.auth.encode_params(uriBase, method, kwargs) @@ -156,17 +201,33 @@ class TwitterCall(object): 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 + 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(data) + f = gzip.GzipFile(fileobj=buf) + data = f.read() if "json" == self.format: - res = json.loads(handle.read().decode('utf8')) + res = json.loads(data.decode('utf8')) return wrap_response(res, handle.headers) else: return wrap_response( - handle.read().decode('utf8'), handle.headers) + data.decode('utf8'), handle.headers) except urllib_error.HTTPError as e: if (e.code == 304): return [] @@ -180,43 +241,54 @@ class Twitter(TwitterCall): Get RESTful data by accessing members of this class. The result is decoded python objects (lists and dicts). - The Twitter API is documented here: + The Twitter API is documented at: http://dev.twitter.com/doc Examples:: - twitter = Twitter( - auth=OAuth(token, token_key, con_secret, con_secret_key))) + t = Twitter( + auth=OAuth(token, token_key, con_secret, con_secret_key))) - # Get the public timeline - twitter.statuses.public_timeline() + # Get your "home" timeline + t.statuses.home_timeline() - # Get a particular friend's timeline - twitter.statuses.friends_timeline(id="billybob") + # Get a particular friend's timeline + t.statuses.friends_timeline(id="billybob") - # Also supported (but totally weird) - twitter.statuses.friends_timeline.billybob() + # Also supported (but totally weird) + t.statuses.friends_timeline.billybob() - # Send a direct message - twitter.direct_messages.new( - user="billybob", - text="I think yer swell!") + # Update your status + t.statuses.update( + status="Using @sixohsix's sweet Python Twitter Tools.") - # Get the members of a particular list of a particular friend - twitter.user.listname.members(user="billybob", listname="billysbuds") + # Send a direct message + t.direct_messages.new( + user="billybob", + text="I think yer swell!") + # Get the members of tamtar's list "Things That Are Rad" + t._("tamtar")._("things-that-are-rad").members() - Searching Twitter:: + # Note how the magic `_` method can be used to insert data + # into the middle of a call. You can also use replacement: + t.user.list.members(user="tamtar", list="things-that-are-rad") - twitter_search = Twitter(domain="search.twitter.com") + # 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) - # Find the latest search trends - twitter_search.trends() - # Search for the latest News on #gaza - twitter_search.search(q="#gaza") + + Searching Twitter:: + + # Search for the latest tweets about #pycon + t.search.tweets(q="#pycon") Using the data returned @@ -225,13 +297,13 @@ 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] + # The first 'tweet' in the timeline + x[0] - # The screen name of the user who wrote the first 'tweet' - x[0]['user']['screen_name'] + # The screen name of the user who wrote the first 'tweet' + x[0]['user']['screen_name'] Getting raw XML data @@ -240,10 +312,10 @@ class Twitter(TwitterCall): If you prefer to get your Twitter data in XML format, pass format="xml" to the Twitter object when you instantiate it:: - twitter = Twitter(format="xml") + twitter = Twitter(format="xml") - The output will not be parsed in any way. It will be a raw string - of XML. + The output will not be parsed in any way. It will be a raw string + of XML. """ def __init__( @@ -278,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' - else: - api_version = None + api_version = '1.1' uriparts = () if api_version: