from base64 import b64encode
+from urllib import urlencode
-import httplib
-import simplejson
+import urllib2
+
+from exceptions import Exception
+
+from twitter.twitter_globals import POST_ACTIONS
+
+def _py26OrGreater():
+ import sys
+ return sys.hexversion > 0x20600f0
+
+if _py26OrGreater():
+ import json
+else:
+ import simplejson as json
+
+class TwitterError(Exception):
+ """
+ Exception thrown by the Twitter object when there is an
+ error interacting with twitter.com.
+ """
+ pass
class TwitterCall(object):
- def __init__(self, username=None, password=None, uri=""):
+ def __init__(
+ self, username, password, format, domain, uri="", agent=None, encoded_args=None):
self.username = username
self.password = password
+ self.format = format
+ self.domain = domain
self.uri = uri
+ self.agent = agent
+ self.encoded_args = encoded_args
+
def __getattr__(self, k):
try:
return object.__getattr__(self, k)
except AttributeError:
return TwitterCall(
- self.username, self.password, self.uri + "/" + k)
+ self.username, self.password, self.format, self.domain,
+ self.uri + "/" + k, self.agent, self.encoded_args)
+
def __call__(self, **kwargs):
+ uri = self.uri
method = "GET"
- if self.uri.endswith('new') or self.uri.endswith('update'):
- method = "POST"
+ for action in POST_ACTIONS:
+ if self.uri.endswith(action):
+ method = "POST"
+ if (self.agent):
+ kwargs["source"] = self.agent
+ break
+
+ if (not self.encoded_args):
+ if kwargs.has_key('id'):
+ uri += "/%s" %(kwargs['id'])
+
+ self.encoded_args = urlencode(kwargs.items())
+
argStr = ""
- if kwargs:
- argStr = "?" + "&".join([
- "%s=%s" %(k, v) for k, v in kwargs.iteritems()])
- c = httplib.HTTPConnection("twitter.com")
+ 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.username):
+ headers["Authorization"] = "Basic " + b64encode("%s:%s" %(
+ self.username, self.password))
+
+ req = urllib2.Request(
+ "http://%s/%s.%s%s" %(self.domain, uri, self.format, argStr),
+ argData, headers
+ )
try:
- c.putrequest(method, "/%s.json%s" %(self.uri, argStr))
- if (self.username):
- c.putheader("Authorization", "Basic "
- + b64encode("%s:%s" %(
- self.username, self.password)))
- c.endheaders()
- r = c.getresponse()
- if (r.status == 304):
+ handle = urllib2.urlopen(req)
+ if "json" == self.format:
+ return json.loads(handle.read())
+ else:
+ return handle.read()
+ except urllib2.HTTPError, e:
+ if (e.code == 304):
return []
- elif (r.status != 200):
- raise Exception("Twitter sent status %i: %s" %(
- r.status, r.read()))
- return simplejson.loads(r.read())
- finally:
- c.close()
+ 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()))
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://groups.google.com/group/twitter-development-talk/web/api-documentation
-
+
+ http://apiwiki.twitter.com/
+ http://groups.google.com/group/twitter-development-talk/web/api-documentation
+
Examples::
-
+
twitter = Twitter("hello@foo.com", "password123")
-
+
# 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!")
+ Searching Twitter::
+
+ twitter_search = Twitter(domain="search.twitter.com")
+
+ # Find the latest search trends
+ twitter_search.trends()
+
+ # 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
# 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:
+
+ 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):
+ def __init__(
+ self, email=None, password=None, format="json", domain="twitter.com",
+ agent=None):
"""
Create a new twitter API connector using the specified
- credentials (email and password).
+ credentials (email and password). Format specifies the output
+ format ("json" (default) or "xml").
"""
- TwitterCall.__init__(self, email, password)
+ if (format not in ("json", "xml")):
+ raise TwitterError("Unknown data format '%s'" %(format))
+ TwitterCall.__init__(self, email, password, format, domain, "", agent)
-__all__ = ["Twitter"]
+__all__ = ["Twitter", "TwitterError"]
projects / z_archive / twitter.git / blobdiff