More cleanup.

[python_utils.git] / text_utils.py

diff --git a/text_utils.py b/text_utils.py
index cfed1699dc3f29090a7846bff8dc2d3c89fa9174..720bf20561a63bcd5c1afeba42658c8924566adc 100644 (file)
--- a/text_utils.py
+++ b/text_utils.py
@@ -1,37 +1,42 @@
 #!/usr/bin/env python3
+# -*- coding: utf-8 -*-
 
 """Utilities for dealing with "text"."""
 
-from collections import defaultdict
+import contextlib
 import logging
 import math
 import sys
-from typing import List, NamedTuple, Optional
+from collections import defaultdict
+from dataclasses import dataclass
+from typing import Dict, Generator, List, Literal, Optional, Tuple
 
 from ansi import fg, reset
 
-
 logger = logging.getLogger(__file__)
 
 
-class RowsColumns(NamedTuple):
-    rows: int
-    columns: int
+@dataclass
+class RowsColumns:
+    """Row + Column"""
+
+    rows: int = 0
+    columns: int = 0
 
 
 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))
 
 
@@ -69,7 +74,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='')
@@ -87,6 +92,8 @@ 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)
@@ -104,6 +111,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],
     *,
@@ -125,9 +154,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)
@@ -149,13 +176,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
 
 
@@ -215,8 +236,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))
@@ -243,7 +264,7 @@ def wrap_string(text: str, n: int) -> str:
     return out
 
 
-class Indenter(object):
+class Indenter(contextlib.AbstractContextManager):
     """
     with Indenter(pad_count = 8) as i:
         i.print('test')
@@ -271,10 +292,11 @@ class Indenter(object):
         self.level += 1
         return self
 
-    def __exit__(self, exc_type, exc_value, exc_tb):
+    def __exit__(self, exc_type, exc_value, exc_tb) -> Literal[False]:
         self.level -= 1
         if self.level < -1:
             self.level = -1
+        return False
 
     def print(self, *arg, **kwargs):
         import string_utils