# treetable
Helper to pretty print an ascii table with a tree-like structure.
## Installation and requirements
`treetable` requires at least python3.6.
```
pip3 install treetable
```
## Quick example
`treetable` allows to easily output complex ascii tables like
```
|| || metrics
|| info || train | test
name || index status || Pr recall | auc accuracy
RirpUoE || 21 L || 94.4% 56.4% | 46.3% 79.6%
wtAYHBf || ||
j || ||
rLsITTK || 47 q || 66.0% 84.8% | 46.5% 64.9%
S || ||
Uumlvod || 49 Z || 63.1% 99.8% | 94.6% 10.6%
SmIsO || ||
rzXlDqM || 32 J || 48.8% 33.5% | 30.8% 94.2%
PyCX || ||
```
## Usage and examples
The main function is `treetable.treetable`. It takes a tree-like structure
to represent the table. For instance, I could have a sub-table `info` and
a sub-table `metrics`, each one being recursively composed of other sub-tables.
Each extra level of sub-tables use a different separator (by default up to 3
levels but you can provide extra separators with the `separators` arguments).
At the leaf level of the tree, a format string (that can be passed to the
`format` builtin) can be specified. Let's take an example
```python
from treetable import table, group, leaf
mytable = table([
group('info', [
leaf('name'),
leaf('index')]),
group('metrics', align='>', groups=[
leaf('speed', '.0f'),
leaf('accuracy', '.1%'),
leaf('special', '.1%', align='=')]),
])
```
The lines of the table should be provided following a list of nested
dictionaries with the same shape, for instance:
```python
lines = [
{'info': {'name': 'bob', 'index': 4}, 'metrics':{'speed': 200, 'accuracy': 0.21, 'special': 0.1}},
{'info': {'name': 'alice', 'index': 2}, 'metrics':{'speed': 67, 'accuracy': 0.45, 'special': 4.56}},
]
```
Now running `print(treetable(lines, groups))` will give you
```
info | metrics
name index | speed accuracy special
bob 4 | 200 21.0% 10.0%
alice 2 | 67 45.0% 456.0%
```
`table`, `group` and `leaf` are all node definition functions. They all
accept the same arguments and differ only in the order of positional arguments.
When defined in a leaf node, the arguments will directly influence
how the data is rendered. In group nodes or the root (aka table) node,
they will override the default behaviors in descendent leafs. The following
arguments are defined:
- `key`: access key in the `lines` data structure.
- `groups` (only for `group` and `table` nodes): list of sub-tables.
- `display`: display name used, when different to the name to access
the value in the `lines` structure.
- `align`: alignment of text, either '<' (left aligned), '=' (centered) or
'>' (right aligned).
- `wrap`: wrap text beyond a certain number of characters. No smart wrapping,
this will wrap exactly at the limit characters by inserting a new line.
- `missing`: value used when a specific key is not present. Default
is `''`.
- `shorten`: automatically shorten columns names. They are not shorten
any more than the width of the underlying column and a long enough prefix
is kept to remove any possible ambiguity with other columns in the same
sub-tab le.
For instance, when using `shorten=True` with the above table:
```
info | metrics
name i | spee accur specia
bob 4 | 200 21.0% 10.0%
alice 2 | 67 45.0% 456.0%
```
`name` wasn't shortened because `alice` is longer than `name` so there would
be no point in shortening it. However `speed` is kept long enough
to avoid ambiguity with `special`.
When setting `wrap=3` for the `name` column we obtain the following:
```
info | metrics
nam i | spee accur specia
bob 4 | 200 21.0% 10.0%
ali 2 | 67 45.0% 456.0%
ce |
```
It is possible to customize the column separators by passing
`separators` to the `treetable` function. Its default value is
`[' ', ' | ', ' || ']`.
### Colors
It is possible to use ANSI color codes by passing a list of color codes to `treetable()` with the `colors` argument.
The i-th line (including headers) will have the color `colors[i % len(colors]`. For instance:
```python
treetable(lines, mytable, colors=["30", "39"])
```
<img src="misc/colors.png" alt="table generated by treetable with ANSI color codes" width="300">
For a good reference on ANSI color codes, checkout [this stackoverflow question](https://stackoverflow.com/questions/4842424/list-of-ansi-color-escape-sequences).
## License
`treetable` is distributed under the Unlicense license.
See the LICENSE file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/adefossez/treetable",
"name": "treetable",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.0",
"maintainer_email": "",
"keywords": "",
"author": "Alexandre D\u00e9fossez",
"author_email": "alexandredefossez@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/35/c6/b6d8dd6d3216bf19f11cd3a93e34109fb55412f4b6752f05d22dbdbf8f2a/treetable-0.2.5.tar.gz",
"platform": "",
"description": "# treetable\n\nHelper to pretty print an ascii table with a tree-like structure.\n\n## Installation and requirements\n\n`treetable` requires at least python3.6.\n```\npip3 install treetable\n```\n\n\n## Quick example\n\n`treetable` allows to easily output complex ascii tables like\n\n```\n || || metrics\n || info || train | test\nname || index status || Pr recall | auc accuracy\nRirpUoE || 21 L || 94.4% 56.4% | 46.3% 79.6%\nwtAYHBf || ||\nj || ||\nrLsITTK || 47 q || 66.0% 84.8% | 46.5% 64.9%\nS || ||\nUumlvod || 49 Z || 63.1% 99.8% | 94.6% 10.6%\nSmIsO || ||\nrzXlDqM || 32 J || 48.8% 33.5% | 30.8% 94.2%\nPyCX || ||\n```\n\n## Usage and examples\n\nThe main function is `treetable.treetable`. It takes a tree-like structure\nto represent the table. For instance, I could have a sub-table `info` and\na sub-table `metrics`, each one being recursively composed of other sub-tables.\n\nEach extra level of sub-tables use a different separator (by default up to 3\nlevels but you can provide extra separators with the `separators` arguments).\n\nAt the leaf level of the tree, a format string (that can be passed to the\n`format` builtin) can be specified. Let's take an example\n\n```python\nfrom treetable import table, group, leaf\n\nmytable = table([\n group('info', [\n leaf('name'),\n leaf('index')]),\n group('metrics', align='>', groups=[\n leaf('speed', '.0f'),\n leaf('accuracy', '.1%'),\n leaf('special', '.1%', align='=')]),\n])\n```\n\nThe lines of the table should be provided following a list of nested\ndictionaries with the same shape, for instance:\n\n```python\nlines = [\n {'info': {'name': 'bob', 'index': 4}, 'metrics':{'speed': 200, 'accuracy': 0.21, 'special': 0.1}},\n {'info': {'name': 'alice', 'index': 2}, 'metrics':{'speed': 67, 'accuracy': 0.45, 'special': 4.56}},\n]\n```\n\nNow running `print(treetable(lines, groups))` will give you\n\n```\n info | metrics\nname index | speed accuracy special\nbob 4 | 200 21.0% 10.0%\nalice 2 | 67 45.0% 456.0%\n```\n\n`table`, `group` and `leaf` are all node definition functions. They all\naccept the same arguments and differ only in the order of positional arguments.\nWhen defined in a leaf node, the arguments will directly influence\nhow the data is rendered. In group nodes or the root (aka table) node,\nthey will override the default behaviors in descendent leafs. The following\narguments are defined:\n- `key`: access key in the `lines` data structure.\n- `groups` (only for `group` and `table` nodes): list of sub-tables.\n- `display`: display name used, when different to the name to access\n the value in the `lines` structure.\n- `align`: alignment of text, either '<' (left aligned), '=' (centered) or\n '>' (right aligned).\n- `wrap`: wrap text beyond a certain number of characters. No smart wrapping,\n this will wrap exactly at the limit characters by inserting a new line.\n- `missing`: value used when a specific key is not present. Default\n is `''`.\n- `shorten`: automatically shorten columns names. They are not shorten\n any more than the width of the underlying column and a long enough prefix\n is kept to remove any possible ambiguity with other columns in the same\n sub-tab le.\n\n\nFor instance, when using `shorten=True` with the above table:\n```\n info | metrics\nname i | spee accur specia\nbob 4 | 200 21.0% 10.0%\nalice 2 | 67 45.0% 456.0%\n```\n\n`name` wasn't shortened because `alice` is longer than `name` so there would\nbe no point in shortening it. However `speed` is kept long enough\nto avoid ambiguity with `special`.\n\nWhen setting `wrap=3` for the `name` column we obtain the following:\n```\n info | metrics\nnam i | spee accur specia\nbob 4 | 200 21.0% 10.0%\nali 2 | 67 45.0% 456.0%\nce |\n```\n\nIt is possible to customize the column separators by passing\n`separators` to the `treetable` function. Its default value is\n`[' ', ' | ', ' || ']`.\n\n\n### Colors\n\nIt is possible to use ANSI color codes by passing a list of color codes to `treetable()` with the `colors` argument.\nThe i-th line (including headers) will have the color `colors[i % len(colors]`. For instance:\n\n```python\ntreetable(lines, mytable, colors=[\"30\", \"39\"])\n```\n\n<img src=\"misc/colors.png\" alt=\"table generated by treetable with ANSI color codes\" width=\"300\">\n\nFor a good reference on ANSI color codes, checkout [this stackoverflow question](https://stackoverflow.com/questions/4842424/list-of-ansi-color-escape-sequences).\n\n## License\n\n`treetable` is distributed under the Unlicense license.\nSee the LICENSE file for more information.",
"bugtrack_url": null,
"license": "Unlicense license",
"summary": "Helper to pretty print an ascii table with atree-like structure",
"version": "0.2.5",
"project_urls": {
"Homepage": "https://github.com/adefossez/treetable"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "35c6b6d8dd6d3216bf19f11cd3a93e34109fb55412f4b6752f05d22dbdbf8f2a",
"md5": "f0dbe9a88a5c9a5c00aa8921896671fb",
"sha256": "29c95b797a8ecff4bb894cb7b103e39a78c905ab78a88a9a247de30c87743a2f"
},
"downloads": -1,
"filename": "treetable-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "f0dbe9a88a5c9a5c00aa8921896671fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6.0",
"size": 10251,
"upload_time": "2021-05-18T14:23:37",
"upload_time_iso_8601": "2021-05-18T14:23:37.208246Z",
"url": "https://files.pythonhosted.org/packages/35/c6/b6d8dd6d3216bf19f11cd3a93e34109fb55412f4b6752f05d22dbdbf8f2a/treetable-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-18 14:23:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adefossez",
"github_project": "treetable",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "treetable"
}
JSON
