Pretty-print tabular data
Pretty-print tabular data in Python.
The main use cases of the library are:
pip install tabulate
The module provides just one function, tabulate, which takes alist of lists or another tabular data type as the first argument,and outputs a nicely formatted plain-text table:
>>> from tabulate import tabulate >>> table = [["Sun",696000,1989100000],["Earth",6371,5973.6], ... ["Moon",1737,73.5],["Mars",3390,641.85]] >>> print tabulate(table) ----- ------ ------------- Sun 696000 1.9891e+09 Earth 6371 5973.6 Moon 1737 73.5 Mars 3390 641.85 ----- ------ -------------
The following tabular data types are supported:
Examples in this file use Python2. Tabulate supports Python3 too (Python >= 3.3).
The second optional argument named headers defines a list ofcolumn headers to be used:
>>> print tabulate(table, headers=["Planet","R (km)", "mass (x 10^29 kg)"]) Planet R (km) mass (x 10^29 kg) -------- -------- ------------------- Sun 696000 1.9891e+09 Earth 6371 5973.6 Moon 1737 73.5 Mars 3390 641.85
If headers="firstrow", then the first row of data is used:
>>> print tabulate([["Name","Age"],["Alice",24],["Bob",19]], ... headers="firstrow") Name Age ------ ----- Alice 24 Bob 19
If headers="keys", then the keys of a dictionary/dataframe,or column indices are used:
>>> print tabulate({"Name": ["Alice", "Bob"], ... "Age": [24, 19]}, headers="keys") Age Name ----- ------ 24 Alice 19 Bob
There is more than one way to format a table in plain text.The third optional argument namedtablefmt defineshow the table is formatted.
Supported table formats are:
plain tables do not use any pseudo-graphics to draw lines:
>>> table = [["spam",42],["eggs",451],["bacon",0]] >>> headers = ["item", "qty"] >>> print tabulate(table, headers, tablefmt="plain") item qty spam 42 eggs 451 bacon 0
simple is the default format (the default may change in futureversions). It corresponds tosimple_tables in Pandoc Markdownextensions:
>>> print tabulate(table, headers, tablefmt="simple") item qty ------ ----- spam 42 eggs 451 bacon 0
grid is like tables formatted by Emacs' table.elpackage. It corresponds to grid_tables in Pandoc Markdownextensions:
>>> print tabulate(table, headers, tablefmt="grid") +--------+-------+ | item | qty | +========+=======+ | spam | 42 | +--------+-------+ | eggs | 451 | +--------+-------+ | bacon | 0 | +--------+-------+
pipe follows the conventions of PHP Markdown Extra extension. Itcorresponds topipe_tables in Pandoc. This format uses colons toindicate column alignment:
>>> print tabulate(table, headers, tablefmt="pipe") | item | qty | |:-------|------:| | spam | 42 | | eggs | 451 | | bacon | 0 |
orgtbl follows the conventions of Emacs org-mode, and is editablealso in the minor orgtbl-mode. Hence its name:
>>> print tabulate(table, headers, tablefmt="orgtbl") | item | qty | |--------+-------| | spam | 42 | | eggs | 451 | | bacon | 0 |
rst formats data like a simple table of the reStructuredText format:
>>> print tabulate(table, headers, tablefmt="rst") ====== ===== item qty ====== ===== spam 42 eggs 451 bacon 0 ====== =====
mediawiki format produces a table markup used inWikipedia and onother MediaWiki-based sites:
>>> print tabulate(table, headers, tablefmt="mediawiki") {| class="wikitable" style="text-align: left;" |+ <!-- caption --> |- ! item !! align="right"| qty |- | spam || align="right"| 42 |- | eggs || align="right"| 451 |- | bacon || align="right"| 0 |}
tabulate is smart about column alignment. It detects columns whichcontain only numbers, and aligns them by a decimal point (or flushesthem to the right if they appear to be integers). Text columns areflushed to the left.
You can override the default alignment with numalign andstralign named arguments. Possible column alignments are:right,center,left, decimal (only for numbers).
Aligning by a decimal point works best when you need to comparenumbers at a glance:
>>> print tabulate([[1.2345],[123.45],[12.345],[12345],[1234.5]]) ---------- 1.2345 123.45 12.345 12345 1234.5 ----------
Compare this with a more common right alignment:
>>> print tabulate([[1.2345],[123.45],[12.345],[12345],[1234.5]], numalign="right") ------ 1.2345 123.45 12.345 12345 1234.5 ------
For tabulate, anything which can be parsed as a number is anumber. Even numbers represented as strings are aligned properly. Thisfeature comes in handy when reading a mixed table of text and numbersfrom a file:
>>> import csv ; from StringIO import StringIO >>> table = list(csv.reader(StringIO("spam, 42\neggs, 451\n"))) >>> table [['spam', ' 42'], ['eggs', ' 451']] >>> print tabulate(table) ---- ---- spam 42 eggs 451 ---- ----
tabulate allows to define custom number formatting applied to allcolumns of decimal numbers. Usefloatfmt named argument:
>>> print tabulate([["pi",3.141593],["e",2.718282]], floatfmt=".4f") -- ------ pi 3.1416 e 2.7183 -- ------
Such features as decimal point alignment and trying to parse everythingas a number imply thattabulate:
It may not be suitable for serializing really big tables (but who'sgoing to do that, anyway?) or printing tables in performance sensitiveapplications.tabulate is about two orders of magnitude slowerthan simply joining lists of values with a tab, coma or otherseparator.
In the same time tabulate is comparable to other tablepretty-printers. Given a 10x10 table (a list of lists) of mixed textand numeric data,tabulate appears to be slower thanasciitable, and faster thanPrettyTable and texttable
=========================== ========== =========== Table formatter time, μs rel. time =========================== ========== =========== join with tabs and newlines 34.7 1.0 csv to StringIO 49.1 1.4 asciitable (0.8.0) 1272.1 36.7 tabulate (0.6) 1964.5 56.6 PrettyTable (0.7.1) 5678.9 163.7 texttable (0.8.1) 6005.2 173.1 =========================== ========== ===========
File | Type | Py Version | Uploaded on | Size | |
---|---|---|---|---|---|
tabulate-0.6.tar.gz (md5) | Source | 2013-08-09 | 14KB | ||