This commit is contained in:
GitHub Merge Button 2012-03-21 12:27:20 -07:00
commit 65b62ff252
2 changed files with 77 additions and 79 deletions

View file

@ -4,7 +4,7 @@ from setuptools import setup
from setuptools import find_packages from setuptools import find_packages
__author__ = 'Ryan McGrath <ryan@venodesigns.net>' __author__ = 'Ryan McGrath <ryan@venodesigns.net>'
__version__ = '1.5.0' __version__ = '1.5.1'
setup( setup(
# Basic package information. # Basic package information.

View file

@ -9,7 +9,7 @@
""" """
__author__ = "Ryan McGrath <ryan@venodesigns.net>" __author__ = "Ryan McGrath <ryan@venodesigns.net>"
__version__ = "1.5.0" __version__ = "1.5.1"
import urllib import urllib
import re import re
@ -95,12 +95,13 @@ class TwythonAPILimit(TwythonError):
def __str__(self): def __str__(self):
return repr(self.msg) return repr(self.msg)
class APILimit(TwythonError): class APILimit(TwythonError):
""" """
Raised when you've hit an API limit. Try to avoid these, read the API Raised when you've hit an API limit. Try to avoid these, read the API
docs if you're running into issues here, Twython does not concern itself with docs if you're running into issues here, Twython does not concern itself with
this matter beyond telling you that you've done goofed. this matter beyond telling you that you've done goofed.
DEPRECATED, import and catch TwythonAPILimit instead. DEPRECATED, import and catch TwythonAPILimit instead.
""" """
def __init__(self, msg): def __init__(self, msg):
@ -168,44 +169,44 @@ class Twython(object):
""" """
OAuthHook.consumer_key = twitter_token OAuthHook.consumer_key = twitter_token
OAuthHook.consumer_secret = twitter_secret OAuthHook.consumer_secret = twitter_secret
# Needed for hitting that there API. # Needed for hitting that there API.
self.request_token_url = 'http://twitter.com/oauth/request_token' self.request_token_url = 'http://twitter.com/oauth/request_token'
self.access_token_url = 'http://twitter.com/oauth/access_token' self.access_token_url = 'http://twitter.com/oauth/access_token'
self.authorize_url = 'http://twitter.com/oauth/authorize' self.authorize_url = 'http://twitter.com/oauth/authorize'
self.authenticate_url = 'http://twitter.com/oauth/authenticate' self.authenticate_url = 'http://twitter.com/oauth/authenticate'
self.twitter_token = twitter_token self.twitter_token = twitter_token
self.twitter_secret = twitter_secret self.twitter_secret = twitter_secret
self.oauth_token = oauth_token self.oauth_token = oauth_token
self.oauth_secret = oauth_token_secret self.oauth_secret = oauth_token_secret
self.callback_url = callback_url self.callback_url = callback_url
# If there's headers, set them, otherwise be an embarassing parent for their own good. # If there's headers, set them, otherwise be an embarassing parent for their own good.
self.headers = headers self.headers = headers
if self.headers is None: if self.headers is None:
self.headers = {'User-agent': 'Twython Python Twitter Library v' + __version__} self.headers = {'User-agent': 'Twython Python Twitter Library v' + __version__}
self.client = None self.client = None
if self.twitter_token is not None and self.twitter_secret is not None: if self.twitter_token is not None and self.twitter_secret is not None:
self.client = requests.session(hooks={'pre_request': OAuthHook()}) self.client = requests.session(hooks={'pre_request': OAuthHook()})
if self.oauth_token is not None and self.oauth_secret is not None: if self.oauth_token is not None and self.oauth_secret is not None:
self.oauth_hook = OAuthHook(self.oauth_token, self.oauth_secret) self.oauth_hook = OAuthHook(self.oauth_token, self.oauth_secret)
self.client = requests.session(hooks={'pre_request': self.oauth_hook}) self.client = requests.session(hooks={'pre_request': self.oauth_hook})
# Filter down through the possibilities here - if they have a token, if they're first stage, etc. # Filter down through the possibilities here - if they have a token, if they're first stage, etc.
if self.client is None: if self.client is None:
# If they don't do authentication, but still want to request unprotected resources, we need an opener. # If they don't do authentication, but still want to request unprotected resources, we need an opener.
self.client = requests.session() self.client = requests.session()
# register available funcs to allow listing name when debugging. # register available funcs to allow listing name when debugging.
def setFunc(key): def setFunc(key):
return lambda **kwargs: self._constructFunc(key, **kwargs) return lambda **kwargs: self._constructFunc(key, **kwargs)
for key in api_table.keys(): for key in api_table.keys():
self.__dict__[key] = setFunc(key) self.__dict__[key] = setFunc(key)
def _constructFunc(self, api_call, **kwargs): def _constructFunc(self, api_call, **kwargs):
# Go through and replace any mustaches that are in our API url. # Go through and replace any mustaches that are in our API url.
fn = api_table[api_call] fn = api_table[api_call]
@ -215,21 +216,21 @@ class Twython(object):
lambda m: "%s" % kwargs.get(m.group(1), '1'), lambda m: "%s" % kwargs.get(m.group(1), '1'),
base_url + fn['url'] base_url + fn['url']
) )
method = fn['method'].lower() method = fn['method'].lower()
if not method in ('get', 'post', 'delete'): if not method in ('get', 'post', 'delete'):
raise TwythonError('Method must be of GET, POST or DELETE') raise TwythonError('Method must be of GET, POST or DELETE')
if method == 'get': if method == 'get':
myargs = ['%s=%s' % (key, value) for (key, value) in kwargs.iteritems()] myargs = ['%s=%s' % (key, value) for (key, value) in kwargs.iteritems()]
else: else:
myargs = kwargs myargs = kwargs
func = getattr(self.client, method) func = getattr(self.client, method)
response = func(base, data=myargs) response = func(base, data=myargs)
return simplejson.loads(response.content.decode('utf-8')) return simplejson.loads(response.content.decode('utf-8'))
def get_authentication_tokens(self): def get_authentication_tokens(self):
""" """
get_auth_url(self) get_auth_url(self)
@ -237,41 +238,38 @@ class Twython(object):
Returns an authorization URL for a user to hit. Returns an authorization URL for a user to hit.
""" """
callback_url = self.callback_url or 'oob' callback_url = self.callback_url or 'oob'
request_args = {} request_args = {}
request_args['oauth_callback'] = callback_url request_args['oauth_callback'] = callback_url
method = 'get' method = 'get'
if not OAUTH_LIB_SUPPORTS_CALLBACK:
method = 'post'
func = getattr(self.client, method) func = getattr(self.client, method)
response = func(self.request_token_url, data=request_args) response = func(self.request_token_url, data=request_args)
if response.status_code != 200: if response.status_code != 200:
raise TwythonAuthError("Seems something couldn't be verified with your OAuth junk. Error: %s, Message: %s" % (response.status_code, response.content)) raise TwythonAuthError("Seems something couldn't be verified with your OAuth junk. Error: %s, Message: %s" % (response.status_code, response.content))
request_tokens = dict(parse_qsl(response.content)) request_tokens = dict(parse_qsl(response.content))
if not request_tokens: if not request_tokens:
raise TwythonError('Unable to decode request tokens.') raise TwythonError('Unable to decode request tokens.')
oauth_callback_confirmed = request_tokens.get('oauth_callback_confirmed') == 'true' oauth_callback_confirmed = request_tokens.get('oauth_callback_confirmed') == 'true'
if not OAUTH_LIB_SUPPORTS_CALLBACK and callback_url != 'oob' and oauth_callback_confirmed: if not OAUTH_LIB_SUPPORTS_CALLBACK and callback_url != 'oob' and oauth_callback_confirmed:
import warnings import warnings
warnings.warn("oauth2 library doesn't support OAuth 1.0a type callback, but remote requires it") warnings.warn("oauth2 library doesn't support OAuth 1.0a type callback, but remote requires it")
oauth_callback_confirmed = False oauth_callback_confirmed = False
auth_url_params = { auth_url_params = {
'oauth_token': request_tokens['oauth_token'], 'oauth_token': request_tokens['oauth_token'],
} }
# Use old-style callback argument # Use old-style callback argument
if OAUTH_CALLBACK_IN_URL or (callback_url != 'oob' and not oauth_callback_confirmed): if OAUTH_CALLBACK_IN_URL or (callback_url != 'oob' and not oauth_callback_confirmed):
auth_url_params['oauth_callback'] = callback_url auth_url_params['oauth_callback'] = callback_url
request_tokens['auth_url'] = self.authenticate_url + '?' + urllib.urlencode(auth_url_params) request_tokens['auth_url'] = self.authenticate_url + '?' + urllib.urlencode(auth_url_params)
return request_tokens return request_tokens
def get_authorized_tokens(self): def get_authorized_tokens(self):
@ -286,35 +284,35 @@ class Twython(object):
raise TwythonError('Unable to decode authorized tokens.') raise TwythonError('Unable to decode authorized tokens.')
return authorized_tokens return authorized_tokens
# ------------------------------------------------------------------------------------------------------------------------ # ------------------------------------------------------------------------------------------------------------------------
# The following methods are all different in some manner or require special attention with regards to the Twitter API. # The following methods are all different in some manner or require special attention with regards to the Twitter API.
# Because of this, we keep them separate from all the other endpoint definitions - ideally this should be change-able, # Because of this, we keep them separate from all the other endpoint definitions - ideally this should be change-able,
# but it's not high on the priority list at the moment. # but it's not high on the priority list at the moment.
# ------------------------------------------------------------------------------------------------------------------------ # ------------------------------------------------------------------------------------------------------------------------
@staticmethod @staticmethod
def shortenURL(url_to_shorten, shortener = "http://is.gd/api.php", query="longurl"): def shortenURL(url_to_shorten, shortener="http://is.gd/api.php", query="longurl"):
""" """
shortenURL(url_to_shorten, shortener = "http://is.gd/api.php", query="longurl") shortenURL(url_to_shorten, shortener = "http://is.gd/api.php", query="longurl")
Shortens url specified by url_to_shorten. Shortens url specified by url_to_shorten.
Note: Twitter automatically shortens all URLs behind their own custom t.co shortener now, Note: Twitter automatically shortens all URLs behind their own custom t.co shortener now,
but we keep this here for anyone who was previously using it for alternative purposes. ;) but we keep this here for anyone who was previously using it for alternative purposes. ;)
Parameters: Parameters:
url_to_shorten - URL to shorten. url_to_shorten - URL to shorten.
shortener = In case you want to use a url shortening service other than is.gd. shortener = In case you want to use a url shortening service other than is.gd.
""" """
request = requests.get('http://is.gd/api.php' , params = { request = requests.get('http://is.gd/api.php', params={
'query': url_to_shorten 'query': url_to_shorten
}) })
if r.status_code in [301, 201, 200]: if request.status_code in [301, 201, 200]:
return request.text return request.text
else: else:
raise TwythonError('shortenURL() failed with a %s error code.' % r.status_code) raise TwythonError('shortenURL() failed with a %s error code.' % request.status_code)
@staticmethod @staticmethod
def constructApiURL(base_url, params): def constructApiURL(base_url, params):
return base_url + "?" + "&".join(["%s=%s" % (Twython.unicode2utf8(key), urllib.quote_plus(Twython.unicode2utf8(value))) for (key, value) in params.iteritems()]) return base_url + "?" + "&".join(["%s=%s" % (Twython.unicode2utf8(key), urllib.quote_plus(Twython.unicode2utf8(value))) for (key, value) in params.iteritems()])
@ -331,14 +329,14 @@ class Twython(object):
kwargs['user_id'] = ','.join(map(str, ids)) kwargs['user_id'] = ','.join(map(str, ids))
if screen_names: if screen_names:
kwargs['screen_name'] = ','.join(screen_names) kwargs['screen_name'] = ','.join(screen_names)
lookupURL = Twython.constructApiURL("http://api.twitter.com/%d/users/lookup.json" % version, kwargs) lookupURL = Twython.constructApiURL("http://api.twitter.com/%d/users/lookup.json" % version, kwargs)
try: try:
response = self.client.post(lookupURL, headers=self.headers) response = self.client.post(lookupURL, headers=self.headers)
return simplejson.loads(response.content.decode('utf-8')) return simplejson.loads(response.content.decode('utf-8'))
except RequestException, e: except RequestException, e:
raise TwythonError("bulkUserLookup() failed with a %s error code." % e.code, e.code) raise TwythonError("bulkUserLookup() failed with a %s error code." % e.code, e.code)
def search(self, **kwargs): def search(self, **kwargs):
"""search(search_query, **kwargs) """search(search_query, **kwargs)
@ -359,16 +357,16 @@ class Twython(object):
retry_wait_seconds, retry_wait_seconds,
retry_wait_seconds, retry_wait_seconds,
response.status_code) response.status_code)
return simplejson.loads(response.content.decode('utf-8')) return simplejson.loads(response.content.decode('utf-8'))
except RequestException, e: except RequestException, e:
raise TwythonError("getSearchTimeline() failed with a %s error code." % e.code, e.code) raise TwythonError("getSearchTimeline() failed with a %s error code." % e.code, e.code)
def searchTwitter(self, **kwargs): def searchTwitter(self, **kwargs):
"""use search() ,this is a fall back method to support searchTwitter() """use search() ,this is a fall back method to support searchTwitter()
""" """
return self.search(**kwargs) return self.search(**kwargs)
def searchGen(self, search_query, **kwargs): def searchGen(self, search_query, **kwargs):
"""searchGen(search_query, **kwargs) """searchGen(search_query, **kwargs)
@ -386,13 +384,13 @@ class Twython(object):
data = simplejson.loads(response.content.decode('utf-8')) data = simplejson.loads(response.content.decode('utf-8'))
except RequestException, e: except RequestException, e:
raise TwythonError("searchGen() failed with a %s error code." % e.code, e.code) raise TwythonError("searchGen() failed with a %s error code." % e.code, e.code)
if not data['results']: if not data['results']:
raise StopIteration raise StopIteration
for tweet in data['results']: for tweet in data['results']:
yield tweet yield tweet
if 'page' not in kwargs: if 'page' not in kwargs:
kwargs['page'] = '2' kwargs['page'] = '2'
else: else:
@ -405,15 +403,15 @@ class Twython(object):
except e: except e:
raise TwythonError("searchGen() failed with %s error code" % \ raise TwythonError("searchGen() failed with %s error code" % \
e.code, e.code) e.code, e.code)
for tweet in self.searchGen(search_query, **kwargs): for tweet in self.searchGen(search_query, **kwargs):
yield tweet yield tweet
def searchTwitterGen(self, search_query, **kwargs): def searchTwitterGen(self, search_query, **kwargs):
"""use searchGen(), this is a fallback method to support """use searchGen(), this is a fallback method to support
searchTwitterGen()""" searchTwitterGen()"""
return self.searchGen(search_query, **kwargs) return self.searchGen(search_query, **kwargs)
def isListMember(self, list_id, id, username, version=1): def isListMember(self, list_id, id, username, version=1):
""" isListMember(self, list_id, id, version) """ isListMember(self, list_id, id, version)
@ -432,7 +430,7 @@ class Twython(object):
return simplejson.loads(response.content.decode('utf-8')) return simplejson.loads(response.content.decode('utf-8'))
except RequestException, e: except RequestException, e:
raise TwythonError("isListMember() failed with a %d error code." % e.code, e.code) raise TwythonError("isListMember() failed with a %d error code." % e.code, e.code)
def isListSubscriber(self, username, list_id, id, version=1): def isListSubscriber(self, username, list_id, id, version=1):
""" isListSubscriber(self, list_id, id, version) """ isListSubscriber(self, list_id, id, version)
@ -451,7 +449,7 @@ class Twython(object):
return simplejson.loads(response.content.decode('utf-8')) return simplejson.loads(response.content.decode('utf-8'))
except RequestException, e: except RequestException, e:
raise TwythonError("isListMember() failed with a %d error code." % e.code, e.code) raise TwythonError("isListMember() failed with a %d error code." % e.code, e.code)
# The following methods are apart from the other Account methods, because they rely on a whole multipart-data posting function set. # The following methods are apart from the other Account methods, because they rely on a whole multipart-data posting function set.
def updateProfileBackgroundImage(self, file_, tile=True, version=1): def updateProfileBackgroundImage(self, file_, tile=True, version=1):
""" updateProfileBackgroundImage(filename, tile=True) """ updateProfileBackgroundImage(filename, tile=True)
@ -465,8 +463,8 @@ class Twython(object):
""" """
return self._media_update('http://api.twitter.com/%d/account/update_profile_background_image.json' % version, { return self._media_update('http://api.twitter.com/%d/account/update_profile_background_image.json' % version, {
'image': (file_, open(file_, 'rb')) 'image': (file_, open(file_, 'rb'))
}, params = {'tile': tile}) }, params={'tile': tile})
def updateProfileImage(self, file_, version=1): def updateProfileImage(self, file_, version=1):
""" updateProfileImage(filename) """ updateProfileImage(filename)
@ -479,7 +477,7 @@ class Twython(object):
return self._media_update('http://api.twitter.com/%d/account/update_profile_image.json' % version, { return self._media_update('http://api.twitter.com/%d/account/update_profile_image.json' % version, {
'image': (file_, open(file_, 'rb')) 'image': (file_, open(file_, 'rb'))
}) })
# statuses/update_with_media # statuses/update_with_media
def updateStatusWithMedia(self, file_, version=1, **params): def updateStatusWithMedia(self, file_, version=1, **params):
""" updateStatusWithMedia(filename) """ updateStatusWithMedia(filename)
@ -493,7 +491,7 @@ class Twython(object):
return self._media_update('https://upload.twitter.com/%d/statuses/update_with_media.json' % version, { return self._media_update('https://upload.twitter.com/%d/statuses/update_with_media.json' % version, {
'media': (file_, open(file_, 'rb')) 'media': (file_, open(file_, 'rb'))
}, **params) }, **params)
def _media_update(self, url, file_, params=None): def _media_update(self, url, file_, params=None):
params = params or {} params = params or {}
@ -525,24 +523,24 @@ class Twython(object):
'oauth_token': self.oauth_token, 'oauth_token': self.oauth_token,
'oauth_timestamp': int(time.time()), 'oauth_timestamp': int(time.time()),
} }
#create a fake request with your upload url and parameters #create a fake request with your upload url and parameters
faux_req = oauth.Request(method='POST', url=url, parameters=oauth_params) faux_req = oauth.Request(method='POST', url=url, parameters=oauth_params)
#sign the fake request. #sign the fake request.
signature_method = oauth.SignatureMethod_HMAC_SHA1() signature_method = oauth.SignatureMethod_HMAC_SHA1()
class dotdict(dict): class dotdict(dict):
""" """
This is a helper func. because python-oauth2 wants a This is a helper func. because python-oauth2 wants a
dict in dot notation. dict in dot notation.
""" """
def __getattr__(self, attr): def __getattr__(self, attr):
return self.get(attr, None) return self.get(attr, None)
__setattr__ = dict.__setitem__ __setattr__ = dict.__setitem__
__delattr__ = dict.__delitem__ __delattr__ = dict.__delitem__
consumer = { consumer = {
'key': self.oauth_hook.consumer_key, 'key': self.oauth_hook.consumer_key,
'secret': self.oauth_hook.consumer_secret 'secret': self.oauth_hook.consumer_secret
@ -551,15 +549,15 @@ class Twython(object):
'key': self.oauth_token, 'key': self.oauth_token,
'secret': self.oauth_secret 'secret': self.oauth_secret
} }
faux_req.sign_request(signature_method, dotdict(consumer), dotdict(token)) faux_req.sign_request(signature_method, dotdict(consumer), dotdict(token))
#create a dict out of the fake request signed params #create a dict out of the fake request signed params
self.headers.update(faux_req.to_header()) self.headers.update(faux_req.to_header())
req = requests.post(url, data=params, files=file_, headers=self.headers) req = requests.post(url, data=params, files=file_, headers=self.headers)
return req.content return req.content
def getProfileImageUrl(self, username, size=None, version=1): def getProfileImageUrl(self, username, size=None, version=1):
""" getProfileImageUrl(username) """ getProfileImageUrl(username)
@ -573,16 +571,16 @@ class Twython(object):
url = "http://api.twitter.com/%s/users/profile_image/%s.json" % (version, username) url = "http://api.twitter.com/%s/users/profile_image/%s.json" % (version, username)
if size: if size:
url = self.constructApiURL(url, {'size': size}) url = self.constructApiURL(url, {'size': size})
#client.follow_redirects = False #client.follow_redirects = False
response = self.client.get(url, allow_redirects=False) response = self.client.get(url, allow_redirects=False)
image_url = response.headers.get('location') image_url = response.headers.get('location')
if response.status_code in (301, 302, 303, 307) and image_url is not None: if response.status_code in (301, 302, 303, 307) and image_url is not None:
return image_url return image_url
raise TwythonError("getProfileImageUrl() failed with a %d error code." % response.status_code, response.status_code) raise TwythonError("getProfileImageUrl() failed with a %d error code." % response.status_code, response.status_code)
@staticmethod @staticmethod
def stream(data, callback): def stream(data, callback):
""" """
@ -601,7 +599,7 @@ class Twython(object):
done over SSL (https://), so you're not left totally vulnerable. done over SSL (https://), so you're not left totally vulnerable.
endpoint - Optional. Override the endpoint you're using with the Twitter Streaming API. This is defaulted to the one endpoint - Optional. Override the endpoint you're using with the Twitter Streaming API. This is defaulted to the one
that everyone has access to, but if Twitter <3's you feel free to set this to your wildest desires. that everyone has access to, but if Twitter <3's you feel free to set this to your wildest desires.
Parameters: Parameters:
data - Required. Dictionary of attributes to attach to the request (see: params https://dev.twitter.com/docs/streaming-api/methods) data - Required. Dictionary of attributes to attach to the request (see: params https://dev.twitter.com/docs/streaming-api/methods)
callback - Required. Callback function to be fired when tweets come in (this is an event-based-ish API). callback - Required. Callback function to be fired when tweets come in (this is an event-based-ish API).
@ -609,22 +607,22 @@ class Twython(object):
endpoint = 'https://stream.twitter.com/1/statuses/filter.json' endpoint = 'https://stream.twitter.com/1/statuses/filter.json'
if 'endpoint' in data: if 'endpoint' in data:
endpoint = data.pop('endpoint') endpoint = data.pop('endpoint')
needs_basic_auth = False needs_basic_auth = False
if 'username' in data: if 'username' in data:
needs_basic_auth = True needs_basic_auth = True
username = data.pop('username') username = data.pop('username')
password = data.pop('password') password = data.pop('password')
if needs_basic_auth: if needs_basic_auth:
stream = requests.post(endpoint, data = data, auth = (username, password)) stream = requests.post(endpoint, data=data, auth=(username, password))
else: else:
stream = requests.post(endpoint, data = data) stream = requests.post(endpoint, data=data)
for line in stream.iter_lines(): for line in stream.iter_lines():
if line: if line:
callback(json.loads(line)) callback(simplejson.loads(line))
@staticmethod @staticmethod
def unicode2utf8(text): def unicode2utf8(text):
try: try:
@ -633,7 +631,7 @@ class Twython(object):
except: except:
pass pass
return text return text
@staticmethod @staticmethod
def encode(text): def encode(text):
if isinstance(text, (str, unicode)): if isinstance(text, (str, unicode)):