code/twython
1
Fork 0
Code Issues 23 Pull requests 4 Projects Releases 5 Packages Wiki Activity Actions

Remove exceptions and methods in 2.0

Browse source 
* update twitter_endpoints with isListSubscriber and isListMember
instead of having them in twython.py

* app_key and app_secret in place to take over twitter_token and
twitter_secret

* updated methods to have the short hand description show up, should
always be on first line and the description.. not repeating the function

* fixed other method docs and stuff
This commit is contained in:
Michael Helmick 2012-05-13 12:38:30 -04:00
parent 59c723ed7e
commit 19293b54a9
2 changed files with 30 additions and 164 deletions
Download patch file Download diff file Expand all files Collapse all files

8
twython/twitter_endpoints.py
View file

@ -257,6 +257,10 @@ api_table = {
'url': '/lists/subscriptions.json', 'url': '/lists/subscriptions.json',
'method': 'GET', 'method': 'GET',
}, },
'isListSubscriber': {
'url': '/lists/subscribers/show.json',
'method': 'GET',
},
'deleteList': { 'deleteList': {
'url': '/lists/destroy.json', 'url': '/lists/destroy.json',
'method': 'POST', 'method': 'POST',
@ -273,6 +277,10 @@ api_table = {
'url': '/lists/statuses.json', 'url': '/lists/statuses.json',
'method': 'GET' 'method': 'GET'
}, },
'isListMember': {
'url': '/lists/members/show.json',
'method': 'GET',
},
'addListMember': { 'addListMember': {
'url': '/lists/members/create.json', 'url': '/lists/members/create.json',
'method': 'POST', 'method': 'POST',

186
twython/twython.py
View file

@ -67,15 +67,12 @@ class TwythonError(AttributeError):
(twitter_http_status_codes[error_code][0], (twitter_http_status_codes[error_code][0],
twitter_http_status_codes[error_code][1], twitter_http_status_codes[error_code][1],
self.msg) self.msg)
if error_code == 400:
raise TwythonAPILimit( self.msg , error_code)
if error_code == 420: if error_code == 420:
raise TwythonRateLimitError(self.msg, raise TwythonRateLimitError(self.msg,
error_code, error_code,
retry_after=retry_after) retry_after=retry_after)
def __str__(self): def __str__(self):
return repr(self.msg) return repr(self.msg)
@ -105,75 +102,18 @@ class TwythonRateLimitError(TwythonError):
return repr(self.msg) return repr(self.msg)
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''
''' REMOVE THE FOLLOWING IN TWYTHON 2.0 '''
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''
class TwythonAPILimit(TwythonError):
""" 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
this matter beyond telling you that you've done goofed.
"""
def __init__(self, msg, error_code=None):
self.msg = '%s\n Notice: APILimit is deprecated and soon to be removed, catch on TwythonRateLimitLimit instead!' % msg
self.error_code = error_code
def __str__(self):
return repr(self.msg)
class APILimit(TwythonError):
""" 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
this matter beyond telling you that you've done goofed.
DEPRECATED, import and catch TwythonAPILimit instead.
"""
def __init__(self, msg, error_code=None):
self.msg = '%s\n Notice: APILimit is deprecated and soon to be removed, catch on TwythonRateLimitLimit instead!' % msg
self.error_code = error_code
def __str__(self):
return repr(self.msg)
class AuthError(TwythonError):
""" Raised when you try to access a protected resource and it fails due to some issue with
your authentication.
"""
def __init__(self, msg, error_code=None):
self.msg = '%s\n Notice: AuthError is deprecated and soon to be removed, catch on TwythonAuthError instead!' % msg
self.error_code = error_code
def __str__(self):
return repr(self.msg)
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''
class Twython(object): class Twython(object):
def __init__(self, twitter_token=None, twitter_secret=None, oauth_token=None, oauth_token_secret=None, \ def __init__(self, app_key=None, app_secret=None, oauth_token=None, oauth_token_secret=None, \
headers=None, callback_url=None): headers=None, callback_url=None, twitter_token=None, twitter_secret=None):
"""setup(self, oauth_token = None, headers = None) """Instantiates an instance of Twython. Takes optional parameters for authentication and such (see below).
Instantiates an instance of Twython. Takes optional parameters for authentication and such (see below). :param app_key: (optional) Your applications key
:param app_secret: (optional) Your applications secret key
Parameters: :param oauth_token: (optional) Used with oauth_secret to make authenticated calls
twitter_token - Given to you when you register your application with Twitter. :param oauth_secret: (optional) Used with oauth_token to make authenticated calls
twitter_secret - Given to you when you register your application with Twitter. :param headers: (optional) Custom headers to send along with the request
oauth_token - If you've gone through the authentication process and have a token for this user, :param callback_url: (optional) If set, will overwrite the callback url set in your application
pass it in and it'll be used for all requests going forward.
oauth_token_secret - see oauth_token; it's the other half.
headers - User agent header, dictionary style ala {'User-Agent': 'Bert'}
client_args - additional arguments for HTTP client (see httplib2.Http.__init__), e.g. {'timeout': 10.0}
** Note: versioning is not currently used by search.twitter functions;
when Twitter moves their junk, it'll be supported.
""" """
OAuthHook.consumer_key = twitter_token
OAuthHook.consumer_secret = twitter_secret
# Needed for hitting that there API. # Needed for hitting that there API.
self.api_url = 'https://api.twitter.com/%s' self.api_url = 'https://api.twitter.com/%s'
@ -182,8 +122,8 @@ class Twython(object):
self.authorize_url = self.api_url % 'oauth/authorize' self.authorize_url = self.api_url % 'oauth/authorize'
self.authenticate_url = self.api_url % 'oauth/authenticate' self.authenticate_url = self.api_url % 'oauth/authenticate'
self.twitter_token = twitter_token OAuthHook.consumer_key = self.app_key = app_key or twitter_token
self.twitter_secret = twitter_secret OAuthHook.consumer_secret = self.app_secret = app_secret or 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
@ -195,7 +135,7 @@ class Twython(object):
self.client = None self.client = None
if self.twitter_token is not None and self.twitter_secret is not None: if self.app_key is not None and self.app_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:
@ -341,10 +281,7 @@ class Twython(object):
return None return None
def get_authentication_tokens(self): def get_authentication_tokens(self):
""" """Returns an authorization URL for a user to hit.
get_auth_url(self)
Returns an authorization URL for a user to hit.
""" """
callback_url = self.callback_url callback_url = self.callback_url
@ -379,10 +316,7 @@ class Twython(object):
return request_tokens return request_tokens
def get_authorized_tokens(self): def get_authorized_tokens(self):
""" """Returns authorized tokens after they go through the auth_url phase.
get_authorized_tokens
Returns authorized tokens after they go through the auth_url phase.
""" """
response = self.client.get(self.access_token_url) response = self.client.get(self.access_token_url)
authorized_tokens = dict(parse_qsl(response.content)) authorized_tokens = dict(parse_qsl(response.content))
@ -399,10 +333,7 @@ class Twython(object):
@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"):
""" """Shortens url specified by url_to_shorten.
shortenURL(url_to_shorten, shortener = "http://is.gd/api.php", query="longurl")
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. ;)
@ -417,7 +348,7 @@ class Twython(object):
if request.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.' % request.status_code , request.status_code ) raise TwythonError('shortenURL() failed with a %s error code.' % request.status_code, request.status_code)
@staticmethod @staticmethod
def constructApiURL(base_url, params): def constructApiURL(base_url, params):
@ -454,7 +385,7 @@ class Twython(object):
def search(self, **kwargs): def search(self, **kwargs):
""" Returns tweets that match a specified query. """ Returns tweets that match a specified query.
Documentation: https://dev.twitter.com/ Documentation: https://dev.twitter.com/doc/get/search
:param q: (required) The query you want to search Twitter for :param q: (required) The query you want to search Twitter for
@ -484,12 +415,12 @@ class Twython(object):
if 'q' in kwargs: if 'q' in kwargs:
kwargs['q'] = urllib.quote_plus(Twython.unicode2utf8(kwargs['q'])) kwargs['q'] = urllib.quote_plus(Twython.unicode2utf8(kwargs['q']))
return self.get('http://search.twitter.com/search.json', params=kwargs) return self.get('https://search.twitter.com/search.json', params=kwargs)
def searchGen(self, search_query, **kwargs): def searchGen(self, search_query, **kwargs):
""" Returns a generator of tweets that match a specified query. """ Returns a generator of tweets that match a specified query.
Documentation: https://dev.twitter.com/doc/get/search. Documentation: https://dev.twitter.com/doc/get/search
See Twython.search() for acceptable parameters See Twython.search() for acceptable parameters
@ -498,7 +429,7 @@ class Twython(object):
print result print result
""" """
kwargs['q'] = urllib.quote_plus(Twython.unicode2utf8(search_query)) kwargs['q'] = urllib.quote_plus(Twython.unicode2utf8(search_query))
content = self.get('http://search.twitter.com/search.json', params=kwargs) content = self.get('https://search.twitter.com/search.json', params=kwargs)
if not content['results']: if not content['results']:
raise StopIteration raise StopIteration
@ -519,63 +450,6 @@ class Twython(object):
for tweet in self.searchGen(search_query, **kwargs): for tweet in self.searchGen(search_query, **kwargs):
yield tweet yield tweet
def isListMember(self, list_id, id, username, version=1, **kwargs):
""" Check if a specified user (username) is a member of the list in question (list_id).
Documentation: https://dev.twitter.com/docs/api/1/get/lists/members/show
**Note: This method may not work for private/protected lists,
unless you're authenticated and have access to those lists.
:param list_id: (required) The numerical id of the list.
:param username: (required) The screen name for whom to return results for
:param version: (optional) Currently, default (only effective value) is 1
:param id: (deprecated) This value is no longer needed.
e.g.
**Note: currently TwythonError is not descriptive enough
to handle specific errors, those errors will be
included in the library soon enough
try:
x.isListMember(53131724, None, 'ryanmcgrath')
except TwythonError:
print 'User is not a member'
"""
kwargs['list_id'] = list_id
kwargs['screen_name'] = username
return self.get('lists/members/show', params=kwargs)
def isListSubscriber(self, username, list_id, id, version=1, **kwargs):
""" Check if a specified user (username) is a subscriber of the list in question (list_id).
Documentation: https://dev.twitter.com/docs/api/1/get/lists/subscribers/show
**Note: This method may not work for private/protected lists,
unless you're authenticated and have access to those lists.
:param list_id: (required) The numerical id of the list.
:param username: (required) The screen name for whom to return results for
:param version: (optional) Currently, default (only effective value) is 1
:param id: (deprecated) This value is no longer needed.
e.g.
**Note: currently TwythonError is not descriptive enough
to handle specific errors, those errors will be
included in the library soon enough
try:
x.isListSubscriber('ryanmcgrath', 53131724, None)
except TwythonError:
print 'User is not a member'
The above throws a TwythonError, the following returns data about
the user since they follow the specific list:
x.isListSubscriber('icelsius', 53131724, None)
"""
kwargs['list_id'] = list_id
kwargs['screen_name'] = username
return self.get('lists/subscribers/show', params=kwargs)
# The following methods are apart from the other Account methods, # The following methods are apart from the other Account methods,
# because they rely on a whole multipart-data posting function set. # 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):
@ -764,19 +638,3 @@ class Twython(object):
if isinstance(text, (str, unicode)): if isinstance(text, (str, unicode)):
return Twython.unicode2utf8(text) return Twython.unicode2utf8(text)
return str(text) return str(text)
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''
''' REMOVE THE FOLLOWING IN TWYTHON 2.0 '''
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''
def searchTwitter(self, **kwargs):
"""use search() ,this is a fall back method to support searchTwitter()
"""
return self.search(**kwargs)
def searchTwitterGen(self, search_query, **kwargs):
"""use searchGen(), this is a fallback method to support
searchTwitterGen()"""
return self.searchGen(search_query, **kwargs)
''' !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! '''