nltk.twitter.api.TweetHandlerI

class documentation

class TweetHandlerI(BasicTweetHandler): (source)

Known subclasses: nltk.twitter.twitterclient.TweetViewer, nltk.twitter.twitterclient.TweetWriter

Constructor: TweetHandlerI(limit, upper_date_limit, lower_date_limit)

View In Hierarchy

Interface class whose subclasses should implement a handle method that Twitter clients can delegate to.

Method __init__ No summary
Method check_date_limit Validate date limits.
Method handle Deal appropriately with data returned by the Twitter API
Method on_finish Actions when the tweet limit has been reached
Instance Variable do_stop Stores the id of the last fetched Tweet to handle pagination.
Instance Variable lower_date_limit Undocumented
Instance Variable startingup Undocumented
Instance Variable upper_date_limit Undocumented

Inherited from BasicTweetHandler:

Method do_continue Returns False if the client should stop fetching Tweets.
Instance Variable counter A flag to indicate to the client whether to stop fetching data given some condition (e.g., reaching a date limit).
Instance Variable limit Undocumented
Instance Variable max_id Undocumented
def __init__(self, limit=20, upper_date_limit=None, lower_date_limit=None): (source)
overrides nltk.twitter.api.BasicTweetHandler.__init__
overridden in nltk.twitter.twitterclient.TweetWriter
Parameters
limitUndocumented
upper_date_limitUndocumented
lower_date_limitUndocumented
int limitThe number of data items to process in the current round of processing.
tuple upper_date_limitThe date at which to stop collecting new data. This should be entered as a tuple which can serve as the argument to datetime.datetime. E.g. date_limit=(2015, 4, 1, 12, 40) for 12:30 pm on April 1 2015.
tuple lower_date_limitThe date at which to stop collecting new data. See upper_data_limit for formatting.
def check_date_limit(self, data, verbose=False): (source)

Validate date limits.

@abstractmethod
def handle(self, data): (source)
overridden in nltk.twitter.twitterclient.TweetViewer, nltk.twitter.twitterclient.TweetWriter

Deal appropriately with data returned by the Twitter API

@abstractmethod
def on_finish(self): (source)
overridden in nltk.twitter.twitterclient.TweetViewer, nltk.twitter.twitterclient.TweetWriter

Actions when the tweet limit has been reached

do_stop: bool = (source)
overrides nltk.twitter.api.BasicTweetHandler.do_stop

Stores the id of the last fetched Tweet to handle pagination.

lower_date_limit = (source)

Undocumented

startingup: bool = (source)
overridden in nltk.twitter.twitterclient.TweetWriter

Undocumented

upper_date_limit = (source)

Undocumented