Skip to content

Simplied string_to_rich_text(). #1479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2025
Merged

Simplied string_to_rich_text(). #1479

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea752be
Simplied string_to_rich_text().
kmvanbrunt Aug 19, 2025
71ab48b
Updated comments.
kmvanbrunt Aug 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 6 additions & 24 deletions cmd2/rich_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,36 +188,18 @@ def rich_text_to_string(text: Text) -> str:
def string_to_rich_text(text: str) -> Text:
r"""Create a Text object from a string which can contain ANSI escape codes.

This wraps rich.Text.from_ansi() to handle a discarded newline issue.
This function is a workaround for a bug where rich.Text.from_ansi() incorrectly
removes a trailing newline. The official fix is pending.

Text.from_ansi() currently removes the ending line break from string.
e.g. "Hello\n" becomes "Hello"

There is currently a pull request to fix this.
https://github.com/Textualize/rich/pull/3793
See: https://github.com/Textualize/rich/pull/3793

:param text: a string to convert to a Text object.
:return: the converted string
:return: the string converted to a Text object
"""
result = Text.from_ansi(text)

# If 'text' ends with a line break character, restore the missing newline to 'result'.
# Note: '\r\n' is handled as its last character is '\n'.
# Source: https://docs.python.org/3/library/stdtypes.html#str.splitlines
line_break_chars = {
"\n", # Line Feed
"\r", # Carriage Return
"\v", # Vertical Tab
"\f", # Form Feed
"\x1c", # File Separator
"\x1d", # Group Separator
"\x1e", # Record Separator
"\x85", # Next Line (NEL)
"\u2028", # Line Separator
"\u2029", # Paragraph Separator
}
if text and text[-1] in line_break_chars:
# We use "\n" because Text.from_ansi() converts all line breaks chars into newlines.
# Handle case where Text.from_ansi() removed the trailing newline.
if text.endswith("\n"):
result.append("\n")

return result
Expand Down
Loading