cleanup ansi and colourise arguments

Author: samuelcolvin

.gitignore

@@ -13,3 +13,4 @@ htmlcov/
 benchmarks/*.json
 docs/_build/
 old-version/
+*.swp

devtools/ansi.py

@@ -22,30 +22,28 @@ def strip_ansi(value):
 
 
 class Style(IntEnum):
-    """
-    Heavily borrowed from https://github.com/pallets/click/blob/6.7/click/termui.py
-
-    Italic added, multiple ansi codes condensed into one block and generally modernised.
-    """
     reset = 0
 
     bold = 1
-    un_bold = 22
+    not_bold = 22
 
     dim = 2
-    un_dim = 22
+    not_dim = 22
 
     italic = 3
-    un_italic = 23
+    not_italic = 23
 
     underline = 4
-    un_underline = 24
+    not_underline = 24
 
     blink = 5
-    un_blink = 25
+    not_blink = 25
 
     reverse = 7
-    un_reverse = 27
+    not_reverse = 27
+
+    strike_through = 9
+    not_strike_through = 29
 
     # foreground colours
     black = 30
@@ -56,7 +54,6 @@ class Style(IntEnum):
     magenta = 35
     cyan = 36
     white = 37
-    fg_reset = 38
 
     # background colours
     bg_black = 40
@@ -67,55 +64,45 @@ class Style(IntEnum):
     bg_magenta = 45
     bg_cyan = 46
     bg_white = 47
-    bg_reset = 48
 
     # this is a meta value used for the "Style" instance which is the "style" function
     function = -1
 
-    def __call__(self, text: Any, *styles, reset: bool=True):
+    def __call__(self, input: Any, *styles, reset: bool=True, apply: bool=True):
         """
-        Styles a text with ANSI styles and returns the new string.
+        Styles text with ANSI styles and returns the new string.
 
         By default the styling is cleared at the end of the string, this can be prevented with``reset=False``.
 
         Examples::
 
-            print(style('Hello World!', style.green))
-            print(style('ATTENTION!', style.bg_magenta))
-            print(style('Some things', style.reverse, style.bold))
+            print(sformat('Hello World!', sformat.green))
+            print(sformat('ATTENTION!', sformat.bg_magenta))
+            print(sformat('Some things', sformat.reverse, sformat.bold))
 
-        Supported color names:
-
-        * ``black`` (might be a gray)
-        * ``red``
-        * ``green``
-        * ``yellow`` (might be an orange)
-        * ``blue``
-        * ``magenta``
-        * ``cyan``
-        * ``white`` (might be light gray)
-        * ``reset`` (reset the color code only)
-
-        :param text: the string to style with ansi codes.
+        :param input: the object to style with ansi codes.
         :param *styles: zero or more styles to apply to the text, should be either style instances or strings
                         matching style names.
-        :param reset: by default a reset-all code is added at the end of the
-                      string which means that styles do not carry over.  This
-                      can be disabled to compose styles.
+        :param reset: if False the ansi reset code is not appended to the end of the string
+        :param: apply: if False no ansi codes are applied
         """
+        text = str(input)
+        if not apply:
+            return text
         codes = []
         for s in styles:
-            if not isinstance(s, self.__class__):
+            # raw ints are allowed
+            if not isinstance(s, self.__class__) and not isinstance(s, int):
                 try:
                     s = self.styles[s]
                 except KeyError:
                     raise ValueError('invalid style "{}"'.format(s))
             codes.append(str(s.value))
 
         if codes:
-            r = _ansi_template.format(';'.join(codes)) + str(text)
+            r = _ansi_template.format(';'.join(codes)) + text
         else:
-            r = str(text)
+            r = text
 
         if reset:
             r += _ansi_template.format(self.reset)
@@ -127,7 +114,7 @@ def styles(self):
 
     def __repr__(self):
         if self == self.function:
-            return '<pseudo function style(text, *styles)>'
+            return '<pseudo function sformat(text, *styles)>'
         else:
             return super().__repr__()
 
@@ -141,7 +128,20 @@ def __str__(self):
 sformat = Style(-1)
 
 
-def sprint(text, *styles, reset=True, flush=True, file=None, **print_kwargs):
-    if isatty(file):
-        text = sformat(text, *styles, reset=reset)
-    print(text, flush=flush, file=file, **print_kwargs)
+class StylePrint:
+    """
+    Annoyingly enums do not allow inheritance, this is a lazy design mistake, this is an ugly work around
+    for that mistake.
+    """
+    def __call__(self, input, *styles, reset=True, flush=True, file=None, **print_kwargs):
+        text = sformat(input, *styles, reset=reset, apply=isatty(file))
+        print(text, flush=flush, file=file, **print_kwargs)
+
+    def __getattr__(self, item):
+        return getattr(sformat, item)
+
+    def __repr__(self):
+        return '<pseudo function sprint(text, *styles)>'
+
+
+sprint = StylePrint()

devtools/debug.py

@@ -30,15 +30,21 @@ def __init__(self, value, *, name=None, **extra):
             self.extra.append(('len', len(value)))
         self.extra += [(k, v) for k, v in extra.items() if v is not None]
 
-    def __str__(self) -> str:
-        template = '{value} ({self.value.__class__.__name__}) {extra}'
+    def str(self, colours=False) -> str:
+        s = ''
         if self.name:
-            template = '{self.name} = ' + template
-        return template.format(
-            self=self,
-            value=pformat(self.value, indent=2),
-            extra=' '.join('{}={}'.format(k, v) for k, v in self.extra)
-        ).rstrip(' ')  # trailing space if extra is empty
+            s = sformat(self.name, sformat.blue, apply=colours) + ' = '
+        s += pformat(self.value, indent=2)
+        suffix = (
+            ' ({0.value.__class__.__name__}) {1}'
+            .format(self, ' '.join('{}={}'.format(k, v) for k, v in self.extra))
+            .rstrip(' ')  # trailing space if extra is empty
+        )
+        s += sformat(suffix, sformat.dim, apply=colours)
+        return s
+
+    def __str__(self) -> str:
+        return self.str()
 
 
 class DebugOutput:
@@ -63,7 +69,7 @@ def str(self, colours=False) -> str:
             )
         else:
             prefix = '{0.filename}:{0.lineno} {0.frame}\n  '.format(self)
-        return prefix + '\n  '.join(str(a) for a in self.arguments)
+        return prefix + '\n  '.join(a.str(colours) for a in self.arguments)
 
     def __str__(self) -> str:
         return self.str()
@@ -99,7 +105,8 @@ def _env_bool(cls, value, env_name, env_default='TRUE'):
 
     def __call__(self, *args, file_=None, flush_=True, **kwargs) -> None:
         d_out = self._process(args, kwargs, r'debug *\(')
-        s = d_out.str(isatty(file_))
+        colours_possible = isatty(file_)
+        s = d_out.str(self._colours and colours_possible)
         print(s, file=file_, flush=flush_)
 
     def format(self, *args, **kwargs) -> DebugOutput:

devtools/prettier.py

@@ -23,14 +23,14 @@
 
 class PrettyFormat:
     def __init__(self,
-                 colorize=False,
+                 colours=False,
                  indent_step=4,
                  indent_char=' ',
                  repr_strings=False,
                  simple_cutoff=10,
                  max_width=120,
                  yield_from_generators=True):
-        self._colorize = colorize
+        self._colours = colours
         self._indent_step = indent_step
         self._c = indent_char
         self._repr_strings = repr_strings
@@ -49,7 +49,7 @@ def __call__(self, value: Any, *, indent: int=0, indent_first: bool=False):
         self._stream = io.StringIO()
         self._format(value, indent_current=indent, indent_first=indent_first)
         s = self._stream.getvalue()
-        if self._colorize and pyg_lexer:
+        if self._colours and pyg_lexer:
             s = highlight(s, lexer=pyg_lexer, formatter=pyg_formatter)
         return s
 
@@ -145,7 +145,7 @@ def _format_raw(self, value: Any, value_repr: str, indent_current: int, indent_n
 
 
 pformat = PrettyFormat()
-_ppformat = PrettyFormat(colorize=isatty())
+_ppformat = PrettyFormat(colours=isatty())
 
 
 def pprint(s):

tests/test_ansi.py

@@ -5,7 +5,7 @@
 from devtools.ansi import sformat, sprint
 
 
-def test_colorize():
+def test_colours():
     v = sformat('hello', sformat.red)
     assert v == '\x1b[31mhello\x1b[0m'
 
@@ -43,7 +43,7 @@ def test_invalid_style_str():
 
 def test_print_not_tty():
     stream = io.StringIO()
-    sprint('hello', sformat.green, file=stream)
+    sprint('hello', sprint.green, file=stream)
     out = stream.getvalue()
     assert out == 'hello\n'
 
@@ -54,7 +54,7 @@ def isatty(self):
             return True
 
     stream = TTYStream()
-    sprint('hello', sformat.green, file=stream)
+    sprint('hello', sprint.green, file=stream)
     out = stream.getvalue()
     assert out == '\x1b[32mhello\x1b[0m\n', repr(out)
 
@@ -72,14 +72,15 @@ def isatty(self):
 
 def test_get_styles():
     assert sformat.styles['bold'] == 1
-    assert sformat.styles['un_bold'] == 22
+    assert sformat.styles['not_bold'] == 22
 
 
-def test_repr():
-    assert repr(sformat) == '<pseudo function style(text, *styles)>'
+def test_repr_str():
+    assert repr(sformat) == '<pseudo function sformat(text, *styles)>'
     assert repr(sformat.red) == '<Style.red: 31>'
 
-
-def test_str():
-    assert str(sformat) == '<pseudo function style(text, *styles)>'
+    assert str(sformat) == '<pseudo function sformat(text, *styles)>'
     assert str(sformat.red) == 'Style.red'
+
+    assert repr(sprint) == '<pseudo function sprint(text, *styles)>'
+    assert str(sprint) == '<pseudo function sprint(text, *styles)>'

tests/test_prettier.py

@@ -28,7 +28,7 @@ def test_print(capsys):
 
 
 def test_colours():
-    pformat_ = PrettyFormat(colorize=True)
+    pformat_ = PrettyFormat(colours=True)
     v = pformat_({1: 2, 3: 4})
     assert v.startswith('\x1b'), repr(v)
     v2 = strip_ansi(v)