-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
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,
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))
+ # 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)
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)
else:
body = arg_data
- req = urllib2.Request(uriBase, body, headers)
+ req = urllib.request.Request(uriBase, body, 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())
+ return wrap_response(res, handle.headers)
else:
- return handle.read()
- except urllib2.HTTPError, e:
+ return wrap_response(str(handle.read()), handle.headers)
+ except urllib.error.HTTPError as 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):
"""
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::
"""
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.
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.
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()
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"]
projects / z_archive / twitter.git / blobdiff