Merge pull request #507 from takluyver/prompt-manager

Prompt manager refactoring: use a new `PromptManager` class responsible for handling everything to do with the prompts. The critical part is its `render` method, which assembles the necessary information, then uses the string formatting introduced in Python 2.6 to fill in the prompt template.

I've expanded the definition of 'prompts' to include the auto_rewrite prompt (`"------> "` by default). So there are now four prompts: input, continuation, output, and rewrite.

This definition of prompts does not include input/output separators. For now, I've left those as attributes of the main InteractiveShell object.

IPython/config/profile/pysh/ipython_config.py

@@ -5,11 +5,11 app = c.InteractiveShellApp
 # and merge it into the current one.
 load_subconfig('ipython_config.py', profile='default')
 
-c.InteractiveShell.prompt_in1 = r'\C_LightGreen\u@\h\C_LightBlue[\C_LightCyan\Y1\C_LightBlue]\C_Green|\#> '
-c.InteractiveShell.prompt_in2 = r'\C_Green|\C_LightGreen\D\C_Green> '
-c.InteractiveShell.prompt_out = r'<\#> '
+c.PromptManager.in_template = r'{color.LightGreen}\u@\h{color.LightBlue}[{color.LightCyan}\Y1{color.LightBlue}]{color.Green}|\#> '
+c.PromptManager.in2_template = r'{color.Green}|{color.LightGreen}\D{color.Green}> '
+c.PromptManager.out_template = r'<\#> '
 
-c.InteractiveShell.prompts_pad_left = True
+c.PromptManager.justify = True
 
 c.InteractiveShell.separate_in = ''
 c.InteractiveShell.separate_out = ''

IPython/core/displayhook.py

@@ -25,7 +25,6 Authors:
 import __builtin__
 
 from IPython.config.configurable import Configurable
-from IPython.core import prompts
 from IPython.utils import io
 from IPython.utils.traitlets import Instance, List
 from IPython.utils.warn import warn
@@ -34,32 +33,20 from IPython.utils.warn import warn
 # Main displayhook class
 #-----------------------------------------------------------------------------
 
-# TODO: The DisplayHook class should be split into two classes, one that
-# manages the prompts and their synchronization and another that just does the
-# displayhook logic and calls into the prompt manager.
-
-# TODO: Move the various attributes (cache_size, colors, input_sep,
-# output_sep, output_sep2, ps1, ps2, ps_out, pad_left). Some of these are also
-# attributes of InteractiveShell. They should be on ONE object only and the
-# other objects should ask that one object for their values.
+# TODO: Move the various attributes (cache_size, [others now moved]). Some
+# of these are also attributes of InteractiveShell. They should be on ONE object
+# only and the other objects should ask that one object for their values.
 
 class DisplayHook(Configurable):
     """The custom IPython displayhook to replace sys.displayhook.
 
     This class does many things, but the basic idea is that it is a callable
     that gets called anytime user code returns a value.
-
-    Currently this class does more than just the displayhook logic and that
-    extra logic should eventually be moved out of here.
     """
 
     shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
 
-    def __init__(self, shell=None, cache_size=1000,
-                 colors='NoColor', input_sep='\n',
-                 output_sep='\n', output_sep2='',
-                 ps1 = None, ps2 = None, ps_out = None, pad_left=True,
-                 config=None):
+    def __init__(self, shell=None, cache_size=1000, config=None):
         super(DisplayHook, self).__init__(shell=shell, config=config)
 
         cache_size_min = 3
@@ -75,36 +62,10 class DisplayHook(Configurable):
             self.do_full_cache = 1
 
         self.cache_size = cache_size
-        self.input_sep = input_sep
 
         # we need a reference to the user-level namespace
         self.shell = shell
 
-        # Set input prompt strings and colors
-        if cache_size == 0:
-            if ps1.find('%n') > -1 or ps1.find(r'\#') > -1 \
-                   or ps1.find(r'\N') > -1:
-                ps1 = '>>> '
-            if ps2.find('%n') > -1 or ps2.find(r'\#') > -1 \
-                   or ps2.find(r'\N') > -1:
-                ps2 = '... '
-        self.ps1_str = self._set_prompt_str(ps1,'In [\\#]: ','>>> ')
-        self.ps2_str = self._set_prompt_str(ps2,'   .\\D.: ','... ')
-        self.ps_out_str = self._set_prompt_str(ps_out,'Out[\\#]: ','')
-
-        self.color_table = prompts.PromptColors
-        self.prompt1 = prompts.Prompt1(self,sep=input_sep,prompt=self.ps1_str,
-                               pad_left=pad_left)
-        self.prompt2 = prompts.Prompt2(self,prompt=self.ps2_str,pad_left=pad_left)
-        self.prompt_out = prompts.PromptOut(self,sep='',prompt=self.ps_out_str,
-                                    pad_left=pad_left)
-        self.set_colors(colors)
-
-        # Store the last prompt string each time, we need it for aligning
-        # continuation and auto-rewrite prompts
-        self.last_prompt = ''
-        self.output_sep = output_sep
-        self.output_sep2 = output_sep2
         self._,self.__,self.___ = '','',''
 
         # these are deliberately global:
@@ -115,32 +76,6 class DisplayHook(Configurable):
     def prompt_count(self):
         return self.shell.execution_count
 
-    def _set_prompt_str(self,p_str,cache_def,no_cache_def):
-        if p_str is None:
-            if self.do_full_cache:
-                return cache_def
-            else:
-                return no_cache_def
-        else:
-            return p_str
-
-    def set_colors(self, colors):
-        """Set the active color scheme and configure colors for the three
-        prompt subsystems."""
-
-        # FIXME: This modifying of the global prompts.prompt_specials needs
-        # to be fixed. We need to refactor all of the prompts stuff to use
-        # proper configuration and traits notifications.
-        if colors.lower()=='nocolor':
-            prompts.prompt_specials = prompts.prompt_specials_nocolor
-        else:
-            prompts.prompt_specials = prompts.prompt_specials_color
-
-        self.color_table.set_active_scheme(colors)
-        self.prompt1.set_colors()
-        self.prompt2.set_colors()
-        self.prompt_out.set_colors()
-
     #-------------------------------------------------------------------------
     # Methods used in __call__. Override these methods to modify the behavior
     # of the displayhook.
@@ -180,8 +115,8 class DisplayHook(Configurable):
         ``io.stdout``.
         """
         # Use write, not print which adds an extra space.
-        io.stdout.write(self.output_sep)
-        outprompt = str(self.prompt_out)
+        io.stdout.write(self.shell.separate_out)
+        outprompt = self.shell.prompt_manager.render('out')
         if self.do_full_cache:
             io.stdout.write(outprompt)
 
@@ -235,11 +170,12 class DisplayHook(Configurable):
             # So that multi-line strings line up with the left column of
             # the screen, instead of having the output prompt mess up
             # their first line.
-            # We use the ps_out_str template instead of the expanded prompt
+            # We use the prompt template instead of the expanded prompt
             # because the expansion may add ANSI escapes that will interfere
             # with our ability to determine whether or not we should add
             # a newline.
-            if self.ps_out_str and not self.ps_out_str.endswith('\n'):
+            prompt_template = self.shell.prompt_manager.out_template
+            if prompt_template and not prompt_template.endswith('\n'):
                 # But avoid extraneous empty lines.
                 result_repr = '\n' + result_repr
 
@@ -286,7 +222,7 class DisplayHook(Configurable):
 
     def finish_displayhook(self):
         """Finish up all displayhook activities."""
-        io.stdout.write(self.output_sep2)
+        io.stdout.write(self.shell.separate_out2)
         io.stdout.flush()
 
     def __call__(self, result=None):

IPython/core/hooks.py

@@ -51,7 +51,7 from IPython.core.error import TryNext
 
 __all__ = ['editor', 'fix_error_editor', 'synchronize_with_editor',
            'input_prefilter', 'shutdown_hook', 'late_startup_hook',
-           'generate_prompt', 'show_in_pager','pre_prompt_hook',
+           'show_in_pager','pre_prompt_hook',
            'pre_run_code_hook', 'clipboard_get']
 
 def editor(self,filename, linenum=None):
@@ -187,13 +187,6 def late_startup_hook(self):
     #print "default startup hook ok" # dbg
 
 
-def generate_prompt(self, is_continuation):
-    """ calculate and return a string with the prompt to display """
-    if is_continuation:
-        return str(self.displayhook.prompt2)
-    return str(self.displayhook.prompt1)
-
-
 def show_in_pager(self,s):
     """ Run a string through pager """
     # raising TryNext here will use the default paging functionality

IPython/core/interactiveshell.py

@@ -63,6 +63,7 from IPython.core.plugin import PluginManager
 from IPython.core.prefilter import PrefilterManager, ESC_MAGIC
 from IPython.core.profiledir import ProfileDir
 from IPython.core.pylabtools import pylab_activate
+from IPython.core.prompts import PromptManager
 from IPython.external.Itpl import ItplNS
 from IPython.utils import PyColorize
 from IPython.utils import io
@@ -594,10 +595,8 class InteractiveShell(SingletonConfigurable, Magic):
             io.stderr = io.IOStream(sys.stderr)
 
     def init_prompts(self):
-        # TODO: This is a pass for now because the prompts are managed inside
-        # the DisplayHook. Once there is a separate prompt manager, this
-        # will initialize that object and all prompt related information.
-        pass
+        self.prompt_manager = PromptManager(shell=self, config=self.config)
+        self.configurables.append(self.prompt_manager)
 
     def init_display_formatter(self):
         self.display_formatter = DisplayFormatter(config=self.config)
@@ -613,13 +612,6 class InteractiveShell(SingletonConfigurable, Magic):
             config=self.config,
             shell=self,
             cache_size=self.cache_size,
-            input_sep = self.separate_in,
-            output_sep = self.separate_out,
-            output_sep2 = self.separate_out2,
-            ps1 = self.prompt_in1,
-            ps2 = self.prompt_in2,
-            ps_out = self.prompt_out,
-            pad_left = self.prompts_pad_left
         )
         self.configurables.append(self.displayhook)
         # This is a context manager that installs/revmoes the displayhook at
@@ -2149,7 +2141,7 class InteractiveShell(SingletonConfigurable, Magic):
         after the user's input prompt.  This helps the user understand that the
         input line was transformed automatically by IPython.
         """
-        rw = self.displayhook.prompt1.auto_rewrite() + cmd
+        rw = self.prompt_manager.render('rewrite') + cmd
 
         try:
             # plain ascii works better w/ pyreadline, on some machines, so

IPython/core/magic.py

@@ -2554,12 +2554,12 Defaulting color scheme to 'NoColor'"""
 
         # Set prompt colors
         try:
-            shell.displayhook.set_colors(new_scheme)
+            shell.prompt_manager.color_scheme = new_scheme
         except:
             color_switch_err('prompt')
         else:
             shell.colors = \
-                       shell.displayhook.color_table.active_scheme_name
+                   shell.prompt_manager.color_scheme_table.active_scheme_name
         # Set exception colors
         try:
             shell.InteractiveTB.set_colors(scheme = new_scheme)
@@ -3237,7 +3237,7 Defaulting color scheme to 'NoColor'"""
 
         # Shorthands
         shell = self.shell
-        oc = shell.displayhook
+        pm = shell.prompt_manager
         meta = shell.meta
         disp_formatter = self.shell.display_formatter
         ptformatter = disp_formatter.formatters['text/plain']
@@ -3252,23 +3252,23 Defaulting color scheme to 'NoColor'"""
         save_dstore('xmode',shell.InteractiveTB.mode)
         save_dstore('rc_separate_out',shell.separate_out)
         save_dstore('rc_separate_out2',shell.separate_out2)
-        save_dstore('rc_prompts_pad_left',shell.prompts_pad_left)
+        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('prompt_templates',(pm.in_template, pm.in2_template, pm.out_template))
 
         if mode == False:
             # turn on
-            oc.prompt1.p_template = '>>> '
-            oc.prompt2.p_template = '... '
-            oc.prompt_out.p_template = ''
+            pm.in_template = '>>> '
+            pm.in2_template = '... '
+            pm.out_template = ''
 
             # Prompt separators like plain python
-            oc.input_sep = oc.prompt1.sep = ''
-            oc.output_sep = ''
-            oc.output_sep2 = ''
+            shell.separate_in = ''
+            shell.separate_out = ''
+            shell.separate_out2 = ''
 
-            oc.prompt1.pad_left = oc.prompt2.pad_left = \
-                                  oc.prompt_out.pad_left = False
+            pm.justify = False
 
             ptformatter.pprint = False
             disp_formatter.plain_text_only = True
@@ -3276,17 +3276,14 Defaulting color scheme to 'NoColor'"""
             shell.magic_xmode('Plain')
         else:
             # turn off
-            oc.prompt1.p_template = shell.prompt_in1
-            oc.prompt2.p_template = shell.prompt_in2
-            oc.prompt_out.p_template = shell.prompt_out
+            pm.in_template, pm.in2_template, pm.out_template = dstore.prompt_templates
 
-            oc.input_sep = oc.prompt1.sep = dstore.rc_separate_in
+            shell.separate_in = dstore.rc_separate_in
 
-            oc.output_sep = dstore.rc_separate_out
-            oc.output_sep2 = dstore.rc_separate_out2
+            shell.separate_out = dstore.rc_separate_out
+            shell.separate_out2 = dstore.rc_separate_out2
 
-            oc.prompt1.pad_left = oc.prompt2.pad_left = \
-                         oc.prompt_out.pad_left = dstore.rc_prompts_pad_left
+            pm.justify = dstore.rc_prompts_pad_left
 
             ptformatter.pprint = dstore.rc_pprint
             disp_formatter.plain_text_only = dstore.rc_plain_text_only
@@ -3603,6 +3600,7 Defaulting color scheme to 'NoColor'"""
                 PrefilterManager
                 AliasManager
                 IPCompleter
+                PromptManager
                 DisplayFormatter
 
         To view what is configurable on a given class, just pass the class name::

IPython/core/prompts.py

@@ -5,6 +5,7 Authors:
 
 * Fernando Perez
 * Brian Granger
+* Thomas Kluyver
 """
 
 #-----------------------------------------------------------------------------
@@ -23,20 +24,23 import os
 import re
 import socket
 import sys
+import time
 
+from IPython.config.configurable import Configurable
 from IPython.core import release
-from IPython.external.Itpl import ItplNS
 from IPython.utils import coloransi
+from IPython.utils.traitlets import (Unicode, Instance, Dict, Bool, Int)
 
 #-----------------------------------------------------------------------------
 # Color schemes for prompts
 #-----------------------------------------------------------------------------
 
-PromptColors = coloransi.ColorSchemeTable()
 InputColors = coloransi.InputTermColors  # just a shorthand
 Colors = coloransi.TermColors  # just a shorthand
 
-PromptColors.add_scheme(coloransi.ColorScheme(
+color_lists = dict(normal=Colors(), inp=InputColors(), nocolor=coloransi.NoColors())
+
+PColNoColors = coloransi.ColorScheme(
     'NoColor',
     in_prompt  = InputColors.NoColor,  # Input prompt
     in_number  = InputColors.NoColor,  # Input prompt number
@@ -47,10 +51,10 PromptColors.add_scheme(coloransi.ColorScheme(
     out_number = Colors.NoColor, # Output prompt number
 
     normal = Colors.NoColor  # color off (usu. Colors.Normal)
-    ))
+    )
 
 # make some schemes as instances so we can copy them for modification easily:
-__PColLinux =  coloransi.ColorScheme(
+PColLinux =  coloransi.ColorScheme(
     'Linux',
     in_prompt  = InputColors.Green,
     in_number  = InputColors.LightGreen,
@@ -62,25 +66,35 __PColLinux = coloransi.ColorScheme(
 
     normal = Colors.Normal
     )
-# Don't forget to enter it into the table!
-PromptColors.add_scheme(__PColLinux)
 
 # Slightly modified Linux for light backgrounds
-__PColLightBG  = __PColLinux.copy('LightBG')
+PColLightBG  = PColLinux.copy('LightBG')
 
-__PColLightBG.colors.update(
+PColLightBG.colors.update(
     in_prompt  = InputColors.Blue,
     in_number  = InputColors.LightBlue,
     in_prompt2 = InputColors.Blue
 )
-PromptColors.add_scheme(__PColLightBG)
-
-del Colors,InputColors
 
 #-----------------------------------------------------------------------------
 # Utilities
 #-----------------------------------------------------------------------------
 
+class LazyEvaluate(object):
+    """This is used for formatting strings with values that need to be updated
+    at that time, such as the current time or working directory."""
+    def __init__(self, func, *args, **kwargs):
+        self.func = func
+        self.args = args
+        self.kwargs = kwargs
+    
+    def __call__(self, **kwargs):
+        self.kwargs.update(kwargs)
+        return self.func(*self.args, **self.kwargs)
+    
+    def __str__(self):
+        return str(self())
+
 def multiple_replace(dict, text):
     """ Replace in 'text' all occurences of any key in the given
     dictionary by its corresponding value.  Returns the new string."""
@@ -121,51 +135,43 HOME = os.environ.get("HOME","//////:::::ZZZZZ,,,~~~")
 USER           = os.environ.get("USER")
 HOSTNAME       = socket.gethostname()
 HOSTNAME_SHORT = HOSTNAME.split(".")[0]
-ROOT_SYMBOL    = "$#"[os.name=='nt' or os.getuid()==0]
+ROOT_SYMBOL    = "#" if (os.name=='nt' or os.getuid()==0) else "$"
 
-prompt_specials_color = {
+prompt_abbreviations = {
     # Prompt/history count
-    '%n' : '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}',
-    r'\#': '${self.col_num}' '${self.cache.prompt_count}' '${self.col_p}',
+    '%n' : '{color.number}' '{count}' '{color.prompt}',
+    r'\#': '{color.number}' '{count}' '{color.prompt}',
     # Just the prompt counter number, WITHOUT any coloring wrappers, so users
     # can get numbers displayed in whatever color they want.
-    r'\N': '${self.cache.prompt_count}',
+    r'\N': '{count}',
 
     # Prompt/history count, with the actual digits replaced by dots.  Used
     # mainly in continuation prompts (prompt_in2)
-    #r'\D': '${"."*len(str(self.cache.prompt_count))}',
+    r'\D': '{dots}',
 
-    # More robust form of the above expression, that uses the __builtin__
-    # module.  Note that we can NOT use __builtins__ (note the 's'), because
-    # that can either be a dict or a module, and can even mutate at runtime,
-    # depending on the context (Python makes no guarantees on it).  In
-    # contrast, __builtin__ is always a module object, though it must be
-    # explicitly imported.
-    r'\D': '${"."*__builtin__.len(__builtin__.str(self.cache.prompt_count))}',
-
-    # Current working directory
-    r'\w': '${os.getcwd()}',
     # Current time
-    r'\t' : '${time.strftime("%H:%M:%S")}',
+    r'\T' : '{time}',
+    # Current working directory
+    r'\w': '{cwd}',
     # Basename of current working directory.
     # (use os.sep to make this portable across OSes)
-    r'\W' : '${os.getcwd().split("%s")[-1]}' % os.sep,
+    r'\W' : '{cwd_last}',
     # These X<N> are an extension to the normal bash prompts.  They return
     # N terms of the path, after replacing $HOME with '~'
-    r'\X0': '${os.getcwd().replace("%s","~")}' % HOME,
-    r'\X1': '${self.cwd_filt(1)}',
-    r'\X2': '${self.cwd_filt(2)}',
-    r'\X3': '${self.cwd_filt(3)}',
-    r'\X4': '${self.cwd_filt(4)}',
-    r'\X5': '${self.cwd_filt(5)}',
+    r'\X0': '{cwd_x[0]}',
+    r'\X1': '{cwd_x[1]}',
+    r'\X2': '{cwd_x[2]}',
+    r'\X3': '{cwd_x[3]}',
+    r'\X4': '{cwd_x[4]}',
+    r'\X5': '{cwd_x[5]}',
     # Y<N> are similar to X<N>, but they show '~' if it's the directory
     # N+1 in the list.  Somewhat like %cN in tcsh.
-    r'\Y0': '${self.cwd_filt2(0)}',
-    r'\Y1': '${self.cwd_filt2(1)}',
-    r'\Y2': '${self.cwd_filt2(2)}',
-    r'\Y3': '${self.cwd_filt2(3)}',
-    r'\Y4': '${self.cwd_filt2(4)}',
-    r'\Y5': '${self.cwd_filt2(5)}',
+    r'\Y0': '{cwd_y[0]}',
+    r'\Y1': '{cwd_y[1]}',
+    r'\Y2': '{cwd_y[2]}',
+    r'\Y3': '{cwd_y[3]}',
+    r'\Y4': '{cwd_y[4]}',
+    r'\Y5': '{cwd_y[5]}',
     # Hostname up to first .
     r'\h': HOSTNAME_SHORT,
     # Full hostname
@@ -184,137 +190,11 prompt_specials_color = {
     r'\$': ROOT_SYMBOL,
     }
 
-# A copy of the prompt_specials dictionary but with all color escapes removed,
-# so we can correctly compute the prompt length for the auto_rewrite method.
-prompt_specials_nocolor = prompt_specials_color.copy()
-prompt_specials_nocolor['%n'] = '${self.cache.prompt_count}'
-prompt_specials_nocolor[r'\#'] = '${self.cache.prompt_count}'
-
-# Add in all the InputTermColors color escapes as valid prompt characters.
-# They all get added as \\C_COLORNAME, so that we don't have any conflicts
-# with a color name which may begin with a letter used by any other of the
-# allowed specials.  This of course means that \\C will never be allowed for
-# anything else.
-input_colors = coloransi.InputTermColors
-for _color in dir(input_colors):
-    if _color[0] != '_':
-        c_name = r'\C_'+_color
-        prompt_specials_color[c_name] = getattr(input_colors,_color)
-        prompt_specials_nocolor[c_name] = ''
-
-# we default to no color for safety.  Note that prompt_specials is a global
-# variable used by all prompt objects.
-prompt_specials = prompt_specials_nocolor
-
 #-----------------------------------------------------------------------------
 # More utilities
 #-----------------------------------------------------------------------------
 
-def str_safe(arg):
-    """Convert to a string, without ever raising an exception.
-
-    If str(arg) fails, <ERROR: ... > is returned, where ... is the exception
-    error message."""
-
-    try:
-        out = str(arg)
-    except UnicodeError:
-        try:
-            out = arg.encode('utf_8','replace')
-        except Exception,msg:
-            # let's keep this little duplication here, so that the most common
-            # case doesn't suffer from a double try wrapping.
-            out = '<ERROR: %s>' % msg
-    except Exception,msg:
-        out = '<ERROR: %s>' % msg
-        #raise  # dbg
-    return out
-
-#-----------------------------------------------------------------------------
-# Prompt classes
-#-----------------------------------------------------------------------------
-
-class BasePrompt(object):
-    """Interactive prompt similar to Mathematica's."""
-
-    def _get_p_template(self):
-        return self._p_template
-
-    def _set_p_template(self,val):
-        self._p_template = val
-        self.set_p_str()
-
-    p_template = property(_get_p_template,_set_p_template,
-                          doc='Template for prompt string creation')
-
-    def __init__(self, cache, sep, prompt, pad_left=False):
-
-        # Hack: we access information about the primary prompt through the
-        # cache argument.  We need this, because we want the secondary prompt
-        # to be aligned with the primary one.  Color table info is also shared
-        # by all prompt classes through the cache.  Nice OO spaghetti code!
-        self.cache = cache
-        self.sep = sep
-
-        # regexp to count the number of spaces at the end of a prompt
-        # expression, useful for prompt auto-rewriting
-        self.rspace = re.compile(r'(\s*)$')
-        # Flag to left-pad prompt strings to match the length of the primary
-        # prompt
-        self.pad_left = pad_left
-
-        # Set template to create each actual prompt (where numbers change).
-        # Use a property
-        self.p_template = prompt
-        self.set_p_str()
-
-    def set_p_str(self):
-        """ Set the interpolating prompt strings.
-
-        This must be called every time the color settings change, because the
-        prompt_specials global may have changed."""
-
-        import os,time  # needed in locals for prompt string handling
-        loc = locals()
-        try:
-            self.p_str = ItplNS('%s%s%s' %
-                                ('${self.sep}${self.col_p}',
-                                 multiple_replace(prompt_specials, self.p_template),
-                                 '${self.col_norm}'),self.cache.shell.user_ns,loc)
-
-            self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor,
-                                                         self.p_template),
-                                        self.cache.shell.user_ns,loc)
-        except:
-            print "Illegal prompt template (check $ usage!):",self.p_template
-            self.p_str = self.p_template
-            self.p_str_nocolor = self.p_template
-
-    def write(self, msg):
-        sys.stdout.write(msg)
-        return ''
-
-    def __str__(self):
-        """Return a string form of the prompt.
-
-        This for is useful for continuation and output prompts, since it is
-        left-padded to match lengths with the primary one (if the
-        self.pad_left attribute is set)."""
-
-        out_str = str_safe(self.p_str)
-        if self.pad_left:
-            # We must find the amount of padding required to match lengths,
-            # taking the color escapes (which are invisible on-screen) into
-            # account.
-            esc_pad = len(out_str) - len(str_safe(self.p_str_nocolor))
-            format = '%%%ss' % (len(str(self.cache.last_prompt))+esc_pad)
-            return format % out_str
-        else:
-            return out_str
-
-    # these path filters are put in as methods so that we can control the
-    # namespace where the prompt strings get evaluated
-    def cwd_filt(self, depth):
+def cwd_filt(depth):
         """Return the last depth elements of the current working directory.
 
         $HOME is always replaced with '~'.
@@ -322,12 +202,9 class BasePrompt(object):
 
         cwd = os.getcwd().replace(HOME,"~")
         out = os.sep.join(cwd.split(os.sep)[-depth:])
-        if out:
-            return out
-        else:
-            return os.sep
+    return out or os.sep
 
-    def cwd_filt2(self, depth):
+def cwd_filt2(depth):
         """Return the last depth elements of the current working directory.
 
         $HOME is always replaced with '~'.
@@ -342,95 +219,160 class BasePrompt(object):
             drivepart = os.path.splitdrive(full_cwd)[0]
         out = drivepart + '/'.join(cwd[-depth:])
 
-        if out:
-            return out
-        else:
-            return os.sep
+    return out or os.sep
 
-    def __nonzero__(self):
-        """Implement boolean behavior.
-
-        Checks whether the p_str attribute is non-empty"""
-
-        return bool(self.p_template)
+#-----------------------------------------------------------------------------
+# Prompt classes
+#-----------------------------------------------------------------------------
 
+lazily_evaluate = {'time': LazyEvaluate(time.strftime, "%H:%M:%S"),
+                   'cwd': LazyEvaluate(os.getcwd),
+                   'cwd_last': LazyEvaluate(lambda: os.getcwd().split(os.sep)[-1]),
+                   'cwd_x': [LazyEvaluate(lambda: os.getcwd().replace("%s","~"))] +\
+                            [LazyEvaluate(cwd_filt, x) for x in range(1,6)],
+                   'cwd_y': [LazyEvaluate(cwd_filt2, x) for x in range(6)]
+                   }
 
-class Prompt1(BasePrompt):
-    """Input interactive prompt similar to Mathematica's."""
 
-    def __init__(self, cache, sep='\n', prompt='In [\\#]: ', pad_left=True):
-        BasePrompt.__init__(self, cache, sep, prompt, pad_left)
+class PromptManager(Configurable):
+    """This is the primary interface for producing IPython's prompts."""
+    shell = Instance('IPython.core.interactiveshell.InteractiveShellABC')
+    
+    color_scheme_table = Instance(coloransi.ColorSchemeTable)
+    color_scheme = Unicode('Linux', config=True)
+    def _color_scheme_changed(self, name, new_value):
+        self.color_scheme_table.set_active_scheme(new_value)
+        for pname in ['in', 'in2', 'out', 'rewrite']:
+            # We need to recalculate the number of invisible characters
+            self.update_prompt(pname)
+    
+    lazy_evaluate_fields = Dict(help="""
+        This maps field names used in the prompt templates to functions which
+        will be called when the prompt is rendered. This allows us to include
+        things like the current time in the prompts. Functions are only called
+        if they are used in the prompt.
+        """)
+    def _lazy_evaluate_fields_default(self): return lazily_evaluate.copy()
+    
+    in_template = Unicode('In [\\#]: ', config=True)
+    in2_template = Unicode('   .\\D.: ', config=True)
+    out_template = Unicode('Out[\\#]: ', config=True)
+    rewrite_template = Unicode("------> ", config=True)
+    
+    justify = Bool(True, config=True, help="""
+        If True (default), each prompt will be right-aligned with the
+        preceding one.
+        """)
+    
+    # We actually store the expanded templates here:
+    templates = Dict()
+    
+    # The number of characters in the last prompt rendered, not including
+    # colour characters.
+    width = Int()
+    
+    # The number of characters in each prompt which don't contribute to width
+    invisible_chars = Dict()
+    def _invisible_chars_default(self):
+        return {'in': 0, 'in2': 0, 'out': 0, 'rewrite': 0}
+    
+    def __init__(self, shell, config=None):
+        super(PromptManager, self).__init__(shell=shell, config=config)
+        
+        # Prepare colour scheme table
+        self.color_scheme_table = coloransi.ColorSchemeTable([PColNoColors,
+                                    PColLinux, PColLightBG], self.color_scheme)
+        
+        # Prepare templates
+        self.update_prompt('in', self.in_template)
+        self.update_prompt('in2', self.in2_template)
+        self.update_prompt('out', self.out_template)
+        self.update_prompt('rewrite', self.rewrite_template)
+        self.on_trait_change(self._update_prompt_trait, ['in_template',
+                            'in2_template', 'out_template', 'rewrite_template'])
+    
+    def update_prompt(self, name, new_template=None):
+        """This is called when a prompt template is updated. It processes
+        abbreviations used in the prompt template (like \#) and calculates how
+        many invisible characters (ANSI colour escapes) the resulting prompt
+        contains.
+        
+        It is also called for each prompt on changing the colour scheme. In both
+        cases, traitlets should take care of calling this automatically.
+        """
+        if new_template is not None:
+            self.templates[name] = multiple_replace(prompt_abbreviations, new_template)
+        invis_chars = len(self.render(name, color=True, just=False)) - \
+                            len(self.render(name, color=False, just=False))
+        self.invisible_chars[name] = invis_chars
 
-    def set_colors(self):
-        self.set_p_str()
-        Colors = self.cache.color_table.active_colors # shorthand
-        self.col_p = Colors.in_prompt
-        self.col_num = Colors.in_number
-        self.col_norm = Colors.in_normal
-        # We need a non-input version of these escapes for the '--->'
-        # auto-call prompts used in the auto_rewrite() method.
-        self.col_p_ni = self.col_p.replace('\001','').replace('\002','')
-        self.col_norm_ni = Colors.normal
+    def _update_prompt_trait(self, traitname, new_template):
+        name = traitname[:-9]   # Cut off '_template'
+        self.update_prompt(name, new_template)
 
-    def __str__(self):
-        self.cache.last_prompt = str_safe(self.p_str_nocolor).split('\n')[-1]
-        return str_safe(self.p_str)
-
-    def auto_rewrite(self):
-        """Return a string of the form '--->' which lines up with the previous
-        input string. Useful for systems which re-write the user input when
-        handling automatically special syntaxes."""
-
-        curr = str(self.cache.last_prompt)
-        nrspaces = len(self.rspace.search(curr).group())
-        return '%s%s>%s%s' % (self.col_p_ni,'-'*(len(curr)-nrspaces-1),
-                              ' '*nrspaces,self.col_norm_ni)
-
-
-class PromptOut(BasePrompt):
-    """Output interactive prompt similar to Mathematica's."""
-
-    def __init__(self, cache, sep='', prompt='Out[\\#]: ', pad_left=True):
-        BasePrompt.__init__(self, cache, sep, prompt, pad_left)
-        if not self.p_template:
-            self.__str__ = lambda: ''
-
-    def set_colors(self):
-        self.set_p_str()
-        Colors = self.cache.color_table.active_colors # shorthand
-        self.col_p = Colors.out_prompt
-        self.col_num = Colors.out_number
-        self.col_norm = Colors.normal
-
-
-class Prompt2(BasePrompt):
-    """Interactive continuation prompt."""
-
-    def __init__(self, cache, prompt='   .\\D.: ', pad_left=True):
-        self.cache = cache
-        self.p_template = prompt
-        self.pad_left = pad_left
-        self.set_p_str()
-
-    def set_p_str(self):
-        import os,time  # needed in locals for prompt string handling
-        loc = locals()
-        self.p_str = ItplNS('%s%s%s' %
-                            ('${self.col_p2}',
-                             multiple_replace(prompt_specials, self.p_template),
-                             '$self.col_norm'),
-                            self.cache.shell.user_ns,loc)
-        self.p_str_nocolor = ItplNS(multiple_replace(prompt_specials_nocolor,
-                                                     self.p_template),
-                                    self.cache.shell.user_ns,loc)
-
-    def set_colors(self):
-        self.set_p_str()
-        Colors = self.cache.color_table.active_colors
-        self.col_p2 = Colors.in_prompt2
-        self.col_norm = Colors.in_normal
-        # FIXME (2004-06-16) HACK: prevent crashes for users who haven't
-        # updated their prompt_in2 definitions.  Remove eventually.
-        self.col_p = Colors.out_prompt
-        self.col_num = Colors.out_number
+    def render(self, name, color=True, just=None, **kwargs):
+        """
+        Render the selected prompt.
+        
+        Parameters
+        ----------
+        name : str
+          Which prompt to render. One of 'in', 'in2', 'out', 'rewrite'
+        color : bool
+          If True (default), include ANSI escape sequences for a coloured prompt.
+        just : bool
+          If True, justify the prompt to the width of the last prompt. The
+          default is stored in self.justify.
+        **kwargs :
+          Additional arguments will be passed to the string formatting operation,
+          so they can override the values that would otherwise fill in the
+          template.
+        
+        Returns
+        -------
+        A string containing the rendered prompt.
+        """
+        if color:
+            scheme = self.color_scheme_table.active_colors
+            if name=='out':
+                colors = color_lists['normal']
+                colors.number, colors.prompt, colors.normal = \
+                        scheme.out_number, scheme.out_prompt, scheme.normal
+            elif name=='rewrite':
+                colors = color_lists['normal']
+                # We need a non-input version of these escapes
+                colors.number = scheme.in_number.replace("\001","").replace("\002","")
+                colors.prompt = scheme.in_prompt.replace("\001","").replace("\002","")
+                colors.normal = scheme.normal
+            else:
+                colors = color_lists['inp']
+                colors.number, colors.prompt, colors.normal = \
+                        scheme.in_number, scheme.in_prompt, scheme.in_normal
+                if name=='in2':
+                    colors.prompt = scheme.in_prompt2
+        else:
+            # No color
+            colors = color_lists['nocolor']
+            colors.number, colors.prompt, colors.normal = '', '', ''
+        
+        count = self.shell.execution_count    # Shorthand
+        # Build the dictionary to be passed to string formatting
+        fmtargs = dict(color=colors, count=count,
+                        dots="."*len(str(count)) )
+        fmtargs.update(self.lazy_evaluate_fields)
+        fmtargs.update(kwargs)
+        
+        # Prepare the prompt
+        prompt = colors.prompt + self.templates[name] + colors.normal
+        
+        # Fill in required fields
+        res = prompt.format(**fmtargs)
+        
+        # Handle justification of prompt
+        invis_chars = self.invisible_chars[name] if color else 0
+        just = self.justify if (just is None) else just
+        if just:
+            res = res.rjust(self.width + invis_chars)
+        self.width = len(res) - invis_chars
+        return res
 

IPython/core/tests/test_run.py

@@ -148,7 +148,7 class TestMagicRunPass(tt.TempFileMixin):
         """Test that prompts correctly generate after %run"""
         self.run_tmpfile()
         _ip = get_ipython()
-        p2 = str(_ip.displayhook.prompt2).strip()
+        p2 = _ip.prompt_manager.render('in2').strip()
         nt.assert_equals(p2[:3], '...')
         
     def test_run_profile( self ):

IPython/frontend/terminal/interactiveshell.py

@@ -356,7 +356,7 class TerminalInteractiveShell(InteractiveShell):
             self.hooks.pre_prompt_hook()
             if more:
                 try:
-                    prompt = self.hooks.generate_prompt(True)
+                    prompt = self.prompt_manager.render('in2')
                 except:
                     self.showtraceback()
                 if self.autoindent:
@@ -364,7 +364,7 class TerminalInteractiveShell(InteractiveShell):
 
             else:
                 try:
-                    prompt = self.hooks.generate_prompt(False)
+                    prompt = self.separate_in + self.prompt_manager.render('in')
                 except:
                     self.showtraceback()
             try:

IPython/utils/coloransi.py

@@ -15,11 +15,6 import os
 
 from IPython.utils.ipstruct import Struct
 
-def make_color_table(in_class):
-    """Build a set of color attributes in a class.
-
-    Helper function for building the *TermColors classes."""
-
     color_templates = (
         # Dark colors
         ("Black"       , "0;30"),
@@ -50,6 +45,11 def make_color_table(in_class):
         ("BlinkLightGray", "5;37"),
         )
 
+def make_color_table(in_class):
+    """Build a set of color attributes in a class.
+
+    Helper function for building the *TermColors classes."""
+
     for name,value in color_templates:
         setattr(in_class,name,in_class._base % value)
 
@@ -98,6 +98,14 class InputTermColors:
 # Build the actual color table as a set of class attributes:
 make_color_table(InputTermColors)
 
+class NoColors:
+    """This defines all the same names as the colour classes, but maps them to
+    empty strings, so it can easily be substituted to turn off colours."""
+    NoColor = ''
+
+for name, value in color_templates:
+    setattr(NoColors, name, '')
+
 class ColorScheme:
     """Generic color scheme class. Just a name and a Struct."""
     def __init__(self,__scheme_name_,colordict=None,**colormap):

IPython/utils/tests/test_text.py

@@ -76,13 +76,15 def eval_formatter_slicing_check(f):
     
     nt.assert_raises(SyntaxError, f.format, "{n:x}", **ns)
     
-
 def eval_formatter_no_slicing_check(f):
     ns = dict(n=12, pi=math.pi, stuff='hello there', os=os)
     
     s = f.format('{n:x} {pi**2:+f}', **ns)
     nt.assert_equals(s, "c +9.869604")
     
+    s = f.format('{stuff[slice(1,4)]}', **ns)
+    nt.assert_equals(s, 'ell')
+    
     nt.assert_raises(SyntaxError, f.format, "{a[:]}")
 
 def test_eval_formatter():

IPython/zmq/zmqshell.py

@@ -133,7 +133,7 class ZMQInteractiveShell(InteractiveShell):
         FIXME: this payload is currently not correctly processed by the
         frontend.
         """
-        new = self.displayhook.prompt1.auto_rewrite() + cmd
+        new = self.prompt_manager.render('rewrite') + cmd
         payload = dict(
             source='IPython.zmq.zmqshell.ZMQInteractiveShell.auto_rewrite_input',
             transformed_input=new,

docs/source/config/ipython.txt

@@ -124,12 +124,13 attributes::
     c.InteractiveShell.confirm_exit = False
     c.InteractiveShell.deep_reload = True
     c.InteractiveShell.editor = 'nano'
-    c.InteractiveShell.prompt_in1 = 'In [\#]: '
-    c.InteractiveShell.prompt_in2 = '   .\D.: '
-    c.InteractiveShell.prompt_out = 'Out[\#]: '
-    c.InteractiveShell.prompts_pad_left = True
     c.InteractiveShell.xmode = 'Context'
 
+    c.PromptManager.in_template  = 'In [\#]: '
+    c.PromptManager.in2_template = '   .\D.: '
+    c.PromptManager.out_template = 'Out[\#]: '
+    c.PromptManager.justify = True
+
     c.PrefilterManager.multi_line_specials = True
 
     c.AliasManager.user_aliases = [

docs/source/whatsnew/development.txt

@@ -117,6 +117,15 Backwards incompatible changes
   traits, rather than several ip/port pair ``_addr`` traits. This better matches the
   rest of the code, where the ip cannot not be set separately for each channel.
 
+* Custom prompts are now configured using a new class,
+  :class:`~IPython.core.prompts.PromptManager`, which has traits for :attr:`in_template`,
+  :attr:`in2_template` (the ``...:`` continuation prompt), :attr:`out_template`
+  and :attr:`rewrite_template`. This uses Python's string formatting system, so
+  you can use ``{time}`` and ``{cwd}``, although we have preserved the abbreviations
+  from previous versions, e.g. ``\#`` (prompt number) and ``\w`` (working 
+  directory). For the list of available fields, refer to the source of
+  :file:`IPython/core/prompts.py`.
+
 * The class inheritance of the Launchers in :mod:`IPython.parallel.apps.launcher`
   used by ipcluster has changed, so that trait names are more consistent across
   batch systems. This may require a few renames in your config files, if you