Fix progress cursor visibility #3691
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add get_unicode_width function to Text class - Update cell_len to use Unicode width calculation - Add comprehensive tests for Unicode character handling - Fix table alignment with full-width, wide, and ambiguous characters
TomJGooding
reviewed
Apr 2, 2025
There was a problem hiding this comment.
Please don't waste the time of open source maintainers with this LLM-generated slop.
Hopefully you realise by now that all your pull requests will be rejected. This PR is probably the most egregious as you didn't even notice to remove the create_pr.sh or pull_request.md files.
I'm not sure what your motivation is here, but I'm assuming you're new to coding. Using LLMs to generate pull requests may seem like an easy way to get started, but it's not a substitute for real learning and experience.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix cursor visibility issues when Progress/Live displays are interrupted
Problem
When a Rich Progress or Live display is interrupted (e.g., by a Ctrl+C or an unhandled exception), the cursor sometimes remains hidden in the terminal, making it difficult for users to type or interact with the console after the program ends.
Root Cause
The
Progress.stop()andLive.stop()methods handle cleaning up the console state, including restoring cursor visibility, but they lack robust exception handling. If an exception occurs during the cleanup process, the code to restore cursor visibility might not execute.Solution
This PR implements the following improvements:
Added try/except handlers in both
Progress.stop()andLive.stop()methods to ensure cursor visibility is restored even if an exception occurs during cleanup.Added signal handlers (SIGINT) to catch Ctrl+C interruptions and ensure cursor visibility is restored before the program exits.
Added an atexit handler as an additional safety measure to ensure cursor visibility is restored when the program exits.
Added platform checks to avoid setting up signal handlers on platforms that don't support them (e.g., Windows).
Benefits
Testing
A test script (
test_cursor_visibility.py) is included to demonstrate the fix. The script shows a progress bar that can be interrupted with Ctrl+C, and verifies that the cursor remains visible after interruption.Notes
This fix builds on the foundation of existing cursor management in Rich, adding additional safeguards to handle edge cases without changing the core functionality.