"""Utilities for dealing with "text"."""
+import contextlib
import logging
import math
+import re
import sys
from collections import defaultdict
-from typing import Dict, Generator, List, NamedTuple, Optional, Tuple
+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:
).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))
include_text=True,
width=70,
fgcolor=fg("school bus yellow"),
- reset=reset(),
+ reset_seq=reset(),
left_end="[",
right_end="]",
) -> str:
"""Returns a string containing a bar graph.
- >>> bar_graph(0.5, fgcolor='', reset='')
+ >>> bar_graph(0.5, fgcolor='', reset_seq='')
'[███████████████████████████████████ ] 50.0%'
"""
+ "█" * whole_width
+ part_char
+ " " * (width - whole_width - 1)
- + reset
+ + reset_seq
+ right_end
+ " "
+ text
barcount = len(_bar)
min_num, max_num = min(numbers), max(numbers)
span = max_num - min_num
- sparkline = ''.join(
+ sline = ''.join(
_bar[min([barcount - 1, int((n - min_num) / span * barcount)])] for n in numbers
)
- return min_num, max_num, sparkline
+ return min_num, max_num, sline
def distribute_strings(
strings: List[str],
*,
width: int = 80,
- alignment: str = "c",
padding: str = " ",
) -> str:
"""
- Distributes strings into a line with a particular justification.
+ Distributes strings into a line for justified text.
>>> distribute_strings(['this', 'is', 'a', 'test'], width=40)
- ' this is a test '
- >>> distribute_strings(['this', 'is', 'a', 'test'], width=40, alignment='l')
- 'this is a test '
- >>> distribute_strings(['this', 'is', 'a', 'test'], width=40, alignment='r')
- ' this is a test'
+ ' this is a test '
"""
- subwidth = math.floor(width / len(strings))
- retval = ""
- for string in strings:
- string = justify_string(string, width=subwidth, alignment=alignment, padding=padding)
- retval += string
- while len(retval) > width:
- retval = retval.replace(' ', ' ', 1)
- while len(retval) < width:
- retval = retval.replace(' ', ' ', 1)
- return retval
+ ret = ' ' + ' '.join(strings) + ' '
+ assert len(ret) < width
+ x = 0
+ while len(ret) < width:
+ spaces = [m.start() for m in re.finditer(r' ([^ ]|$)', ret)]
+ where = spaces[x]
+ before = ret[:where]
+ after = ret[where:]
+ ret = before + padding + after
+ x += 1
+ if x >= len(spaces):
+ x = 0
+ return ret
def justify_string_by_chunk(string: str, width: int = 80, padding: str = " ") -> str:
Justifies a string.
>>> justify_string_by_chunk("This is a test", 40)
- 'This is a test'
+ 'This is a test'
>>> justify_string_by_chunk("This is a test", 20)
- 'This is a test'
+ 'This is a test'
"""
+ assert len(string) <= width
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
+ w = width - (len(first) + len(last))
+ ret = first + distribute_strings(rest, width=w, padding=padding) + last
return ret
>>> justify_string('This is another test', width=40, alignment='r')
' This is another test'
>>> justify_string('This is another test', width=40, alignment='j')
- 'This is another test'
+ 'This is another test'
"""
alignment = alignment[0]
>>> justify_text('This is a test of the emergency broadcast system. This is only a test.',
... width=40, alignment='j') #doctest: +NORMALIZE_WHITESPACE
'This is a test of the emergency\\nbroadcast system. This is only a test.'
+
"""
retval = ""
line = ""
return out
-class Indenter(object):
+class Indenter(contextlib.AbstractContextManager):
"""
with Indenter(pad_count = 8) as i:
i.print('test')
i.print('-ing')
with i:
i.print('1, 2, 3')
+
"""
def __init__(
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
return ''
+def box(
+ title: Optional[str] = None, text: Optional[str] = None, *, width: int = 80, color: str = ''
+) -> str:
+ assert width > 4
+ ret = ''
+ if color == '':
+ rset = ''
+ else:
+ rset = reset()
+ w = width - 2
+ ret += color + '╭' + '─' * w + '╮' + rset + '\n'
+ if title is not None:
+ ret += (
+ color
+ + '│'
+ + rset
+ + justify_string(title, width=w, alignment='c')
+ + color
+ + '│'
+ + rset
+ + '\n'
+ )
+ ret += color + '│' + ' ' * w + '│' + rset + '\n'
+ if text is not None:
+ for line in justify_text(text, width=w - 2, alignment='l').split('\n'):
+ tw = len(line)
+ assert tw < w
+ ret += color + '│ ' + rset + line + ' ' * (w - tw - 2) + color + ' │' + rset + '\n'
+ ret += color + '╰' + '─' * w + '╯' + rset + '\n'
+ return ret
+
+
+def print_box(
+ title: Optional[str] = None, text: Optional[str] = None, *, width: int = 80, color: str = ''
+) -> None:
+ """Draws a box with nice rounded corners.
+
+ >>> print_box('Title', 'This is text', width=30)
+ ╭────────────────────────────╮
+ │ Title │
+ │ │
+ │ This is text │
+ ╰────────────────────────────╯
+
+ >>> print_box(None, 'OK', width=6)
+ ╭────╮
+ │ OK │
+ ╰────╯
+
+ """
+ print(box(title, text, width=width, color=color), end='')
+
+
if __name__ == '__main__':
import doctest
projects / python_utils.git / blobdiff