X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/4ad03f81ca668732cb6035ddb761651dc7b523c7..f7e6380227ca479157ce8d4e782772ca9b732b71:/twitter/api.py diff --git a/twitter/api.py b/twitter/api.py index 47dae5d..9803c4b 100644 --- a/twitter/api.py +++ b/twitter/api.py @@ -1,10 +1,7 @@ +import urllib.request, urllib.error, urllib.parse -from base64 import b64encode -from urllib import urlencode - -import httplib - -from exceptions import Exception +from twitter.twitter_globals import POST_ACTIONS +from twitter.auth import NoAuth def _py26OrGreater(): import sys @@ -17,117 +14,188 @@ else: class TwitterError(Exception): """ - Exception thrown by the Twitter object when there is an - error interacting with twitter.com. + Base Exception thrown by the Twitter object when there is a + general error interacting with the API. """ pass -# These actions require POST http requests instead of GET -_POST_ACTIONS = [ - "create", "update", "destroy", "new", "follow", "leave", - ] +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, uriparts): + self.e = e + self.uri = uri + self.format = format + 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.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, username, password, format, domain, uri="", agent=None): - self.username = username - self.password = password + self, auth, format, domain, uri="", agent=None, + uriparts=None, secure=True): + self.auth = auth self.format = format self.domain = domain self.uri = uri self.agent = agent + self.uriparts = uriparts + self.secure = secure + def __getattr__(self, k): try: return object.__getattr__(self, k) except AttributeError: return TwitterCall( - self.username, self.password, self.format, self.domain, - self.uri + "/" + k, self.agent) + auth=self.auth, format=self.format, domain=self.domain, + agent=self.agent, uriparts=self.uriparts + (k,), + secure=self.secure) + def __call__(self, **kwargs): - 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. + uriparts.append(str(kwargs.pop(uripart, uripart))) + uri = '/'.join(uriparts) + method = "GET" - for action in _POST_ACTIONS: - if self.uri.endswith(action): + for action in POST_ACTIONS: + if uri.endswith(action): method = "POST" - if (self.agent): - kwargs["source"] = self.agent 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. id = kwargs.pop('id', None) if id: uri += "/%s" %(id) - - encoded_kwargs = urlencode(kwargs.items()) - argStr = "" - if kwargs and (method == "GET"): - argStr = "?" + encoded_kwargs + + secure_str = '' + if self.secure: + secure_str = 's' + dot = "" + if self.format: + dot = "." + uriBase = "http%s://%s/%s%s%s" %( + secure_str, self.domain, uri, dot, self.format) headers = {} - if (self.agent): - headers["X-Twitter-Client"] = self.agent - if (self.username): - headers["Authorization"] = "Basic " + b64encode("%s:%s" %( - self.username, self.password)) - if method == "POST": - headers["Content-type"] = "application/x-www-form-urlencoded" - headers["Content-length"] = len(encoded_kwargs) - - c = httplib.HTTPConnection(self.domain) + 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 + + req = urllib.request.Request(uriBase, body, headers) + try: - c.putrequest(method, "%s.%s%s" %( - uri, self.format, argStr)) - for item in headers.iteritems(): - c.putheader(*item) - c.endheaders() - if method == "POST": - c.send(encoded_kwargs) - r = c.getresponse() - - if (r.status == 304): - return [] - elif (r.status != 200): - raise TwitterError( - "Twitter sent status %i for URL: %s.%s using parameters: (%s)\ndetails: %s" %( - r.status, uri, self.format, encoded_kwargs, r.read())) + handle = urllib.request.urlopen(req) if "json" == self.format: - return json.loads(r.read()) + res = json.loads(handle.read()) + return wrap_response(res, handle.headers) + else: + return wrap_response(str(handle.read()), handle.headers) + except urllib.error.HTTPError as e: + if (e.code == 304): + return [] else: - return r.read() - finally: - c.close() + raise TwitterHTTPError(e, uri, self.format, arg_data) class Twitter(TwitterCall): """ The minimalist yet fully featured Twitter API class. - + Get RESTful data by accessing members of this class. The result is decoded python objects (lists and dicts). 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:: - - twitter = Twitter("hello@foo.com", "password123") - + + twitter = Twitter( + auth=OAuth(token, token_key, con_secret, con_secret_key))) + # Get the public timeline twitter.statuses.public_timeline() - + # Get a particular friend's timeline twitter.statuses.friends_timeline(id="billybob") - + # Also supported (but totally weird) twitter.statuses.friends_timeline.billybob() - + # Send a direct message twitter.direct_messages.new( user="billybob", text="I think yer swell!") + # Get the members of a particular list of a particular friend + twitter.user.listname.members(user="billybob", listname="billysbuds") + + Searching Twitter:: - + twitter_search = Twitter(domain="search.twitter.com") # Find the latest search trends @@ -136,10 +204,12 @@ class Twitter(TwitterCall): # Search for the latest News on #gaza twitter_search.search(q="#gaza") - Using the data returned:: - Twitter API calls return decoded JSON. This is converted into - a bunch of Python lists, dicts, ints, and strings. For example, + Using the data returned + ----------------------- + + 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() @@ -148,27 +218,64 @@ class Twitter(TwitterCall): # The screen name of the user who wrote the first 'tweet' x[0]['user']['screen_name'] - - Getting raw XML data:: - - If you prefer to get your Twitter data in XML format, pass - format="xml" to the Twitter object when you instantiate it: - + + + Getting raw XML data + -------------------- + + 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") - + The output will not be parsed in any way. It will be a raw string of XML. + """ def __init__( - self, email=None, password=None, format="json", domain="twitter.com", - agent=None): + self, format="json", + domain="twitter.com", secure=True, auth=None, + api_version=''): """ - Create a new twitter API connector using the specified - credentials (email and password). Format specifies the output - format ("json" (default) or "xml"). + Create a new twitter API connector. + + Pass an `auth` parameter to use the credentials of a specific + user. Generally you'll want to pass an `OAuth` + instance:: + + twitter = Twitter(auth=OAuth( + token, token_secret, consumer_key, consumer_secret)) + + + `domain` lets you change the domain you are connecting. By + default it's twitter.com but `search.twitter.com` may be + useful too. + + If `secure` is False you will connect with HTTP instead of + HTTPS. + + The value of `agent` is sent in the `X-Twitter-Client` + header. This is deprecated. Instead Twitter determines the + application using the OAuth Client Key and Client Key Secret + parameters. + + `api_version` is used to set the base uri. By default it's + nothing, but if you set it to '1' your URI will start with + '1/'. """ - if (format not in ("json", "xml")): - raise TwitterError("Unknown data format '%s'" %(format)) - TwitterCall.__init__(self, email, password, format, domain, "", agent) + if not auth: + auth = NoAuth() + + if (format not in ("json", "xml", "")): + raise ValueError("Unknown data format '%s'" %(format)) + + uriparts = () + if api_version: + uriparts += (str(api_version),) + + TwitterCall.__init__( + self, auth=auth, format=format, domain=domain, + secure=secure, uriparts=uriparts) + -__all__ = ["Twitter", "TwitterError"] +__all__ = ["Twitter", "TwitterError", "TwitterHTTPError", "TwitterResponse"]