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

added option to cursor() to yeild "pages" - ie: iterators of items for each page returned by twitter

Browse source 
modified:   api.py
This commit is contained in:
drevicko 2013-11-08 12:23:22 +11:00
parent 638f75b93d
commit cf766311f0
1 changed files with 11 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

16
twython/api.py
View file

@ -388,7 +388,7 @@ class Twython(EndpointsMixin, object):
) )
return self.cursor(self.search, q=search_query, **params) return self.cursor(self.search, q=search_query, **params)
def cursor(self, function, **params): def cursor(self, function, **params, returnPages = False):
"""Returns a generator for results that match a specified query. """Returns a generator for results that match a specified query.
:param function: Instance of a Twython function (Twython.get_home_timeline, Twython.search) :param function: Instance of a Twython function (Twython.get_home_timeline, Twython.search)
@ -418,8 +418,11 @@ class Twython(EndpointsMixin, object):
else: else:
results = content results = content
for result in results: if returnPages:
yield result yield results
else:
for result in results:
yield result
if function.iter_mode == 'cursor' and content['next_cursor_str'] == '0': if function.iter_mode == 'cursor' and content['next_cursor_str'] == '0':
raise StopIteration raise StopIteration
@ -438,8 +441,11 @@ class Twython(EndpointsMixin, object):
except (TypeError, ValueError): # pragma: no cover except (TypeError, ValueError): # pragma: no cover
raise TwythonError('Unable to generate next page of search results, `page` is not a number.') raise TwythonError('Unable to generate next page of search results, `page` is not a number.')
for result in self.cursor(function, **params): if returnPages:
yield result yield self.cursor(function, **params)
else:
for result in self.cursor(function, **params):
yield result
@staticmethod @staticmethod
def unicode2utf8(text): def unicode2utf8(text):