warn on failed formatter calls

takluyver · Jan 7, 2014 · Dec 28, 2013 · Dec 28, 2013 · 4f2f15bc8d4724bc2f3beb5883aeffc9d3c586d0
commit 4f2f15bc8d4724bc2f3beb5883aeffc9d3c586d0
diff --git a/IPython/core/formatters.py b/IPython/core/formatters.py
@@ -28,12 +28,15 @@
 import sys
 import warnings
 
+from IPython.external.decorator import decorator
+
 # Our own imports
 from IPython.config.configurable import Configurable
 from IPython.lib import pretty
 from IPython.utils.traitlets import (
     Bool, Dict, Integer, Unicode, CUnicode, ObjectName, List,
 )
+from IPython.utils.warn import warn
 from IPython.utils.py3compat import (
     unicode_to_str, with_metaclass, PY3, string_types,
 )
@@ -180,6 +183,16 @@ def format_types(self):
 #-----------------------------------------------------------------------------
 
 
+@decorator
+def warn_format_error(method, self, *args, **kwargs):
+    """decorator for warning on failed format call"""
+    try:
+        return method(self, *args, **kwargs)
+    except Exception as e:
+        warn("Exception in %s formatter: %s" % (self.format_type, e))
+        return None
+
+
 class FormatterABC(with_metaclass(abc.ABCMeta, object)):
     """ Abstract base class for Formatters.
 
@@ -194,17 +207,16 @@ class FormatterABC(with_metaclass(abc.ABCMeta, object)):
 
     # Is the formatter enabled...
     enabled = True
-
+    
     @abc.abstractmethod
+    @warn_format_error
     def __call__(self, obj):
         """Return a JSON'able representation of the object.
 
-        If the object cannot be formatted by this formatter, then return None
+        If the object cannot be formatted by this formatter,
+        warn and return None.
         """
-        try:
-            return repr(obj)
-        except Exception:
-            return None
+        return repr(obj)
 
 
 def _mod_name_key(typ):
@@ -223,6 +235,7 @@ def _get_type(obj):
 
 _raise_key_error = object()
 
+
 class BaseFormatter(Configurable):
     """A base formatter class that is configurable.
 
@@ -266,24 +279,22 @@ class BaseFormatter(Configurable):
     # Map (modulename, classname) pairs to the format functions.
     deferred_printers = Dict(config=True)
 
+    @warn_format_error
     def __call__(self, obj):
         """Compute the format for an object."""
         if self.enabled:
+            # lookup registered printer
             try:
-                # lookup registered printer
-                try:
-                    printer = self.lookup(obj)
-                except KeyError:
-                    pass
-                else:
-                    return printer(obj)
-                # Finally look for special method names
-                method = pretty._safe_getattr(obj, self.print_method, None)
-                if method is not None:
-                    return method()
-                return None
-            except Exception:
+                printer = self.lookup(obj)
+            except KeyError:
                 pass
+            else:
+                return printer(obj)
+            # Finally look for special method names
+            method = pretty._safe_getattr(obj, self.print_method, None)
+            if method is not None:
+                return method()
+            return None
         else:
             return None
 
@@ -599,6 +610,7 @@ def _deferred_printers_default(self):
 
     #### FormatterABC interface ####
 
+    @warn_format_error
     def __call__(self, obj):
         """Compute the pretty representation of the object."""
         if not self.pprint:

diff --git a/IPython/core/tests/test_formatters.py b/IPython/core/tests/test_formatters.py
@@ -1,5 +1,4 @@
-"""Tests for the Formatters.
-"""
+"""Tests for the Formatters."""
 
 from math import pi
 
@@ -9,7 +8,8 @@
     numpy = None
 import nose.tools as nt
 
-from IPython.core.formatters import PlainTextFormatter, _mod_name_key
+from IPython.core.formatters import PlainTextFormatter, HTMLFormatter, _mod_name_key
+from IPython.utils.io import capture_output
 
 class A(object):
     def __repr__(self):
@@ -231,4 +231,40 @@ def test_pop_string():
     nt.assert_is(f.pop(type_str, None), None)
 
 
+def test_warn_error_method():
+    f = HTMLFormatter()
+    class BadHTML(object):
+        def _repr_html_(self):
+            return 1/0
+    bad = BadHTML()
+    with capture_output() as captured:
+        result = f(bad)
+    nt.assert_is(result, None)
+    nt.assert_in("WARNING", captured.stderr)
+    nt.assert_in("text/html", captured.stderr)
+    nt.assert_in("zero", captured.stderr)
+
+def test_warn_error_for_type():
+    f = HTMLFormatter()
+    f.for_type(int, lambda i: name_error)
+    with capture_output() as captured:
+        result = f(5)
+    nt.assert_is(result, None)
+    nt.assert_in("WARNING", captured.stderr)
+    nt.assert_in("text/html", captured.stderr)
+    nt.assert_in("name_error", captured.stderr)
+
+def test_warn_error_pretty_method():
+    f = PlainTextFormatter()
+    class BadPretty(object):
+        def _repr_pretty_(self):
+            return "hello"
+    bad = BadPretty()
+    with capture_output() as captured:
+        result = f(bad)
+    nt.assert_is(result, None)
+    nt.assert_in("WARNING", captured.stderr)
+    nt.assert_in("text/plain", captured.stderr)
+    nt.assert_in("argument", captured.stderr)
+