texttable Documentation

You can install texttable via PyPI using pip. It is also available in various Linux/Unix package managers like Debian, FreeBSD, Fedora, and Suse.

pip install texttable

To create a table, instantiate the Texttable class, configure its alignment and decoration, add rows using add_rows(), and then call draw() to get the table as a string.

By default, Texttable uses textwrap for wrapping. If the cjkwrap library is installed, it will be used instead for better CJK text wrapping. If wcwidth is installed, it will be used for better emoji rendering.

from texttable import Texttable

table = Texttable()
table.set_cols_align(["l", "r", "c"])
table.set_cols_valign(["t", "m", "b"])
table.add_rows([["Name", "Age", "Nickname"],
                ["Mr\nXavier\nHuon", 32, "Xav'"],
                ["Mr\nBaptiste\nClement", 1, "Baby"],
                ["Mme\nLouise\nBourgeau", 28, "Lou\n\nLoue"]])
print(table.draw())

Use set_deco(deco) to control which lines are drawn. deco is a bitwise combination of the following constants:

• Texttable.BORDER: Border around the table
• Texttable.HEADER: Horizontal line below the header
• Texttable.HLINES: Horizontal lines between rows
• Texttable.VLINES: Vertical lines between columns

All are enabled by default. You can also customize the characters used for drawing with set_chars(array), which expects an array of 4 fields: [horizontal, vertical, corner, header] (default: ['-', '|', '+', '=']).

table.set_deco(Texttable.BORDER | Texttable.HEADER)

Use set_cols_align(array) to set horizontal alignment for each column. Use set_cols_valign(array) to set vertical alignment.

Horizontal Alignment (set_cols_align) options:

• "l": column flushed left
• "c": column centered
• "r": column flushed right

Vertical Alignment (set_cols_valign) options:

• "t": column aligned on the top of the cell
• "m": column aligned on the middle of the cell
• "b": column aligned on the bottom of the cell

table.set_cols_align(["l", "c", "r"])
table.set_cols_valign(["t", "m", "b"])

Control the dimensions of your table using these methods:

• set_max_width(max_width): Sets the maximum width of the entire table. If set to 0, size is unlimited and cells won't be wrapped.
• set_cols_width(array): Sets the specific width for each column using an array of integers (e.g., [10, 20, 5]).

table.set_max_width(80)
table.set_cols_width([10, 20, 5])

Use the following methods to populate the table:

• add_row(array): Adds a single row to the stack. Cells can contain newlines and tabs.
• add_rows(rows, header=True): Adds multiple rows. rows can be an iterator of arrays or a 2D array. The header flag (default True) determines if the first row is treated as the header.
• header(array): Explicitly specifies the header of the table.

table.add_rows([["Col1", "Col2"], ["Val1", "Val2"]], header=True)

Use set_cols_dtype(array) to specify how data in each column should be formatted. Use set_precision(width) to set the decimal precision for float/exponential formats (default is 3).

Data Type (set_cols_dtype) options:

• "a": automatic (tries to use the most appropriate type)
• "t": treat as text
• "f": treat as float in decimal format
• "e": treat as float in exponential format
• "i": treat as integer
• "b": treat as boolean
• callable: a function that returns a formatted string for any given value

table.set_cols_dtype(['t', 'f', 'e', 'i', 'a'])
table.set_precision(2)