Deal with ansi escape codes when nbconverting to latex

Correctly deals with "reset" codes and short codes.  Interprets blinking
style as bold.

IPython/nbconvert/filters/ansi.py

@@ -1,158 +1,177 b''
 """Filters for processing ANSI colors within Jinja templates.
 """
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import re
 from IPython.utils import coloransi
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 __all__ = [
     'strip_ansi',
     'ansi2html',
     'single_ansi2latex',
     'ansi2latex'
 ]
 
 def strip_ansi(source):
     """
     Remove ansi from text
     
     Parameters
     ----------
     source : str
         Source to remove the ansi from
     """
     
     return re.sub(r'\033\[(\d|;)+?m', '', source)
 
 
 def ansi2html(text):
     """
     Conver ansi colors to html colors.
     
     Parameters
     ----------
     text : str
         Text containing ansi colors to convert to html
     """
     
     ansi_colormap = {
         '30': 'ansiblack',
         '31': 'ansired',
         '32': 'ansigreen',
         '33': 'ansiyellow',
         '34': 'ansiblue',
         '35': 'ansipurple',
         '36': 'ansicyan',
         '37': 'ansigrey',
         '01': 'ansibold',
     }
 
     # do ampersand first
     text = text.replace('&', '&')
     html_escapes = {
         '<': '&lt;',
         '>': '&gt;',
         "'": '&apos;',
         '"': '&quot;',
         '`': '&#96;',
     }
     
     for c, escape in html_escapes.items():
         text = text.replace(c, escape)
 
     ansi_re = re.compile('\x1b' + r'\[([\dA-Fa-f;]*?)m')
     m = ansi_re.search(text)
     opened = False
     cmds = []
     opener = ''
     closer = ''
     while m:
         cmds = m.groups()[0].split(';')
         closer = '</span>' if opened else ''
         
         # True if there is there more than one element in cmds, *or*
         # if there is only one but it is not equal to a string of zeroes.
         opened = len(cmds) > 1 or cmds[0] != '0' * len(cmds[0])
         classes = []
         for cmd in cmds:
             if cmd in ansi_colormap:
                 classes.append(ansi_colormap.get(cmd))
 
         if classes:
             opener = '<span class="%s">' % (' '.join(classes))
         else:
             opener = ''
         text = re.sub(ansi_re, closer + opener, text, 1)
 
         m = ansi_re.search(text)
 
     if opened:
         text += '</span>'
     return text
 
 
 def single_ansi2latex(code):
-    """Converts single ansi markup to latex format
+    """Converts single ansi markup to latex format.
 
     Return latex code and number of open brackets.
+
+    Accepts codes like '\x1b[1;32m' (bold, red) and the short form '\x1b[32m' (red)
+
+    Colors are matched to those defined in coloransi, which defines colors
+    using the 0, 1 (bold) and 5 (blinking) styles. Styles 1 and 5 are
+    interpreted as bold. All other styles are mapped to 0. Note that in
+    coloransi, a style of 1 does not just mean bold; for example, Brown is
+    "0;33", but Yellow is "1;33". An empty string is returned for unrecognised
+    codes and the "reset" code '\x1b[m'.
     """
-    for color in coloransi.color_templates:
-
-        #Make sure to get the color code (which is a part of the overall style)
-        # i.e.  0;31 is valid
-        #       31 is also valid, and means the same thing
-        #coloransi.color_templates stores the longer of the two formats %d;%d
-        #Get the short format so we can parse that too.  Short format only exist
-        #if no other formating is applied (the other number must be a 0)!
-        style_code = getattr(coloransi.TermColors, color[0])
-        color_code = style_code.split(';')[1]
-        is_normal = style_code.split(';')[0] == '0'
-
-        # regular weight
-        if (code == style_code) or (is_normal and code == color_code):
-            
-            return r'{\color{'+color[0].lower()+'}', 1
-        # bold
-        if code == style_code[:3]+str(1)+style_code[3:]:
-            return r'\textbf{\color{'+color[0].lower()+'}', 1
-    return '', 0
+    components = code.split(';')
+    if len(components) > 1:
+        style = components[0][-1]
+        color = components[1][:-1]
+    else:
+        style = '0'
+        color = components[0][-3:-1]
+        
+    # If the style is not normal (0), bold (1) or blinking (5) then treat it as normal
+    if style not in '015':
+        style = '0'
+
+    for name, tcode in coloransi.color_templates:
+        tstyle, tcolor = tcode.split(';')
+        if tstyle == style and tcolor == color:
+            break
+    else:
+        return '', 0
+
+    if style == '5':
+        name = name[5:]                             # BlinkRed -> Red, etc
+    name = name.lower()
+
+    if style in '15':
+        return r'\textbf{\color{'+name+'}', 1
+    else:
+        return r'{\color{'+name+'}', 1
 
 def ansi2latex(text):
     """Converts ansi formated text to latex version
 
     based on https://bitbucket.org/birkenfeld/sphinx-contrib/ansi.py
     """
-    color_pattern = re.compile('\x1b\\[([^m]+)m')
+    color_pattern = re.compile('\x1b\\[([^m]*)m')
     last_end = 0
     openbrack = 0
     outstring = ''
     for match in color_pattern.finditer(text):
         head = text[last_end:match.start()]
         outstring += head
         if openbrack:
             outstring += '}'*openbrack
             openbrack = 0
-        if not (match.group() == coloransi.TermColors.Normal or openbrack):
-            texform, openbrack = single_ansi2latex(match.group())
+        code = match.group()
+        if not (code == coloransi.TermColors.Normal or openbrack):
+            texform, openbrack = single_ansi2latex(code)
             outstring += texform
         last_end = match.end()
     
     # Add the remainer of the string and THEN close any remaining color brackets.
     outstring += text[last_end:]
     if openbrack: 
         outstring += '}'*openbrack
     return outstring.strip()
+
+

IPython/nbconvert/filters/tests/test_ansi.py

@@ -1,84 +1,87 b''
 """
 Module with tests for ansi filters
 """
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from IPython.utils.coloransi import TermColors
 
 from ...tests.base import TestsBase
 from ..ansi import strip_ansi, ansi2html, ansi2latex
 
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestAnsi(TestsBase):
     """Contains test functions for ansi.py"""
 
     def test_strip_ansi(self):
         """strip_ansi test"""
         correct_outputs = {
             '%s%s%s' % (TermColors.Green, TermColors.White, TermColors.Red)  : '',
             'hello%s' % TermColors.Blue: 'hello',
             'he%s%sllo' % (TermColors.Yellow, TermColors.Cyan) : 'hello',
             '%shello' % TermColors.Blue : 'hello',
             '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.Red) : 'hello',
             'hel%slo' % TermColors.Green : 'hello',
             'hello' : 'hello'}
 
         for inval, outval in correct_outputs.items():
             self._try_strip_ansi(inval, outval)
 
 
     def _try_strip_ansi(self, inval, outval):
         self.assertEqual(outval, strip_ansi(inval))
 
 
     def test_ansi2html(self):
         """ansi2html test"""
         correct_outputs = {
             '%s' % (TermColors.Red)  : '<span class="ansired"></span>',
             'hello%s' % TermColors.Blue: 'hello<span class="ansiblue"></span>',
             'he%s%sllo' % (TermColors.Green, TermColors.Cyan) : 'he<span class="ansigreen"></span><span class="ansicyan">llo</span>',
             '%shello' % TermColors.Yellow : '<span class="ansiyellow">hello</span>',
             '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.White) : '<span class="ansigrey">h</span><span class="ansigrey">e</span><span class="ansigrey">l</span><span class="ansigrey">l</span><span class="ansigrey">o</span><span class="ansigrey"></span>',
             'hel%slo' % TermColors.Green : 'hel<span class="ansigreen">lo</span>',
             'hello' : 'hello'}
 
         for inval, outval in correct_outputs.items():
             self._try_ansi2html(inval, outval)
 
 
     def _try_ansi2html(self, inval, outval):
         self.fuzzy_compare(outval, ansi2html(inval))
 
 
     def test_ansi2latex(self):
         """ansi2latex test"""
         correct_outputs = {
             '%s' % (TermColors.Red)  : r'{\color{red}}',
             'hello%s' % TermColors.Blue: r'hello{\color{blue}}',
             'he%s%sllo' % (TermColors.Green, TermColors.Cyan) : r'he{\color{green}}{\color{cyan}llo}',
-            '%shello' % TermColors.Yellow : r'{\color{yellow}hello}',
-            '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.White) : r'{\color{white}h}{\color{white}e}{\color{white}l}{\color{white}l}{\color{white}o}{\color{white}}',
+            '%shello' % TermColors.Yellow : r'\textbf{\color{yellow}hello}',
+            '{0}h{0}e{0}l{0}l{0}o{0}'.format(TermColors.White) : r'\textbf{\color{white}h}\textbf{\color{white}e}\textbf{\color{white}l}\textbf{\color{white}l}\textbf{\color{white}o}\textbf{\color{white}}',
             'hel%slo' % TermColors.Green : r'hel{\color{green}lo}',
-            'hello' : 'hello'}
+            'hello' : 'hello',
+            u'hello\x1b[34mthere\x1b[mworld' : u'hello{\\color{blue}there}world',
+            u'hello\x1b[mthere': u'hellothere'
+            }
 
         for inval, outval in correct_outputs.items():
             self._try_ansi2latex(inval, outval)
 
 
     def _try_ansi2latex(self, inval, outval):
         self.fuzzy_compare(outval, ansi2latex(inval), case_sensitive=True)