TablePrinter Class Reference

Public Member Functions
	__init__ (self, ncols, width=None)
	tot_width (self)
	print_divider (self, char="=")
	print (self, cols)

Public Attributes
	ncols = ncols
	the number of columns
list	widths = [width] * ncols
	width of each column

Detailed Description

 A tiny class to print columns of fixed width numbers. 

Definition at line 713 of file validationcomparison.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			ncols,
			width = None )

Constructor.
@param ncols: Number of columns
@param width: Width of each column. Either int or list.

Definition at line 716 of file validationcomparison.py.

    def __init__(self, ncols, width=None):
        """
        Constructor.
        @param ncols: Number of columns
        @param width: Width of each column. Either int or list.
        """
        
        self.ncols = ncols
        if not width:
            width = 10
        if isinstance(width, int):
            
            self.widths = [width] * ncols
        elif isinstance(width, list) or isinstance(width, tuple):
            # let's hope this is a list then.
            self.widths = width
 

Member Function Documentation

print()

print	(		self,
			cols )

 Print one row 

Definition at line 751 of file validationcomparison.py.

    def print(self, cols):
        """ Print one row """
        assert len(cols) == self.ncols
        out = []
        for icol, col in enumerate(cols):
            width = self.widths[icol]
            if isinstance(col, int):
                form = f"{{:{width}d}}"
                out.append(form.format(col))
            elif isinstance(col, float):
                form = f"{{:{width}.{width // 2}f}}"
                out.append(form.format(col))
            else:
                # convert everything else to a string if it isn't already
                col = str(col)
                col = col[:width].rjust(width)
                out.append(col)
        print("| " + " | ".join(out) + " |")
 
 

print_divider()

print_divider	(		self,
			char = "=" )

 Print a divider made up from repeated chars 

Definition at line 745 of file validationcomparison.py.

    def print_divider(self, char="="):
        """ Print a divider made up from repeated chars """
        # \cond false positive doxygen warning
        print(char * self.tot_width)
        # \endcond
 

tot_width()

tot_width

(

self

)

 Total width of the table 

Definition at line 734 of file validationcomparison.py.

    def tot_width(self):
        """ Total width of the table """
        width = 0
        # the widths of each column
        width += sum(self.widths)
        # three characters between each two columns
        width += (self.ncols - 1) * 3
        # 2 characters at the very left and right
        width += 2 * 2
        return width
 

Member Data Documentation

ncols

ncols = ncols

the number of columns

Definition at line 723 of file validationcomparison.py.

widths

list widths = [width] * ncols

width of each column

Definition at line 728 of file validationcomparison.py.

---

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

• validation/scripts/validationcomparison.py