2 # -*- coding: utf-8 -*-
4 # © Copyright 2021-2022, Scott Gasch
6 """Utilities for dealing with "text"."""
15 from collections import defaultdict
16 from dataclasses import dataclass
17 from typing import Dict, Generator, List, Literal, Optional, Tuple
19 from pyutils import string_utils
20 from pyutils.ansi import fg, reset
22 logger = logging.getLogger(__file__)
33 """Number of columns"""
36 def get_console_rows_columns() -> RowsColumns:
39 The number of rows/columns on the current console or None
40 if we can't tell or an error occurred.
42 from pyutils.exec_utils import cmd
44 rows: Optional[str] = os.environ.get('LINES', None)
45 cols: Optional[str] = os.environ.get('COLUMNS', None)
46 if not rows or not cols:
47 logger.debug('Rows: %s, cols: %s, trying stty.', rows, cols)
58 logger.debug('Rows: %s, cols: %s, tput rows.', rows, cols)
68 logger.debug('Rows: %s, cols: %s, tput cols.', 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 ret = "\r" if redraw else "\n"
121 bar = bar_graph_string(
130 print(bar, end=ret, flush=True, file=sys.stderr)
133 def _make_bar_graph_text(
134 text: BarGraphText, current: int, total: int, percentage: float
136 if text == BarGraphText.NONE:
138 elif text == BarGraphText.PERCENTAGE:
139 return f'{percentage:.1f}'
140 elif text == BarGraphText.FRACTION:
141 return f'{current} / {total}'
142 raise ValueError(text)
145 def bar_graph_string(
149 text: BarGraphText = BarGraphText.PERCENTAGE,
151 fgcolor=fg("school bus yellow"),
156 """Returns a string containing a bar graph.
159 current: how many have we done so far?
160 total: how many are there to do total?
161 text: how should we render the text at the end?
162 width: how many columns wide should be progress graph be?
163 fgcolor: what color should "done" part of the graph be?
164 reset_seq: sequence to use to turn off color
165 left_end: the character at the left side of the graph
166 right_end: the character at the right side of the graph
168 >>> bar_graph_string(5, 10, fgcolor='', reset_seq='')
169 '[███████████████████████████████████ ] 0.5'
174 percentage = float(current) / float(total)
177 if percentage < 0.0 or percentage > 1.0:
178 raise ValueError(percentage)
179 text = _make_bar_graph_text(text, current, total, percentage)
180 whole_width = math.floor(percentage * width)
181 if whole_width == width:
184 elif whole_width == 0 and percentage > 0.0:
187 remainder_width = (percentage * width) % 1
188 part_width = math.floor(remainder_width * 8)
189 part_char = [" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"][part_width]
195 + " " * (width - whole_width - 1)
203 def sparkline(numbers: List[float]) -> Tuple[float, float, str]:
205 Makes a "sparkline" little inline histogram graph. Auto scales.
208 numbers: the population over which to create the sparkline
211 a three tuple containing:
213 * the minimum number in the population
214 * the maximum number in the population
215 * a string representation of the population in a concise format
217 >>> sparkline([1, 2, 3, 5, 10, 3, 5, 7])
220 >>> sparkline([104, 99, 93, 96, 82, 77, 85, 73])
221 (73, 104, '█▇▆▆▃▂▄▁')
224 _bar = '▁▂▃▄▅▆▇█' # Unicode: 9601, 9602, 9603, 9604, 9605, 9606, 9607, 9608
227 min_num, max_num = min(numbers), max(numbers)
228 span = max_num - min_num
230 _bar[min([barcount - 1, int((n - min_num) / span * barcount)])] for n in numbers
232 return min_num, max_num, sline
235 def distribute_strings(
242 Distributes strings into a line for justified text.
245 strings: a list of string tokens to distribute
246 width: the width of the line to create
247 padding: the padding character to place between string chunks
250 The distributed, justified string.
252 >>> distribute_strings(['this', 'is', 'a', 'test'], width=40)
255 ret = ' ' + ' '.join(strings) + ' '
256 assert len(string_utils.strip_ansi_sequences(ret)) < width
258 while len(string_utils.strip_ansi_sequences(ret)) < width:
259 spaces = [m.start() for m in re.finditer(r' ([^ ]|$)', ret)]
263 ret = before + padding + after
270 def _justify_string_by_chunk(string: str, width: int = 80, padding: str = " ") -> str:
272 Justifies a string chunk by chunk.
275 string: the string to be justified
276 width: how wide to make the output
277 padding: what padding character to use between chunks
282 >>> _justify_string_by_chunk("This is a test", 40)
284 >>> _justify_string_by_chunk("This is a test", 20)
288 assert len(string_utils.strip_ansi_sequences(string)) <= width
290 first, *rest, last = string.split()
292 len(string_utils.strip_ansi_sequences(first))
293 + len(string_utils.strip_ansi_sequences(last))
295 ret = first + distribute_strings(rest, width=w, padding=padding) + last
300 string: str, *, width: int = 80, alignment: str = "c", padding: str = " "
302 """Justify a string to width with left, right, center of justified
306 string: the string to justify
307 width: the width to justify the string to
308 alignment: a single character indicating the desired alignment:
309 * 'c' = centered within the width
310 * 'j' = justified at width
311 * 'l' = left alignment
312 * 'r' = right alignment
313 padding: the padding character to use while justifying
315 >>> justify_string('This is another test', width=40, alignment='c')
316 ' This is another test '
317 >>> justify_string('This is another test', width=40, alignment='l')
318 'This is another test '
319 >>> justify_string('This is another test', width=40, alignment='r')
320 ' This is another test'
321 >>> justify_string('This is another test', width=40, alignment='j')
322 'This is another test'
324 alignment = alignment[0]
326 while len(string_utils.strip_ansi_sequences(string)) < width:
329 elif alignment == "r":
330 string = padding + string
331 elif alignment == "j":
332 return _justify_string_by_chunk(string, width=width, padding=padding)
333 elif alignment == "c":
334 if len(string) % 2 == 0:
337 string = padding + string
344 text: str, *, width: int = 80, alignment: str = "c", indent_by: int = 0
346 """Justifies text with left, right, centered or justified alignment
347 and optionally with initial indentation.
350 text: the text to be justified
351 width: the width at which to justify text
352 alignment: a single character indicating the desired alignment:
353 * 'c' = centered within the width
354 * 'j' = justified at width
355 * 'l' = left alignment
356 * 'r' = right alignment
357 indent_by: if non-zero, adds n prefix spaces to indent the text.
362 >>> justify_text('This is a test of the emergency broadcast system. This is only a test.',
363 ... width=40, alignment='j') #doctest: +NORMALIZE_WHITESPACE
364 'This is a test of the emergency\\nbroadcast system. This is only a test.'
370 indent += ' ' * indent_by
373 for word in text.split():
375 len(string_utils.strip_ansi_sequences(line))
376 + len(string_utils.strip_ansi_sequences(word))
379 line = justify_string(line, width=width, alignment=alignment)
380 retval = retval + '\n' + line
382 line = line + ' ' + word
383 if len(string_utils.strip_ansi_sequences(line)) > 0:
385 retval += "\n" + justify_string(line[1:], width=width, alignment=alignment)
387 retval += "\n" + line[1:]
391 def generate_padded_columns(text: List[str]) -> Generator:
392 """Given a list of strings, break them into columns using :meth:`split`
393 and then compute the maximum width of each column. Finally,
394 distribute the columular chunks into the output padding each to
398 text: a list of strings to chunk into padded columns
401 padded columns based on text.split()
403 >>> for x in generate_padded_columns(
404 ... [ 'reading writing arithmetic',
405 ... 'mathematics psychology physics',
406 ... 'communications sociology anthropology' ]):
408 reading writing arithmetic
409 mathematics psychology physics
410 communications sociology anthropology
412 max_width: Dict[int, int] = defaultdict(int)
414 for pos, word in enumerate(line.split()):
415 max_width[pos] = max(
416 max_width[pos], len(string_utils.strip_ansi_sequences(word))
421 for pos, word in enumerate(line.split()):
422 width = max_width[pos]
423 word = justify_string(word, width=width, alignment='l')
428 def wrap_string(text: str, n: int) -> str:
431 text: the string to be wrapped
432 n: the width after which to wrap text
435 The wrapped form of text
437 chunks = text.split()
441 if width + len(string_utils.strip_ansi_sequences(chunk)) > n:
445 width += len(string_utils.strip_ansi_sequences(chunk)) + 1
449 class Indenter(contextlib.AbstractContextManager):
451 Context manager that indents stuff (even recursively). e.g.::
453 with Indenter(pad_count = 8) as i:
470 pad_prefix: Optional[str] = None,
474 """Construct an Indenter.
477 pad_prefix: an optional prefix to prepend to each line
478 pad_char: the character used to indent
479 pad_count: the number of pad_chars to use to indent
482 if pad_prefix is not None:
483 self.pad_prefix = pad_prefix
486 self.padding = pad_char * pad_count
492 def __exit__(self, exc_type, exc_value, exc_tb) -> Literal[False]:
498 def print(self, *arg, **kwargs):
499 text = string_utils.sprintf(*arg, **kwargs)
500 print(self.pad_prefix + self.padding * self.level + text, end='')
506 width: Optional[int] = None,
507 align: Optional[str] = None,
508 style: Optional[str] = 'solid',
509 color: Optional[str] = None,
512 Creates a nice header line with a title.
516 width: how wide to make the header
517 align: "left" or "right"
518 style: "ascii", "solid" or "dashed"
521 The header as a string.
523 >>> header('title', width=60, style='ascii')
524 '----[ title ]-----------------------------------------------'
528 width = get_console_rows_columns().columns
536 text_len = len(string_utils.strip_ansi_sequences(title))
539 right = width - (left + text_len + 4)
540 elif align == 'right':
542 left = width - (right + text_len + 4)
544 left = int((width - (text_len + 4)) / 2)
546 while left + text_len + 4 + right < width:
553 elif style == 'dashed':
581 title: Optional[str] = None,
582 text: Optional[str] = None,
588 Make a nice unicode box (optionally with color) around some text.
591 title: the title of the box
592 text: the text in the box
593 width: the box's width
594 color: the box's color
599 >>> print(box('title', 'this is some text', width=20).strip())
609 text = justify_text(text, width=width - 4, alignment='l')
610 return preformatted_box(title, text, width=width, color=color)
613 def preformatted_box(
614 title: Optional[str] = None,
615 text: Optional[str] = None,
620 """Creates a nice box with rounded corners and returns it as a string.
623 title: the title of the box
624 text: the text inside the box
625 width: the width of the box
626 color: the box's color
631 >>> print(preformatted_box('title', 'this\\nis\\nsome\\ntext', width=20).strip())
648 ret += color + '╭' + '─' * w + '╮' + rset + '\n'
649 if title is not None:
654 + justify_string(title, width=w, alignment='c')
660 ret += color + '│' + ' ' * w + '│' + rset + '\n'
662 for line in text.split('\n'):
663 tw = len(string_utils.strip_ansi_sequences(line))
676 ret += color + '╰' + '─' * w + '╯' + rset + '\n'
681 title: Optional[str] = None,
682 text: Optional[str] = None,
687 """Draws a box with nice rounded corners.
689 >>> print_box('Title', 'This is text', width=30)
690 ╭────────────────────────────╮
694 ╰────────────────────────────╯
696 >>> print_box(None, 'OK', width=6)
701 print(preformatted_box(title, text, width=width, color=color), end='')
704 if __name__ == '__main__':