X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/4e9d63435b514ee669b2fb0045180aa1b49abfdc..652c5402f2c931dd91af107b4419f69541f78ca3:/twitter/api.py diff --git a/twitter/api.py b/twitter/api.py index 118d4fb..4520e35 100644 --- a/twitter/api.py +++ b/twitter/api.py @@ -1,94 +1,172 @@ +try: + import urllib.request as urllib_request + import urllib.error as urllib_error +except ImportError: + import urllib2 as urllib_request + import urllib2 as urllib_error -from base64 import b64encode -from urllib import urlencode +from twitter.twitter_globals import POST_ACTIONS +from twitter.auth import NoAuth -import urllib2 - -from exceptions import Exception - -from twitter.twitter_globals import _POST_ACTIONS - -def _py26OrGreater(): - import sys - return sys.hexversion > 0x20600f0 - -if _py26OrGreater(): +try: import json -else: +except ImportError: import simplejson as json +class _DEFAULT(object): + pass + 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 +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, callable_cls, uri="", + uriparts=None, secure=True): + self.auth = auth self.format = format self.domain = domain + self.callable_cls = callable_cls 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) + return self.callable_cls( + auth=self.auth, format=self.format, domain=self.domain, + callable_cls=self.callable_cls, 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 = "" - argData = None - encoded_kwargs = urlencode(kwargs.items()) - if kwargs: - if (method == "GET"): - argStr = "?%s" %(encoded_kwargs) - else: - argData = 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)) - - req = urllib2.Request( - "http://%s/%s.%s%s" %(self.domain, self.uri, self.format, argStr), - argData, headers - ) + 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) + return self._handle_response(req, uri, arg_data) + + def _handle_response(self, req, uri, arg_data): 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 TwitterError( - "Twitter sent status %i for URL: %s.%s using parameters: (%s)\ndetails: %s" %( - e.code, uri, self.format, encoded_kwargs, e.fp.read())) - + raise TwitterHTTPError(e, uri, self.format, arg_data) + class Twitter(TwitterCall): """ The minimalist yet fully featured Twitter API class. @@ -98,12 +176,13 @@ 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:: - 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() @@ -119,6 +198,10 @@ class Twitter(TwitterCall): 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") @@ -129,10 +212,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() @@ -142,26 +227,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="api.twitter.com", secure=True, auth=None, + api_version=_DEFAULT): """ - 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 `api.twitter.com` but `search.twitter.com` may be + useful too. + + If `secure` is False you will connect with HTTP instead of + HTTPS. + + `api_version` is used to set the base uri. By default it's + '1'. If you are using "search.twitter.com" set this to None. """ - 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)) + + if api_version is _DEFAULT: + if domain == 'api.twitter.com': + api_version = '1' + else: + api_version = None + + uriparts = () + if api_version: + uriparts += (str(api_version),) + + TwitterCall.__init__( + self, auth=auth, format=format, domain=domain, + callable_cls=TwitterCall, + secure=secure, uriparts=uriparts) + -__all__ = ["Twitter", "TwitterError"] +__all__ = ["Twitter", "TwitterError", "TwitterHTTPError", "TwitterResponse"]