[BUG] box.py susceptible to breakage when commited with trailing-whitespace pre-commit hook

[robinbowes]

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

Describe the bug

We committed a copy of the rich module to a git repo as part of building an AWS lambda layer.

box.py got mangled by the pre-commit trailing-whitespace hook.

Would it be possible to redefine the box character definitions in a way that does not have trailing white space?

Platform

Click to expand

This was on a Mac, with python 3.10.12 and rich v13.4.2

Other details not relevant to this issue.

[github-actions]

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]

I guess implicit line continuations would address that. I'd accept a PR.

[robinbowes]

Any preferred style?

eg. this works:

box = "\n".join(
    [
        "  ╷ ",
        "  │ ",
        "╶─┼╴",
        "  │ ",
        "╶─┼╴",
        "╶─┼╴",
        "  │ ",
        "  ╵ ",
    ]
)

[willmcgugan]

I was thinking this, so there would be no work at runtime:

box = (
        "  ╷ "
        "  │ "
        "╶─┼╴"
        "  │ "
        "╶─┼╴"
        "╶─┼╴"
        "  │ "
        "  ╵ "
)

I hope black doesn't mangle that. If it does you may have to disable formatting for those lines.

[robinbowes]

Black mangles that to one line.

[willmcgugan]

There's a comment you can add to disable formatting for a given block. Something line # fmt: off IIRC.

[robinbowes]

Also, it doesn't work anyway - it is read as a single line.

[willmcgugan]

I forgot the\n characters, but I think it should work.

[robinbowes]

Ah yes - will work with \n characeters embedded in the strings.

[robinbowes]

This sort of thing works:

# fmt: off
box = (
    "  ╷ \n"
    "  │ \n"
    "╶─┼╴\n"
    "  │ \n"
    "╶─┼╴\n"
    "╶─┼╴\n"
    "  │ \n"
    "  ╵ \n"
)
# fmt: on

If that looks OK, I'll knock up a PR that changes all box definitions to use that format.

[willmcgugan]

Works for me.