Skip to content

Table Class

A simple ASCII table generator.

Parameters:

Name Type Description Default
data List[List[str | int]]

A 2D list representing table headers and rows.

 required
Source code in tableascii/core.py 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
class Table:
    """
    A simple ASCII table generator.

    Args:
        data (List[List[str|int]]): A 2D list representing table headers and rows.
    """

    def __init__(self, data):
        self.header = data[0]
        self.rows = data[1:]
        self.data = data
        # self.columns = [[d[i] for d in data] for i in range(self.col_num)]
        self.width = self.col_num - 1

    @property
    def col_num(self):
        """Number of columns"""
        return len(self.header)

    @property
    def col_width(self):
        "Width of each column"
        return [[len(str(d[i])) for d in self.data] for i in range(self.col_num)]

    def create(self) -> str:
        """Creates the table"""
        output = []
        c = {}
        for i, col_w in enumerate(self.col_width):
            mx_w = max(col_w)
            c[f'c_{i+1}'] = mx_w
            self.width += mx_w + 2

        output.append("+" + "-" * self.width + "+")
        row_fmt = "| " + " | ".join(["{:<{c_%d}}" % (i + 1) for i in range(self.col_num)]) + " |"
        output.append(row_fmt.format(*self.header, **c))
        output.append("|" + "-" * self.width + "|")

        for row in self.rows:
            row_fmt = "| " + " | ".join(["{:<{c_%d}}" % (i + 1) for i in range(self.col_num)]) + " |"
            output.append(row_fmt.format(*row, **c))

        output.append("+" + "-" * self.width + "+")

        return '\n'.join(output)

    def display(self):
        """Prints the table"""
        return print(self.create())

col_num property

Number of columns

col_width property

Width of each column

create()

Creates the table

Source code in tableascii/core.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def create(self) -> str:
    """Creates the table"""
    output = []
    c = {}
    for i, col_w in enumerate(self.col_width):
        mx_w = max(col_w)
        c[f'c_{i+1}'] = mx_w
        self.width += mx_w + 2

    output.append("+" + "-" * self.width + "+")
    row_fmt = "| " + " | ".join(["{:<{c_%d}}" % (i + 1) for i in range(self.col_num)]) + " |"
    output.append(row_fmt.format(*self.header, **c))
    output.append("|" + "-" * self.width + "|")

    for row in self.rows:
        row_fmt = "| " + " | ".join(["{:<{c_%d}}" % (i + 1) for i in range(self.col_num)]) + " |"
        output.append(row_fmt.format(*row, **c))

    output.append("+" + "-" * self.width + "+")

    return '\n'.join(output)

display()

Prints the table

Source code in tableascii/core.py 
48
49
50
def display(self):
    """Prints the table"""
    return print(self.create())