2 # -*- coding: utf-8 -*-
4 # © Copyright 2021-2023, Scott Gasch
7 Utilities for dealing with and creating text chunks. For example:
9 - Make a bar graph / progress graph,
11 - left, right, center, justify text,
13 - indent / dedent text,
14 - create a header line,
15 - draw a box around some text.
26 from collections import defaultdict
27 from dataclasses import dataclass
28 from typing import Dict, Generator, List, Literal, Optional, Tuple, Union
30 from pyutils import string_utils
31 from pyutils.ansi import fg, reset
33 logger = logging.getLogger(__file__)
44 """Number of columns"""
47 def get_console_rows_columns() -> RowsColumns:
50 The number of rows/columns on the current console or None
51 if we can't tell or an error occurred.
53 from pyutils.exec_utils import cmd
55 rows: Union[Optional[str], int] = os.environ.get('LINES', None)
56 cols: Union[Optional[str], int] = os.environ.get('COLUMNS', None)
57 if not rows or not cols:
59 size = os.get_terminal_size()
66 if not rows or not cols:
67 logger.debug('Rows: %s, cols: %s, trying stty.', rows, cols)
77 if not rows or not cols:
78 raise Exception('Can\'t determine console size?!')
79 return RowsColumns(int(rows), int(cols))
82 class BarGraphText(enum.Enum):
83 """What kind of text to include at the end of the bar graph?"""
86 """None, leave it blank."""
100 text: BarGraphText = BarGraphText.PERCENTAGE,
101 fgcolor=fg("school bus yellow"),
106 """Draws a progress graph at the current cursor position.
109 current: how many have we done so far?
110 total: how many are there to do total?
111 text: how should we render the text at the end?
112 width: how many columns wide should be progress graph be?
113 fgcolor: what color should "done" part of the graph be?
114 left_end: the character at the left side of the graph
115 right_end: the character at the right side of the graph
116 redraw: if True, omit a line feed after the carriage return
117 so that subsequent calls to this method redraw the graph
120 See also :meth:`bar_graph_string`, :meth:`sparkline`.
124 '[███████████████████████████████████ ] 0.5'
127 ret = "\r" if redraw else "\n"
128 bar = bar_graph_string(
137 print(bar, end=ret, flush=True, file=sys.stderr)
140 def _make_bar_graph_text(
141 text: BarGraphText, current: int, total: int, percentage: float
143 if text == BarGraphText.NONE:
145 elif text == BarGraphText.PERCENTAGE:
146 return f'{percentage:.1f}'
147 elif text == BarGraphText.FRACTION:
148 return f'{current} / {total}'
149 raise ValueError(text)
152 def bar_graph_string(
156 text: BarGraphText = BarGraphText.PERCENTAGE,
158 fgcolor=fg("school bus yellow"),
163 """Returns a string containing a bar graph.
166 current: how many have we done so far?
167 total: how many are there to do total?
168 text: how should we render the text at the end?
169 width: how many columns wide should be progress graph be?
170 fgcolor: what color should "done" part of the graph be?
171 reset_seq: sequence to use to turn off color
172 left_end: the character at the left side of the graph
173 right_end: the character at the right side of the graph
175 See also :meth:`bar_graph`, :meth:`sparkline`.
177 >>> bar_graph_string(5, 10, fgcolor='', reset_seq='')
178 '[███████████████████████████████████ ] 0.5'
183 percentage = float(current) / float(total)
186 if percentage < 0.0 or percentage > 1.0:
187 raise ValueError(percentage)
188 text = _make_bar_graph_text(text, current, total, percentage)
189 whole_width = math.floor(percentage * width)
190 if whole_width == width:
193 elif whole_width == 0 and percentage > 0.0:
196 remainder_width = (percentage * width) % 1
197 part_width = math.floor(remainder_width * 8)
198 part_char = [" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"][part_width]
204 + " " * (width - whole_width - 1)
212 def sparkline(numbers: List[float]) -> Tuple[float, float, str]:
214 Makes a "sparkline" little inline histogram graph. Auto scales.
217 numbers: the population over which to create the sparkline
220 a three tuple containing:
222 * the minimum number in the population
223 * the maximum number in the population
224 * a string representation of the population in a concise format
226 See also :meth:`bar_graph`, :meth:`bar_graph_string`.
228 >>> sparkline([1, 2, 3, 5, 10, 3, 5, 7])
231 >>> sparkline([104, 99, 93, 96, 82, 77, 85, 73])
232 (73, 104, '█▇▆▆▃▂▄▁')
235 _bar = '▁▂▃▄▅▆▇█' # Unicode: 9601, 9602, 9603, 9604, 9605, 9606, 9607, 9608
238 min_num, max_num = min(numbers), max(numbers)
239 span = max_num - min_num
241 _bar[min([barcount - 1, int((n - min_num) / span * barcount)])] for n in numbers
243 return min_num, max_num, sline
246 def distribute_strings(
253 Distributes strings into a line for justified text.
256 strings: a list of string tokens to distribute
257 width: the width of the line to create
258 padding: the padding character to place between string chunks
261 The distributed, justified string.
263 See also :meth:`justify_string`, :meth:`justify_text`.
265 >>> distribute_strings(['this', 'is', 'a', 'test'], width=40)
268 ret = ' ' + ' '.join(strings) + ' '
269 assert len(string_utils.strip_ansi_sequences(ret)) < width
271 while len(string_utils.strip_ansi_sequences(ret)) < width:
272 spaces = [m.start() for m in re.finditer(r' ([^ ]|$)', ret)]
276 ret = before + padding + after
283 def _justify_string_by_chunk(string: str, width: int = 80, padding: str = " ") -> str:
285 Justifies a string chunk by chunk.
288 string: the string to be justified
289 width: how wide to make the output
290 padding: what padding character to use between chunks
295 >>> _justify_string_by_chunk("This is a test", 40)
297 >>> _justify_string_by_chunk("This is a test", 20)
301 assert len(string_utils.strip_ansi_sequences(string)) <= width
303 first, *rest, last = string.split()
305 len(string_utils.strip_ansi_sequences(first))
306 + len(string_utils.strip_ansi_sequences(last))
308 ret = first + distribute_strings(rest, width=w, padding=padding) + last
313 string: str, *, width: int = 80, alignment: str = "c", padding: str = " "
315 """Justify a string to width with left, right, center of justified
319 string: the string to justify
320 width: the width to justify the string to
321 alignment: a single character indicating the desired alignment:
322 * 'c' = centered within the width
323 * 'j' = justified at width
324 * 'l' = left alignment
325 * 'r' = right alignment
326 padding: the padding character to use while justifying
328 >>> justify_string('This is another test', width=40, alignment='c')
329 ' This is another test '
330 >>> justify_string('This is another test', width=40, alignment='l')
331 'This is another test '
332 >>> justify_string('This is another test', width=40, alignment='r')
333 ' This is another test'
334 >>> justify_string('This is another test', width=40, alignment='j')
335 'This is another test'
337 alignment = alignment[0]
339 while len(string_utils.strip_ansi_sequences(string)) < width:
342 elif alignment == "r":
343 string = padding + string
344 elif alignment == "j":
345 return _justify_string_by_chunk(string, width=width, padding=padding)
346 elif alignment == "c":
347 if len(string) % 2 == 0:
350 string = padding + string
357 text: str, *, width: int = 80, alignment: str = "c", indent_by: int = 0
359 """Justifies text with left, right, centered or justified alignment
360 and optionally with initial indentation.
363 text: the text to be justified
364 width: the width at which to justify text
365 alignment: a single character indicating the desired alignment:
366 * 'c' = centered within the width
367 * 'j' = justified at width
368 * 'l' = left alignment
369 * 'r' = right alignment
370 indent_by: if non-zero, adds n prefix spaces to indent the text.
375 See also :meth:`justify_text`.
377 >>> justify_text('This is a test of the emergency broadcast system. This is only a test.',
378 ... width=40, alignment='j') #doctest: +NORMALIZE_WHITESPACE
379 'This is a test of the emergency\\nbroadcast system. This is only a test.'
385 indent += ' ' * indent_by
388 for word in text.split():
390 len(string_utils.strip_ansi_sequences(line))
391 + len(string_utils.strip_ansi_sequences(word))
394 line = justify_string(line, width=width, alignment=alignment)
395 retval = retval + '\n' + line
397 line = line + ' ' + word
398 if len(string_utils.strip_ansi_sequences(line)) > 0:
400 retval += "\n" + justify_string(line[1:], width=width, alignment=alignment)
402 retval += "\n" + line[1:]
406 def generate_padded_columns(text: List[str]) -> Generator:
407 """Given a list of strings, break them into columns using :meth:`split`
408 and then compute the maximum width of each column. Finally,
409 distribute the columular chunks into the output padding each to
413 text: a list of strings to chunk into padded columns
416 padded columns based on text.split()
418 >>> for x in generate_padded_columns(
419 ... [ 'reading writing arithmetic',
420 ... 'mathematics psychology physics',
421 ... 'communications sociology anthropology' ]):
423 reading writing arithmetic
424 mathematics psychology physics
425 communications sociology anthropology
427 max_width: Dict[int, int] = defaultdict(int)
429 for pos, word in enumerate(line.split()):
430 max_width[pos] = max(
431 max_width[pos], len(string_utils.strip_ansi_sequences(word))
436 for pos, word in enumerate(line.split()):
437 width = max_width[pos]
438 word = justify_string(word, width=width, alignment='l')
443 def wrap_string(text: str, n: int) -> str:
446 text: the string to be wrapped
447 n: the width after which to wrap text
450 The wrapped form of text
452 chunks = text.split()
456 if width + len(string_utils.strip_ansi_sequences(chunk)) > n:
460 width += len(string_utils.strip_ansi_sequences(chunk)) + 1
464 class Indenter(contextlib.AbstractContextManager):
466 Context manager that indents stuff (even recursively). e.g.::
468 with Indenter(pad_count = 8) as i:
485 pad_prefix: Optional[str] = None,
489 """Construct an Indenter.
492 pad_prefix: an optional prefix to prepend to each line
493 pad_char: the character used to indent
494 pad_count: the number of pad_chars to use to indent
497 if pad_prefix is not None:
498 self.pad_prefix = pad_prefix
501 self.padding = pad_char * pad_count
507 def __exit__(self, exc_type, exc_value, exc_tb) -> Literal[False]:
513 def print(self, *arg, **kwargs):
514 text = string_utils.sprintf(*arg, **kwargs)
515 print(self.pad_prefix + self.padding * self.level + text, end='')
521 width: Optional[int] = None,
522 align: Optional[str] = None,
523 style: Optional[str] = 'solid',
524 color: Optional[str] = None,
527 Creates a nice header line with a title.
531 width: how wide to make the header
532 align: "left" or "right"
533 style: "ascii", "solid" or "dashed"
536 The header as a string.
538 >>> header('title', width=60, style='ascii')
539 '----[ title ]-----------------------------------------------'
543 width = get_console_rows_columns().columns
551 text_len = len(string_utils.strip_ansi_sequences(title))
554 right = width - (left + text_len + 4)
555 elif align == 'right':
557 left = width - (right + text_len + 4)
559 left = int((width - (text_len + 4)) / 2)
561 while left + text_len + 4 + right < width:
568 elif style == 'dashed':
596 title: Optional[str] = None,
597 text: Optional[str] = None,
603 Make a nice unicode box (optionally with color) around some text.
606 title: the title of the box
607 text: the text in the box
608 width: the box's width
609 color: the box's color
614 See also :meth:`print_box`, :meth:`preformatted_box`.
616 >>> print(box('title', 'this is some text', width=20).strip())
626 text = justify_text(text, width=width - 4, alignment='l')
627 return preformatted_box(title, text, width=width, color=color)
630 def preformatted_box(
631 title: Optional[str] = None,
632 text: Optional[str] = None,
637 """Creates a nice box with rounded corners and returns it as a string.
640 title: the title of the box
641 text: the text inside the box
642 width: the width of the box
643 color: the box's color
648 See also :meth:`print_box`, :meth:`box`.
650 >>> print(preformatted_box('title', 'this\\nis\\nsome\\ntext', width=20).strip())
667 ret += color + '╭' + '─' * w + '╮' + rset + '\n'
668 if title is not None:
673 + justify_string(title, width=w, alignment='c')
679 ret += color + '│' + ' ' * w + '│' + rset + '\n'
681 for line in text.split('\n'):
682 tw = len(string_utils.strip_ansi_sequences(line))
695 ret += color + '╰' + '─' * w + '╯' + rset + '\n'
700 title: Optional[str] = None,
701 text: Optional[str] = None,
706 """Draws a box with nice rounded corners.
709 title: the title of the box
710 text: the text inside the box
711 width: the width of the box
712 color: the box's color
718 Prints a box with your text on the console to sys.stdout.
720 See also :meth:`preformatted_box`, :meth:`box`.
722 >>> print_box('Title', 'This is text', width=30)
723 ╭────────────────────────────╮
727 ╰────────────────────────────╯
729 >>> print_box(None, 'OK', width=6)
734 print(preformatted_box(title, text, width=width, color=color), end='')
737 if __name__ == '__main__':