Merge pull request #2871 from minrk/shortexc

truncate potentially long CompositeErrors

IPython/parallel/error.py

@@ -232,6 +232,8 b' class TaskRejectError(KernelError):'
 
 class CompositeError(RemoteError):
     """Error for representing possibly multiple errors on engines"""
+    tb_limit = 4 # limit on how many tracebacks to draw
+    
     def __init__(self, message, elist):
         Exception.__init__(self, *(message, elist))
         # Don't use pack_exception because it will conflict with the .message
@@ -256,22 +258,28 b' class CompositeError(RemoteError):'
 
     def __str__(self):
         s = str(self.msg)
-        for en, ev, etb, ei in self.elist:
+        for en, ev, etb, ei in self.elist[:self.tb_limit]:
             engine_str = self._get_engine_str(ei)
             s = s + '\n' + engine_str + en + ': ' + str(ev)
+        if len(self.elist) > self.tb_limit:
+            s = s + '\n.... %i more exceptions ...' % (len(self.elist) - self.tb_limit)
         return s
 
     def __repr__(self):
-        return "CompositeError(%i)"%len(self.elist)
+        return "CompositeError(%i)" % len(self.elist)
     
     def render_traceback(self, excid=None):
         """render one or all of my tracebacks to a list of lines"""
         lines = []
         if excid is None:
-            for (en,ev,etb,ei) in self.elist:
+            for (en,ev,etb,ei) in self.elist[:self.tb_limit]:
                 lines.append(self._get_engine_str(ei))
                 lines.extend((etb or 'No traceback available').splitlines())
                 lines.append('')
+            if len(self.elist) > self.tb_limit:
+                lines.append(
+                    '... %i more exceptions ...' % (len(self.elist) - self.tb_limit)
+                )
         else:
             try:
                 en,ev,etb,ei = self.elist[excid]

IPython/parallel/tests/test_view.py

@@ -622,6 +622,33 b' class TestView(ClusterTestCase, ParametricTestCase):'
         self.assertEqual(io.stdout.count('by zero'), len(view), io.stdout)
         self.assertEqual(io.stdout.count(':execute'), len(view), io.stdout)
     
+    def test_compositeerror_truncate(self):
+        """Truncate CompositeErrors with many exceptions"""
+        view = self.client[:]
+        msg_ids = []
+        for i in range(10):
+            ar = view.execute("1/0")
+            msg_ids.extend(ar.msg_ids)
+        
+        ar = self.client.get_result(msg_ids)
+        try:
+            ar.get()
+        except error.CompositeError as e:
+            pass
+        else:
+            self.fail("Should have raised CompositeError")
+        
+        lines = e.render_traceback()
+        with capture_output() as io:
+            e.print_traceback()
+        
+        self.assertTrue("more exceptions" in lines[-1])
+        count = e.tb_limit
+        
+        self.assertEqual(io.stdout.count('ZeroDivisionError'), 2 * count, io.stdout)
+        self.assertEqual(io.stdout.count('by zero'), count, io.stdout)
+        self.assertEqual(io.stdout.count(':execute'), count, io.stdout)
+    
     @dec.skipif_not_matplotlib
     def test_magic_pylab(self):
         """%pylab works on engines"""

docs/source/parallel/parallel_multiengine.txt

@@ -560,25 +560,25 b' more other types of exceptions. Here is how it works:'
     In [79]: dview.execute("1/0")
     [0:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
     [1:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
     [2:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
     [3:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
@@ -595,7 +595,7 b' If you want, you can even raise one of these original exceptions:'
        ....: 
        ....: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
@@ -608,25 +608,25 b' instance:'
     In [81]: dview.execute('1/0')
     [0:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
     [1:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
     [2:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
     [3:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
     
@@ -654,11 +654,31 b' instance:'
     ipdb> e.print_traceback(1)
     [1:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
 
 
+Since you might have 100 engines, you probably don't want to see 100 tracebacks
+for a simple NameError because of a typo.
+For this reason, CompositeError truncates the list of exceptions it will print
+to :attr:`CompositeError.tb_limit` (default is five).
+You can change this limit to suit your needs with:
+
+.. sourcecode:: ipython
+
+    In [20]: from IPython.parallel import CompositeError
+    In [21]: CompositeError.tb_limit = 1
+    In [22]: %px a=b
+    [0:execute]: 
+    ---------------------------------------------------------------------------
+    NameError                                 Traceback (most recent call last)
+    ----> 1 a=b
+    NameError: name 'b' is not defined
+
+    ... 3 more exceptions ...
+
+
 All of this same error handling magic even works in non-blocking mode:
 
 .. sourcecode:: ipython
@@ -670,25 +690,8 b' All of this same error handling magic even works in non-blocking mode:'
     In [85]: ar.get()
     [0:execute]: 
     ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
-    ----> 1 1/0
-    ZeroDivisionError: integer division or modulo by zero
-
-    [1:execute]: 
-    ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
+    ZeroDivisionError                         Traceback (most recent call last)
     ----> 1 1/0
     ZeroDivisionError: integer division or modulo by zero
-
-    [2:execute]: 
-    ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
-    ----> 1 1/0
-    ZeroDivisionError: integer division or modulo by zero
-
-    [3:execute]: 
-    ---------------------------------------------------------------------------
-    ZeroDivisionError                         Traceback (most recent call last)<ipython-input-1-05c9758a9c21> in <module>()
-    ----> 1 1/0
-    ZeroDivisionError: integer division or modulo by zero
-
+    
+    ... 3 more exceptions ...