X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=text_utils.py;h=f04c61813ef227c4bfe356f42d08c59f2234132c;hb=532df2c5b57c7517dfb3dddd8c1358fbadf8baf3;hp=76cc7e816db9ae87581989bc314fd7d07d4ca154;hpb=a3eb24ea374a7f231e595c1a6e2c8e49d482c594;p=python_utils.git diff --git a/text_utils.py b/text_utils.py index 76cc7e8..f04c618 100644 --- a/text_utils.py +++ b/text_utils.py @@ -1,22 +1,31 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- +# © Copyright 2021-2022, Scott Gasch + """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 +import string_utils 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: @@ -31,7 +40,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)) @@ -66,13 +75,13 @@ def bar_graph( 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%' """ @@ -99,7 +108,7 @@ def bar_graph( + "█" * whole_width + part_char + " " * (width - whole_width - 1) - + reset + + reset_seq + right_end + " " + text @@ -122,40 +131,38 @@ def sparkline(numbers: List[float]) -> Tuple[float, float, str]: 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(string_utils.strip_ansi_sequences(ret)) < width + x = 0 + while len(string_utils.strip_ansi_sequences(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: @@ -163,15 +170,18 @@ def justify_string_by_chunk(string: str, width: int = 80, padding: 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_utils.strip_ansi_sequences(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(string_utils.strip_ansi_sequences(first)) + len(string_utils.strip_ansi_sequences(last)) + ) + ret = first + distribute_strings(rest, width=w, padding=padding) + last return ret @@ -187,12 +197,12 @@ def justify_string( >>> 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] padding = padding[0] - while len(string) < width: + while len(string_utils.strip_ansi_sequences(string)) < width: if alignment == "l": string += padding elif alignment == "r": @@ -209,25 +219,36 @@ def justify_string( return string -def justify_text(text: str, *, width: int = 80, alignment: str = "c") -> str: +def justify_text(text: str, *, width: int = 80, alignment: str = "c", indent_by: int = 0) -> str: """ - Justifies text. + Justifies text optionally with initial indentation. >>> 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 = "" + retval = '' + indent = '' + if indent_by > 0: + indent += ' ' * indent_by + line = indent + for word in text.split(): - if len(line) + len(word) > width: + if ( + len(string_utils.strip_ansi_sequences(line)) + + len(string_utils.strip_ansi_sequences(word)) + ) > width: line = line[1:] line = justify_string(line, width=width, alignment=alignment) - retval = retval + "\n" + line - line = "" - line = line + " " + word - if len(line) > 0: - retval += "\n" + line[1:] + retval = retval + '\n' + line + line = indent + line = line + ' ' + word + if len(string_utils.strip_ansi_sequences(line)) > 0: + if alignment != 'j': + retval += "\n" + justify_string(line[1:], width=width, alignment=alignment) + else: + retval += "\n" + line[1:] return retval[1:] @@ -235,7 +256,7 @@ 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)) + max_width[pos] = max(max_width[pos], len(string_utils.strip_ansi_sequences(word))) for line in text: out = "" @@ -251,15 +272,15 @@ def wrap_string(text: str, n: int) -> str: out = '' width = 0 for chunk in chunks: - if width + len(chunk) > n: + if width + len(string_utils.strip_ansi_sequences(chunk)) > n: out += '\n' width = 0 out += chunk + ' ' - width += len(chunk) + 1 + width += len(string_utils.strip_ansi_sequences(chunk)) + 1 return out -class Indenter(object): +class Indenter(contextlib.AbstractContextManager): """ with Indenter(pad_count = 8) as i: i.print('test') @@ -267,6 +288,7 @@ class Indenter(object): i.print('-ing') with i: i.print('1, 2, 3') + """ def __init__( @@ -287,38 +309,117 @@ 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 - text = string_utils.sprintf(*arg, **kwargs) print(self.pad_prefix + self.padding * self.level + text, end='') -def header(title: str, *, width: int = 80, color: str = ''): +def header( + title: str, + *, + width: Optional[int] = None, + align: Optional[str] = None, + style: Optional[str] = 'solid', +): """ Returns a nice header line with a title. - >>> header('title', width=60, color='') + >>> header('title', width=60, style='ascii') '----[ title ]-----------------------------------------------' """ - w = width - w -= len(title) + 4 - if w >= 4: - left = 4 * '-' - right = (w - 4) * '-' - if color != '' and color is not None: - r = reset() - else: - r = '' - return f'{left}[ {color}{title}{r} ]{right}' + if not width: + width = get_console_rows_columns().columns + if not align: + align = 'left' + if not style: + style = 'ascii' + + text_len = len(string_utils.strip_ansi_sequences(title)) + if align == 'left': + left = 4 + right = width - (left + text_len + 4) + elif align == 'right': + right = 4 + left = width - (right + text_len + 4) + else: + left = int((width - (text_len + 4)) / 2) + right = left + while left + text_len + 4 + right < width: + right += 1 + + if style == 'solid': + line_char = '━' + begin = '' + end = '' + elif style == 'dashed': + line_char = '┅' + begin = '' + end = '' else: - return '' + line_char = '-' + begin = '[' + end = ']' + return line_char * left + begin + ' ' + title + ' ' + end + line_char * right + + +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(string_utils.strip_ansi_sequences(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__':