The IPythonWidget now tries to be smart about choosing colors to use for ANSI color codes.

IPython/frontend/qt/console/ansi_code_processor.py

@@ -1,177 +1,203 b''
 # Standard library imports
 import re
 
 # System library imports
 from PyQt4 import QtCore, QtGui
 
 
 class AnsiAction(object):
     """ Represents an action requested by an ANSI escape sequence.
     """
     def __init__(self, kind):
         self.kind = kind
 
 class MoveAction(AnsiAction):
     """ An AnsiAction for cursor move requests (CUU, CUD, CUF, CUB, CNL, CPL, 
         CHA, and CUP commands).
     """
     def __init__(self):
         raise NotImplementedError
 
 class EraseAction(AnsiAction):
     """ An AnsiAction for erase requests (ED and EL commands).
     """
     def __init__(self, area, erase_to):
         super(EraseAction, self).__init__('erase')
         self.area = area
         self.erase_to = erase_to
 
 
 class AnsiCodeProcessor(object):
     """ Translates ANSI escape codes into readable attributes.
     """
 
+    # Whether to increase intensity or set boldness for SGR code 1.
+    # (Different terminals handle this in different ways.)
+    bold_text_enabled = False    
+
     # Protected class variables.
     _ansi_commands = 'ABCDEFGHJKSTfmnsu'
     _ansi_pattern = re.compile('\x01?\x1b\[(.*?)([%s])\x02?' % _ansi_commands)
 
     def __init__(self):
         self.actions = []
         self.reset_sgr()
 
     def reset_sgr(self):
         """ Reset graphics attributs to their default values.
         """
         self.intensity = 0
         self.italic = False
         self.bold = False
         self.underline = False
         self.foreground_color = None
         self.background_color = None
 
     def split_string(self, string):
         """ Yields substrings for which the same escape code applies.
         """
         self.actions = []
         start = 0
 
         for match in self._ansi_pattern.finditer(string):
             substring = string[start:match.start()]
             if substring or self.actions:
                 yield substring
             start = match.end()
 
             self.actions = []
             try:
                 params = []
                 for param in match.group(1).split(';'):
                     if param:
                         params.append(int(param))
             except ValueError:
                 # Silently discard badly formed escape codes.
                 pass
             else:
                 self.set_csi_code(match.group(2), params)
 
         substring = string[start:]
         if substring or self.actions:
             yield substring
 
     def set_csi_code(self, command, params=[]):
         """ Set attributes based on CSI (Control Sequence Introducer) code.
 
         Parameters
         ----------
         command : str
             The code identifier, i.e. the final character in the sequence.
         
         params : sequence of integers, optional
             The parameter codes for the command.
         """
         if command == 'm':   # SGR - Select Graphic Rendition
             for code in params:
                 self.set_sgr_code(code)
 
         elif (command == 'J' or # ED - Erase Data
               command == 'K'):  # EL - Erase in Line
             code = params[0] if params else 0
             if 0 <= code <= 2:
                 area = 'screen' if command == 'J' else 'line'
                 if code == 0:
                     erase_to = 'end'
                 elif code == 1:
                     erase_to = 'start'
                 elif code == 2:
                     erase_to = 'all'
                 self.actions.append(EraseAction(area, erase_to))
         
     def set_sgr_code(self, code):
         """ Set attributes based on SGR (Select Graphic Rendition) code.
         """
         if code == 0:
             self.reset_sgr()
         elif code == 1:
-            self.intensity = 1
+            if self.bold_text_enabled:
             self.bold = True
+            else:
+                self.intensity = 1
         elif code == 2:
             self.intensity = 0
         elif code == 3:
             self.italic = True
         elif code == 4:
             self.underline = True
         elif code == 22:
             self.intensity = 0
             self.bold = False
         elif code == 23:
             self.italic = False
         elif code == 24:
             self.underline = False
         elif code >= 30 and code <= 37:
             self.foreground_color = code - 30
         elif code == 39:
             self.foreground_color = None
         elif code >= 40 and code <= 47:
             self.background_color = code - 40
         elif code == 49:
             self.background_color = None
         
 
 class QtAnsiCodeProcessor(AnsiCodeProcessor):
     """ Translates ANSI escape codes into QTextCharFormats.
     """
 
     # A map from color codes to RGB colors.
-    ansi_colors = (# Normal,      Bright/Light    ANSI color code
+    default_map = (# Normal,      Bright/Light    ANSI color code
                    ('black',      'grey'),        # 0: black
                    ('darkred',    'red'),         # 1: red
-                   ('darkgreen',  'green'),       # 2: green
-                   ('gold',       'yellow'),      # 3: yellow
-                   ('darkblue',   'blue'),        # 4: blue
+                   ('darkgreen',  'lime'),        # 2: green
+                   ('brown',      'yellow'),      # 3: yellow
+                   ('darkblue',   'deepskyblue'), # 4: blue
                    ('darkviolet', 'magenta'),     # 5: magenta
                    ('steelblue',  'cyan'),        # 6: cyan
                    ('grey',       'white'))       # 7: white
     
+    def __init__(self):
+        super(QtAnsiCodeProcessor, self).__init__()
+        self.color_map = self.default_map
+    
     def get_format(self):
         """ Returns a QTextCharFormat that encodes the current style attributes.
         """
         format = QtGui.QTextCharFormat()
 
         # Set foreground color
         if self.foreground_color is not None:
-            color = self.ansi_colors[self.foreground_color][self.intensity]
+            color = self.color_map[self.foreground_color][self.intensity]
             format.setForeground(QtGui.QColor(color))
 
         # Set background color
         if self.background_color is not None:
-            color = self.ansi_colors[self.background_color][self.intensity]
+            color = self.color_map[self.background_color][self.intensity]
             format.setBackground(QtGui.QColor(color))
 
         # Set font weight/style options
         if self.bold:
             format.setFontWeight(QtGui.QFont.Bold)
         else:
             format.setFontWeight(QtGui.QFont.Normal)
         format.setFontItalic(self.italic)
         format.setFontUnderline(self.underline)
 
         return format
+
+    def set_background_color(self, color):
+        """ Given a background color (a QColor), attempt to set a color map
+            that will be aesthetically pleasing.
+        """
+        if color.value() < 127:
+            # Colors appropriate for a terminal with a dark background.
+            self.color_map = self.default_map
+
+        else:
+            # Colors appropriate for a terminal with a light background. For 
+            # now, only use non-bright colors...
+            self.color_map = [ (pair[0], pair[0]) for pair in self.default_map ]
+
+            # ...and replace white with black.
+            self.color_map[7] = ('black', 'black')

IPython/frontend/qt/console/ipython_widget.py

@@ -1,372 +1,375 b''
 """ A FrontendWidget that emulates the interface of the console IPython and
     supports the additional functionality provided by the IPython kernel.
 
     TODO: Add support for retrieving the system default editor. Requires code
           paths for Windows (use the registry), Mac OS (use LaunchServices), and
           Linux (use the xdg system).
 """
 
 # Standard library imports
 from subprocess import Popen
 
 # System library imports
 from PyQt4 import QtCore, QtGui
 
 # Local imports
 from IPython.core.inputsplitter import IPythonInputSplitter
 from IPython.core.usage import default_banner
 from frontend_widget import FrontendWidget
 
 
 class IPythonPromptBlock(object):
     """ An internal storage object for IPythonWidget.
     """
     def __init__(self, block, length, number):
         self.block = block
         self.length = length
         self.number = number
 
 
 class IPythonWidget(FrontendWidget):
     """ A FrontendWidget for an IPython kernel.
     """
 
     # Signal emitted when an editor is needed for a file and the editor has been
     # specified as 'custom'. See 'set_editor' for more information.
     custom_edit_requested = QtCore.pyqtSignal(object, object)
 
     # The default stylesheet: black text on a white background.
     default_stylesheet = """
         .error { color: red; }
         .in-prompt { color: navy; }
         .in-prompt-number { font-weight: bold; }
         .out-prompt { color: darkred; }
         .out-prompt-number { font-weight: bold; }
     """
 
     # A dark stylesheet: white text on a black background.
     dark_stylesheet = """
         QPlainTextEdit, QTextEdit { background-color: black; color: white }
         QFrame { border: 1px solid grey; }
         .error { color: red; }
         .in-prompt { color: lime; }
         .in-prompt-number { color: lime; font-weight: bold; }
         .out-prompt { color: red; }
         .out-prompt-number { color: red; font-weight: bold; }
     """
 
     # Default prompts.
     in_prompt = 'In [<span class="in-prompt-number">%i</span>]: '
     out_prompt = 'Out[<span class="out-prompt-number">%i</span>]: '
 
     # FrontendWidget protected class variables.
     _input_splitter_class = IPythonInputSplitter
 
     # IPythonWidget protected class variables.
     _payload_source_edit = 'IPython.zmq.zmqshell.ZMQInteractiveShell.edit_magic'
     _payload_source_page = 'IPython.zmq.page.page'
 
     #---------------------------------------------------------------------------
     # 'object' interface
     #---------------------------------------------------------------------------
     
     def __init__(self, *args, **kw):
         super(IPythonWidget, self).__init__(*args, **kw)
 
         # IPythonWidget protected variables.
         self._previous_prompt_obj = None
 
         # Set a default editor and stylesheet.
         self.set_editor('default')
         self.reset_styling()
 
     #---------------------------------------------------------------------------
     # 'BaseFrontendMixin' abstract interface
     #---------------------------------------------------------------------------
 
     def _handle_complete_reply(self, rep):
         """ Reimplemented to support IPython's improved completion machinery.
         """
         cursor = self._get_cursor()
         if rep['parent_header']['msg_id'] == self._complete_id and \
                 cursor.position() == self._complete_pos:
             # The completer tells us what text was actually used for the
             # matching, so we must move that many characters left to apply the
             # completions.
             text = rep['content']['matched_text']
             cursor.movePosition(QtGui.QTextCursor.Left, n=len(text))
             self._complete_with_items(cursor, rep['content']['matches'])
 
     def _handle_history_reply(self, msg):
         """ Implemented to handle history replies, which are only supported by
             the IPython kernel.
         """
         history_dict = msg['content']['history']
         items = [ history_dict[key] for key in sorted(history_dict.keys()) ]
         self._set_history(items)
 
     def _handle_prompt_reply(self, msg):
         """ Implemented to handle prompt number replies, which are only
             supported by the IPython kernel.
         """
         content = msg['content']
         self._show_interpreter_prompt(content['prompt_number'], 
                                       content['input_sep'])
 
     def _handle_pyout(self, msg):
         """ Reimplemented for IPython-style "display hook".
         """
         if not self._hidden and self._is_from_this_session(msg):
             content = msg['content']
             prompt_number = content['prompt_number']
             self._append_plain_text(content['output_sep'])
             self._append_html(self._make_out_prompt(prompt_number))
             self._append_plain_text(content['data'] + '\n' + 
                                     content['output_sep2'])
 
     def _started_channels(self):
         """ Reimplemented to make a history request.
         """
         super(IPythonWidget, self)._started_channels()
         # FIXME: Disabled until history requests are properly implemented.
         #self.kernel_manager.xreq_channel.history(raw=True, output=False)
 
     #---------------------------------------------------------------------------
     # 'FrontendWidget' interface
     #---------------------------------------------------------------------------
 
     def execute_file(self, path, hidden=False):
         """ Reimplemented to use the 'run' magic.
         """
         self.execute('%%run %s' % path, hidden=hidden)
 
     #---------------------------------------------------------------------------
     # 'FrontendWidget' protected interface
     #---------------------------------------------------------------------------
 
     def _complete(self):
         """ Reimplemented to support IPython's improved completion machinery.
         """
         # We let the kernel split the input line, so we *always* send an empty
         # text field. Readline-based frontends do get a real text field which
         # they can use.
         text = ''
         
         # Send the completion request to the kernel
         self._complete_id = self.kernel_manager.xreq_channel.complete(
             text,                                    # text
             self._get_input_buffer_cursor_line(),    # line
             self._get_input_buffer_cursor_column(),  # cursor_pos
             self.input_buffer)                       # block 
         self._complete_pos = self._get_cursor().position()
 
     def _get_banner(self):
         """ Reimplemented to return IPython's default banner.
         """
         return default_banner + '\n'
 
     def _process_execute_error(self, msg):
         """ Reimplemented for IPython-style traceback formatting.
         """
         content = msg['content']
         traceback = '\n'.join(content['traceback']) + '\n'
         if False:
             # FIXME: For now, tracebacks come as plain text, so we can't use
             # the html renderer yet.  Once we refactor ultratb to produce
             # properly styled tracebacks, this branch should be the default
             traceback = traceback.replace(' ', '&nbsp;')
             traceback = traceback.replace('\n', '<br/>')
 
             ename = content['ename']
             ename_styled = '<span class="error">%s</span>' % ename
             traceback = traceback.replace(ename, ename_styled)
 
             self._append_html(traceback)
         else:
             # This is the fallback for now, using plain text with ansi escapes
             self._append_plain_text(traceback)
 
     def _process_execute_payload(self, item):
         """ Reimplemented to handle %edit and paging payloads.
         """
         if item['source'] == self._payload_source_edit:
             self._edit(item['filename'], item['line_number'])
             return True
         elif item['source'] == self._payload_source_page:
             self._page(item['data'])
             return True
         else:
             return False
 
     def _show_interpreter_prompt(self, number=None, input_sep='\n'):
         """ Reimplemented for IPython-style prompts.
         """
         # If a number was not specified, make a prompt number request.
         if number is None:
             self.kernel_manager.xreq_channel.prompt()
             return
 
         # Show a new prompt and save information about it so that it can be
         # updated later if the prompt number turns out to be wrong.
         self._prompt_sep = input_sep
         self._show_prompt(self._make_in_prompt(number), html=True)
         block = self._control.document().lastBlock()
         length = len(self._prompt)
         self._previous_prompt_obj = IPythonPromptBlock(block, length, number)
 
         # Update continuation prompt to reflect (possibly) new prompt length.
         self._set_continuation_prompt(
             self._make_continuation_prompt(self._prompt), html=True)
 
     def _show_interpreter_prompt_for_reply(self, msg):
         """ Reimplemented for IPython-style prompts.
         """
         # Update the old prompt number if necessary.
         content = msg['content']
         previous_prompt_number = content['prompt_number']
         if self._previous_prompt_obj and \
                 self._previous_prompt_obj.number != previous_prompt_number:
             block = self._previous_prompt_obj.block
 
             # Make sure the prompt block has not been erased.
             if block.isValid() and not block.text().isEmpty():
 
                 # Remove the old prompt and insert a new prompt.
                 cursor = QtGui.QTextCursor(block)
                 cursor.movePosition(QtGui.QTextCursor.Right,
                                     QtGui.QTextCursor.KeepAnchor, 
                                     self._previous_prompt_obj.length)
                 prompt = self._make_in_prompt(previous_prompt_number)
                 self._prompt = self._insert_html_fetching_plain_text(
                     cursor, prompt)
 
                 # When the HTML is inserted, Qt blows away the syntax
                 # highlighting for the line, so we need to rehighlight it.
                 self._highlighter.rehighlightBlock(cursor.block())
 
             self._previous_prompt_obj = None
 
         # Show a new prompt with the kernel's estimated prompt number.
         next_prompt = content['next_prompt']
         self._show_interpreter_prompt(next_prompt['prompt_number'], 
                                       next_prompt['input_sep'])
 
     #---------------------------------------------------------------------------
     # 'IPythonWidget' interface
     #---------------------------------------------------------------------------
 
     def reset_styling(self):
         """ Restores the default IPythonWidget styling.
         """
         self.set_styling(self.default_stylesheet, syntax_style='default')
         #self.set_styling(self.dark_stylesheet, syntax_style='monokai')
 
     def set_editor(self, editor, line_editor=None):
         """ Sets the editor to use with the %edit magic.
 
         Parameters:
         -----------
         editor : str
             A command for invoking a system text editor. If the string contains
             a {filename} format specifier, it will be used. Otherwise, the 
             filename will be appended to the end the command.
 
             This parameter also takes a special value:
                 'custom'  : Emit a 'custom_edit_requested(str, int)' signal 
                             instead of opening an editor.
 
         line_editor : str, optional
             The editor command to use when a specific line number is
             requested. The string should contain two format specifiers: {line}
             and {filename}. If this parameter is not specified, the line number
             option to the %edit magic will be ignored.
         """
         self._editor = editor
         self._editor_line = line_editor
 
     def set_styling(self, stylesheet, syntax_style=None):
         """ Sets the IPythonWidget styling.
 
         Parameters:
         -----------
         stylesheet : str
             A CSS stylesheet. The stylesheet can contain classes for:
                 1. Qt: QPlainTextEdit, QFrame, QWidget, etc
                 2. Pygments: .c, .k, .o, etc (see PygmentsHighlighter)
                 3. IPython: .error, .in-prompt, .out-prompt, etc.
 
         syntax_style : str or None [default None]
             If specified, use the Pygments style with given name. Otherwise, 
             the stylesheet is queried for Pygments style information.
         """
         self.setStyleSheet(stylesheet)
         self._control.document().setDefaultStyleSheet(stylesheet)
         if self._page_control:
             self._page_control.document().setDefaultStyleSheet(stylesheet)
 
         if syntax_style is None:
             self._highlighter.set_style_sheet(stylesheet)
         else:
             self._highlighter.set_style(syntax_style)
 
+        bg_color = self._control.palette().background().color()
+        self._ansi_processor.set_background_color(bg_color)
+
     #---------------------------------------------------------------------------
     # 'IPythonWidget' protected interface
     #---------------------------------------------------------------------------
 
     def _edit(self, filename, line=None):
         """ Opens a Python script for editing.
 
         Parameters:
         -----------
         filename : str
             A path to a local system file.
 
         line : int, optional
             A line of interest in the file.
         """
         if self._editor == 'custom':
             self.custom_edit_requested.emit(filename, line)
         elif self._editor == 'default':
             self._append_plain_text('No default editor available.\n')
         else:
             try:
                 filename = '"%s"' % filename
                 if line and self._editor_line:
                     command = self._editor_line.format(filename=filename,
                                                        line=line)
                 else:
                     try:
                         command = self._editor.format()
                     except KeyError:
                         command = self._editor.format(filename=filename)
                     else:
                         command += ' ' + filename
             except KeyError:
                 self._append_plain_text('Invalid editor command.\n')
             else:
                 try:
                     Popen(command, shell=True)
                 except OSError:
                     msg = 'Opening editor with command "%s" failed.\n'
                     self._append_plain_text(msg % command)
 
     def _make_in_prompt(self, number):
         """ Given a prompt number, returns an HTML In prompt.
         """
         body = self.in_prompt % number
         return '<span class="in-prompt">%s</span>' % body
 
     def _make_continuation_prompt(self, prompt):
         """ Given a plain text version of an In prompt, returns an HTML
             continuation prompt.
         """
         end_chars = '...: '
         space_count = len(prompt.lstrip('\n')) - len(end_chars)
         body = '&nbsp;' * space_count + end_chars
         return '<span class="in-prompt">%s</span>' % body
         
     def _make_out_prompt(self, number):
         """ Given a prompt number, returns an HTML Out prompt.
         """
         body = self.out_prompt % number
         return '<span class="out-prompt">%s</span>' % body

IPython/frontend/qt/console/scripts/ipythonqt.py

@@ -1,92 +1,88 b''
 #!/usr/bin/env python
 
 """ A minimal application using the Qt console-style IPython frontend.
 """
 
 # Systemm library imports
 from PyQt4 import QtCore, QtGui
 
 # Local imports
 from IPython.external.argparse import ArgumentParser
 from IPython.frontend.qt.console.frontend_widget import FrontendWidget
 from IPython.frontend.qt.console.ipython_widget import IPythonWidget
 from IPython.frontend.qt.console.rich_ipython_widget import RichIPythonWidget
 from IPython.frontend.qt.kernelmanager import QtKernelManager
 
 # Constants
 LOCALHOST = '127.0.0.1'
 
 
 def main():
     """ Entry point for application.
     """
     # Parse command line arguments.
     parser = ArgumentParser()
     parser.add_argument('-r', '--rich', action='store_true',
                         help='use a rich text frontend')
     parser.add_argument('-t', '--tab-simple', action='store_true',
                         help='do tab completion ala a Unix terminal')
 
     parser.add_argument('--existing', action='store_true',
                         help='connect to an existing kernel')
     parser.add_argument('--ip', type=str, default=LOCALHOST,
                         help='set the kernel\'s IP address [default localhost]')
     parser.add_argument('--xreq', type=int, metavar='PORT', default=0,
                         help='set the XREQ channel port [default random]')
     parser.add_argument('--sub', type=int, metavar='PORT', default=0,
                         help='set the SUB channel port [default random]')
     parser.add_argument('--rep', type=int, metavar='PORT', default=0,
                         help='set the REP channel port [default random]')
 
     group = parser.add_mutually_exclusive_group()
     group.add_argument('--pure', action='store_true', help = \
                        'use a pure Python kernel instead of an IPython kernel')
     group.add_argument('--pylab', action='store_true',
                         help='use a kernel with PyLab enabled')
     
     args = parser.parse_args()
     
     # Don't let Qt or ZMQ swallow KeyboardInterupts.
     import signal
     signal.signal(signal.SIGINT, signal.SIG_DFL)
 
     # Create a KernelManager and start a kernel.
     kernel_manager = QtKernelManager(xreq_address=(args.ip, args.xreq),
                                      sub_address=(args.ip, args.sub),
                                      rep_address=(args.ip, args.rep))
     if args.ip == LOCALHOST and not args.existing:
         if args.pure:
             kernel_manager.start_kernel(ipython=False)
         elif args.pylab:
             if args.rich:
                 kernel_manager.start_kernel(pylab='payload-svg')
             else:
                 kernel_manager.start_kernel(pylab='qt4')
         else:
             kernel_manager.start_kernel()
     kernel_manager.start_channels()
 
     # Create the widget.
     app = QtGui.QApplication([])
     if args.pure:
         kind = 'rich' if args.rich else 'plain'
         widget = FrontendWidget(kind=kind)
     elif args.rich:
         widget = RichIPythonWidget()
     else:
         widget = IPythonWidget()
     widget.gui_completion = not args.tab_simple
     widget.kernel_manager = kernel_manager
     widget.setWindowTitle('Python' if args.pure else 'IPython')
     widget.show()
 
-    # FIXME: This is a hack: set colors to lightbg by default in qt terminal
-    # unconditionally, regardless of user settings in config files.
-    widget.execute("%colors lightbg", hidden=True)
-
     # Start the application main loop.
     app.exec_()
 
 
 if __name__ == '__main__':
     main()