Merge pull request #2981 from minrk/format_types

IPEP 10: kernel side filtering of display formats

IPython/core/formatters.py

@@ -26,13 +26,16 b' Authors:'
 # Stdlib imports
 import abc
 import sys
+import warnings
 # We must use StringIO, as cStringIO doesn't handle unicode properly.
 from StringIO import StringIO
 
 # 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
+from IPython.utils.traitlets import (
+    Bool, Dict, Integer, Unicode, CUnicode, ObjectName, List,
+)
 from IPython.utils.py3compat import unicode_to_str
 
 
@@ -45,7 +48,33 b' class DisplayFormatter(Configurable):'
 
     # When set to true only the default plain text formatter will be used.
     plain_text_only = Bool(False, config=True)
-
+    def _plain_text_only_changed(self, name, old, new):
+        warnings.warn("""DisplayFormatter.plain_text_only is deprecated.
+        
+        Use DisplayFormatter.active_types = ['text/plain']
+        for the same effect.
+        """, DeprecationWarning)
+        if new:
+            self.active_types = ['text/plain']
+        else:
+            self.active_types = self.format_types
+    
+    active_types = List(Unicode, config=True,
+        help="""List of currently active mime-types to display.
+        You can use this to set a white-list for formats to display.
+        
+        Most users will not need to change this value.
+        """)
+    def _active_types_default(self):
+        return self.format_types
+    
+    def _active_types_changed(self, name, old, new):
+        for key, formatter in self.formatters.items():
+            if key in new:
+                formatter.enabled = True
+            else:
+                formatter.enabled = False
+    
     # A dict of formatter whose keys are format types (MIME types) and whose
     # values are subclasses of BaseFormatter.
     formatters = Dict()
@@ -92,7 +121,7 b' class DisplayFormatter(Configurable):'
             format data dict. If this is set *only* the format types included
             in this list will be computed.
         exclude : list or tuple, optional
-            A list of format type string (MIME types) to exclue in the format
+            A list of format type string (MIME types) to exclude in the format
             data dict. If this is set all format types will be computed,
             except for those included in this argument.
 
@@ -107,25 +136,11 b' class DisplayFormatter(Configurable):'
         """
         format_dict = {}
 
-        # If plain text only is active
-        if self.plain_text_only:
-            formatter = self.formatters['text/plain']
-            try:
-                data = formatter(obj)
-            except:
-                # FIXME: log the exception
-                raise
-            if data is not None:
-                format_dict['text/plain'] = data
-            return format_dict
-
         for format_type, formatter in self.formatters.items():
-            if include is not None:
-                if format_type not in include:
-                    continue
-            if exclude is not None:
-                if format_type in exclude:
-                    continue
+            if include and format_type not in include:
+                continue
+            if exclude and format_type in exclude:
+                continue
             try:
                 data = formatter(obj)
             except:

IPython/core/magics/basic.py

@@ -427,7 +427,7 b' Defaulting color scheme to \'NoColor\'"""'
         save_dstore('rc_separate_out2',shell.separate_out2)
         save_dstore('rc_prompts_pad_left',pm.justify)
         save_dstore('rc_separate_in',shell.separate_in)
-        save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
+        save_dstore('rc_active_types',disp_formatter.active_types)
         save_dstore('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
 
         if mode == False:
@@ -444,7 +444,7 b' Defaulting color scheme to \'NoColor\'"""'
             pm.justify = False
 
             ptformatter.pprint = False
-            disp_formatter.plain_text_only = True
+            disp_formatter.active_types = ['text/plain']
 
             shell.magic('xmode Plain')
         else:
@@ -459,7 +459,7 b' Defaulting color scheme to \'NoColor\'"""'
             pm.justify = dstore.rc_prompts_pad_left
 
             ptformatter.pprint = dstore.rc_pprint
-            disp_formatter.plain_text_only = dstore.rc_plain_text_only
+            disp_formatter.active_types = dstore.rc_active_types
 
             shell.magic('xmode ' + dstore.xmode)
 

IPython/frontend/terminal/interactiveshell.py

@@ -383,6 +383,15 b' class TerminalInteractiveShell(InteractiveShell):'
         self.init_banner(banner1, banner2, display_banner)
 
     #-------------------------------------------------------------------------
+    # Overrides of init stages
+    #-------------------------------------------------------------------------
+
+    def init_display_formatter(self):
+        super(TerminalInteractiveShell, self).init_display_formatter()
+        # terminal only supports plaintext
+        self.display_formatter.active_types = ['text/plain']
+
+    #-------------------------------------------------------------------------
     # Things related to the terminal
     #-------------------------------------------------------------------------
 

IPython/kernel/zmq/zmqshell.py

@@ -150,18 +150,18 b' class KernelMagics(Magics):'
         # save a few values we'll need to recover later
         mode = save_dstore('mode', False)
         save_dstore('rc_pprint', ptformatter.pprint)
-        save_dstore('rc_plain_text_only',disp_formatter.plain_text_only)
+        save_dstore('rc_active_types',disp_formatter.active_types)
         save_dstore('xmode', shell.InteractiveTB.mode)
 
         if mode == False:
             # turn on
             ptformatter.pprint = False
-            disp_formatter.plain_text_only = True
+            disp_formatter.active_types = ['text/plain']
             shell.magic('xmode Plain')
         else:
             # turn off
             ptformatter.pprint = dstore.rc_pprint
-            disp_formatter.plain_text_only = dstore.rc_plain_text_only
+            disp_formatter.active_types = dstore.rc_active_types
             shell.magic("xmode " + dstore.xmode)
 
         # Store new mode and inform on console