[BUG] table column no_wrap can squash columns below their min_width

rjbs commented 1 year ago

[X] I've checked docs and closed issues for possible solutions.
[X] I can't find my issue in the FAQ.

Describe the bug

I'll start with: the bug may be with my understanding of options, so I'm prepared to accept that I'm thinking about things wrong. That said, I feel pretty confident that my thinking is not incoherent. 😉

In a table column, the no_wrap option does not function as I would expect. My expectation is that the content of a column would not be allowed to wrap, and that the overflow property would apply. Further, that with no specification of the column's width, its width would be determined by finding the total available table width, meeting the width requirements of other columns (and borders) and then using the remaining space.

Instead, a no_wrap column is forcing other table column contents to be squashed below their minimum width. Consider this program:

from rich import print
from rich.table import Table
from rich.text import Text

table = Table(show_header=True, header_style="bold magenta")
table.add_column("Issue", min_width=7, width=7)
table.add_column("S", min_width=1, width=1)
table.add_column("Pri", min_width=3, width=3)
table.add_column("Title", overflow="ellipsis")

too_long = """\
This is a full line sentence and it fills a whole line so it overflows a cell!\
"""

for i in range(2):
    table.add_row("ABC-123", "X", "123", " ".join([too_long, too_long]))

print(table)

This prints the following table on my 80 column terminal (iTerm2):

If I update the program to use no_wrap:

from rich import print
from rich.table import Table
from rich.text import Text

table = Table(show_header=True, header_style="bold magenta")
table.add_column("Issue", min_width=7, width=7)
table.add_column("S", min_width=1, width=1)
table.add_column("Pri", min_width=3, width=3)
table.add_column("Title", overflow="ellipsis", no_wrap=True)

too_long = """\
This is a full line sentence and it fills a whole line so it overflows a cell!\
"""

for i in range(2):
    table.add_row("ABC-123", "X", "123", " ".join([too_long, too_long]))

print(table)

...then the table produced squashes the first three columns below their minimum before applying the ellipsis overflow behavior.

I think instead, the left columns should be displayed at their specified widths, and the rightmost column truncated earlier.

Platform

Click to expand

What platform (Win/Linux/Mac) are you running on? What terminal software are you using? I'm running on macOS Venture: ``` Darwin snowdrop 22.3.0 Darwin Kernel Version 22.3.0: Mon Jan 30 20:38:43 PST 2023; root:xnu-8792.81.3~2/RELEASE_ARM64_T8112 arm64 ``` I'm using iTerm2 v3.4.19.

rich.diagnose

───────────────────────╮ │ A high level console interface. │ │ │ │ ╭──────────────────────────────────────────────────────────────────────────╮ │ │ │ │ │ │ ╰──────────────────────────────────────────────────────────────────────────╯ │ │ │ │ color_system = 'truecolor' │ │ encoding = 'utf-8' │ │ file = <_io.TextIOWrapper name='' mode='w' │ │ encoding='utf-8'> │ │ height = 33 │ │ is_alt_screen = False │ │ is_dumb_terminal = False │ │ is_interactive = True │ │ is_jupyter = False │ │ is_terminal = True │ │ legacy_windows = False │ │ no_color = False │ │ options = ConsoleOptions( │ │ size=ConsoleDimensions(width=80, height=33), │ │ legacy_windows=False, │ │ min_width=1, │ │ max_width=80, │ │ is_terminal=True, │ │ encoding='utf-8', │ │ max_height=33, │ │ justify=None, │ │ overflow=None, │ │ no_wrap=False, │ │ highlight=None, │ │ markup=None, │ │ height=None │ │ ) │ │ quiet = False │ │ record = False │ │ safe_box = True │ │ size = ConsoleDimensions(width=80, height=33) │ │ soft_wrap = False │ │ stderr = False │ │ style = None │ │ tab_size = 8 │ │ width = 80 │ ╰──────────────────────────────────────────────────────────────────────────────╯ ╭─── ────╮ │ Windows features available. │ │ │ │ ╭───────────────────────────────────────────────────╮ │ │ │ WindowsConsoleFeatures(vt=False, truecolor=False) │ │ │ ╰───────────────────────────────────────────────────╯ │ │ │ │ truecolor = False │ │ vt = False │ ╰───────────────────────────────────────────────────────╯ ╭────── Environment Variables ───────╮ │ { │ │ 'TERM': 'xterm-256color', │ │ 'COLORTERM': 'truecolor', │ │ 'CLICOLOR': None, │ │ 'NO_COLOR': None, │ │ 'TERM_PROGRAM': 'iTerm.app', │ │ 'COLUMNS': None, │ │ 'LINES': None, │ │ 'JUPYTER_COLUMNS': None, │ │ 'JUPYTER_LINES': None, │ │ 'JPY_PARENT_PID': None, │ │ 'VSCODE_VERBOSE_LOGGING': None │ │ } │ ╰────────────────────────────────────╯ platform="Darwin" ```

pip freeze | grep rich

``` snowdrop:~/fm/code/glinpy$ pip freeze | grep rich rich==13.3.2 ```

github-actions[bot] commented 1 year ago

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

willmcgugan commented 1 year ago

You have given Rich an impossible to satisfy set of restraints. The first three columns are fixed, and the last isn't permitted to wrap. There is no way to shrink that without breaking at least one constraint, so it defaults to a "last resort" algorithm to compress the table.

A workaround would be to remove the constraints from the columns and prevent the cell from wrapping.

from rich import print
from rich.table import Table
from rich.text import Text

table = Table(show_header=True, header_style="bold magenta", expand=True)
table.add_column("Issue")
table.add_column("S")
table.add_column("Pri")
table.add_column("Title")

too_long = """\
This is a full line sentence and it fills a whole line so it overflows a cell!\
"""

for i in range(2):
    table.add_row(
        "ABC-123",
        "X",
        "123",
        Text(" ".join([too_long, too_long]), no_wrap=True),
    )

print(table)

rjbs commented 1 year ago

Thanks, @willmcgugan, that does get me the behavior that I wanted. I really appreciate it.

I'd like to ask a follow-up question, if I may. You said, "You have given Rich an impossible to satisfy set of restraints." and I reckon you're right! But I would've thought the model worked differently, and I think I'll do better moving forward if I understand it more. Maybe you can speak the three words that will enlighten me, or just point me at something for me to read over and over until it clicks. :)

You wrote:

The first three columns are fixed, and the last isn't permitted to wrap. There is no way to shrink that without breaking at least one constraint, so it defaults to a "last resort" algorithm to compress the table.

I would have thought that it would be able to be satisfied like so:

the table is contained only by the terminal, so its maximum width is bounded by the terminal width
there are 4 columns, three with fixed size
the last column may not wrap, so its maximum size is perforce (table width - border&c width - first three columns)
let's say that's 50; the text in the final cell would then be told to render in 50 columns, with both overflow and no-wrap
...so I would expect that the (implicitly created) text element with the long sentence would be given rendering instructions equivalent to the cell construction that does work

I suspect that my misunderstanding is related to the way in which the no_wrap/overflow of the column are communicated to, or share dependency ordering with, the renderable in each row of the column, but I'm afraid I don't understand my own understanding.

If you can clear it up, I would be grateful. If not, well, I'm already grateful for the above. Thanks!

FrancoisBeaune commented 12 months ago

I struggled with this exact problem for a long time, and @willmcgugan solution also worked perfectly for me.

To be honest, I'm not sure I understand the difference between a column not being allowed to wrap vs a cell not being able to wrap...

peterjc commented 2 weeks ago

For the reference of anyone reading, the workaround gives the following (desired) output:

>>> print("x"*80)
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
>>> print(table)
┏━━━━━━━━━┳━━━┳━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Issue   ┃ S ┃ Pri ┃ Title                                                    ┃
┡━━━━━━━━━╇━━━╇━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ ABC-123 │ X │ 123 │ This is a full line sentence and it fills a whole line … │
│ ABC-123 │ X │ 123 │ This is a full line sentence and it fills a whole line … │
└─────────┴───┴─────┴──────────────────────────────────────────────────────────┘

Textualize / rich

[BUG] table column no_wrap can squash columns below their min_width #2890