X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/7e43e2edc96e7bf453716d651173dd6396389f42..7bfe7d97d94ea248b1d73c746354cd241203fe5d:/twitter/api.py diff --git a/twitter/api.py b/twitter/api.py index 67e3756..f675822 100644 --- a/twitter/api.py +++ b/twitter/api.py @@ -1,15 +1,7 @@ -""" -Attempting to patch to accommodate API like the list interface. -Note: Make sure not to use keyword substitutions that have the same name -as an argument that will get encoded. -""" - -import urllib2 - -from exceptions import Exception +import urllib.request, urllib.error, urllib.parse from twitter.twitter_globals import POST_ACTIONS -from twitter.auth import UserPassAuth, NoAuth +from twitter.auth import NoAuth def _py26OrGreater(): import sys @@ -32,19 +24,65 @@ class TwitterHTTPError(TwitterError): Exception thrown by the Twitter object when there is an HTTP error interacting with twitter.com. """ - def __init__(self, e, uri, format, encoded_args): + def __init__(self, e, uri, format, uriparts): self.e = e self.uri = uri self.format = format - self.encoded_args = encoded_args + self.uriparts = uriparts def __str__(self): return ( "Twitter sent status %i for URL: %s.%s using parameters: " "(%s)\ndetails: %s" %( - self.e.code, self.uri, self.format, self.encoded_args, + 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(response_typ, TwitterResponse): + __doc__ = TwitterResponse.__doc__ + + def __init__(self, response): + if response_typ is not int: + response_typ.__init__(self, response) + TwitterResponse.__init__(self, headers) + + return WrappedTwitterResponse(response) + + + class TwitterCall(object): def __init__( self, auth, format, domain, uri="", agent=None, @@ -61,31 +99,28 @@ class TwitterCall(object): try: return object.__getattr__(self, k) except AttributeError: - """Instead of incrementally building the uri string, now we - just append to uriparts. We'll build the uri later.""" return TwitterCall( - self.auth, self.format, self.domain, - self.uri, self.agent, self.uriparts + (k,)) + auth=self.auth, format=self.format, domain=self.domain, + agent=self.agent, uriparts=self.uriparts + (k,), + secure=self.secure) def __call__(self, **kwargs): - #build the uri - uri = self.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 - uri = uri + "/" + kwargs.pop(uripart,uripart) + # If this part matches a keyword argument, use the + # supplied value otherwise, just use the part. + uriparts.append(str(kwargs.pop(uripart, uripart))) + uri = '/'.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) @@ -94,38 +129,36 @@ class TwitterCall(object): if self.secure: secure_str = 's' dot = "" - if self.format != '': + if self.format: dot = "." uriBase = "http%s://%s/%s%s%s" %( secure_str, self.domain, uri, dot, self.format) - argStr = "" - argData = None - if (method == "GET"): - if self.encoded_args: - argStr = "?%s" %(self.encoded_args) - else: - argData = self.encoded_args - headers = {} - if (self.agent): - headers["X-Twitter-Client"] = self.agent - if self.auth is not None: + if self.auth: headers.update(self.auth.generate_headers()) + arg_data = self.auth.encode_params(uriBase, method, kwargs) + if method == 'GET': + uriBase += '?' + arg_data + body = None + else: + body = arg_data.encode('utf8') + + req = urllib.request.Request(uriBase, body, headers) - req = urllib2.Request(uriBase+argStr, argData, headers) - try: - handle = urllib2.urlopen(req) + handle = urllib.request.urlopen(req) if "json" == self.format: - return json.loads(handle.read()) + res = json.loads(handle.read().decode('utf8')) + return wrap_response(res, handle.headers) else: - return handle.read() - except urllib2.HTTPError, e: + return wrap_response( + handle.read().decode('utf8'), handle.headers) + except urllib.error.HTTPError as e: if (e.code == 304): return [] else: - raise TwitterHTTPError(e, uri, self.format, self.encoded_args) + raise TwitterHTTPError(e, uri, self.format, arg_data) class Twitter(TwitterCall): """ @@ -136,8 +169,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:: @@ -201,8 +234,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. @@ -215,13 +248,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. @@ -238,26 +264,19 @@ 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() if (format not in ("json", "xml", "")): raise ValueError("Unknown data format '%s'" %(format)) - uri = "" + uriparts = () if api_version: - uri = str(api_version) + uriparts += (str(api_version),) TwitterCall.__init__( - self, auth, format, domain, uri, agent, - (), secure=secure) + self, auth=auth, format=format, domain=domain, + secure=secure, uriparts=uriparts) -__all__ = ["Twitter", "TwitterError", "TwitterHTTPError"] +__all__ = ["Twitter", "TwitterError", "TwitterHTTPError", "TwitterResponse"]