3609: Add command line help strings
[arvados.git] / sdk / python / arvados / stream.py
index 4a53324c8a7d4e6d16fb9282181aa328faedc2e3..04b6b8180421e763e9c27a4ed080195a6b28f9a3 100644 (file)
@@ -1,7 +1,6 @@
 import gflags
 import httplib
 import httplib2
-import logging
 import os
 import pprint
 import sys
@@ -17,7 +16,9 @@ import zlib
 import fcntl
 import time
 import threading
+import collections
 
+from arvados.retry import retry_method
 from keep import *
 import config
 import errors
@@ -27,25 +28,68 @@ BLOCKSIZE = 1
 OFFSET = 2
 SEGMENTSIZE = 3
 
-def locators_and_ranges(self, data_locators, range_start, range_size):
-    '''returns list of [block locator, blocksize, segment offset, segment size] that satisfies the range'''
+def locators_and_ranges(data_locators, range_start, range_size, debug=False):
+    '''
+    Get blocks that are covered by the range
+    data_locators: list of [locator, block_size, block_start], assumes that blocks are in order and contigous
+    range_start: start of range
+    range_size: size of range
+    returns list of [block locator, blocksize, segment offset, segment size] that satisfies the range
+    '''
+    if range_size == 0:
+        return []
     resp = []
     range_start = long(range_start)
     range_size = long(range_size)
     range_end = range_start + range_size
     block_start = 0L
-    for locator, block_size, block_start in data_locators:
+
+    # range_start/block_start is the inclusive lower bound
+    # range_end/block_end is the exclusive upper bound
+
+    hi = len(data_locators)
+    lo = 0
+    i = int((hi + lo) / 2)
+    block_size = data_locators[i][BLOCKSIZE]
+    block_start = data_locators[i][OFFSET]
+    block_end = block_start + block_size
+    if debug: print '---'
+
+    # perform a binary search for the first block
+    # assumes that all of the blocks are contigious, so range_start is guaranteed
+    # to either fall into the range of a block or be outside the block range entirely
+    while not (range_start >= block_start and range_start < block_end):
+        if lo == i:
+            # must be out of range, fail
+            return []
+        if range_start > block_start:
+            lo = i
+        else:
+            hi = i
+        i = int((hi + lo) / 2)
+        if debug: print lo, i, hi
+        block_size = data_locators[i][BLOCKSIZE]
+        block_start = data_locators[i][OFFSET]
+        block_end = block_start + block_size
+
+    while i < len(data_locators):
+        locator, block_size, block_start = data_locators[i]
         block_end = block_start + block_size
-        if range_end < block_start:
+        if debug:
+            print locator, "range_start", range_start, "block_start", block_start, "range_end", range_end, "block_end", block_end
+        if range_end <= block_start:
             # range ends before this block starts, so don't look at any more locators
             break
-        if range_start > block_end:
+
+        #if range_start >= block_end:
             # range starts after this block ends, so go to next block
-            next
-        elif range_start >= block_start and range_end <= block_end:
+            # we should always start at the first block due to the binary above, so this test is redundant
+            #next
+
+        if range_start >= block_start and range_end <= block_end:
             # range starts and ends in this block
             resp.append([locator, block_size, range_start - block_start, range_size])
-        elif range_start >= block_start:
+        elif range_start >= block_start and range_end > block_end:
             # range starts in this block
             resp.append([locator, block_size, range_start - block_start, block_end - range_start])
         elif range_start < block_start and range_end > block_end:
@@ -55,6 +99,7 @@ def locators_and_ranges(self, data_locators, range_start, range_size):
             # range starts in a previous block and ends in this block
             resp.append([locator, block_size, 0L, range_end - block_start])
         block_start = block_end
+        i += 1
     return resp
 
 
@@ -64,6 +109,7 @@ class StreamFileReader(object):
         self.segments = segments
         self._name = name
         self._filepos = 0L
+        self.num_retries = stream.num_retries
 
     def name(self):
         return self._name
@@ -77,63 +123,75 @@ class StreamFileReader(object):
     def seek(self, pos):
         self._filepos = min(max(pos, 0L), self.size())
 
-    def tell(self, pos):
+    def tell(self):
         return self._filepos
 
     def size(self):
-        n = self.data_locators[-1]
-        return n[self.OFFSET] + n[self.BLOCKSIZE]
+        n = self.segments[-1]
+        return n[OFFSET] + n[BLOCKSIZE]
 
-    def read(self, size, **kwargs):
+    @retry_method
+    def read(self, size, num_retries=None):
         """Read up to 'size' bytes from the stream, starting at the current file position"""
         if size == 0:
             return ''
 
         data = ''
-        for locator, blocksize, segmentoffset, segmentsize in locators_and_ranges(self.segments, self._filepos, size):
-            self._stream.seek(locator+segmentoffset)
-            data += self._stream.read(segmentsize)
-            self._filepos += len(data)
+        available_chunks = locators_and_ranges(self.segments, self._filepos, size)
+        if available_chunks:
+            locator, blocksize, segmentoffset, segmentsize = available_chunks[0]
+            data = self._stream.readfrom(locator+segmentoffset, segmentsize,
+                                         num_retries=num_retries)
+
+        self._filepos += len(data)
         return data
 
-    def readall(self, size=2**20, **kwargs):
+    @retry_method
+    def readfrom(self, start, size, num_retries=None):
+        """Read up to 'size' bytes from the stream, starting at 'start'"""
+        if size == 0:
+            return ''
+
+        data = []
+        for locator, blocksize, segmentoffset, segmentsize in locators_and_ranges(self.segments, start, size):
+            data.append(self._stream.readfrom(locator+segmentoffset, segmentsize,
+                                              num_retries=num_retries))
+        return ''.join(data)
+
+    @retry_method
+    def readall(self, size=2**20, num_retries=None):
         while True:
-            data = self.read(size, **kwargs)
+            data = self.read(size, num_retries=num_retries)
             if data == '':
                 break
             yield data
 
-    def bunzip2(self, size):
-        decompressor = bz2.BZ2Decompressor()
-        for segment in self.readall(size):
-            data = decompressor.decompress(segment)
+    @retry_method
+    def decompress(self, decompress, size, num_retries=None):
+        for segment in self.readall(size, num_retries):
+            data = decompress(segment)
             if data and data != '':
                 yield data
 
-    def gunzip(self, size):
-        decompressor = zlib.decompressobj(16+zlib.MAX_WBITS)
-        for segment in self.readall(size):
-            data = decompressor.decompress(decompressor.unconsumed_tail + segment)
-            if data and data != '':
-                yield data
-
-    def readall_decompressed(self, size=2**20):
+    @retry_method
+    def readall_decompressed(self, size=2**20, num_retries=None):
         self.seek(0)
         if re.search('\.bz2$', self._name):
-            return self.bunzip2(size)
+            dc = bz2.BZ2Decompressor()
+            return self.decompress(dc.decompress, size,
+                                   num_retries=num_retries)
         elif re.search('\.gz$', self._name):
-            return self.gunzip(size)
+            dc = zlib.decompressobj(16+zlib.MAX_WBITS)
+            return self.decompress(lambda segment: dc.decompress(dc.unconsumed_tail + segment),
+                                   size, num_retries=num_retries)
         else:
-            return self.readall(size)
+            return self.readall(size, num_retries=num_retries)
 
-    def readlines(self, decompress=True):
-        if decompress:
-            datasource = self.readall_decompressed()
-        else:
-            self._stream.seek(self._pos + self._filepos)
-            datasource = self.readall()
+    @retry_method
+    def readlines(self, decompress=True, num_retries=None):
+        read_func = self.readall_decompressed if decompress else self.readall
         data = ''
-        for newdata in datasource:
+        for newdata in read_func(num_retries=num_retries):
             data += newdata
             sol = 0
             while True:
@@ -146,19 +204,27 @@ class StreamFileReader(object):
         if data != '':
             yield data
 
+    def as_manifest(self):
+        manifest_text = ['.']
+        manifest_text.extend([d[LOCATOR] for d in self._stream._data_locators])
+        manifest_text.extend(["{}:{}:{}".format(seg[LOCATOR], seg[BLOCKSIZE], self.name().replace(' ', '\\040')) for seg in self.segments])
+        return arvados.CollectionReader(' '.join(manifest_text) + '\n').manifest_text()
 
-class StreamReader(object):
-    def __init__(self, tokens):
-        self._tokens = tokens
-        self._pos = 0L
 
+class StreamReader(object):
+    def __init__(self, tokens, keep=None, debug=False, _empty=False,
+                 num_retries=0):
         self._stream_name = None
-        self.data_locators = []
-        self.files = {}
+        self._data_locators = []
+        self._files = collections.OrderedDict()
+        self._keep = keep
+        self.num_retries = num_retries
 
         streamoffset = 0L
 
-        for tok in self._tokens:
+        # parse stream
+        for tok in tokens:
+            if debug: print 'tok', tok
             if self._stream_name == None:
                 self._stream_name = tok.replace('\\040', ' ')
                 continue
@@ -166,7 +232,7 @@ class StreamReader(object):
             s = re.match(r'^[0-9a-f]{32}\+(\d+)(\+\S+)*$', tok)
             if s:
                 blocksize = long(s.group(1))
-                self.data_locators.append([tok, blocksize, streamoffset])
+                self._data_locators.append([tok, blocksize, streamoffset])
                 streamoffset += blocksize
                 continue
 
@@ -175,43 +241,52 @@ class StreamReader(object):
                 pos = long(s.group(1))
                 size = long(s.group(2))
                 name = s.group(3).replace('\\040', ' ')
-                if name not in self.files:
-                    self.files[name] = StreamFileReader(self, [[pos, size, 0]], name)
+                if name not in self._files:
+                    self._files[name] = StreamFileReader(self, [[pos, size, 0]], name)
                 else:
-                    n = self.files[name]
+                    n = self._files[name]
                     n.segments.append([pos, size, n.size()])
                 continue
 
             raise errors.SyntaxError("Invalid manifest format")
-            
-    def tokens(self):
-        return self._tokens
 
     def name(self):
         return self._stream_name
 
-    def all_files(self):
-        return self.files.values()
-
-    def seek(self, pos):
-        """Set the position of the next read operation."""
-        self._pos = pos
+    def files(self):
+        return self._files
 
-    def tell(self):
-        return self._pos
+    def all_files(self):
+        return self._files.values()
 
     def size(self):
-        n = self.data_locators[-1]
-        return n[self.OFFSET] + n[self.BLOCKSIZE]
+        n = self._data_locators[-1]
+        return n[OFFSET] + n[BLOCKSIZE]
 
-    def locators_and_ranges(self.data_locators, self._pos, size)
+    def locators_and_ranges(self, range_start, range_size):
+        return locators_and_ranges(self._data_locators, range_start, range_size)
 
-    def read(self, size):
-        """Read up to 'size' bytes from the stream, starting at the current file position"""
+    @retry_method
+    def readfrom(self, start, size, num_retries=None):
+        """Read up to 'size' bytes from the stream, starting at 'start'"""
         if size == 0:
             return ''
-        data = ''
-        for locator, blocksize, segmentoffset, segmentsize in locators_and_ranges(self.data_locators, self._pos, size):
-            data += Keep.get(locator)[segmentoffset:segmentoffset+segmentsize]
-        self._pos += len(data)
-        return data
+        if self._keep is None:
+            self._keep = KeepClient(num_retries=self.num_retries)
+        data = []
+        for locator, blocksize, segmentoffset, segmentsize in locators_and_ranges(self._data_locators, start, size):
+            data.append(self._keep.get(locator, num_retries=num_retries)[segmentoffset:segmentoffset+segmentsize])
+        return ''.join(data)
+
+    def manifest_text(self, strip=False):
+        manifest_text = [self.name().replace(' ', '\\040')]
+        if strip:
+            for d in self._data_locators:
+                m = re.match(r'^[0-9a-f]{32}\+\d+', d[LOCATOR])
+                manifest_text.append(m.group(0))
+        else:
+            manifest_text.extend([d[LOCATOR] for d in self._data_locators])
+        manifest_text.extend([' '.join(["{}:{}:{}".format(seg[LOCATOR], seg[BLOCKSIZE], f.name().replace(' ', '\\040'))
+                                        for seg in f.segments])
+                              for f in self._files.values()])
+        return ' '.join(manifest_text) + '\n'