LongTable Class Reference

Inheritance diagram for LongTable:

Public Member Functions
def	__init__ (self, columnspecs, caption, format_string, head)
def	add (self, *args, **kwargs)
def	finish (self, tail='')

Public Attributes
	format_string
	python-style format-string used to generate a new row out of a given dictionary.

Detailed Description

Creates a longtable in latex. A longtable can span multiple pages
and is automatically wrapped.

Definition at line 377 of file b2latex.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			columnspecs,
			caption,
			format_string,
			head
	)

Calls super-class init, begins centered environment and longtable environment.
Defines caption and head of the table.
    @param columnspecs of the longtable, something like:
            rclp{7cm} 4 columns, right-center-left aligned and one paragraph column with a width of 7cm
    @param caption string or object with implicit string conversion used as caption.
    @param format_string  python-style format-string used to generate a new row out of a given dictionary.
    @param head of the table

Reimplemented from LatexObject.

Definition at line 383 of file b2latex.py.

    def __init__(self, columnspecs, caption, format_string, head):
        """
        Calls super-class init, begins centered environment and longtable environment.
        Defines caption and head of the table.
            @param columnspecs of the longtable, something like:
                    rclp{7cm} 4 columns, right-center-left aligned and one paragraph column with a width of 7cm
            @param caption string or object with implicit string conversion used as caption.
            @param format_string  python-style format-string used to generate a new row out of a given dictionary.
            @param head of the table
        """
        super().__init__()
        self.output += r"\begin{center}" + '\n'
        self.output += r"\begin{longtable}{" + str(columnspecs) + r"}" + '\n'
        self.output += r"\caption{" + str(caption) + r"}\\" + '\n'
        self.output += r"\toprule" + '\n'
        self.output += head + r"\\" + '\n'
        self.output += r"\midrule" + '\n'
        
        self.format_string = format_string
 

Member Function Documentation

add()

def add	(		self,
		*	args,
		**	kwargs
	)

Add a new row to the longtable by generating the row using the format_string given in init
and the provided dictionary.
    @param args positional arguments used to generate the row using the python-style format string.
    @param kwargs dictionary used to generate the row using the python-style format-string.

Reimplemented from LatexObject.

Definition at line 403 of file b2latex.py.

    def add(self, *args, **kwargs):
        """
        Add a new row to the longtable by generating the row using the format_string given in init
        and the provided dictionary.
            @param args positional arguments used to generate the row using the python-style format string.
            @param kwargs dictionary used to generate the row using the python-style format-string.
        """
        self.output += self.format_string.format(*args, **kwargs) + r"\\" + '\n'
        return self
 

finish()

def finish	(		self,
			tail = ''
	)

Adds optional tail of the table, ends longtable and centered environment.
    @param tail optional tail, like head but at the bottom of the table.

Reimplemented from LatexObject.

Definition at line 413 of file b2latex.py.

    def finish(self, tail=''):
        """
        Adds optional tail of the table, ends longtable and centered environment.
            @param tail optional tail, like head but at the bottom of the table.
        """
        self.output += r"\bottomrule" + '\n'
        if str(tail) != '':
            self.output += str(tail) + r"\\" + '\n'
            self.output += r"\bottomrule" + '\n'
        self.output += r"\end{longtable}" + '\n'
        self.output += r"\end{center}" + '\n'
        return self
 
 

Member Data Documentation

format_string

format_string

python-style format-string used to generate a new row out of a given dictionary.

Definition at line 401 of file b2latex.py.

---

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

• framework/scripts/B2Tools/b2latex.py