{"author":"","author_email":"Sergey Astanin ","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Software Development :: Libraries"],"description":"python-tabulate\n===============\n\nPretty-print tabular data in Python, a library and a command-line\nutility.\n\nThe main use cases of the library are:\n\n- printing small tables without hassle: just one function call,\n formatting is guided by the data itself\n- authoring tabular data for lightweight plain-text markup: multiple\n output formats suitable for further editing or transformation\n- readable presentation of mixed textual and numeric data: smart\n column alignment, configurable number formatting, alignment by a\n decimal point\n\nInstallation\n------------\n\nTo install the Python library and the command line utility, run:\n\n```shell\npip install tabulate\n```\n\nThe command line utility will be installed as `tabulate` to `bin` on\nLinux (e.g. `/usr/bin`); or as `tabulate.exe` to `Scripts` in your\nPython installation on Windows (e.g. `C:\\Python39\\Scripts\\tabulate.exe`).\n\nYou may consider installing the library only for the current user:\n\n```shell\npip install tabulate --user\n```\n\nIn this case the command line utility will be installed to\n`~/.local/bin/tabulate` on Linux and to\n`%APPDATA%\\Python\\Scripts\\tabulate.exe` on Windows.\n\nTo install just the library on Unix-like operating systems:\n\n```shell\nTABULATE_INSTALL=lib-only pip install tabulate\n```\n\nOn Windows:\n\n```shell\nset TABULATE_INSTALL=lib-only\npip install tabulate\n```\n\nBuild status\n------------\n\n[![Build status](https://circleci.com/gh/astanin/python-tabulate.svg?style=svg)](https://circleci.com/gh/astanin/python-tabulate/tree/master) [![Build status](https://ci.appveyor.com/api/projects/status/8745yksvvol7h3d7/branch/master?svg=true)](https://ci.appveyor.com/project/astanin/python-tabulate/branch/master)\n\nLibrary usage\n-------------\n\nThe module provides just one function, `tabulate`, which takes a list of\nlists or another tabular data type as the first argument, and outputs a\nnicely formatted plain-text table:\n\n```pycon\n>>> from tabulate import tabulate\n\n>>> table = [[\"Sun\",696000,1989100000],[\"Earth\",6371,5973.6],\n... [\"Moon\",1737,73.5],[\"Mars\",3390,641.85]]\n>>> print(tabulate(table))\n----- ------ -------------\nSun 696000 1.9891e+09\nEarth 6371 5973.6\nMoon 1737 73.5\nMars 3390 641.85\n----- ------ -------------\n```\n\nThe following tabular data types are supported:\n\n- list of lists or another iterable of iterables\n- list or another iterable of dicts (keys as columns)\n- dict of iterables (keys as columns)\n- list of dataclasses (Python 3.7+ only, field names as columns)\n- two-dimensional NumPy array\n- NumPy record arrays (names as columns)\n- pandas.DataFrame\n\nTabulate is a Python3 library.\n\n### Headers\n\nThe second optional argument named `headers` defines a list of column\nheaders to be used:\n\n```pycon\n>>> print(tabulate(table, headers=[\"Planet\",\"R (km)\", \"mass (x 10^29 kg)\"]))\nPlanet R (km) mass (x 10^29 kg)\n-------- -------- -------------------\nSun 696000 1.9891e+09\nEarth 6371 5973.6\nMoon 1737 73.5\nMars 3390 641.85\n```\n\nIf `headers=\"firstrow\"`, then the first row of data is used:\n\n```pycon\n>>> print(tabulate([[\"Name\",\"Age\"],[\"Alice\",24],[\"Bob\",19]],\n... headers=\"firstrow\"))\nName Age\n------ -----\nAlice 24\nBob 19\n```\n\nIf `headers=\"keys\"`, then the keys of a dictionary/dataframe, or column\nindices are used. It also works for NumPy record arrays and lists of\ndictionaries or named tuples:\n\n```pycon\n>>> print(tabulate({\"Name\": [\"Alice\", \"Bob\"],\n... \"Age\": [24, 19]}, headers=\"keys\"))\n Age Name\n----- ------\n 24 Alice\n 19 Bob\n```\n\n### Row Indices\n\nBy default, only pandas.DataFrame tables have an additional column\ncalled row index. To add a similar column to any other type of table,\npass `showindex=\"always\"` or `showindex=True` argument to `tabulate()`.\nTo suppress row indices for all types of data, pass `showindex=\"never\"`\nor `showindex=False`. To add a custom row index column, pass\n`showindex=rowIDs`, where `rowIDs` is some iterable:\n\n```pycon\n>>> print(tabulate([[\"F\",24],[\"M\",19]], showindex=\"always\"))\n- - --\n0 F 24\n1 M 19\n- - --\n```\n\n### Table format\n\nThere is more than one way to format a table in plain text. The third\noptional argument named `tablefmt` defines how the table is formatted.\n\nSupported table formats are:\n\n- \"plain\"\n- \"simple\"\n- \"github\"\n- \"grid\"\n- \"simple\\_grid\"\n- \"rounded\\_grid\"\n- \"heavy\\_grid\"\n- \"mixed\\_grid\"\n- \"double\\_grid\"\n- \"fancy\\_grid\"\n- \"outline\"\n- \"simple\\_outline\"\n- \"rounded\\_outline\"\n- \"heavy\\_outline\"\n- \"mixed\\_outline\"\n- \"double\\_outline\"\n- \"fancy\\_outline\"\n- \"pipe\"\n- \"orgtbl\"\n- \"asciidoc\"\n- \"jira\"\n- \"presto\"\n- \"pretty\"\n- \"psql\"\n- \"rst\"\n- \"mediawiki\"\n- \"moinmoin\"\n- \"youtrack\"\n- \"html\"\n- \"unsafehtml\"\n- \"latex\"\n- \"latex\\_raw\"\n- \"latex\\_booktabs\"\n- \"latex\\_longtable\"\n- \"textile\"\n- \"tsv\"\n\n`plain` tables do not use any pseudo-graphics to draw lines:\n\n```pycon\n>>> table = [[\"spam\",42],[\"eggs\",451],[\"bacon\",0]]\n>>> headers = [\"item\", \"qty\"]\n>>> print(tabulate(table, headers, tablefmt=\"plain\"))\nitem qty\nspam 42\neggs 451\nbacon 0\n```\n\n`simple` is the default format (the default may change in future\nversions). It corresponds to `simple_tables` in [Pandoc Markdown\nextensions](http://johnmacfarlane.net/pandoc/README.html#tables):\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"simple\"))\nitem qty\n------ -----\nspam 42\neggs 451\nbacon 0\n```\n\n`github` follows the conventions of GitHub flavored Markdown. It\ncorresponds to the `pipe` format without alignment colons:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"github\"))\n| item | qty |\n|--------|-------|\n| spam | 42 |\n| eggs | 451 |\n| bacon | 0 |\n```\n\n`grid` is like tables formatted by Emacs'\n[table.el](http://table.sourceforge.net/) package. It corresponds to\n`grid_tables` in Pandoc Markdown extensions:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"grid\"))\n+--------+-------+\n| item | qty |\n+========+=======+\n| spam | 42 |\n+--------+-------+\n| eggs | 451 |\n+--------+-------+\n| bacon | 0 |\n+--------+-------+\n```\n\n`simple_grid` draws a grid using single-line box-drawing characters:\n\n >>> print(tabulate(table, headers, tablefmt=\"simple_grid\"))\n ┌────────┬───────┐\n │ item │ qty │\n ├────────┼───────┤\n │ spam │ 42 │\n ├────────┼───────┤\n │ eggs │ 451 │\n ├────────┼───────┤\n │ bacon │ 0 │\n └────────┴───────┘\n\n`rounded_grid` draws a grid using single-line box-drawing characters with rounded corners:\n\n >>> print(tabulate(table, headers, tablefmt=\"rounded_grid\"))\n ╭────────┬───────╮\n │ item │ qty │\n ├────────┼───────┤\n │ spam │ 42 │\n ├────────┼───────┤\n │ eggs │ 451 │\n ├────────┼───────┤\n │ bacon │ 0 │\n ╰────────┴───────╯\n\n`heavy_grid` draws a grid using bold (thick) single-line box-drawing characters:\n\n >>> print(tabulate(table, headers, tablefmt=\"heavy_grid\"))\n ┏━━━━━━━━┳━━━━━━━┓\n ┃ item ┃ qty ┃\n ┣━━━━━━━━╋━━━━━━━┫\n ┃ spam ┃ 42 ┃\n ┣━━━━━━━━╋━━━━━━━┫\n ┃ eggs ┃ 451 ┃\n ┣━━━━━━━━╋━━━━━━━┫\n ┃ bacon ┃ 0 ┃\n ┗━━━━━━━━┻━━━━━━━┛\n\n`mixed_grid` draws a grid using a mix of light (thin) and heavy (thick) lines box-drawing characters:\n\n >>> print(tabulate(table, headers, tablefmt=\"mixed_grid\"))\n ┍━━━━━━━━┯━━━━━━━┑\n │ item │ qty │\n ┝━━━━━━━━┿━━━━━━━┥\n │ spam │ 42 │\n ├────────┼───────┤\n │ eggs │ 451 │\n ├────────┼───────┤\n │ bacon │ 0 │\n ┕━━━━━━━━┷━━━━━━━┙\n\n`double_grid` draws a grid using double-line box-drawing characters:\n\n >>> print(tabulate(table, headers, tablefmt=\"double_grid\"))\n ╔════════╦═══════╗\n ║ item ║ qty ║\n ╠════════╬═══════╣\n ║ spam ║ 42 ║\n ╠════════╬═══════╣\n ║ eggs ║ 451 ║\n ╠════════╬═══════╣\n ║ bacon ║ 0 ║\n ╚════════╩═══════╝\n\n`fancy_grid` draws a grid using a mix of single and\n double-line box-drawing characters:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"fancy_grid\"))\n╒════════╤═══════╕\n│ item │ qty │\n╞════════╪═══════╡\n│ spam │ 42 │\n├────────┼───────┤\n│ eggs │ 451 │\n├────────┼───────┤\n│ bacon │ 0 │\n╘════════╧═══════╛\n```\n\n`outline` is the same as the `grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"outline\"))\n +--------+-------+\n | item | qty |\n +========+=======+\n | spam | 42 |\n | eggs | 451 |\n | bacon | 0 |\n +--------+-------+\n\n`simple_outline` is the same as the `simple_grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"simple_outline\"))\n ┌────────┬───────┐\n │ item │ qty │\n ├────────┼───────┤\n │ spam │ 42 │\n │ eggs │ 451 │\n │ bacon │ 0 │\n └────────┴───────┘\n\n`rounded_outline` is the same as the `rounded_grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"rounded_outline\"))\n ╭────────┬───────╮\n │ item │ qty │\n ├────────┼───────┤\n │ spam │ 42 │\n │ eggs │ 451 │\n │ bacon │ 0 │\n ╰────────┴───────╯\n\n`heavy_outline` is the same as the `heavy_grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"heavy_outline\"))\n ┏━━━━━━━━┳━━━━━━━┓\n ┃ item ┃ qty ┃\n ┣━━━━━━━━╋━━━━━━━┫\n ┃ spam ┃ 42 ┃\n ┃ eggs ┃ 451 ┃\n ┃ bacon ┃ 0 ┃\n ┗━━━━━━━━┻━━━━━━━┛\n\n`mixed_outline` is the same as the `mixed_grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"mixed_outline\"))\n ┍━━━━━━━━┯━━━━━━━┑\n │ item │ qty │\n ┝━━━━━━━━┿━━━━━━━┥\n │ spam │ 42 │\n │ eggs │ 451 │\n │ bacon │ 0 │\n ┕━━━━━━━━┷━━━━━━━┙\n\n`double_outline` is the same as the `double_grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"double_outline\"))\n ╔════════╦═══════╗\n ║ item ║ qty ║\n ╠════════╬═══════╣\n ║ spam ║ 42 ║\n ║ eggs ║ 451 ║\n ║ bacon ║ 0 ║\n ╚════════╩═══════╝\n\n`fancy_outline` is the same as the `fancy_grid` format but doesn't draw lines between rows:\n\n >>> print(tabulate(table, headers, tablefmt=\"fancy_outline\"))\n ╒════════╤═══════╕\n │ item │ qty │\n ╞════════╪═══════╡\n │ spam │ 42 │\n │ eggs │ 451 │\n │ bacon │ 0 │\n ╘════════╧═══════╛\n\n`presto` is like tables formatted by Presto cli:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"presto\"))\n item | qty\n--------+-------\n spam | 42\n eggs | 451\n bacon | 0\n```\n\n`pretty` attempts to be close to the format emitted by the PrettyTables\nlibrary:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"pretty\"))\n+-------+-----+\n| item | qty |\n+-------+-----+\n| spam | 42 |\n| eggs | 451 |\n| bacon | 0 |\n+-------+-----+\n```\n\n`psql` is like tables formatted by Postgres' psql cli:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"psql\"))\n+--------+-------+\n| item | qty |\n|--------+-------|\n| spam | 42 |\n| eggs | 451 |\n| bacon | 0 |\n+--------+-------+\n```\n\n`pipe` follows the conventions of [PHP Markdown\nExtra](http://michelf.ca/projects/php-markdown/extra/#table) extension.\nIt corresponds to `pipe_tables` in Pandoc. This format uses colons to\nindicate column alignment:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"pipe\"))\n| item | qty |\n|:-------|------:|\n| spam | 42 |\n| eggs | 451 |\n| bacon | 0 |\n```\n\n`asciidoc` formats data like a simple table of the\n[AsciiDoctor](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#tables)\nformat:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"asciidoc\"))\n[cols=\"8<,7>\",options=\"header\"]\n|====\n| item | qty\n| spam | 42\n| eggs | 451\n| bacon | 0\n|====\n```\n\n`orgtbl` follows the conventions of Emacs\n[org-mode](http://orgmode.org/manual/Tables.html), and is editable also\nin the minor orgtbl-mode. Hence its name:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"orgtbl\"))\n| item | qty |\n|--------+-------|\n| spam | 42 |\n| eggs | 451 |\n| bacon | 0 |\n```\n\n`jira` follows the conventions of Atlassian Jira markup language:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"jira\"))\n|| item || qty ||\n| spam | 42 |\n| eggs | 451 |\n| bacon | 0 |\n```\n\n`rst` formats data like a simple table of the\n[reStructuredText](http://docutils.sourceforge.net/docs/user/rst/quickref.html#tables)\nformat:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"rst\"))\n====== =====\nitem qty\n====== =====\nspam 42\neggs 451\nbacon 0\n====== =====\n```\n\n`mediawiki` format produces a table markup used in\n[Wikipedia](http://www.mediawiki.org/wiki/Help:Tables) and on other\nMediaWiki-based sites:\n\n ```pycon\n>>> print(tabulate(table, headers, tablefmt=\"mediawiki\"))\n{| class=\"wikitable\" style=\"text-align: left;\"\n|+ \n|-\n! item !! align=\"right\"| qty\n|-\n| spam || align=\"right\"| 42\n|-\n| eggs || align=\"right\"| 451\n|-\n| bacon || align=\"right\"| 0\n|}\n```\n\n`moinmoin` format produces a table markup used in\n[MoinMoin](https://moinmo.in/) wikis:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"moinmoin\"))\n|| ''' item ''' || ''' quantity ''' ||\n|| spam || 41.999 ||\n|| eggs || 451 ||\n|| bacon || ||\n```\n\n`youtrack` format produces a table markup used in Youtrack tickets:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"youtrack\"))\n|| item || quantity ||\n| spam | 41.999 |\n| eggs | 451 |\n| bacon | |\n```\n\n`textile` format produces a table markup used in\n[Textile](http://redcloth.org/hobix.com/textile/) format:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"textile\"))\n|_. item |_. qty |\n|<. spam |>. 42 |\n|<. eggs |>. 451 |\n|<. bacon |>. 0 |\n```\n\n`html` produces standard HTML markup as an html.escape'd str\nwith a ._repr_html_ method so that Jupyter Lab and Notebook display the HTML\nand a .str property so that the raw HTML remains accessible.\n`unsafehtml` table format can be used if an unescaped HTML is required:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"html\"))\n\n\n\n\n\n\n\n

item	qty
spam	42
eggs	451
bacon	0

\n```\n\n`latex` format creates a `tabular` environment for LaTeX markup,\nreplacing special characters like `_` or `\\` to their LaTeX\ncorrespondents:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"latex\"))\n\\begin{tabular}{lr}\n\\hline\n item & qty \\\\\n\\hline\n spam & 42 \\\\\n eggs & 451 \\\\\n bacon & 0 \\\\\n\\hline\n\\end{tabular}\n```\n\n`latex_raw` behaves like `latex` but does not escape LaTeX commands and\nspecial characters.\n\n`latex_booktabs` creates a `tabular` environment for LaTeX markup using\nspacing and style from the `booktabs` package.\n\n`latex_longtable` creates a table that can stretch along multiple pages,\nusing the `longtable` package.\n\n### Column alignment\n\n`tabulate` is smart about column alignment. It detects columns which\ncontain only numbers, and aligns them by a decimal point (or flushes\nthem to the right if they appear to be integers). Text columns are\nflushed to the left.\n\nYou can override the default alignment with `numalign` and `stralign`\nnamed arguments. Possible column alignments are: `right`, `center`,\n`left`, `decimal` (only for numbers), and `None` (to disable alignment).\n\nAligning by a decimal point works best when you need to compare numbers\nat a glance:\n\n```pycon\n>>> print(tabulate([[1.2345],[123.45],[12.345],[12345],[1234.5]]))\n----------\n 1.2345\n 123.45\n 12.345\n12345\n 1234.5\n----------\n```\n\nCompare this with a more common right alignment:\n\n```pycon\n>>> print(tabulate([[1.2345],[123.45],[12.345],[12345],[1234.5]], numalign=\"right\"))\n------\n1.2345\n123.45\n12.345\n 12345\n1234.5\n------\n```\n\nFor `tabulate`, anything which can be parsed as a number is a number.\nEven numbers represented as strings are aligned properly. This feature\ncomes in handy when reading a mixed table of text and numbers from a\nfile:\n\n```pycon\n>>> import csv ; from StringIO import StringIO\n>>> table = list(csv.reader(StringIO(\"spam, 42\\neggs, 451\\n\")))\n>>> table\n[['spam', ' 42'], ['eggs', ' 451']]\n>>> print(tabulate(table))\n---- ----\nspam 42\neggs 451\n---- ----\n```\n\nTo disable this feature use `disable_numparse=True`.\n\n```pycon\n>>> print(tabulate.tabulate([[\"Ver1\", \"18.0\"], [\"Ver2\",\"19.2\"]], tablefmt=\"simple\", disable_numparse=True))\n---- ----\nVer1 18.0\nVer2 19.2\n---- ----\n```\n\n### Custom column alignment\n\n`tabulate` allows a custom column alignment to override the above. The\n`colalign` argument can be a list or a tuple of `stralign` named\narguments. Possible column alignments are: `right`, `center`, `left`,\n`decimal` (only for numbers), and `None` (to disable alignment).\nOmitting an alignment uses the default. For example:\n\n```pycon\n>>> print(tabulate([[\"one\", \"two\"], [\"three\", \"four\"]], colalign=(\"right\",))\n----- ----\n one two\nthree four\n----- ----\n```\n\n### Number formatting\n\n`tabulate` allows to define custom number formatting applied to all\ncolumns of decimal numbers. Use `floatfmt` named argument:\n\n```pycon\n>>> print(tabulate([[\"pi\",3.141593],[\"e\",2.718282]], floatfmt=\".4f\"))\n-- ------\npi 3.1416\ne 2.7183\n-- ------\n```\n\n`floatfmt` argument can be a list or a tuple of format strings, one per\ncolumn, in which case every column may have different number formatting:\n\n```pycon\n>>> print(tabulate([[0.12345, 0.12345, 0.12345]], floatfmt=(\".1f\", \".3f\")))\n--- ----- -------\n0.1 0.123 0.12345\n--- ----- -------\n```\n\n`intfmt` works similarly for integers\n\n >>> print(tabulate([[\"a\",1000],[\"b\",90000]], intfmt=\",\"))\n - ------\n a 1,000\n b 90,000\n - ------\n\n### Text formatting\n\nBy default, `tabulate` removes leading and trailing whitespace from text\ncolumns. To disable whitespace removal, set the global module-level flag\n`PRESERVE_WHITESPACE`:\n\n```python\nimport tabulate\ntabulate.PRESERVE_WHITESPACE = True\n```\n\n### Wide (fullwidth CJK) symbols\n\nTo properly align tables which contain wide characters (typically\nfullwidth glyphs from Chinese, Japanese or Korean languages), the user\nshould install `wcwidth` library. To install it together with\n`tabulate`:\n\n```shell\npip install tabulate[widechars]\n```\n\nWide character support is enabled automatically if `wcwidth` library is\nalready installed. To disable wide characters support without\nuninstalling `wcwidth`, set the global module-level flag\n`WIDE_CHARS_MODE`:\n\n```python\nimport tabulate\ntabulate.WIDE_CHARS_MODE = False\n```\n\n### Multiline cells\n\nMost table formats support multiline cell text (text containing newline\ncharacters). The newline characters are honored as line break\ncharacters.\n\nMultiline cells are supported for data rows and for header rows.\n\nFurther automatic line breaks are not inserted. Of course, some output\nformats such as latex or html handle automatic formatting of the cell\ncontent on their own, but for those that don't, the newline characters\nin the input cell text are the only means to break a line in cell text.\n\nNote that some output formats (e.g. simple, or plain) do not represent\nrow delimiters, so that the representation of multiline cells in such\nformats may be ambiguous to the reader.\n\nThe following examples of formatted output use the following table with\na multiline cell, and headers with a multiline cell:\n\n```pycon\n>>> table = [[\"eggs\",451],[\"more\\nspam\",42]]\n>>> headers = [\"item\\nname\", \"qty\"]\n```\n\n`plain` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"plain\"))\nitem qty\nname\neggs 451\nmore 42\nspam\n```\n\n`simple` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"simple\"))\nitem qty\nname\n------ -----\neggs 451\nmore 42\nspam\n```\n\n`grid` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"grid\"))\n+--------+-------+\n| item | qty |\n| name | |\n+========+=======+\n| eggs | 451 |\n+--------+-------+\n| more | 42 |\n| spam | |\n+--------+-------+\n```\n\n`fancy_grid` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"fancy_grid\"))\n╒════════╤═══════╕\n│ item │ qty │\n│ name │ │\n╞════════╪═══════╡\n│ eggs │ 451 │\n├────────┼───────┤\n│ more │ 42 │\n│ spam │ │\n╘════════╧═══════╛\n```\n\n`pipe` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"pipe\"))\n| item | qty |\n| name | |\n|:-------|------:|\n| eggs | 451 |\n| more | 42 |\n| spam | |\n```\n\n`orgtbl` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"orgtbl\"))\n| item | qty |\n| name | |\n|--------+-------|\n| eggs | 451 |\n| more | 42 |\n| spam | |\n```\n\n`jira` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"jira\"))\n| item | qty |\n| name | |\n|:-------|------:|\n| eggs | 451 |\n| more | 42 |\n| spam | |\n```\n\n`presto` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"presto\"))\n item | qty\n name |\n--------+-------\n eggs | 451\n more | 42\n spam |\n```\n\n`pretty` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"pretty\"))\n+------+-----+\n| item | qty |\n| name | |\n+------+-----+\n| eggs | 451 |\n| more | 42 |\n| spam | |\n+------+-----+\n```\n\n`psql` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"psql\"))\n+--------+-------+\n| item | qty |\n| name | |\n|--------+-------|\n| eggs | 451 |\n| more | 42 |\n| spam | |\n+--------+-------+\n```\n\n`rst` tables:\n\n```pycon\n>>> print(tabulate(table, headers, tablefmt=\"rst\"))\n====== =====\nitem qty\nname\n====== =====\neggs 451\nmore 42\nspam\n====== =====\n```\n\nMultiline cells are not well-supported for the other table formats.\n\n### Automating Multilines\nWhile tabulate supports data passed in with multilines entries explicitly provided,\nit also provides some support to help manage this work internally.\n\nThe `maxcolwidths` argument is a list where each entry specifies the max width for\nit's respective column. Any cell that will exceed this will automatically wrap the content.\nTo assign the same max width for all columns, a singular int scaler can be used.\n\nUse `None` for any columns where an explicit maximum does not need to be provided,\nand thus no automate multiline wrapping will take place.\n\nThe wrapping uses the python standard [textwrap.wrap](https://docs.python.org/3/library/textwrap.html#textwrap.wrap)\nfunction with default parameters - aside from width.\n\nThis example demonstrates usage of automatic multiline wrapping, though typically\nthe lines being wrapped would probably be significantly longer than this.\n\n```pycon\n>>> print(tabulate([[\"John Smith\", \"Middle Manager\"]], headers=[\"Name\", \"Title\"], tablefmt=\"grid\", maxcolwidths=[None, 8]))\n+------------+---------+\n| Name | Title |\n+============+=========+\n| John Smith | Middle |\n| | Manager |\n+------------+---------+\n```\n\n### Adding Separating lines\nOne might want to add one or more separating lines to highlight different sections in a table.\n\nThe separating lines will be of the same type as the one defined by the specified formatter as either the\nlinebetweenrows, linebelowheader, linebelow, lineabove or just a simple empty line when none is defined for the formatter\n\n\n >>> from tabulate import tabulate, SEPARATING_LINE\n\n table = [[\"Earth\",6371],\n [\"Mars\",3390],\n SEPARATING_LINE,\n [\"Moon\",1737]]\n print(tabulate(table, tablefmt=\"simple\"))\n ----- ----\n Earth 6371\n Mars 3390\n ----- ----\n Moon 1737\n ----- ----\n\n### ANSI support\nANSI escape codes are non-printable byte sequences usually used for terminal operations like setting\ncolor output or modifying cursor positions. Because multi-byte ANSI sequences are inherently non-printable,\nthey can still introduce unwanted extra length to strings. For example:\n\n >>> len('\\033[31mthis text is red\\033[0m') # printable length is 16\n 25\n\nTo deal with this, string lengths are calculated after first removing all ANSI escape sequences. This ensures\nthat the actual printable length is used for column widths, rather than the byte length. In the final, printable\ntable, however, ANSI escape sequences are not removed so the original styling is preserved.\n\nSome terminals support a special grouping of ANSI escape sequences that are intended to display hyperlinks\nmuch in the same way they are shown in browsers. These are handled just as mentioned before: non-printable\nANSI escape sequences are removed prior to string length calculation. The only diifference with escaped\nhyperlinks is that column width will be based on the length of the URL _text_ rather than the URL\nitself (terminals would show this text). For example:\n\n >>> len('\\x1b]8;;https://example.com\\x1b\\\\example\\x1b]8;;\\x1b\\\\') # display length is 7, showing 'example'\n 45\n\n\nUsage of the command line utility\n---------------------------------\n\n Usage: tabulate [options] [FILE ...]\n\n FILE a filename of the file with tabular data;\n if \"-\" or missing, read data from stdin.\n\n Options:\n\n -h, --help show this message\n -1, --header use the first row of data as a table header\n -o FILE, --output FILE print table to FILE (default: stdout)\n -s REGEXP, --sep REGEXP use a custom column separator (default: whitespace)\n -F FPFMT, --float FPFMT floating point number format (default: g)\n -I INTFMT, --int INTFMT integer point number format (default: \"\")\n -f FMT, --format FMT set output table format; supported formats:\n plain, simple, github, grid, fancy_grid, pipe,\n orgtbl, rst, mediawiki, html, latex, latex_raw,\n latex_booktabs, latex_longtable, tsv\n (default: simple)\n\nPerformance considerations\n--------------------------\n\nSuch features as decimal point alignment and trying to parse everything\nas a number imply that `tabulate`:\n\n- has to \"guess\" how to print a particular tabular data type\n- needs to keep the entire table in-memory\n- has to \"transpose\" the table twice\n- does much more work than it may appear\n\nIt may not be suitable for serializing really big tables (but who's\ngoing to do that, anyway?) or printing tables in performance sensitive\napplications. `tabulate` is about two orders of magnitude slower than\nsimply joining lists of values with a tab, comma, or other separator.\n\nAt the same time, `tabulate` is comparable to other table\npretty-printers. Given a 10x10 table (a list of lists) of mixed text and\nnumeric data, `tabulate` appears to be slower than `asciitable`, and\nfaster than `PrettyTable` and `texttable` The following mini-benchmark\nwas run in Python 3.9.13 on Windows 10:\n\n ================================= ========== ===========\n Table formatter time, μs rel. time\n ================================= ========== ===========\n csv to StringIO 12.5 1.0\n join with tabs and newlines 14.6 1.2\n asciitable (0.8.0) 192.0 15.4\n tabulate (0.9.0) 483.5 38.7\n tabulate (0.9.0, WIDE_CHARS_MODE) 637.6 51.1\n PrettyTable (3.4.1) 1080.6 86.6\n texttable (1.6.4) 1390.3 111.4\n ================================= ========== ===========\n\n\nVersion history\n---------------\n\nThe full version history can be found at the [changelog](https://github.com/astanin/python-tabulate/blob/master/CHANGELOG).\n\nHow to contribute\n-----------------\n\nContributions should include tests and an explanation for the changes\nthey propose. Documentation (examples, docstrings, README.md) should be\nupdated accordingly.\n\nThis project uses [pytest](https://docs.pytest.org/) testing\nframework and [tox](https://tox.readthedocs.io/) to automate testing in\ndifferent environments. Add tests to one of the files in the `test/`\nfolder.\n\nTo run tests on all supported Python versions, make sure all Python\ninterpreters, `pytest` and `tox` are installed, then run `tox` in the root\nof the project source tree.\n\nOn Linux `tox` expects to find executables like `python3.7`, `python3.8` etc.\nOn Windows it looks for `C:\\Python37\\python.exe`, `C:\\Python38\\python.exe` etc. respectively.\n\nOne way to install all the required versions of the Python interpreter is to use [pyenv](https://github.com/pyenv/pyenv).\nAll versions can then be easily installed with something like:\n\n pyenv install 3.7.12\n pyenv install 3.8.12\n ...\n\nDon't forget to change your `PATH` so that `tox` knows how to find all the installed versions. Something like\n\n export PATH=\"${PATH}:${HOME}/.pyenv/shims\"\n\nTo test only some Python environments, use `-e` option. For example, to\ntest only against Python 3.7 and Python 3.10, run:\n\n```shell\ntox -e py37,py310\n```\n\nin the root of the project source tree.\n\nTo enable NumPy and Pandas tests, run:\n\n```shell\ntox -e py37-extra,py310-extra\n```\n\n(this may take a long time the first time, because NumPy and Pandas will\nhave to be installed in the new virtual environments)\n\nTo fix code formatting:\n\n```shell\ntox -e lint\n```\n\nSee `tox.ini` file to learn how to use to test\nindividual Python versions.\n\nContributors\n------------\n\nSergey Astanin, Pau Tallada Crespí, Erwin Marsi, Mik Kocikowski, Bill\nRyder, Zach Dwiel, Frederik Rietdijk, Philipp Bogensberger, Greg\n(anonymous), Stefan Tatschner, Emiel van Miltenburg, Brandon Bennett,\nAmjith Ramanujam, Jan Schulz, Simon Percivall, Javier Santacruz\nLópez-Cepero, Sam Denton, Alexey Ziyangirov, acaird, Cesar Sanchez,\nnaught101, John Vandenberg, Zack Dever, Christian Clauss, Benjamin\nMaier, Andy MacKinlay, Thomas Roten, Jue Wang, Joe King, Samuel Phan,\nNick Satterly, Daniel Robbins, Dmitry B, Lars Butler, Andreas Maier,\nDick Marinus, Sébastien Celles, Yago González, Andrew Gaul, Wim Glenn,\nJean Michel Rouly, Tim Gates, John Vandenberg, Sorin Sbarnea,\nWes Turner, Andrew Tija, Marco Gorelli, Sean McGinnis, danja100,\nendolith, Dominic Davis-Foster, pavlocat, Daniel Aslau, paulc,\nFelix Yan, Shane Loretz, Frank Busse, Harsh Singh, Derek Weitzel,\nVladimir Vrzić, 서승우 (chrd5273), Georgy Frolov, Christian Cwienk,\nBart Broere, Vilhelm Prytz, Alexander Gažo, Hugo van Kemenade,\njamescooke, Matt Warner, Jérôme Provensal, Kevin Deldycke,\nKian-Meng Ang, Kevin Patterson, Shodhan Save, cleoold, KOLANICH,\nVijaya Krishna Kasula, Furcy Pin, Christian Fibich, Shaun Duncan,\nDimitri Papadopoulos.\n\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"","keywords":"","license":"MIT","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"tabulate","package_url":"https://pypi.org/project/tabulate/","platform":null,"project_url":"https://pypi.org/project/tabulate/","project_urls":{"Homepage":"https://github.com/astanin/python-tabulate"},"provides_extra":null,"release_url":"https://pypi.org/project/tabulate/0.9.0/","requires_dist":["wcwidth ; extra == 'widechars'"],"requires_python":">=3.7","summary":"Pretty-print tabular data","version":"0.9.0","yanked":false,"yanked_reason":null}

Package search

tabulate

project_urls

Dependencies

All package metadata

Releases