App exitable argument for Application object #1279
Open
Conversation
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
How it works:
Make app exitable with custom key-binding by passing 'exit_on_key':
app = Application(exit_on_key='c-q')
Also accepts a tuple:
app = Application(exit_on_key=('escape', 'q'))
Obs1: 'exit_on_key' defaults to None (same behavior as currently)
Obs2: a key set in 'key_bindings' argument always takes precedence.
Rationale:
An app.exit() key-binding is arguably needed in many (if not most)
applications. Being able to set as argument to Application is handy.
Side benefit: simplify examples in documentation. Many aren't exit'able
actually. Currently not the most welcoming for someone starting to learn.
Contributor
Author
|
I'm running |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Making an app exitable is commonly needed (almost all fullscreen apps will want it?). Being able to set this key-binding right when an
Applicationobject is being created is handy:Quick examples:
app = Application(exit_on_key="c-q")orapp = Application(exit_on_key=("escape", "q")).This would also simply some examples in the docs that are currently unexit'able (quite annoying to run, actually).
Let me know if this makes sense or not. Open to suggestions for changing anything also.
This feature does not change the default behavior of the
Applicationobject (no key-bindings). It's also overriden by the currently availablekey_bindingsargument.Wrote four tests which I think covers most common scenarios. Didn't see the need to write more, but let me know if I missed anything important.