astanin / python-tabulate

Pretty-print tabular data in Python, a library and a command-line utility. Repository migrated from bitbucket.org/astanin/python-tabulate.
https://pypi.org/project/tabulate/
MIT License
2.08k stars 162 forks source link

Fix column wrapping breaking ANSI escape codes (fixes #307) #308

Open devdanzin opened 7 months ago

devdanzin commented 7 months ago

In tabulate._CustomTextWrap._handle_long_word, ANSI escape codes may be broken in the middle, resulting wrongly formatted tables. That happens because the length of the string is checked in while self._len(chunk[:i]) <= space_left:, which may strip ANSI codes after they were broken by indexing into their middle.

To solve that, we instead calculate the length of the string without ANSI codes, then index into it: while len(_strip_ansi(chunk)[:i]) <= space_left:. That gives the amount of printable characters that should be included. Then we iterate through the escape codes present until we reach that many printable characters, and add the escape code lengths to figure out how much of the original string should be included.

Tests included.

Test code:

import tabulate
print(tabulate.tabulate(tabular_data=(('012345 (\x1b[32mabcdefghij\x1b[0m)', 'XX'),), maxcolwidths=11, tablefmt='grid'))"

Result before patch:

+-------------+----+
| 012345 ( XX |
| 2mabcdefghi |    |
| j)          |    |
+-------------+----+

broken_tabulate-color_wrap

Result after patch:

+-------------+----+
| 012345 (abc | XX |
| defghij)    |    |
+-------------+----+

fixed_tabulate_color_wrap

Fixes #307.