tbl.SimpleTable Class Reference

Public Member Functions
	__init__ (self, list[list] data, str headline='', str headline_color='\x1b[37m', str header_color='\x1b[104m')
	CONSTRUCTOR.
	calculateColumnWidth (self)
	Calculate width of each column except the row type column.
	run (self)
	Display the data table.

Static Public Attributes
	data = None
	Two-dimensional data table.
list	cw = None
	Column width list.
	headline = None
	Headline, which is printed before the table.
str	headline_color = '\x1b[37m'
	ANSI ESC-sequence for the header color.
str	header_color = '\x1b[104m'
	ANSI ESC-sequence for the header color.

Detailed Description

Definition at line 58 of file tbl.py.

Constructor & Destructor Documentation

__init__()

tbl.SimpleTable.__init__	(		self,
		list[list]	data,
		str	headline = '',
		str	headline_color = '\x1b[37m',
		str	header_color = '\x1b[104m' )

CONSTRUCTOR.

Parameters

data	List of data row lists to define the table.
headline	Text of the headline shown above the table. Default: Empty str = No headline.
headline_color	ANSI color ESC sequence for the headline. Default: "\x1b[37m". = blue on black background
header_color	ANSI color ESC sequence for the column headers. Default: "\x1b[104m" = white on blue background.

Definition at line 69 of file tbl.py.

    ):
        # Initialize
        self.data = data
        self.headline=headline
        self.headline_color=headline_color
        self.header_color = header_color
        # Check for completeness
        if len(self.data) < 3:
            log.warning('Data table length is less than 3.')
            log.info('To fulfill the table design, it must have header row, separator row and a final separator row.')
            raise ValueError()
        if not isinstance(self.data[0][0], int):
            log.warning('The first column of first row is not as "int".')
            log.info('To fulfill the table design, each row must start with a row type integer constant.')
        if self.data[0][0] != HEADER:
            log.warning('First data row is not the table header.')
            log.info('To fulfil the table design, the table header must be sorted to the first index position.')
        # Check row data and add aesthetical spaces
        row_lengths: list[int] = []
        for i in range(len(self.data)):
            row = self.data[i]
            if self.data[i][0] not in ROW_TYPES:
                log.warning('Found not implemented value "{}" in row type column.'.format(self.data[i][0]))
                log.info('The first value in each row must be in "{}" = "[tbl.HEADER, tbl.SEPARATOR, tbl.DATA]".'.format(ROW_TYPES))
                raise NotImplementedError()
            if self.data[i][0] is SEPARATOR:
                self.data[i] = (
                    [self.data[i][0]]
                    +
                    [None for _ in range(len(self.data[0]) - 1)]
                )
            row_lengths.append(len(self.data[i]))
            if (row[0] != SEPARATOR) and (row_lengths[-1] < 2):
                log.warning('Data row length is less than 2.')
                log.info('Each data and header row must have a row type column and min. 1 data cell column.')
                raise ValueError()
            for j in range(len(row)):
                if j == 0: continue  # Skip row type
                cell = str(data[i][j])
                # Add aesthetical spaces to cell,
                # clone and force as "str".
                if cell is not None:
                    if not cell.startswith(' '):
                        cell = ' ' + str(cell)
                    if not cell.endswith(' '):
                        cell += ' '
                data[i][j] = cell
            # End For
        # End for
        # Check if all rows have the same number of cells
        if not all(item == row_lengths[0] for item in row_lengths):
            log.warning(
                'Length of each row is not identical (see {}).'.format(row_lengths))
            log.info('Check/repair the deviating rows.')
            raise ValueError()
 

Member Function Documentation

calculateColumnWidth()

tbl.SimpleTable.calculateColumnWidth

(

self

)

Calculate width of each column except the row type column.

Store the results in the "self.cw" property.

Definition at line 152 of file tbl.py.

    def calculateColumnWidth(self):
        self.cw = [int(0) for _ in range(len(self.data[0]))]
        # Calculate column with
        for item in self.data:
            if not isinstance(item[0], int):
                log.warning('First item in this row "{}" is not as "int".'.format(item))
                log.info('The first column in each row defines the row type as "int".')
                raise ValueError()
            if item[0] in [1, 3]:
                for i in range(len(self.cw)):
                    if i == 0:
                        continue  # Skip row type
                    else:
                        cc: str = item[i]
                        l = readableLen(cc)
                        if l > self.cw[i]:
                            self.cw[i] = l

run()

tbl.SimpleTable.run

(

self

)

Display the data table.

Definition at line 170 of file tbl.py.

    def run(self):
        print('\n{}{}\x1b[0m\n'.format(
            self.headline_color,
            self.headline
        ))
        self.calculateColumnWidth()
        for row in self.data:
            if row[0] == HEADER:
                row_str = ''
                for i in range(len(row)):
                    if i == 0:
                        continue  # Skip row type
                    else:
                        row_str += '{}{}{}\x1b[0m'.format(
                            self.header_color,
                            row[i],
                            ' ' * (self.cw[i] - len(row[i])),
                        )
                        if i < len(row) - 1:
                            row_str += ' '
                # End for
                print(row_str)
            elif row[0] == SEPARATOR:
                row_width = sum(self.cw[1:]) + len(self.cw) - 2
                row_str = '-' * row_width
                print(row_str)
            elif row[0] == DATA:
                row_str = ''
                for i in range(len(row)):
                    if i == 0:
                        continue  # Skip row type
                    else:
                        row_str += '{}{}'.format(
                            row[i],
                            ' ' * (self.cw[i] - readableLen(row[i])),
                        )
                        if i < len(row) - 1:
                            row_str += ' '
                # End for
                print(row_str)
            # End if
        # End for
 
 
# --- END OF CODE ------------------------------------------------------
 

Member Data Documentation

data

tbl.SimpleTable.data = None

static

Two-dimensional data table.

Default: None.

Definition at line 133 of file tbl.py.

cw

tbl.SimpleTable.cw = None

static

Column width list.

Default: None.

Definition at line 137 of file tbl.py.

headline

tbl.SimpleTable.headline = None

static

Headline, which is printed before the table.

Definition at line 140 of file tbl.py.

headline_color

tbl.SimpleTable.headline_color = '\x1b[37m'

static

ANSI ESC-sequence for the header color.

Default: "\x1b[37m".

Definition at line 144 of file tbl.py.

header_color

str tbl.SimpleTable.header_color = '\x1b[104m'

static

ANSI ESC-sequence for the header color.

Default: "\x1b[104m".

Definition at line 148 of file tbl.py.

---

The documentation for this class was generated from the following file:

• bin/lib/tbl.py