feat: add tq.tasks() method

taskqueue/aws_queue_api.py

@@ -170,9 +170,6 @@ def purge(self):
       for task in tasks:
         self.delete(task)
     return self
-
-  def list(self):
-    return list(self)
 
   def __iter__(self):
     return iter(self._request(num_tasks=10, visibility_timeout=0))

taskqueue/taskqueue.py

@@ -37,6 +37,9 @@ def totalfn(iterator, total):
   except TypeError:
     return None
 
+class UnsupportedProtocolError(BaseException):
+  pass
+
 class QueueEmptyError(LookupError):
   pass
 
@@ -88,7 +91,7 @@ def initialize_api(self, path, **kwargs):
     elif path.protocol == 'fq':
       return FileQueueAPI(path.path)
     else:
-      raise ValueError('Unsupported protocol ' + str(self.path.protocol))
+      raise UnsupportedProtocolError('Unsupported protocol ' + str(self.path.protocol))
 
   def check_monkey_patch_status(self):
     import gevent.monkey
@@ -260,6 +263,21 @@ def purge(self):
         self.wait()
       return self
 
+  def tasks(self):
+    """
+    Iterate over all tasks. 
+    Can cause infinite loops on SQS and so is not
+    supported. You can use the api method directly 
+    if you know what you're doing.
+    """
+    if self.path.protocol == "sqs":
+      raise UnsupportedProtocolError("SQS could enter an infinite loop from this method.")
+
+    tsks = ( totask(task) for task in iter(self.api) )
+    if N >= 0:
+      return itertools.islice(tsks, 0, N)
+    return tsks
+
   def poll(
     self, lease_seconds=LEASE_SECONDS,  
     verbose=False, execute_args=[], execute_kwargs={}, 

test/test_filequeue.py

@@ -79,3 +79,26 @@ def test_renew():
 
   assert ts(filename) >= int(time.time()) + 1
   assert ident(filename) == identity
+
+def test_enumerating_tasks():
+  tq = TaskQueue(FILE_QURL)
+  tq.purge()
+
+  for _ in range(10):
+    tq.insert(PrintTask('hello'))
+    tq.insert(PrintTask('world'))
+
+  lst = list(tq.tasks())
+
+  assert len(lst) == 20
+  hello = 0
+  world = 0
+  for task in lst:
+    hello += int(task.txt == "hello")
+    world += int(task.txt == "world")
+
+  assert hello == 10
+  assert world == 10
+
+
+