More cleanup, yey!
[python_utils.git] / text_utils.py
index 0d07905be78daeb273995a0b5e131722e6e344d5..4384a1e6134810982e9227d2bb1dfdb517627f72 100644 (file)
@@ -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 Dict, Generator, 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
 
@@ -31,7 +33,7 @@ def get_console_rows_columns() -> RowsColumns:
         ).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))
 
 
@@ -106,6 +108,28 @@ def bar_graph(
     )
 
 
+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(
     strings: List[str],
     *,
@@ -127,9 +151,7 @@ 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:
         retval = retval.replace('  ', ' ', 1)
@@ -151,13 +173,7 @@ def justify_string_by_chunk(string: str, width: int = 80, padding: str = " ") ->
     padding = padding[0]
     first, *rest, last = string.split()
     w = width - (len(first) + 1 + len(last) + 1)
-    ret = (
-        first
-        + padding
-        + distribute_strings(rest, width=w, padding=padding)
-        + padding
-        + last
-    )
+    ret = first + padding + distribute_strings(rest, width=w, padding=padding) + padding + last
     return ret