Skip to content

cmd2.table_creator

cmd2.table_creator

cmd2 table creation API This API is built upon two core classes: Column and TableCreator The general use case is to inherit from TableCreator to create a table class with custom formatting options. There are already implemented and ready-to-use examples of this below TableCreator's code.

EMPTY module-attribute 

EMPTY = ''

SPACE module-attribute 

SPACE = ' '

HorizontalAlignment

Bases: Enum

Horizontal alignment of text in a cell

LEFT class-attribute instance-attribute 

LEFT = 1

CENTER class-attribute instance-attribute 

CENTER = 2

RIGHT class-attribute instance-attribute 

RIGHT = 3

VerticalAlignment

Bases: Enum

Vertical alignment of text in a cell

TOP class-attribute instance-attribute 

TOP = 1

MIDDLE class-attribute instance-attribute 

MIDDLE = 2

BOTTOM class-attribute instance-attribute 

BOTTOM = 3

Column 

Column(
    header,
    *,
    width=None,
    header_horiz_align=LEFT,
    header_vert_align=BOTTOM,
    style_header_text=True,
    data_horiz_align=LEFT,
    data_vert_align=TOP,
    style_data_text=True,
    max_data_lines=INFINITY
)

Table column configuration

Column initializer

:param header: label for column header :param width: display width of column. This does not account for any borders or padding which may be added (e.g pre_line, inter_cell, and post_line). Header and data text wrap within this width using word-based wrapping (defaults to actual width of header or 1 if header is blank) :param header_horiz_align: horizontal alignment of header cells (defaults to left) :param header_vert_align: vertical alignment of header cells (defaults to bottom) :param style_header_text: if True, then the table is allowed to apply styles to the header text, which may conflict with any styles the header already has. If False, the header is printed as is. Table classes which apply style to headers must account for the value of this flag. (defaults to True) :param data_horiz_align: horizontal alignment of data cells (defaults to left) :param data_vert_align: vertical alignment of data cells (defaults to top) :param style_data_text: if True, then the table is allowed to apply styles to the data text, which may conflict with any styles the data already has. If False, the data is printed as is. Table classes which apply style to data must account for the value of this flag. (defaults to True) :param max_data_lines: maximum lines allowed in a data cell. If line count exceeds this, then the final line displayed will be truncated with an ellipsis. (defaults to INFINITY) :raises: ValueError if width is less than 1 :raises: ValueError if max_data_lines is less than 1

PARAMETER DESCRIPTION
header

TYPE: str

width

TYPE: Optional[int] DEFAULT: None

header_horiz_align

TYPE: HorizontalAlignment DEFAULT: LEFT

header_vert_align

TYPE: VerticalAlignment DEFAULT: BOTTOM

style_header_text

TYPE: bool DEFAULT: True

data_horiz_align

TYPE: HorizontalAlignment DEFAULT: LEFT

data_vert_align

TYPE: VerticalAlignment DEFAULT: TOP

style_data_text

TYPE: bool DEFAULT: True

max_data_lines

TYPE: Union[int, float] DEFAULT: INFINITY

Source code in cmd2/table_creator.py 
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
def __init__(
    self,
    header: str,
    *,
    width: Optional[int] = None,
    header_horiz_align: HorizontalAlignment = HorizontalAlignment.LEFT,
    header_vert_align: VerticalAlignment = VerticalAlignment.BOTTOM,
    style_header_text: bool = True,
    data_horiz_align: HorizontalAlignment = HorizontalAlignment.LEFT,
    data_vert_align: VerticalAlignment = VerticalAlignment.TOP,
    style_data_text: bool = True,
    max_data_lines: Union[int, float] = constants.INFINITY,
) -> None:
    """
    Column initializer

    :param header: label for column header
    :param width: display width of column. This does not account for any borders or padding which
                  may be added (e.g pre_line, inter_cell, and post_line). Header and data text wrap within
                  this width using word-based wrapping (defaults to actual width of header or 1 if header is blank)
    :param header_horiz_align: horizontal alignment of header cells (defaults to left)
    :param header_vert_align: vertical alignment of header cells (defaults to bottom)
    :param style_header_text: if True, then the table is allowed to apply styles to the header text, which may
                              conflict with any styles the header already has. If False, the header is printed as is.
                              Table classes which apply style to headers must account for the value of this flag.
                              (defaults to True)
    :param data_horiz_align: horizontal alignment of data cells (defaults to left)
    :param data_vert_align: vertical alignment of data cells (defaults to top)
    :param style_data_text: if True, then the table is allowed to apply styles to the data text, which may
                            conflict with any styles the data already has. If False, the data is printed as is.
                            Table classes which apply style to data must account for the value of this flag.
                            (defaults to True)
    :param max_data_lines: maximum lines allowed in a data cell. If line count exceeds this, then the final
                           line displayed will be truncated with an ellipsis. (defaults to INFINITY)
    :raises: ValueError if width is less than 1
    :raises: ValueError if max_data_lines is less than 1
    """
    self.header = header

    if width is not None and width < 1:
        raise ValueError("Column width cannot be less than 1")
    else:
        self.width: int = width if width is not None else -1

    self.header_horiz_align = header_horiz_align
    self.header_vert_align = header_vert_align
    self.style_header_text = style_header_text

    self.data_horiz_align = data_horiz_align
    self.data_vert_align = data_vert_align
    self.style_data_text = style_data_text

    if max_data_lines < 1:
        raise ValueError("Max data lines cannot be less than 1")

    self.max_data_lines = max_data_lines

header instance-attribute 

header = header

width instance-attribute 

width = width if width is not None else -1

header_horiz_align instance-attribute 

header_horiz_align = header_horiz_align

header_vert_align instance-attribute 

header_vert_align = header_vert_align

style_header_text instance-attribute 

style_header_text = style_header_text

data_horiz_align instance-attribute 

data_horiz_align = data_horiz_align

data_vert_align instance-attribute 

data_vert_align = data_vert_align

style_data_text instance-attribute 

style_data_text = style_data_text

max_data_lines instance-attribute 

max_data_lines = max_data_lines

TableCreator 

TableCreator(cols, *, tab_width=4)

Base table creation class. This class handles ANSI style sequences and characters with display widths greater than 1 when performing width calculations. It was designed with the ability to build tables one row at a time. This helps when you have large data sets that you don't want to hold in memory or when you receive portions of the data set incrementally.

TableCreator has one public method: generate_row()

This function and the Column class provide all features needed to build tables with headers, borders, colors, horizontal and vertical alignment, and wrapped text. However, it's generally easier to inherit from this class and implement a more granular API rather than use TableCreator directly. There are ready-to-use examples of this defined after this class.

TableCreator initializer

:param cols: column definitions for this table :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab, then it will be converted to one space. :raises: ValueError if tab_width is less than 1

PARAMETER DESCRIPTION
cols

TYPE: Sequence[Column]

tab_width

TYPE: int DEFAULT: 4

Source code in cmd2/table_creator.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def __init__(self, cols: Sequence[Column], *, tab_width: int = 4) -> None:
    """
    TableCreator initializer

    :param cols: column definitions for this table
    :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab,
                      then it will be converted to one space.
    :raises: ValueError if tab_width is less than 1
    """
    if tab_width < 1:
        raise ValueError("Tab width cannot be less than 1")

    self.cols = copy.copy(cols)
    self.tab_width = tab_width

    for col in self.cols:
        # Replace tabs before calculating width of header strings
        col.header = col.header.replace('\t', SPACE * self.tab_width)

        # For headers with the width not yet set, use the width of the
        # widest line in the header or 1 if the header has no width
        if col.width <= 0:
            col.width = max(1, ansi.widest_line(col.header))

cols instance-attribute 

cols = copy(cols)

tab_width instance-attribute 

tab_width = tab_width

generate_row 

generate_row(
    row_data,
    is_header,
    *,
    fill_char=SPACE,
    pre_line=EMPTY,
    inter_cell=2 * SPACE,
    post_line=EMPTY
)

Generate a header or data table row

:param row_data: data with an entry for each column in the row :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to use header or data alignment settings as well as maximum lines to wrap. :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab, then it will be converted to one space. (Cannot be a line breaking character) :param pre_line: string to print before each line of a row. This can be used for a left row border and padding before the first cell's text. (Defaults to blank) :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding between it and the 2 cells' text. (Defaults to 2 spaces) :param post_line: string to print after each line of a row. This can be used for padding after the last cell's text and a right row border. (Defaults to blank) :return: row string :raises: ValueError if row_data isn't the same length as self.cols :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable character like a newline

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

is_header

TYPE: bool

fill_char

TYPE: str DEFAULT: SPACE

pre_line

TYPE: str DEFAULT: EMPTY

inter_cell

TYPE: str DEFAULT: 2 * SPACE

post_line

TYPE: str DEFAULT: EMPTY

Source code in cmd2/table_creator.py 
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
def generate_row(
    self,
    row_data: Sequence[Any],
    is_header: bool,
    *,
    fill_char: str = SPACE,
    pre_line: str = EMPTY,
    inter_cell: str = (2 * SPACE),
    post_line: str = EMPTY,
) -> str:
    """
    Generate a header or data table row

    :param row_data: data with an entry for each column in the row
    :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to
                      use header or data alignment settings as well as maximum lines to wrap.
    :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab,
                      then it will be converted to one space. (Cannot be a line breaking character)
    :param pre_line: string to print before each line of a row. This can be used for a left row border and
                     padding before the first cell's text. (Defaults to blank)
    :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding
                       between it and the 2 cells' text. (Defaults to 2 spaces)
    :param post_line: string to print after each line of a row. This can be used for padding after
                      the last cell's text and a right row border. (Defaults to blank)
    :return: row string
    :raises: ValueError if row_data isn't the same length as self.cols
    :raises: TypeError if fill_char is more than one character (not including ANSI style sequences)
    :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable
             character like a newline
    """

    class Cell:
        """Inner class which represents a table cell"""

        def __init__(self) -> None:
            # Data in this cell split into individual lines
            self.lines: Deque[str] = deque()

            # Display width of this cell
            self.width = 0

    if len(row_data) != len(self.cols):
        raise ValueError("Length of row_data must match length of cols")

    # Replace tabs (tabs in data strings will be handled in _generate_cell_lines())
    fill_char = fill_char.replace('\t', SPACE)
    pre_line = pre_line.replace('\t', SPACE * self.tab_width)
    inter_cell = inter_cell.replace('\t', SPACE * self.tab_width)
    post_line = post_line.replace('\t', SPACE * self.tab_width)

    # Validate fill_char character count
    if len(ansi.strip_style(fill_char)) != 1:
        raise TypeError("Fill character must be exactly one character long")

    # Look for unprintable characters
    validation_dict = {'fill_char': fill_char, 'pre_line': pre_line, 'inter_cell': inter_cell, 'post_line': post_line}
    for key, val in validation_dict.items():
        if ansi.style_aware_wcswidth(val) == -1:
            raise ValueError(f"{key} contains an unprintable character")

    # Number of lines this row uses
    total_lines = 0

    # Generate the cells for this row
    cells = list()

    for col_index, col in enumerate(self.cols):
        cell = Cell()
        cell.lines, cell.width = self._generate_cell_lines(row_data[col_index], is_header, col, fill_char)
        cells.append(cell)
        total_lines = max(len(cell.lines), total_lines)

    row_buf = io.StringIO()

    # Vertically align each cell
    for cell_index, cell in enumerate(cells):
        col = self.cols[cell_index]
        vert_align = col.header_vert_align if is_header else col.data_vert_align

        # Check if this cell need vertical filler
        line_diff = total_lines - len(cell.lines)
        if line_diff == 0:
            continue

        # Add vertical filler lines
        padding_line = utils.align_left(EMPTY, fill_char=fill_char, width=cell.width)
        if vert_align == VerticalAlignment.TOP:
            to_top = 0
            to_bottom = line_diff
        elif vert_align == VerticalAlignment.MIDDLE:
            to_top = line_diff // 2
            to_bottom = line_diff - to_top
        else:
            to_top = line_diff
            to_bottom = 0

        for i in range(to_top):
            cell.lines.appendleft(padding_line)
        for i in range(to_bottom):
            cell.lines.append(padding_line)

    # Build this row one line at a time
    for line_index in range(total_lines):
        for cell_index, cell in enumerate(cells):
            if cell_index == 0:
                row_buf.write(pre_line)

            row_buf.write(cell.lines[line_index])

            if cell_index < len(self.cols) - 1:
                row_buf.write(inter_cell)
            if cell_index == len(self.cols) - 1:
                row_buf.write(post_line)

        # Add a newline if this is not the last line
        if line_index < total_lines - 1:
            row_buf.write('\n')

    return row_buf.getvalue()

SimpleTable 

SimpleTable(
    cols,
    *,
    column_spacing=2,
    tab_width=4,
    divider_char="-",
    header_bg=None,
    data_bg=None
)

Bases: TableCreator

Implementation of TableCreator which generates a borderless table with an optional divider row after the header. This class can be used to create the whole table at once or one row at a time.

SimpleTable initializer

:param cols: column definitions for this table :param column_spacing: how many spaces to place between columns. Defaults to 2. :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab, then it will be converted to one space. :param divider_char: optional character used to build the header divider row. Set this to blank or None if you don't want a divider row. Defaults to dash. (Cannot be a line breaking character) :param header_bg: optional background color for header cells (defaults to None) :param data_bg: optional background color for data cells (defaults to None) :raises: ValueError if tab_width is less than 1 :raises: ValueError if column_spacing is less than 0 :raises: TypeError if divider_char is longer than one character :raises: ValueError if divider_char is an unprintable character

PARAMETER DESCRIPTION
cols

TYPE: Sequence[Column]

column_spacing

TYPE: int DEFAULT: 2

tab_width

TYPE: int DEFAULT: 4

divider_char

TYPE: Optional[str] DEFAULT: '-'

header_bg

TYPE: Optional[BgColor] DEFAULT: None

data_bg

TYPE: Optional[BgColor] DEFAULT: None

Source code in cmd2/table_creator.py 
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
def __init__(
    self,
    cols: Sequence[Column],
    *,
    column_spacing: int = 2,
    tab_width: int = 4,
    divider_char: Optional[str] = '-',
    header_bg: Optional[ansi.BgColor] = None,
    data_bg: Optional[ansi.BgColor] = None,
) -> None:
    """
    SimpleTable initializer

    :param cols: column definitions for this table
    :param column_spacing: how many spaces to place between columns. Defaults to 2.
    :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab,
                      then it will be converted to one space.
    :param divider_char: optional character used to build the header divider row. Set this to blank or None if you don't
                         want a divider row. Defaults to dash. (Cannot be a line breaking character)
    :param header_bg: optional background color for header cells (defaults to None)
    :param data_bg: optional background color for data cells (defaults to None)
    :raises: ValueError if tab_width is less than 1
    :raises: ValueError if column_spacing is less than 0
    :raises: TypeError if divider_char is longer than one character
    :raises: ValueError if divider_char is an unprintable character
    """
    super().__init__(cols, tab_width=tab_width)

    if column_spacing < 0:
        raise ValueError("Column spacing cannot be less than 0")

    self.column_spacing = column_spacing

    if divider_char == '':
        divider_char = None

    if divider_char is not None:
        if len(ansi.strip_style(divider_char)) != 1:
            raise TypeError("Divider character must be exactly one character long")

        divider_char_width = ansi.style_aware_wcswidth(divider_char)
        if divider_char_width == -1:
            raise ValueError("Divider character is an unprintable character")

    self.divider_char = divider_char
    self.header_bg = header_bg
    self.data_bg = data_bg

cols instance-attribute 

cols = copy(cols)

tab_width instance-attribute 

tab_width = tab_width

column_spacing instance-attribute 

column_spacing = column_spacing

divider_char instance-attribute 

divider_char = divider_char

header_bg instance-attribute 

header_bg = header_bg

data_bg instance-attribute 

data_bg = data_bg

generate_row 

generate_row(
    row_data,
    is_header,
    *,
    fill_char=SPACE,
    pre_line=EMPTY,
    inter_cell=2 * SPACE,
    post_line=EMPTY
)

Generate a header or data table row

:param row_data: data with an entry for each column in the row :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to use header or data alignment settings as well as maximum lines to wrap. :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab, then it will be converted to one space. (Cannot be a line breaking character) :param pre_line: string to print before each line of a row. This can be used for a left row border and padding before the first cell's text. (Defaults to blank) :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding between it and the 2 cells' text. (Defaults to 2 spaces) :param post_line: string to print after each line of a row. This can be used for padding after the last cell's text and a right row border. (Defaults to blank) :return: row string :raises: ValueError if row_data isn't the same length as self.cols :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable character like a newline

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

is_header

TYPE: bool

fill_char

TYPE: str DEFAULT: SPACE

pre_line

TYPE: str DEFAULT: EMPTY

inter_cell

TYPE: str DEFAULT: 2 * SPACE

post_line

TYPE: str DEFAULT: EMPTY

Source code in cmd2/table_creator.py 
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
def generate_row(
    self,
    row_data: Sequence[Any],
    is_header: bool,
    *,
    fill_char: str = SPACE,
    pre_line: str = EMPTY,
    inter_cell: str = (2 * SPACE),
    post_line: str = EMPTY,
) -> str:
    """
    Generate a header or data table row

    :param row_data: data with an entry for each column in the row
    :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to
                      use header or data alignment settings as well as maximum lines to wrap.
    :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab,
                      then it will be converted to one space. (Cannot be a line breaking character)
    :param pre_line: string to print before each line of a row. This can be used for a left row border and
                     padding before the first cell's text. (Defaults to blank)
    :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding
                       between it and the 2 cells' text. (Defaults to 2 spaces)
    :param post_line: string to print after each line of a row. This can be used for padding after
                      the last cell's text and a right row border. (Defaults to blank)
    :return: row string
    :raises: ValueError if row_data isn't the same length as self.cols
    :raises: TypeError if fill_char is more than one character (not including ANSI style sequences)
    :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable
             character like a newline
    """

    class Cell:
        """Inner class which represents a table cell"""

        def __init__(self) -> None:
            # Data in this cell split into individual lines
            self.lines: Deque[str] = deque()

            # Display width of this cell
            self.width = 0

    if len(row_data) != len(self.cols):
        raise ValueError("Length of row_data must match length of cols")

    # Replace tabs (tabs in data strings will be handled in _generate_cell_lines())
    fill_char = fill_char.replace('\t', SPACE)
    pre_line = pre_line.replace('\t', SPACE * self.tab_width)
    inter_cell = inter_cell.replace('\t', SPACE * self.tab_width)
    post_line = post_line.replace('\t', SPACE * self.tab_width)

    # Validate fill_char character count
    if len(ansi.strip_style(fill_char)) != 1:
        raise TypeError("Fill character must be exactly one character long")

    # Look for unprintable characters
    validation_dict = {'fill_char': fill_char, 'pre_line': pre_line, 'inter_cell': inter_cell, 'post_line': post_line}
    for key, val in validation_dict.items():
        if ansi.style_aware_wcswidth(val) == -1:
            raise ValueError(f"{key} contains an unprintable character")

    # Number of lines this row uses
    total_lines = 0

    # Generate the cells for this row
    cells = list()

    for col_index, col in enumerate(self.cols):
        cell = Cell()
        cell.lines, cell.width = self._generate_cell_lines(row_data[col_index], is_header, col, fill_char)
        cells.append(cell)
        total_lines = max(len(cell.lines), total_lines)

    row_buf = io.StringIO()

    # Vertically align each cell
    for cell_index, cell in enumerate(cells):
        col = self.cols[cell_index]
        vert_align = col.header_vert_align if is_header else col.data_vert_align

        # Check if this cell need vertical filler
        line_diff = total_lines - len(cell.lines)
        if line_diff == 0:
            continue

        # Add vertical filler lines
        padding_line = utils.align_left(EMPTY, fill_char=fill_char, width=cell.width)
        if vert_align == VerticalAlignment.TOP:
            to_top = 0
            to_bottom = line_diff
        elif vert_align == VerticalAlignment.MIDDLE:
            to_top = line_diff // 2
            to_bottom = line_diff - to_top
        else:
            to_top = line_diff
            to_bottom = 0

        for i in range(to_top):
            cell.lines.appendleft(padding_line)
        for i in range(to_bottom):
            cell.lines.append(padding_line)

    # Build this row one line at a time
    for line_index in range(total_lines):
        for cell_index, cell in enumerate(cells):
            if cell_index == 0:
                row_buf.write(pre_line)

            row_buf.write(cell.lines[line_index])

            if cell_index < len(self.cols) - 1:
                row_buf.write(inter_cell)
            if cell_index == len(self.cols) - 1:
                row_buf.write(post_line)

        # Add a newline if this is not the last line
        if line_index < total_lines - 1:
            row_buf.write('\n')

    return row_buf.getvalue()

apply_header_bg 

apply_header_bg(value)

If defined, apply the header background color to header text :param value: object whose text is to be colored :return: formatted text

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
600
601
602
603
604
605
606
607
608
def apply_header_bg(self, value: Any) -> str:
    """
    If defined, apply the header background color to header text
    :param value: object whose text is to be colored
    :return: formatted text
    """
    if self.header_bg is None:
        return str(value)
    return ansi.style(value, bg=self.header_bg)

apply_data_bg 

apply_data_bg(value)

If defined, apply the data background color to data text :param value: object whose text is to be colored :return: formatted data string

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
610
611
612
613
614
615
616
617
618
def apply_data_bg(self, value: Any) -> str:
    """
    If defined, apply the data background color to data text
    :param value: object whose text is to be colored
    :return: formatted data string
    """
    if self.data_bg is None:
        return str(value)
    return ansi.style(value, bg=self.data_bg)

base_width classmethod 

base_width(num_cols, *, column_spacing=2)

Utility method to calculate the display width required for a table before data is added to it. This is useful when determining how wide to make your columns to have a table be a specific width.

:param num_cols: how many columns the table will have :param column_spacing: how many spaces to place between columns. Defaults to 2. :return: base width :raises: ValueError if column_spacing is less than 0 :raises: ValueError if num_cols is less than 1

PARAMETER DESCRIPTION
num_cols

TYPE: int

column_spacing

TYPE: int DEFAULT: 2

Source code in cmd2/table_creator.py 
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
@classmethod
def base_width(cls, num_cols: int, *, column_spacing: int = 2) -> int:
    """
    Utility method to calculate the display width required for a table before data is added to it.
    This is useful when determining how wide to make your columns to have a table be a specific width.

    :param num_cols: how many columns the table will have
    :param column_spacing: how many spaces to place between columns. Defaults to 2.
    :return: base width
    :raises: ValueError if column_spacing is less than 0
    :raises: ValueError if num_cols is less than 1
    """
    if num_cols < 1:
        raise ValueError("Column count cannot be less than 1")

    data_str = SPACE
    data_width = ansi.style_aware_wcswidth(data_str) * num_cols

    tbl = cls([Column(data_str)] * num_cols, column_spacing=column_spacing)
    data_row = tbl.generate_data_row([data_str] * num_cols)

    return ansi.style_aware_wcswidth(data_row) - data_width

total_width 

total_width()

Calculate the total display width of this table

Source code in cmd2/table_creator.py 
643
644
645
646
647
def total_width(self) -> int:
    """Calculate the total display width of this table"""
    base_width = self.base_width(len(self.cols), column_spacing=self.column_spacing)
    data_width = sum(col.width for col in self.cols)
    return base_width + data_width

generate_header 

generate_header()

Generate table header with an optional divider row

Source code in cmd2/table_creator.py 
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
def generate_header(self) -> str:
    """Generate table header with an optional divider row"""
    header_buf = io.StringIO()

    fill_char = self.apply_header_bg(SPACE)
    inter_cell = self.apply_header_bg(self.column_spacing * SPACE)

    # Apply background color to header text in Columns which allow it
    to_display: List[Any] = []
    for col in self.cols:
        if col.style_header_text:
            to_display.append(self.apply_header_bg(col.header))
        else:
            to_display.append(col.header)

    # Create the header labels
    header_labels = self.generate_row(to_display, is_header=True, fill_char=fill_char, inter_cell=inter_cell)
    header_buf.write(header_labels)

    # Add the divider if necessary
    divider = self.generate_divider()
    if divider:
        header_buf.write('\n' + divider)

    return header_buf.getvalue()

generate_divider 

generate_divider()

Generate divider row

Source code in cmd2/table_creator.py 
675
676
677
678
679
680
def generate_divider(self) -> str:
    """Generate divider row"""
    if self.divider_char is None:
        return ''

    return utils.align_left('', fill_char=self.divider_char, width=self.total_width())

generate_data_row 

generate_data_row(row_data)

Generate a data row

:param row_data: data with an entry for each column in the row :return: data row string :raises: ValueError if row_data isn't the same length as self.cols

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

Source code in cmd2/table_creator.py 
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
def generate_data_row(self, row_data: Sequence[Any]) -> str:
    """
    Generate a data row

    :param row_data: data with an entry for each column in the row
    :return: data row string
    :raises: ValueError if row_data isn't the same length as self.cols
    """
    if len(row_data) != len(self.cols):
        raise ValueError("Length of row_data must match length of cols")

    fill_char = self.apply_data_bg(SPACE)
    inter_cell = self.apply_data_bg(self.column_spacing * SPACE)

    # Apply background color to data text in Columns which allow it
    to_display: List[Any] = []
    for index, col in enumerate(self.cols):
        if col.style_data_text:
            to_display.append(self.apply_data_bg(row_data[index]))
        else:
            to_display.append(row_data[index])

    return self.generate_row(to_display, is_header=False, fill_char=fill_char, inter_cell=inter_cell)

generate_table 

generate_table(
    table_data, *, include_header=True, row_spacing=1
)

Generate a table from a data set

:param table_data: Data with an entry for each data row of the table. Each entry should have data for each column in the row. :param include_header: If True, then a header will be included at top of table. (Defaults to True) :param row_spacing: A number 0 or greater specifying how many blank lines to place between each row (Defaults to 1) :raises: ValueError if row_spacing is less than 0

PARAMETER DESCRIPTION
table_data

TYPE: Sequence[Sequence[Any]]

include_header

TYPE: bool DEFAULT: True

row_spacing

TYPE: int DEFAULT: 1

Source code in cmd2/table_creator.py 
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
def generate_table(self, table_data: Sequence[Sequence[Any]], *, include_header: bool = True, row_spacing: int = 1) -> str:
    """
    Generate a table from a data set

    :param table_data: Data with an entry for each data row of the table. Each entry should have data for
                       each column in the row.
    :param include_header: If True, then a header will be included at top of table. (Defaults to True)
    :param row_spacing: A number 0 or greater specifying how many blank lines to place between
                        each row (Defaults to 1)
    :raises: ValueError if row_spacing is less than 0
    """
    if row_spacing < 0:
        raise ValueError("Row spacing cannot be less than 0")

    table_buf = io.StringIO()

    if include_header:
        header = self.generate_header()
        table_buf.write(header)
        if len(table_data) > 0:
            table_buf.write('\n')

    row_divider = utils.align_left('', fill_char=self.apply_data_bg(SPACE), width=self.total_width()) + '\n'

    for index, row_data in enumerate(table_data):
        if index > 0 and row_spacing > 0:
            table_buf.write(row_spacing * row_divider)

        row = self.generate_data_row(row_data)
        table_buf.write(row)
        if index < len(table_data) - 1:
            table_buf.write('\n')

    return table_buf.getvalue()

BorderedTable 

BorderedTable(
    cols,
    *,
    tab_width=4,
    column_borders=True,
    padding=1,
    border_fg=None,
    border_bg=None,
    header_bg=None,
    data_bg=None
)

Bases: TableCreator

Implementation of TableCreator which generates a table with borders around the table and between rows. Borders between columns can also be toggled. This class can be used to create the whole table at once or one row at a time.

BorderedTable initializer

:param cols: column definitions for this table :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab, then it will be converted to one space. :param column_borders: if True, borders between columns will be included. This gives the table a grid-like appearance. Turning off column borders results in a unified appearance between a row's cells. (Defaults to True) :param padding: number of spaces between text and left/right borders of cell :param border_fg: optional foreground color for borders (defaults to None) :param border_bg: optional background color for borders (defaults to None) :param header_bg: optional background color for header cells (defaults to None) :param data_bg: optional background color for data cells (defaults to None) :raises: ValueError if tab_width is less than 1 :raises: ValueError if padding is less than 0

PARAMETER DESCRIPTION
cols

TYPE: Sequence[Column]

tab_width

TYPE: int DEFAULT: 4

column_borders

TYPE: bool DEFAULT: True

padding

TYPE: int DEFAULT: 1

border_fg

TYPE: Optional[FgColor] DEFAULT: None

border_bg

TYPE: Optional[BgColor] DEFAULT: None

header_bg

TYPE: Optional[BgColor] DEFAULT: None

data_bg

TYPE: Optional[BgColor] DEFAULT: None

Source code in cmd2/table_creator.py 
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
def __init__(
    self,
    cols: Sequence[Column],
    *,
    tab_width: int = 4,
    column_borders: bool = True,
    padding: int = 1,
    border_fg: Optional[ansi.FgColor] = None,
    border_bg: Optional[ansi.BgColor] = None,
    header_bg: Optional[ansi.BgColor] = None,
    data_bg: Optional[ansi.BgColor] = None,
) -> None:
    """
    BorderedTable initializer

    :param cols: column definitions for this table
    :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab,
                      then it will be converted to one space.
    :param column_borders: if True, borders between columns will be included. This gives the table a grid-like
                           appearance. Turning off column borders results in a unified appearance between
                           a row's cells. (Defaults to True)
    :param padding: number of spaces between text and left/right borders of cell
    :param border_fg: optional foreground color for borders (defaults to None)
    :param border_bg: optional background color for borders (defaults to None)
    :param header_bg: optional background color for header cells (defaults to None)
    :param data_bg: optional background color for data cells (defaults to None)
    :raises: ValueError if tab_width is less than 1
    :raises: ValueError if padding is less than 0
    """
    super().__init__(cols, tab_width=tab_width)
    self.empty_data = [EMPTY] * len(self.cols)
    self.column_borders = column_borders

    if padding < 0:
        raise ValueError("Padding cannot be less than 0")
    self.padding = padding

    self.border_fg = border_fg
    self.border_bg = border_bg
    self.header_bg = header_bg
    self.data_bg = data_bg

cols instance-attribute 

cols = copy(cols)

tab_width instance-attribute 

tab_width = tab_width

empty_data instance-attribute 

empty_data = [EMPTY] * len(cols)

column_borders instance-attribute 

column_borders = column_borders

padding instance-attribute 

padding = padding

border_fg instance-attribute 

border_fg = border_fg

border_bg instance-attribute 

border_bg = border_bg

header_bg instance-attribute 

header_bg = header_bg

data_bg instance-attribute 

data_bg = data_bg

generate_row 

generate_row(
    row_data,
    is_header,
    *,
    fill_char=SPACE,
    pre_line=EMPTY,
    inter_cell=2 * SPACE,
    post_line=EMPTY
)

Generate a header or data table row

:param row_data: data with an entry for each column in the row :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to use header or data alignment settings as well as maximum lines to wrap. :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab, then it will be converted to one space. (Cannot be a line breaking character) :param pre_line: string to print before each line of a row. This can be used for a left row border and padding before the first cell's text. (Defaults to blank) :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding between it and the 2 cells' text. (Defaults to 2 spaces) :param post_line: string to print after each line of a row. This can be used for padding after the last cell's text and a right row border. (Defaults to blank) :return: row string :raises: ValueError if row_data isn't the same length as self.cols :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable character like a newline

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

is_header

TYPE: bool

fill_char

TYPE: str DEFAULT: SPACE

pre_line

TYPE: str DEFAULT: EMPTY

inter_cell

TYPE: str DEFAULT: 2 * SPACE

post_line

TYPE: str DEFAULT: EMPTY

Source code in cmd2/table_creator.py 
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
def generate_row(
    self,
    row_data: Sequence[Any],
    is_header: bool,
    *,
    fill_char: str = SPACE,
    pre_line: str = EMPTY,
    inter_cell: str = (2 * SPACE),
    post_line: str = EMPTY,
) -> str:
    """
    Generate a header or data table row

    :param row_data: data with an entry for each column in the row
    :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to
                      use header or data alignment settings as well as maximum lines to wrap.
    :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab,
                      then it will be converted to one space. (Cannot be a line breaking character)
    :param pre_line: string to print before each line of a row. This can be used for a left row border and
                     padding before the first cell's text. (Defaults to blank)
    :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding
                       between it and the 2 cells' text. (Defaults to 2 spaces)
    :param post_line: string to print after each line of a row. This can be used for padding after
                      the last cell's text and a right row border. (Defaults to blank)
    :return: row string
    :raises: ValueError if row_data isn't the same length as self.cols
    :raises: TypeError if fill_char is more than one character (not including ANSI style sequences)
    :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable
             character like a newline
    """

    class Cell:
        """Inner class which represents a table cell"""

        def __init__(self) -> None:
            # Data in this cell split into individual lines
            self.lines: Deque[str] = deque()

            # Display width of this cell
            self.width = 0

    if len(row_data) != len(self.cols):
        raise ValueError("Length of row_data must match length of cols")

    # Replace tabs (tabs in data strings will be handled in _generate_cell_lines())
    fill_char = fill_char.replace('\t', SPACE)
    pre_line = pre_line.replace('\t', SPACE * self.tab_width)
    inter_cell = inter_cell.replace('\t', SPACE * self.tab_width)
    post_line = post_line.replace('\t', SPACE * self.tab_width)

    # Validate fill_char character count
    if len(ansi.strip_style(fill_char)) != 1:
        raise TypeError("Fill character must be exactly one character long")

    # Look for unprintable characters
    validation_dict = {'fill_char': fill_char, 'pre_line': pre_line, 'inter_cell': inter_cell, 'post_line': post_line}
    for key, val in validation_dict.items():
        if ansi.style_aware_wcswidth(val) == -1:
            raise ValueError(f"{key} contains an unprintable character")

    # Number of lines this row uses
    total_lines = 0

    # Generate the cells for this row
    cells = list()

    for col_index, col in enumerate(self.cols):
        cell = Cell()
        cell.lines, cell.width = self._generate_cell_lines(row_data[col_index], is_header, col, fill_char)
        cells.append(cell)
        total_lines = max(len(cell.lines), total_lines)

    row_buf = io.StringIO()

    # Vertically align each cell
    for cell_index, cell in enumerate(cells):
        col = self.cols[cell_index]
        vert_align = col.header_vert_align if is_header else col.data_vert_align

        # Check if this cell need vertical filler
        line_diff = total_lines - len(cell.lines)
        if line_diff == 0:
            continue

        # Add vertical filler lines
        padding_line = utils.align_left(EMPTY, fill_char=fill_char, width=cell.width)
        if vert_align == VerticalAlignment.TOP:
            to_top = 0
            to_bottom = line_diff
        elif vert_align == VerticalAlignment.MIDDLE:
            to_top = line_diff // 2
            to_bottom = line_diff - to_top
        else:
            to_top = line_diff
            to_bottom = 0

        for i in range(to_top):
            cell.lines.appendleft(padding_line)
        for i in range(to_bottom):
            cell.lines.append(padding_line)

    # Build this row one line at a time
    for line_index in range(total_lines):
        for cell_index, cell in enumerate(cells):
            if cell_index == 0:
                row_buf.write(pre_line)

            row_buf.write(cell.lines[line_index])

            if cell_index < len(self.cols) - 1:
                row_buf.write(inter_cell)
            if cell_index == len(self.cols) - 1:
                row_buf.write(post_line)

        # Add a newline if this is not the last line
        if line_index < total_lines - 1:
            row_buf.write('\n')

    return row_buf.getvalue()

apply_border_color 

apply_border_color(value)

If defined, apply the border foreground and background colors :param value: object whose text is to be colored :return: formatted text

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
790
791
792
793
794
795
796
797
798
def apply_border_color(self, value: Any) -> str:
    """
    If defined, apply the border foreground and background colors
    :param value: object whose text is to be colored
    :return: formatted text
    """
    if self.border_fg is None and self.border_bg is None:
        return str(value)
    return ansi.style(value, fg=self.border_fg, bg=self.border_bg)

apply_header_bg 

apply_header_bg(value)

If defined, apply the header background color to header text :param value: object whose text is to be colored :return: formatted text

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
800
801
802
803
804
805
806
807
808
def apply_header_bg(self, value: Any) -> str:
    """
    If defined, apply the header background color to header text
    :param value: object whose text is to be colored
    :return: formatted text
    """
    if self.header_bg is None:
        return str(value)
    return ansi.style(value, bg=self.header_bg)

apply_data_bg 

apply_data_bg(value)

If defined, apply the data background color to data text :param value: object whose text is to be colored :return: formatted data string

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
810
811
812
813
814
815
816
817
818
def apply_data_bg(self, value: Any) -> str:
    """
    If defined, apply the data background color to data text
    :param value: object whose text is to be colored
    :return: formatted data string
    """
    if self.data_bg is None:
        return str(value)
    return ansi.style(value, bg=self.data_bg)

base_width classmethod 

base_width(num_cols, *, column_borders=True, padding=1)

Utility method to calculate the display width required for a table before data is added to it. This is useful when determining how wide to make your columns to have a table be a specific width.

:param num_cols: how many columns the table will have :param column_borders: if True, borders between columns will be included in the calculation (Defaults to True) :param padding: number of spaces between text and left/right borders of cell :return: base width :raises: ValueError if num_cols is less than 1

PARAMETER DESCRIPTION
num_cols

TYPE: int

column_borders

TYPE: bool DEFAULT: True

padding

TYPE: int DEFAULT: 1

Source code in cmd2/table_creator.py 
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
@classmethod
def base_width(cls, num_cols: int, *, column_borders: bool = True, padding: int = 1) -> int:
    """
    Utility method to calculate the display width required for a table before data is added to it.
    This is useful when determining how wide to make your columns to have a table be a specific width.

    :param num_cols: how many columns the table will have
    :param column_borders: if True, borders between columns will be included in the calculation (Defaults to True)
    :param padding: number of spaces between text and left/right borders of cell
    :return: base width
    :raises: ValueError if num_cols is less than 1
    """
    if num_cols < 1:
        raise ValueError("Column count cannot be less than 1")

    data_str = SPACE
    data_width = ansi.style_aware_wcswidth(data_str) * num_cols

    tbl = cls([Column(data_str)] * num_cols, column_borders=column_borders, padding=padding)
    data_row = tbl.generate_data_row([data_str] * num_cols)

    return ansi.style_aware_wcswidth(data_row) - data_width

total_width 

total_width()

Calculate the total display width of this table

Source code in cmd2/table_creator.py 
843
844
845
846
847
def total_width(self) -> int:
    """Calculate the total display width of this table"""
    base_width = self.base_width(len(self.cols), column_borders=self.column_borders, padding=self.padding)
    data_width = sum(col.width for col in self.cols)
    return base_width + data_width

generate_table_top_border 

generate_table_top_border()

Generate a border which appears at the top of the header and data section

Source code in cmd2/table_creator.py 
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
def generate_table_top_border(self) -> str:
    """Generate a border which appears at the top of the header and data section"""
    fill_char = '═'

    pre_line = '╔' + self.padding * '═'

    inter_cell = self.padding * '═'
    if self.column_borders:
        inter_cell += "╤"
    inter_cell += self.padding * '═'

    post_line = self.padding * '═' + '╗'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_header_bottom_border 

generate_header_bottom_border()

Generate a border which appears at the bottom of the header

Source code in cmd2/table_creator.py 
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
def generate_header_bottom_border(self) -> str:
    """Generate a border which appears at the bottom of the header"""
    fill_char = '═'

    pre_line = '╠' + self.padding * '═'

    inter_cell = self.padding * '═'
    if self.column_borders:
        inter_cell += '╪'
    inter_cell += self.padding * '═'

    post_line = self.padding * '═' + '╣'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_row_bottom_border 

generate_row_bottom_border()

Generate a border which appears at the bottom of rows

Source code in cmd2/table_creator.py 
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
def generate_row_bottom_border(self) -> str:
    """Generate a border which appears at the bottom of rows"""
    fill_char = '─'

    pre_line = '╟' + self.padding * '─'

    inter_cell = self.padding * '─'
    if self.column_borders:
        inter_cell += '┼'
    inter_cell += self.padding * '─'
    inter_cell = inter_cell

    post_line = self.padding * '─' + '╢'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_table_bottom_border 

generate_table_bottom_border()

Generate a border which appears at the bottom of the table

Source code in cmd2/table_creator.py 
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
def generate_table_bottom_border(self) -> str:
    """Generate a border which appears at the bottom of the table"""
    fill_char = '═'

    pre_line = '╚' + self.padding * '═'

    inter_cell = self.padding * '═'
    if self.column_borders:
        inter_cell += '╧'
    inter_cell += self.padding * '═'

    post_line = self.padding * '═' + '╝'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_header 

generate_header()

Generate table header

Source code in cmd2/table_creator.py 
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
def generate_header(self) -> str:
    """Generate table header"""
    fill_char = self.apply_header_bg(SPACE)

    pre_line = self.apply_border_color('║') + self.apply_header_bg(self.padding * SPACE)

    inter_cell = self.apply_header_bg(self.padding * SPACE)
    if self.column_borders:
        inter_cell += self.apply_border_color('│')
    inter_cell += self.apply_header_bg(self.padding * SPACE)

    post_line = self.apply_header_bg(self.padding * SPACE) + self.apply_border_color('║')

    # Apply background color to header text in Columns which allow it
    to_display: List[Any] = []
    for col in self.cols:
        if col.style_header_text:
            to_display.append(self.apply_header_bg(col.header))
        else:
            to_display.append(col.header)

    # Create the bordered header
    header_buf = io.StringIO()
    header_buf.write(self.generate_table_top_border())
    header_buf.write('\n')
    header_buf.write(
        self.generate_row(
            to_display, is_header=True, fill_char=fill_char, pre_line=pre_line, inter_cell=inter_cell, post_line=post_line
        )
    )
    header_buf.write('\n')
    header_buf.write(self.generate_header_bottom_border())

    return header_buf.getvalue()

generate_data_row 

generate_data_row(row_data)

Generate a data row

:param row_data: data with an entry for each column in the row :return: data row string :raises: ValueError if row_data isn't the same length as self.cols

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

Source code in cmd2/table_creator.py 
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
def generate_data_row(self, row_data: Sequence[Any]) -> str:
    """
    Generate a data row

    :param row_data: data with an entry for each column in the row
    :return: data row string
    :raises: ValueError if row_data isn't the same length as self.cols
    """
    if len(row_data) != len(self.cols):
        raise ValueError("Length of row_data must match length of cols")

    fill_char = self.apply_data_bg(SPACE)

    pre_line = self.apply_border_color('║') + self.apply_data_bg(self.padding * SPACE)

    inter_cell = self.apply_data_bg(self.padding * SPACE)
    if self.column_borders:
        inter_cell += self.apply_border_color('│')
    inter_cell += self.apply_data_bg(self.padding * SPACE)

    post_line = self.apply_data_bg(self.padding * SPACE) + self.apply_border_color('║')

    # Apply background color to data text in Columns which allow it
    to_display: List[Any] = []
    for index, col in enumerate(self.cols):
        if col.style_data_text:
            to_display.append(self.apply_data_bg(row_data[index]))
        else:
            to_display.append(row_data[index])

    return self.generate_row(
        to_display, is_header=False, fill_char=fill_char, pre_line=pre_line, inter_cell=inter_cell, post_line=post_line
    )

generate_table 

generate_table(table_data, *, include_header=True)

Generate a table from a data set

:param table_data: Data with an entry for each data row of the table. Each entry should have data for each column in the row. :param include_header: If True, then a header will be included at top of table. (Defaults to True)

PARAMETER DESCRIPTION
table_data

TYPE: Sequence[Sequence[Any]]

include_header

TYPE: bool DEFAULT: True

Source code in cmd2/table_creator.py 
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
def generate_table(self, table_data: Sequence[Sequence[Any]], *, include_header: bool = True) -> str:
    """
    Generate a table from a data set

    :param table_data: Data with an entry for each data row of the table. Each entry should have data for
                       each column in the row.
    :param include_header: If True, then a header will be included at top of table. (Defaults to True)
    """
    table_buf = io.StringIO()

    if include_header:
        header = self.generate_header()
        table_buf.write(header)
    else:
        top_border = self.generate_table_top_border()
        table_buf.write(top_border)

    table_buf.write('\n')

    for index, row_data in enumerate(table_data):
        if index > 0:
            row_bottom_border = self.generate_row_bottom_border()
            table_buf.write(row_bottom_border)
            table_buf.write('\n')

        row = self.generate_data_row(row_data)
        table_buf.write(row)
        table_buf.write('\n')

    table_buf.write(self.generate_table_bottom_border())
    return table_buf.getvalue()

AlternatingTable 

AlternatingTable(
    cols,
    *,
    tab_width=4,
    column_borders=True,
    padding=1,
    border_fg=None,
    border_bg=None,
    header_bg=None,
    odd_bg=None,
    even_bg=DARK_GRAY
)

Bases: BorderedTable

Implementation of BorderedTable which uses background colors to distinguish between rows instead of row border lines. This class can be used to create the whole table at once or one row at a time.

To nest an AlternatingTable within another AlternatingTable, set style_data_text to False on the Column which contains the nested table. That will prevent the current row's background color from affecting the colors of the nested table.

AlternatingTable initializer

Note: Specify background colors using subclasses of BgColor (e.g. Bg, EightBitBg, RgbBg)

:param cols: column definitions for this table :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab, then it will be converted to one space. :param column_borders: if True, borders between columns will be included. This gives the table a grid-like appearance. Turning off column borders results in a unified appearance between a row's cells. (Defaults to True) :param padding: number of spaces between text and left/right borders of cell :param border_fg: optional foreground color for borders (defaults to None) :param border_bg: optional background color for borders (defaults to None) :param header_bg: optional background color for header cells (defaults to None) :param odd_bg: optional background color for odd numbered data rows (defaults to None) :param even_bg: optional background color for even numbered data rows (defaults to StdBg.DARK_GRAY) :raises: ValueError if tab_width is less than 1 :raises: ValueError if padding is less than 0

PARAMETER DESCRIPTION
cols

TYPE: Sequence[Column]

tab_width

TYPE: int DEFAULT: 4

column_borders

TYPE: bool DEFAULT: True

padding

TYPE: int DEFAULT: 1

border_fg

TYPE: Optional[FgColor] DEFAULT: None

border_bg

TYPE: Optional[BgColor] DEFAULT: None

header_bg

TYPE: Optional[BgColor] DEFAULT: None

odd_bg

TYPE: Optional[BgColor] DEFAULT: None

even_bg

TYPE: Optional[BgColor] DEFAULT: DARK_GRAY

Source code in cmd2/table_creator.py 
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
def __init__(
    self,
    cols: Sequence[Column],
    *,
    tab_width: int = 4,
    column_borders: bool = True,
    padding: int = 1,
    border_fg: Optional[ansi.FgColor] = None,
    border_bg: Optional[ansi.BgColor] = None,
    header_bg: Optional[ansi.BgColor] = None,
    odd_bg: Optional[ansi.BgColor] = None,
    even_bg: Optional[ansi.BgColor] = ansi.Bg.DARK_GRAY,
) -> None:
    """
    AlternatingTable initializer

    Note: Specify background colors using subclasses of BgColor (e.g. Bg, EightBitBg, RgbBg)

    :param cols: column definitions for this table
    :param tab_width: all tabs will be replaced with this many spaces. If a row's fill_char is a tab,
                      then it will be converted to one space.
    :param column_borders: if True, borders between columns will be included. This gives the table a grid-like
                           appearance. Turning off column borders results in a unified appearance between
                           a row's cells. (Defaults to True)
    :param padding: number of spaces between text and left/right borders of cell
    :param border_fg: optional foreground color for borders (defaults to None)
    :param border_bg: optional background color for borders (defaults to None)
    :param header_bg: optional background color for header cells (defaults to None)
    :param odd_bg: optional background color for odd numbered data rows (defaults to None)
    :param even_bg: optional background color for even numbered data rows (defaults to StdBg.DARK_GRAY)
    :raises: ValueError if tab_width is less than 1
    :raises: ValueError if padding is less than 0
    """
    super().__init__(
        cols,
        tab_width=tab_width,
        column_borders=column_borders,
        padding=padding,
        border_fg=border_fg,
        border_bg=border_bg,
        header_bg=header_bg,
    )
    self.row_num = 1
    self.odd_bg = odd_bg
    self.even_bg = even_bg

cols instance-attribute 

cols = copy(cols)

tab_width instance-attribute 

tab_width = tab_width

empty_data instance-attribute 

empty_data = [EMPTY] * len(cols)

column_borders instance-attribute 

column_borders = column_borders

padding instance-attribute 

padding = padding

border_fg instance-attribute 

border_fg = border_fg

border_bg instance-attribute 

border_bg = border_bg

header_bg instance-attribute 

header_bg = header_bg

data_bg instance-attribute 

data_bg = data_bg

row_num instance-attribute 

row_num = 1

odd_bg instance-attribute 

odd_bg = odd_bg

even_bg instance-attribute 

even_bg = even_bg

generate_row 

generate_row(
    row_data,
    is_header,
    *,
    fill_char=SPACE,
    pre_line=EMPTY,
    inter_cell=2 * SPACE,
    post_line=EMPTY
)

Generate a header or data table row

:param row_data: data with an entry for each column in the row :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to use header or data alignment settings as well as maximum lines to wrap. :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab, then it will be converted to one space. (Cannot be a line breaking character) :param pre_line: string to print before each line of a row. This can be used for a left row border and padding before the first cell's text. (Defaults to blank) :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding between it and the 2 cells' text. (Defaults to 2 spaces) :param post_line: string to print after each line of a row. This can be used for padding after the last cell's text and a right row border. (Defaults to blank) :return: row string :raises: ValueError if row_data isn't the same length as self.cols :raises: TypeError if fill_char is more than one character (not including ANSI style sequences) :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable character like a newline

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

is_header

TYPE: bool

fill_char

TYPE: str DEFAULT: SPACE

pre_line

TYPE: str DEFAULT: EMPTY

inter_cell

TYPE: str DEFAULT: 2 * SPACE

post_line

TYPE: str DEFAULT: EMPTY

Source code in cmd2/table_creator.py 
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
def generate_row(
    self,
    row_data: Sequence[Any],
    is_header: bool,
    *,
    fill_char: str = SPACE,
    pre_line: str = EMPTY,
    inter_cell: str = (2 * SPACE),
    post_line: str = EMPTY,
) -> str:
    """
    Generate a header or data table row

    :param row_data: data with an entry for each column in the row
    :param is_header: True if writing a header cell, otherwise writing a data cell. This determines whether to
                      use header or data alignment settings as well as maximum lines to wrap.
    :param fill_char: character that fills remaining space in a cell. Defaults to space. If this is a tab,
                      then it will be converted to one space. (Cannot be a line breaking character)
    :param pre_line: string to print before each line of a row. This can be used for a left row border and
                     padding before the first cell's text. (Defaults to blank)
    :param inter_cell: string to print where two cells meet. This can be used for a border between cells and padding
                       between it and the 2 cells' text. (Defaults to 2 spaces)
    :param post_line: string to print after each line of a row. This can be used for padding after
                      the last cell's text and a right row border. (Defaults to blank)
    :return: row string
    :raises: ValueError if row_data isn't the same length as self.cols
    :raises: TypeError if fill_char is more than one character (not including ANSI style sequences)
    :raises: ValueError if fill_char, pre_line, inter_cell, or post_line contains an unprintable
             character like a newline
    """

    class Cell:
        """Inner class which represents a table cell"""

        def __init__(self) -> None:
            # Data in this cell split into individual lines
            self.lines: Deque[str] = deque()

            # Display width of this cell
            self.width = 0

    if len(row_data) != len(self.cols):
        raise ValueError("Length of row_data must match length of cols")

    # Replace tabs (tabs in data strings will be handled in _generate_cell_lines())
    fill_char = fill_char.replace('\t', SPACE)
    pre_line = pre_line.replace('\t', SPACE * self.tab_width)
    inter_cell = inter_cell.replace('\t', SPACE * self.tab_width)
    post_line = post_line.replace('\t', SPACE * self.tab_width)

    # Validate fill_char character count
    if len(ansi.strip_style(fill_char)) != 1:
        raise TypeError("Fill character must be exactly one character long")

    # Look for unprintable characters
    validation_dict = {'fill_char': fill_char, 'pre_line': pre_line, 'inter_cell': inter_cell, 'post_line': post_line}
    for key, val in validation_dict.items():
        if ansi.style_aware_wcswidth(val) == -1:
            raise ValueError(f"{key} contains an unprintable character")

    # Number of lines this row uses
    total_lines = 0

    # Generate the cells for this row
    cells = list()

    for col_index, col in enumerate(self.cols):
        cell = Cell()
        cell.lines, cell.width = self._generate_cell_lines(row_data[col_index], is_header, col, fill_char)
        cells.append(cell)
        total_lines = max(len(cell.lines), total_lines)

    row_buf = io.StringIO()

    # Vertically align each cell
    for cell_index, cell in enumerate(cells):
        col = self.cols[cell_index]
        vert_align = col.header_vert_align if is_header else col.data_vert_align

        # Check if this cell need vertical filler
        line_diff = total_lines - len(cell.lines)
        if line_diff == 0:
            continue

        # Add vertical filler lines
        padding_line = utils.align_left(EMPTY, fill_char=fill_char, width=cell.width)
        if vert_align == VerticalAlignment.TOP:
            to_top = 0
            to_bottom = line_diff
        elif vert_align == VerticalAlignment.MIDDLE:
            to_top = line_diff // 2
            to_bottom = line_diff - to_top
        else:
            to_top = line_diff
            to_bottom = 0

        for i in range(to_top):
            cell.lines.appendleft(padding_line)
        for i in range(to_bottom):
            cell.lines.append(padding_line)

    # Build this row one line at a time
    for line_index in range(total_lines):
        for cell_index, cell in enumerate(cells):
            if cell_index == 0:
                row_buf.write(pre_line)

            row_buf.write(cell.lines[line_index])

            if cell_index < len(self.cols) - 1:
                row_buf.write(inter_cell)
            if cell_index == len(self.cols) - 1:
                row_buf.write(post_line)

        # Add a newline if this is not the last line
        if line_index < total_lines - 1:
            row_buf.write('\n')

    return row_buf.getvalue()

apply_border_color 

apply_border_color(value)

If defined, apply the border foreground and background colors :param value: object whose text is to be colored :return: formatted text

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
790
791
792
793
794
795
796
797
798
def apply_border_color(self, value: Any) -> str:
    """
    If defined, apply the border foreground and background colors
    :param value: object whose text is to be colored
    :return: formatted text
    """
    if self.border_fg is None and self.border_bg is None:
        return str(value)
    return ansi.style(value, fg=self.border_fg, bg=self.border_bg)

apply_header_bg 

apply_header_bg(value)

If defined, apply the header background color to header text :param value: object whose text is to be colored :return: formatted text

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
800
801
802
803
804
805
806
807
808
def apply_header_bg(self, value: Any) -> str:
    """
    If defined, apply the header background color to header text
    :param value: object whose text is to be colored
    :return: formatted text
    """
    if self.header_bg is None:
        return str(value)
    return ansi.style(value, bg=self.header_bg)

base_width classmethod 

base_width(num_cols, *, column_borders=True, padding=1)

Utility method to calculate the display width required for a table before data is added to it. This is useful when determining how wide to make your columns to have a table be a specific width.

:param num_cols: how many columns the table will have :param column_borders: if True, borders between columns will be included in the calculation (Defaults to True) :param padding: number of spaces between text and left/right borders of cell :return: base width :raises: ValueError if num_cols is less than 1

PARAMETER DESCRIPTION
num_cols

TYPE: int

column_borders

TYPE: bool DEFAULT: True

padding

TYPE: int DEFAULT: 1

Source code in cmd2/table_creator.py 
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
@classmethod
def base_width(cls, num_cols: int, *, column_borders: bool = True, padding: int = 1) -> int:
    """
    Utility method to calculate the display width required for a table before data is added to it.
    This is useful when determining how wide to make your columns to have a table be a specific width.

    :param num_cols: how many columns the table will have
    :param column_borders: if True, borders between columns will be included in the calculation (Defaults to True)
    :param padding: number of spaces between text and left/right borders of cell
    :return: base width
    :raises: ValueError if num_cols is less than 1
    """
    if num_cols < 1:
        raise ValueError("Column count cannot be less than 1")

    data_str = SPACE
    data_width = ansi.style_aware_wcswidth(data_str) * num_cols

    tbl = cls([Column(data_str)] * num_cols, column_borders=column_borders, padding=padding)
    data_row = tbl.generate_data_row([data_str] * num_cols)

    return ansi.style_aware_wcswidth(data_row) - data_width

total_width 

total_width()

Calculate the total display width of this table

Source code in cmd2/table_creator.py 
843
844
845
846
847
def total_width(self) -> int:
    """Calculate the total display width of this table"""
    base_width = self.base_width(len(self.cols), column_borders=self.column_borders, padding=self.padding)
    data_width = sum(col.width for col in self.cols)
    return base_width + data_width

generate_table_top_border 

generate_table_top_border()

Generate a border which appears at the top of the header and data section

Source code in cmd2/table_creator.py 
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
def generate_table_top_border(self) -> str:
    """Generate a border which appears at the top of the header and data section"""
    fill_char = '═'

    pre_line = '╔' + self.padding * '═'

    inter_cell = self.padding * '═'
    if self.column_borders:
        inter_cell += "╤"
    inter_cell += self.padding * '═'

    post_line = self.padding * '═' + '╗'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_header_bottom_border 

generate_header_bottom_border()

Generate a border which appears at the bottom of the header

Source code in cmd2/table_creator.py 
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
def generate_header_bottom_border(self) -> str:
    """Generate a border which appears at the bottom of the header"""
    fill_char = '═'

    pre_line = '╠' + self.padding * '═'

    inter_cell = self.padding * '═'
    if self.column_borders:
        inter_cell += '╪'
    inter_cell += self.padding * '═'

    post_line = self.padding * '═' + '╣'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_row_bottom_border 

generate_row_bottom_border()

Generate a border which appears at the bottom of rows

Source code in cmd2/table_creator.py 
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
def generate_row_bottom_border(self) -> str:
    """Generate a border which appears at the bottom of rows"""
    fill_char = '─'

    pre_line = '╟' + self.padding * '─'

    inter_cell = self.padding * '─'
    if self.column_borders:
        inter_cell += '┼'
    inter_cell += self.padding * '─'
    inter_cell = inter_cell

    post_line = self.padding * '─' + '╢'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_table_bottom_border 

generate_table_bottom_border()

Generate a border which appears at the bottom of the table

Source code in cmd2/table_creator.py 
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
def generate_table_bottom_border(self) -> str:
    """Generate a border which appears at the bottom of the table"""
    fill_char = '═'

    pre_line = '╚' + self.padding * '═'

    inter_cell = self.padding * '═'
    if self.column_borders:
        inter_cell += '╧'
    inter_cell += self.padding * '═'

    post_line = self.padding * '═' + '╝'

    return self.generate_row(
        self.empty_data,
        is_header=False,
        fill_char=self.apply_border_color(fill_char),
        pre_line=self.apply_border_color(pre_line),
        inter_cell=self.apply_border_color(inter_cell),
        post_line=self.apply_border_color(post_line),
    )

generate_header 

generate_header()

Generate table header

Source code in cmd2/table_creator.py 
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
def generate_header(self) -> str:
    """Generate table header"""
    fill_char = self.apply_header_bg(SPACE)

    pre_line = self.apply_border_color('║') + self.apply_header_bg(self.padding * SPACE)

    inter_cell = self.apply_header_bg(self.padding * SPACE)
    if self.column_borders:
        inter_cell += self.apply_border_color('│')
    inter_cell += self.apply_header_bg(self.padding * SPACE)

    post_line = self.apply_header_bg(self.padding * SPACE) + self.apply_border_color('║')

    # Apply background color to header text in Columns which allow it
    to_display: List[Any] = []
    for col in self.cols:
        if col.style_header_text:
            to_display.append(self.apply_header_bg(col.header))
        else:
            to_display.append(col.header)

    # Create the bordered header
    header_buf = io.StringIO()
    header_buf.write(self.generate_table_top_border())
    header_buf.write('\n')
    header_buf.write(
        self.generate_row(
            to_display, is_header=True, fill_char=fill_char, pre_line=pre_line, inter_cell=inter_cell, post_line=post_line
        )
    )
    header_buf.write('\n')
    header_buf.write(self.generate_header_bottom_border())

    return header_buf.getvalue()

apply_data_bg 

apply_data_bg(value)

Apply background color to data text based on what row is being generated and whether a color has been defined :param value: object whose text is to be colored :return: formatted data string

PARAMETER DESCRIPTION
value

TYPE: Any

Source code in cmd2/table_creator.py 
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
def apply_data_bg(self, value: Any) -> str:
    """
    Apply background color to data text based on what row is being generated and whether a color has been defined
    :param value: object whose text is to be colored
    :return: formatted data string
    """
    if self.row_num % 2 == 0 and self.even_bg is not None:
        return ansi.style(value, bg=self.even_bg)
    elif self.row_num % 2 != 0 and self.odd_bg is not None:
        return ansi.style(value, bg=self.odd_bg)
    else:
        return str(value)

generate_data_row 

generate_data_row(row_data)

Generate a data row

:param row_data: data with an entry for each column in the row :return: data row string

PARAMETER DESCRIPTION
row_data

TYPE: Sequence[Any]

Source code in cmd2/table_creator.py 
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
def generate_data_row(self, row_data: Sequence[Any]) -> str:
    """
    Generate a data row

    :param row_data: data with an entry for each column in the row
    :return: data row string
    """
    row = super().generate_data_row(row_data)
    self.row_num += 1
    return row

generate_table 

generate_table(table_data, *, include_header=True)

Generate a table from a data set

:param table_data: Data with an entry for each data row of the table. Each entry should have data for each column in the row. :param include_header: If True, then a header will be included at top of table. (Defaults to True)

PARAMETER DESCRIPTION
table_data

TYPE: Sequence[Sequence[Any]]

include_header

TYPE: bool DEFAULT: True

Source code in cmd2/table_creator.py 
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
def generate_table(self, table_data: Sequence[Sequence[Any]], *, include_header: bool = True) -> str:
    """
    Generate a table from a data set

    :param table_data: Data with an entry for each data row of the table. Each entry should have data for
                       each column in the row.
    :param include_header: If True, then a header will be included at top of table. (Defaults to True)
    """
    table_buf = io.StringIO()

    if include_header:
        header = self.generate_header()
        table_buf.write(header)
    else:
        top_border = self.generate_table_top_border()
        table_buf.write(top_border)

    table_buf.write('\n')

    for row_data in table_data:
        row = self.generate_data_row(row_data)
        table_buf.write(row)
        table_buf.write('\n')

    table_buf.write(self.generate_table_bottom_border())
    return table_buf.getvalue()