terminaltables 2.0.0

Simple Usage

from terminaltables import AsciiTable
table_data = [
    ['Heading1', 'Heading2'],
    ['row1 column1', 'row1 column2'],
    ['row2 column1', 'row2 column2'],
    ['row3 column1', 'row3 column2']
]
table = AsciiTable(table_data)
print table.table
+--------------+--------------+
| Heading1     | Heading2     |
+--------------+--------------+
| row1 column1 | row1 column2 |
| row2 column1 | row2 column2 |
| row3 column1 | row3 column2 |
+--------------+--------------+

table_data is a list of lists of strings. The outer list represents the whole table, while the inner lists represents rows. Each row-list holds strings which are the cells of that row.

The first row can be though of the heading, but it doesn’t have to be. You can turn off the heading separator (the only thing that makes the first row a “heading” row) by setting table.inner_heading_row_border = False.

table.inner_heading_row_border = False
print table.table
+--------------+--------------+
| Heading1     | Heading2     |
| row1 column1 | row1 column2 |
| row2 column1 | row2 column2 |
| row3 column1 | row3 column2 |
+--------------+--------------+

Sometimes the last row can be though of a total (summary) row, by default it isn’t. You can turn on the las row separator (the only thing that makes the last row a “total” row) by setting table.inner_footing_row_border = True.

table.inner_heading_row_border = True
table.inner_footing_row_border = True
print table.table
+--------------+--------------+
| Heading1     | Heading2     |
+--------------+--------------+
| row1 column1 | row1 column2 |
| row2 column1 | row2 column2 |
+--------------+--------------+
| row3 column1 | row3 column2 |
+--------------+--------------+

If you want to add colors or bold the heading row, you’ll have to do that yourself. Keep in mind that terminaltables relies on len() and other methods for calculating table borders. I suggest looking at colorclass for supporting colors in terminaltables since it handles color string lengths correctly.

Class Attributes

You can instantiate with AsciiTable(table_data) or AsciiTable(table_data, 'Table Title'). These are available after instantiating any table class.

Class Methods

These are regular methods available in either class.

Class Properties

These are read-only properties after you instantiate either class. They are “real-time”. You do not have to re-instantiate if you change any of the class attributes, including table_data.

2.0.0 - 2015-10-11

Changed

• Refactored code. No new features.

• Breaking changes: UnixTable/WindowsTable/WindowsTableDouble moved. Use SingleTable/DoubleTable instead.

1.2.1 - 2015-09-03

Fixed

• CJK character width fixed by zqqf16 and bcho: https://github.com/Robpol86/terminaltables/pull/9

1.2.0 - 2015-05-31

Added

• Bottom row separator.

1.1.1 - 2014-11-03

Fixed

• Python 2.7 64-bit terminal width bug on Windows.

1.1.0 - 2014-11-02

Added

• Windows support.

• Double-lined table.

1.0.2 - 2014-09-18

Added

• table_width and ok properties.

1.0.1 - 2014-09-12

Added

• Terminal width/height defaults for testing.

• terminaltables.DEFAULT_TERMINAL_WIDTH

• terminaltables.DEFAULT_TERMINAL_HEIGHT

1.0.0 - 2014-09-11

• Initial release.