cement.ext.ext_tabulate

Cement Tabulate extension module.

Note This extension has an external dependency on tabulate. Cement explicitly does not include external dependencies for optional extensions.

• In Cement >=3.0.8 you must include cement[tabulate] in your applications dependencies.

• In Cement <3.0.8 you must include tabulate in your applications dependencies.

class cement.ext.ext_tabulate.TabulateOutputHandler(**kw: Any)

Bases: OutputHandler

This class implements the Output Handler interface. It provides tabularized text output using the Tabulate module. Please see the developer documentation on Output Handling.

class Meta

Bases: Meta

Handler meta-data.

float_format = 'g'

String format to use for float values.

format = 'orgtbl'

Default template format. See the tabulate documentation for all supported template formats.

headers: List[str] = []

Default headers to use.

label: str = 'tabulate'

The string identifier of this handler.

missing_value = ''

Default replacement for missing value.

numeric_alignment = 'decimal'

Default alignment for numeric columns. See the tabulate documentation for all supported numalign options.

overridable: bool = False

Whether or not to include tabulate as an available to choice to override the output_handler via command line options.

padding = True

Whether or not to pad the output with an extra pre/post ‘n’

string_alignment = 'left'

Default alignment for string columns. See the tabulate documentation for all supported stralign options.

render(data: Dict[str, Any], **kw: Any) → str

Take a data dictionary and render it into a table. Additional keyword arguments are passed directly to tabulate.tabulate.

Parameters:

data_dict (dict) – The data dictionary to render.

Returns:

The rendered template text

Return type:

str