X-Git-Url: https://jfr.im/git/z_archive/twitter.git/blobdiff_plain/741507400802fcda26c684a650cc66375fa4906e..12bb62ddccd1fb84c3a8371e923eed946248d0bf:/twitter/stream.py diff --git a/twitter/stream.py b/twitter/stream.py index 2fd9cd8..8a64224 100644 --- a/twitter/stream.py +++ b/twitter/stream.py @@ -7,65 +7,117 @@ except ImportError: import urllib2 as urllib_error import json from ssl import SSLError +import socket +import sys, select, time + +from .api import TwitterCall, wrap_response, TwitterHTTPError + +def recv_chunk(sock): # -> bytearray: + + buf = sock.recv(8) # Scan for an up to 16MiB chunk size (0xffffff). + crlf = buf.find(b'\r\n') # Find the HTTP chunk size. + + if crlf > 0: # If there is a length, then process it + + remaining = int(buf[:crlf], 16) # Decode the chunk size. + + start = crlf + 2 # Add in the length of the header's CRLF pair. + end = len(buf) - start + + chunk = bytearray(remaining) + + if remaining <= 2: # E.g. an HTTP chunk with just a keep-alive delimiter. + chunk[:remaining] = buf[start:start + remaining] + # There are several edge cases (remaining == [3-6]) as the chunk size exceeds the length + # of the initial read of 8 bytes. With Twitter, these do not, in practice, occur. The + # shortest JSON message starts with '{"limit":{'. Hence, it exceeds in size the edge cases + # and eliminates the need to address them. + else: # There is more to read in the chunk. + chunk[:end] = buf[start:] + chunk[end:] = sock.recv(remaining - end) + sock.recv(2) # Read the trailing CRLF pair. Throw it away. + + return chunk + + return bytearray() + +## recv_chunk() -from .api import TwitterCall, wrap_response class TwitterJSONIter(object): - def __init__(self, handle, uri, arg_data, block=True): - self.decoder = json.JSONDecoder() + def __init__(self, handle, uri, arg_data, block=True, timeout=None): self.handle = handle - self.buf = b"" + self.uri = uri + self.arg_data = arg_data self.block = block + self.timeout = timeout + def __iter__(self): - sock = self.handle.fp._sock.fp._sock - if not self.block: - sock.setblocking(False) + sock = self.handle.fp.raw._sock if sys.version_info >= (3, 0) else self.handle.fp._sock.fp._sock + sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1) + sock.setblocking(self.block and not self.timeout) + buf = u'' + json_decoder = json.JSONDecoder() + timer = time.time() while True: try: - utf8_buf = self.buf.decode('utf8').lstrip() - res, ptr = self.decoder.raw_decode(utf8_buf) - self.buf = utf8_buf[ptr:].encode('utf8') + buf = buf.lstrip() + res, ptr = json_decoder.raw_decode(buf) + buf = buf[ptr:] yield wrap_response(res, self.handle.headers) + timer = time.time() 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) + if self.block: pass + else: yield None 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 + buf = buf.lstrip() # Remove any keep-alive delimiters to detect hangups. + if self.timeout: + ready_to_read = select.select([sock], [], [], self.timeout) + if ready_to_read[0]: + buf += recv_chunk(sock).decode('utf-8') # This is a non-blocking read. + if time.time() - timer > self.timeout: + yield {'timeout': True} + else: yield {'timeout': True} else: - raise + buf += recv_chunk(sock).decode('utf-8') + if not buf and self.block: + yield {'hangup': True} + except SSLError as e: + # Error from a non-blocking read of an empty buffer. + if (not self.block or self.timeout) and (e.errno == 2): pass + else: raise + +def handle_stream_response(req, uri, arg_data, block, timeout=None): + try: + handle = urllib_request.urlopen(req,) + except urllib_error.HTTPError as e: + raise TwitterHTTPError(e, uri, 'json', arg_data) + return iter(TwitterJSONIter(handle, uri, arg_data, block, timeout=timeout)) -def handle_stream_response(req, uri, arg_data, block): - handle = urllib_request.urlopen(req,) - return iter(TwitterJSONIter(handle, uri, arg_data, block)) +class TwitterStreamCallWithTimeout(TwitterCall): + def _handle_response(self, req, uri, arg_data, _timeout=None): + return handle_stream_response(req, uri, arg_data, block=True, timeout=self.timeout) class TwitterStreamCall(TwitterCall): - def _handle_response(self, req, 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): + 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')) + twitter_stream = TwitterStream(auth=OAuth(...)) iterator = twitter_stream.statuses.sample() for tweet in iterator: @@ -74,22 +126,25 @@ class TwitterStream(TwitterStreamCall): The iterator will yield tweets forever and ever (until the stream breaks at which point it raises a TwitterHTTPError.) - The `block` paramater controls if the stream is blocking. Default + 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', block=True): + api_version='1.1', block=True, timeout=None): uriparts = () uriparts += (str(api_version),) if block: - call_cls = TwitterStreamCall + if timeout: + call_cls = TwitterStreamCallWithTimeout + else: + call_cls = TwitterStreamCall else: call_cls = TwitterStreamCallNonBlocking TwitterStreamCall.__init__( self, auth=auth, format="json", domain=domain, callable_cls=call_cls, - secure=secure, uriparts=uriparts) + secure=secure, uriparts=uriparts, timeout=timeout, gzip=False)