X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/1be4ce71813a9b52f00f19bc68cc13e0f99d4403..ce92ec7762914d9499be24d1730338ed1de7f642:/twitter/api.py diff --git a/twitter/api.py b/twitter/api.py index c6aa9a1..694d2c4 100644 --- a/twitter/api.py +++ b/twitter/api.py @@ -3,7 +3,7 @@ import urllib2 from exceptions import Exception from twitter.twitter_globals import POST_ACTIONS -from twitter.auth import UserPassAuth, NoAuth +from twitter.auth import NoAuth def _py26OrGreater(): import sys @@ -39,6 +39,50 @@ class TwitterHTTPError(TwitterError): self.e.code, self.uri, self.format, self.uriparts, self.e.fp.read())) +class TwitterResponse(object): + """ + Response from a twitter request. Behaves like a list or a string + (depending on requested format) but it has a few other interesting + attributes. + + `headers` gives you access to the response headers as an + httplib.HTTPHeaders instance. You can do + `response.headers.getheader('h')` to retrieve a header. + """ + def __init__(self, headers): + self.headers = headers + + @property + def rate_limit_remaining(self): + """ + Remaining requests in the current rate-limit. + """ + return int(self.headers.getheader('X-RateLimit-Remaining')) + + @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')) + + +def wrap_response(response, headers): + response_typ = type(response) + if response_typ is bool: + # HURF DURF MY NAME IS PYTHON AND I CAN'T SUBCLASS bool. + response_typ = int + class WrappedTwitterResponse(TwitterResponse, response_typ): + __doc__ = TwitterResponse.__doc__ + + def __init__(self, response, headers): + response_typ.__init__(self, response) + TwitterResponse.__init__(self, headers) + + return WrappedTwitterResponse(response, headers) + + + class TwitterCall(object): def __init__( self, auth, format, domain, uri="", agent=None, @@ -61,26 +105,22 @@ class TwitterCall(object): secure=self.secure) def __call__(self, **kwargs): - #build the uri + # Build the uri. uriparts = [] for uripart in self.uriparts: - #if this part matches a keyword argument, use the supplied value - #otherwise, just use the part - uriparts.append(kwargs.pop(uripart,uripart)) - uri = '/'.join(uriparts) + # If this part matches a keyword argument, use the + # supplied value otherwise, just use the part. + uriparts.append(unicode(kwargs.pop(uripart, uripart))) + uri = u'/'.join(uriparts) method = "GET" for action in POST_ACTIONS: if uri.endswith(action): method = "POST" - if (self.agent): - kwargs["source"] = self.agent break - """This handles a special case. It isn't really needed anymore because now - we can insert an id value (or any other value) at the end of the - uri (or anywhere else). - However we can leave it for backward compatibility.""" + # 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. id = kwargs.pop('id', None) if id: uri += "/%s" %(id) @@ -95,8 +135,6 @@ class TwitterCall(object): secure_str, self.domain, uri, dot, self.format) headers = {} - if (self.agent): - headers["X-Twitter-Client"] = self.agent if self.auth: headers.update(self.auth.generate_headers()) arg_data = self.auth.encode_params(uriBase, method, kwargs) @@ -111,14 +149,15 @@ class TwitterCall(object): try: handle = urllib2.urlopen(req) if "json" == self.format: - return json.loads(handle.read()) + res = json.loads(handle.read()) + return wrap_response(res, handle.headers) else: - return handle.read() + return wrap_response(str(handle.read()), handle.headers) except urllib2.HTTPError, e: if (e.code == 304): return [] else: - raise TwitterHTTPError(e, uriBase, self.format, self.uriparts) + raise TwitterHTTPError(e, uri, self.format, arg_data) class Twitter(TwitterCall): """ @@ -129,8 +168,8 @@ class Twitter(TwitterCall): The Twitter API is documented here: - http://apiwiki.twitter.com/ - http://groups.google.com/group/twitter-development-talk/web/api-documentation + http://dev.twitter.com/doc + Examples:: @@ -194,8 +233,8 @@ class Twitter(TwitterCall): """ def __init__( - self, email=None, password=None, format="json", - domain="twitter.com", agent=None, secure=True, auth=None, + self, format="json", + domain="twitter.com", secure=True, auth=None, api_version=''): """ Create a new twitter API connector. @@ -208,13 +247,6 @@ class Twitter(TwitterCall): token, token_secret, consumer_key, consumer_secret)) - Alternately you can pass `email` and `password` parameters but - this authentication mode will be deactive by Twitter very soon - and is not recommended:: - - twitter = Twitter(email="blah@blah.com", password="foobar") - - `domain` lets you change the domain you are connecting. By default it's twitter.com but `search.twitter.com` may be useful too. @@ -231,13 +263,6 @@ class Twitter(TwitterCall): nothing, but if you set it to '1' your URI will start with '1/'. """ - if email is not None or password is not None: - if auth: - raise ValueError( - "Can't specify 'email'/'password' and 'auth' params" - " simultaneously.") - auth = UserPassAuth(email, password) - if not auth: auth = NoAuth() @@ -249,8 +274,8 @@ class Twitter(TwitterCall): uriparts += (str(api_version),) TwitterCall.__init__( - self, auth=auth, format=format, domain=domain, agent=agent, + self, auth=auth, format=format, domain=domain, secure=secure, uriparts=uriparts) -__all__ = ["Twitter", "TwitterError", "TwitterHTTPError"] +__all__ = ["Twitter", "TwitterError", "TwitterHTTPError", "TwitterResponse"]