Make it possible for users of this library to override argparse's
[python_utils.git] / text_utils.py
index cfed1699dc3f29090a7846bff8dc2d3c89fa9174..d9bb652689f8b317af606b4334a9e09604518975 100644 (file)
@@ -2,15 +2,14 @@
 
 """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
 
 from ansi import fg, reset
 
-
 logger = logging.getLogger(__file__)
 
 
@@ -22,10 +21,10 @@ 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()
@@ -69,7 +68,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 +86,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)
@@ -125,9 +126,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 +148,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 +208,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))