Skip to content

gh-160043: Don't reject fitting text in textwrap.shorten() and wrap(max_lines) - #160044

Open
tonghuaroot wants to merge 1 commit into
python:mainfrom
tonghuaroot:gh-160043-textwrap-placeholder-fits
Open

tonghuaroot wants to merge 1 commit into
python:mainfrom
tonghuaroot:gh-160043-textwrap-placeholder-fits

Conversation

@tonghuaroot

@tonghuaroot tonghuaroot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

shorten() and wrap() with max_lines no longer raise
ValueError("placeholder too large for max width") for text that fits in
width. shorten's docstring promises such text is "returned as is".

The guard's real purpose is to never emit a placeholder-only line wider than
width, but it ran eagerly whenever max_lines was set, before any wrapping,
so it rejected text that never needed a placeholder. Moving the identical
check to the single branch that force-places a placeholder-only line preserves
that invariant: it still raises on every genuine truncation that cannot place
the placeholder, while text that fits (or a truncation that can append the
placeholder to the previous line) no longer raises.

…(max_lines)

The placeholder-fits guard ran eagerly whenever max_lines was set, so
shorten() and wrap() raised ValueError for text that fits in width when
the placeholder was wider than width. Move the check to the branch that
force-places a placeholder-only line, where the placeholder is actually
used.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant