More cleanup, yey!

[python_utils.git] / text_utils.py

diff --git a/text_utils.py b/text_utils.py
index bc05dd9cd791636e8d8ff0a90e9444817ce33af3..4384a1e6134810982e9227d2bb1dfdb517627f72 100644 (file)
--- a/text_utils.py
+++ b/text_utils.py
@@ -1,20 +1,22 @@
 #!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 """Utilities for dealing with "text"."""
 
-from collections import defaultdict
 import logging
 import math
 import sys
-from typing import List, NamedTuple, Optional
+from collections import defaultdict
+from typing import Dict, Generator, List, NamedTuple, Optional, Tuple
 
 from ansi import fg, reset
 
-
 logger = logging.getLogger(__file__)
 
 
 class RowsColumns(NamedTuple):
+    """Row + Column"""
+
     rows: int
     columns: int
 
@@ -22,15 +24,16 @@ class RowsColumns(NamedTuple):
 def get_console_rows_columns() -> RowsColumns:
     """Returns the number of rows/columns on the current console."""
 
-    from exec_utils import cmd_with_timeout
+    from exec_utils import cmd
+
     try:
-        rows, columns = cmd_with_timeout(
+        rows, columns = cmd(
             "stty size",
             timeout_seconds=1.0,
         ).split()
     except Exception as e:
         logger.exception(e)
-        raise Exception('Can\'t determine console size?!')
+        raise Exception('Can\'t determine console size?!') from e
     return RowsColumns(int(rows), int(columns))
 
 
@@ -50,16 +53,13 @@ def progress_graph(
     ret = "\r" if redraw else "\n"
     bar = bar_graph(
         percent,
-        include_text = True,
-        width = width,
-        fgcolor = fgcolor,
-        left_end = left_end,
-        right_end = right_end)
-    print(
-        bar,
-        end=ret,
-        flush=True,
-        file=sys.stderr)
+        include_text=True,
+        width=width,
+        fgcolor=fgcolor,
+        left_end=left_end,
+        right_end=right_end,
+    )
+    print(bar, end=ret, flush=True, file=sys.stderr)
 
 
 def bar_graph(
@@ -71,7 +71,7 @@ def bar_graph(
     reset=reset(),
     left_end="[",
     right_end="]",
-) -> None:
+) -> str:
     """Returns a string containing a bar graph.
 
     >>> bar_graph(0.5, fgcolor='', reset='')
@@ -89,18 +89,45 @@ def bar_graph(
     if whole_width == width:
         whole_width -= 1
         part_char = "▉"
+    elif whole_width == 0 and percentage > 0.0:
+        part_char = "▏"
     else:
         remainder_width = (percentage * width) % 1
         part_width = math.floor(remainder_width * 8)
         part_char = [" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"][part_width]
     return (
-        left_end +
-        fgcolor +
-        "█" * whole_width + part_char +
-        " " * (width - whole_width - 1) +
-        reset +
-        right_end + " " +
-        text)
+        left_end
+        + fgcolor
+        + "█" * whole_width
+        + part_char
+        + " " * (width - whole_width - 1)
+        + reset
+        + right_end
+        + " "
+        + text
+    )
+
+
+def sparkline(numbers: List[float]) -> Tuple[float, float, str]:
+    """
+    Makes a "sparkline" little inline histogram graph.  Auto scales.
+
+    >>> sparkline([1, 2, 3, 5, 10, 3, 5, 7])
+    (1, 10, '▁▁▂▄█▂▄▆')
+
+    >>> sparkline([104, 99, 93, 96, 82, 77, 85, 73])
+    (73, 104, '█▇▆▆▃▂▄▁')
+
+    """
+    _bar = '▁▂▃▄▅▆▇█'  # Unicode: 9601, 9602, 9603, 9604, 9605, 9606, 9607, 9608
+
+    barcount = len(_bar)
+    min_num, max_num = min(numbers), max(numbers)
+    span = max_num - min_num
+    sline = ''.join(
+        _bar[min([barcount - 1, int((n - min_num) / span * barcount)])] for n in numbers
+    )
+    return min_num, max_num, sline
 
 
 def distribute_strings(
@@ -124,20 +151,16 @@ def distribute_strings(
     subwidth = math.floor(width / len(strings))
     retval = ""
     for string in strings:
-        string = justify_string(
-            string, width=subwidth, alignment=alignment, padding=padding
-        )
+        string = justify_string(string, width=subwidth, alignment=alignment, padding=padding)
         retval += string
-    while(len(retval) > width):
+    while len(retval) > width:
         retval = retval.replace('  ', ' ', 1)
-    while(len(retval) < width):
+    while len(retval) < width:
         retval = retval.replace(' ', '  ', 1)
     return retval
 
 
-def justify_string_by_chunk(
-    string: str, width: int = 80, padding: str = " "
-) -> str:
+def justify_string_by_chunk(string: str, width: int = 80, padding: str = " ") -> str:
     """
     Justifies a string.
 
@@ -177,11 +200,7 @@ def justify_string(
         elif alignment == "r":
             string = padding + string
         elif alignment == "j":
-            return justify_string_by_chunk(
-                string,
-                width=width,
-                padding=padding
-            )
+            return justify_string_by_chunk(string, width=width, padding=padding)
         elif alignment == "c":
             if len(string) % 2 == 0:
                 string += padding
@@ -214,8 +233,8 @@ def justify_text(text: str, *, width: int = 80, alignment: str = "c") -> str:
     return retval[1:]
 
 
-def generate_padded_columns(text: List[str]) -> str:
-    max_width = defaultdict(int)
+def generate_padded_columns(text: List[str]) -> Generator:
+    max_width: Dict[int, int] = defaultdict(int)
     for line in text:
         for pos, word in enumerate(line.split()):
             max_width[pos] = max(max_width[pos], len(word))
@@ -251,11 +270,14 @@ class Indenter(object):
             with i:
                 i.print('1, 2, 3')
     """
-    def __init__(self,
-                 *,
-                 pad_prefix: Optional[str] = None,
-                 pad_char: str = ' ',
-                 pad_count: int = 4):
+
+    def __init__(
+        self,
+        *,
+        pad_prefix: Optional[str] = None,
+        pad_char: str = ' ',
+        pad_count: int = 4,
+    ):
         self.level = -1
         if pad_prefix is not None:
             self.pad_prefix = pad_prefix
@@ -274,6 +296,7 @@ class Indenter(object):
 
     def print(self, *arg, **kwargs):
         import string_utils
+
         text = string_utils.sprintf(*arg, **kwargs)
         print(self.pad_prefix + self.padding * self.level + text, end='')
 
@@ -287,7 +310,7 @@ def header(title: str, *, width: int = 80, color: str = ''):
 
     """
     w = width
-    w -= (len(title) + 4)
+    w -= len(title) + 4
     if w >= 4:
         left = 4 * '-'
         right = (w - 4) * '-'
@@ -302,4 +325,5 @@ def header(title: str, *, width: int = 80, color: str = ''):
 
 if __name__ == '__main__':
     import doctest
+
     doctest.testmod()