texttable

Python module to create simple ASCII tables

Availability

This module is available on PyPI, and has been packaged for several Linux/Unix platforms (Debian, FreeBSD, Fedora, Suse...).

Dependencies

If available, cjkwrap library is used instead of textwrap, for a better wrapping of CJK text.

If available, wcwidth library is used for a better rendering (basic emoji support).

Documentation

``` NAME texttable - module to create simple ASCII tables

FILE /usr/local/lib/python2.7/dist-packages/texttable.py

DESCRIPTION

Example:

    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())
    print()

    table = Texttable()
    table.set_deco(Texttable.HEADER)
    table.set_cols_dtype(['t',  # text
                          'f',  # float (decimal)
                          'e',  # float (exponent)
                          'i',  # integer
                          'a']) # automatic
    table.set_cols_align(["l", "r", "r", "r", "l"])
    table.add_rows([["text",    "float", "exp", "int", "auto"],
                    ["abcd",    "67",    654,   89,    128.001],
                    ["efghijk", 67.5434, .654,  89.6,  12800000000000000000000.00023],
                    ["lmn",     5e-78,   5e-78, 89.4,  .000000000000128],
                    ["opqrstu", .023,    5e+78, 92.,   12800000000000000000000]])
    print(table.draw())

Result:

    +----------+-----+----------+
    |   Name   | Age | Nickname |
    +==========+=====+==========+
    | Mr       |     |          |
    | Xavier   |  32 |          |
    | Huon     |     |   Xav'   |
    +----------+-----+----------+
    | Mr       |     |          |
    | Baptiste |   1 |          |
    | Clement  |     |   Baby   |
    +----------+-----+----------+
    | Mme      |     |   Lou    |
    | Louise   |  28 |          |
    | Bourgeau |     |   Loue   |
    +----------+-----+----------+

     text     float       exp      int     auto
    ==============================================
    abcd      67.000   6.540e+02    89   128.001
    efghijk   67.543   6.540e-01    90   1.280e+22
    lmn        0.000   5.000e-78    89   0.000
    opqrstu    0.023   5.000e+78    92   1.280e+22

CLASSES class Texttable | Methods defined here: | | init(self, maxwidth=80) | Constructor | | - maxwidth is an integer, specifying the maximum width of the table | - if set to 0, size is unlimited, therefore cells won't be wrapped | | addrow(self, array) | Add a row in the rows stack | | - cells can contain newlines and tabs | | addrows(self, rows, header=True) | Add several rows in the rows stack | | - The 'rows' argument can be either an iterator returning arrays, | or a by-dimensional array | - 'header' specifies if the first row should be used as the header | of the table | | draw(self) | Draw the table | | - the table is returned as a whole string | | header(self, array) | Specify the header of the table | | reset(self) | Reset the instance | | - reset rows and header | | setchars(self, array) | Set the characters used to draw lines between rows and columns | | - the array should contain 4 fields: | | [horizontal, vertical, corner, header] | | - default is set to: | | ['-', '|', '+', '='] | | setcolsalign(self, array) | Set the desired columns alignment | | - the elements of the array should be either "l", "c" or "r": | | * "l": column flushed left | * "c": column centered | * "r": column flushed right | | setcolsdtype(self, array) | Set the desired columns datatype for the cols. | | - the elements of the array should be either a callable or any of | "a", "t", "f", "e" or "i": | | * "a": automatic (try to use the most appropriate datatype) | * "t": treat as text | * "f": treat as float in decimal format | * "e": treat as float in exponential format | * "i": treat as int | * "b": treat as boolean | * a callable: should return formatted string for any value given | | - by default, automatic datatyping is used for each column | | setcolsvalign(self, array) | Set the desired columns vertical alignment | | - the elements of the array should be either "t", "m" or "b": | | * "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 | | setcolswidth(self, array) | Set the desired columns width | | - the elements of the array should be integers, specifying the | width of each column. For example: | | [10, 20, 5] | | setdeco(self, deco) | Set the table decoration | | - 'deco' can be a combination of: | | 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 of them are enabled by default | | - example: | | Texttable.BORDER | Texttable.HEADER | | setheaderalign(self, array) | Set the desired header alignment | | - the elements of the array should be either "l", "c" or "r": | | * "l": column flushed left | * "c": column centered | * "r": column flushed right | | setmaxwidth(self, maxwidth) | Set the maximum width of the table | | - maxwidth is an integer, specifying the maximum width of the table | - if set to 0, size is unlimited, therefore cells won't be wrapped | | set_precision(self, width) | Set the desired precision for float/exponential formats | | - width must be an integer >= 0 | | - default value is set to 3 | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | BORDER = 1 | | HEADER = 2 | | HLINES = 4 | | VLINES = 8

DATA all = ['Texttable', 'ArraySizeError'] author = 'Gerome Fournier ' credits = 'Jeff Kowalczyk:\n - textwrap improved import\n ...at... license = 'MIT' version = '1.7.0'

VERSION 1.7.0

AUTHOR Gerome Fournier

CREDITS Jeff Kowalczyk: - textwrap improved import - comment concerning header output

Anonymous:
    - add_rows method, for adding rows in one go

Sergey Simonenko:
    - redefined len() function to deal with non-ASCII characters

Roger Lew:
    - columns datatype specifications

Brian Peterson:
    - better handling of unicode errors

Frank Sachsenheim:
    - add Python 2/3-compatibility

Maximilian Hils:
    - fix minor bug for Python 3 compatibility

frinkelpi:
    - preserve empty lines

```

Forks

• latextable is a fork of texttable that provide a LaTeX backend.