Repository navigation
Add example embedding a cmd2 app in a Textual app with textual-tty - #1781
Merged
Merged
Conversation
- Escape the command name and state before putting them in the status panel's markup, so a command like "[/b]" no longer crashes the host. - Start tracking a command in a postparsing hook and ignore finalization for lines that never became a statement (blank lines, comments, Ctrl-C, syntax errors), so they aren't counted or timed from a stale start time. - Count running commands so ones run by run_script, history -r, and run_pyscript don't flip the panel to idle or inflate the command count. - Ignore status titles that aren't JSON objects or whose values have the wrong type, instead of crashing the host. - Document the Textual host as POSIX-only and refuse to start it on Windows, where bittty's PTY can't pass arguments to the child process. - Import Textual only in the host code path so --cmd2-only works without it. - Return the cmd2 app's exit code from the host, and keep the terminal on screen when the cmd2 app fails so its traceback can still be read. - Only report status through the window title with --report-status, which the host passes, so --cmd2-only doesn't overwrite a terminal's title. - Reject negative, NaN, infinite, and huge values in the slow command before printing anything. - Clarify that the Ctrl-Q binding is repeated only to show it in the footer.
Developers can now run the textual_tty_embed example out of the box with "uv run examples/textual_tty_embed.py". It is only a dev dependency, which CI doesn't install, and is limited to non-Windows platforms because the example's Textual host is POSIX-only and bittty pins pywinpty on Windows.
Add an "Embedding in Textual" page to the examples section of the docs which explains how the textual_tty_embed example works and the pitfalls it handles. Link to it from the alternatives overview and the bottom toolbar docs, and add a changelog entry for the example.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1781 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 23 23
Lines 6474 6474
=======================================
Hits 6458 6458
Misses 16 16
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. |
Add a short teaser to the README's introduction which links to the Embedding in Textual docs, so the capability is easy to discover.
- Ignore status titles which make json.loads raise ValueError (integers with too many digits) or RecursionError (documents nested too deeply), not just json.JSONDecodeError. - Report a cmd2 app killed by a signal as 128 + the signal number, like a shell does, instead of passing a negative exit code to sys.exit. - Never let the command depth go negative when a postparsing hook which ran first stopped the status hook from running, and document that the hook should be registered first. - Reject --report-status without --cmd2-only. - Limit textual-tty to <0.5 in the dev group since it is pre-alpha. - Make the compose() snippet in the docs match the example's code.
- Report the running command separately and only update the last command when it finishes, so the panel no longer shows a running command's name next to the previous command's duration. The state line now reads, for example, "running slow". - Ignore OSError when setting the window title, which happens when the Textual application exits while a command is running and has already closed the terminal. - Keep the child's command line in a variable so the compose() snippet in the docs stays within the Markdown line length.
This file contains hidden or 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
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.
This continues #1773 by @DG-Elom, which adds
examples/textual_tty_embed.py: a Textual application that runs acmd2application in a textual-ttyTerminalwidget, with a realtime status panel beside it. #1773 was merged into this branch so its commits and authorship are preserved. This branch adds fixes for the review comments on that PR, documentation, and a dev dependency.Review fixes
[/b]no longer crash the hostrun_script,history -r,run_pyscript) so only the outermost one is reported--cmd2-onlyworks without it--report-status, which the host passes, so--cmd2-onlydoesn't overwrite a normal terminal's titleslowcommand's argument before printing anythingDeveloper environment
textual-ttyis now in thedevdependency group on non-Windows platforms, souv run examples/textual_tty_embed.pyworks out of the box in a development checkout. It is not a runtime dependency ofcmd2, and CI is unaffected because it installs only specific groups.NOTE: While
cmd2andtextualboth fully supports Windows,textual-ttyrelies on POSIX pseudo-terminals (PTYs).Documentation
Testing
make check,make test, andmake docs-testpassrun_script, malformed status titles set withshell printf,slow 1,quit, Ctrl-Q, and a child process that crashes at startup--cmd2-onlywith and without--report-statusin a real pty to confirm the window title is only set when askedCloses #1771