class TwitterStream(TwitterStreamCall):
"""
- Interface to the Twitter Stream API (stream.twitter.com). This can
- be used pretty much the same as the Twitter class except the
- result of calling a method will be an iterator that yields objects
- decoded from the stream. For example::
+ The TwitterStream object is an interface to the Twitter Stream API
+ (stream.twitter.com). This can be used pretty much the same as the
+ Twitter class except the result of calling a method will be an
+ iterator that yields objects decoded from the stream. For
+ example::
twitter_stream = TwitterStream(auth=UserPassAuth('joe', 'joespassword'))
iterator = twitter_stream.statuses.sample()
The iterator will yield tweets forever and ever (until the stream
breaks at which point it raises a TwitterHTTPError.)
- The `bloc` paramater controls if the stream is blocking.
+ The `block` parameter controls if the stream is blocking. Default
+ is blocking (True). When set to False, the iterator will
+ occasionally yield None when there is no available message.
"""
def __init__(
self, domain="stream.twitter.com", secure=True, auth=None,