import urllib2 as urllib_request
import urllib2 as urllib_error
import json
+from ssl import SSLError
+import socket
from .api import TwitterCall, wrap_response
class TwitterJSONIter(object):
- def __init__(self, handle, uri, arg_data):
+ def __init__(self, handle, uri, arg_data, block=True):
self.decoder = json.JSONDecoder()
self.handle = handle
self.buf = b""
+ self.block = block
def __iter__(self):
+ sock = self.handle.fp._sock.fp._sock
+ sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+ if not self.block:
+ sock.setblocking(False)
while True:
- # this is a non-blocking read (ie, it will return if any data is available)
- self.buf += self.handle.fp._sock.fp._sock.recv(1024)
try:
utf8_buf = self.buf.decode('utf8').lstrip()
res, ptr = self.decoder.raw_decode(utf8_buf)
self.buf = utf8_buf[ptr:].encode('utf8')
yield wrap_response(res, self.handle.headers)
- except ValueError as e:
continue
+ except ValueError as e:
+ if self.block:
+ pass
+ else:
+ yield None
except urllib_error.HTTPError as e:
raise TwitterHTTPError(e, uri, self.format, arg_data)
+ # this is a non-blocking read (ie, it will return if any data is available)
+ try:
+ self.buf += sock.recv(1024)
+ except SSLError as e:
+ if (not self.block) and (e.errno == 2):
+ # Apparently this means there was nothing in the socket buf
+ pass
+ else:
+ raise
+
+def handle_stream_response(req, uri, arg_data, block):
+ handle = urllib_request.urlopen(req,)
+ return iter(TwitterJSONIter(handle, uri, arg_data, block))
class TwitterStreamCall(TwitterCall):
- def _handle_response(self, req, uri, arg_data):
- handle = urllib_request.urlopen(req,)
- return iter(TwitterJSONIter(handle, uri, arg_data))
+ def _handle_response(self, req, uri, arg_data, _timeout=None):
+ return handle_stream_response(req, uri, arg_data, block=True)
+
+class TwitterStreamCallNonBlocking(TwitterCall):
+ def _handle_response(self, req, uri, arg_data, _timeout=None):
+ return handle_stream_response(req, uri, arg_data, block=False)
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 `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,
- api_version='1'):
+ api_version='1', block=True):
uriparts = ()
uriparts += (str(api_version),)
+ if block:
+ call_cls = TwitterStreamCall
+ else:
+ call_cls = TwitterStreamCallNonBlocking
+
TwitterStreamCall.__init__(
self, auth=auth, format="json", domain=domain,
- callable_cls=TwitterStreamCall,
+ callable_cls=call_cls,
secure=secure, uriparts=uriparts)