screen: make _wait_for_input public #188
Merged
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
First of all, thank you so much for this amazing project! We are using it in our project [1] to interactively visualize dependency graphs for our pipelines across all platforms. We are mostly using screen class directly, as a cross platform ncurses of sorts and would love to have an ability to use _wait_for_input method directly. In order to do that properly, we need to make it formally public, so we could rely on it in future versions of asciimatics. I couldn't find any docs that need to be adjusted for this(seems auto-generated), so please let me know if I need to add/change anything. [1] https://github.com/iterative/dvc Signed-off-by: Ruslan Kuprieiev <ruslan@iterative.ai>
2 similar comments
|
Thanks for your support! I think I'm happy to expose the API as it stands. Arguably it would be better with an option to block forever, but it sounds like you and I don't need that, so I'll not do that for now. In the meantime, I've added some extra docs so that people are aware of the option. |
|
Thank you! |
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.
Issues fixed by this PR
None
What does this implement/fix?
Renames
Screen._wait_for_inputmethod intoScreen.wait_for_inputand makes it formally public.Any other comments?
First of all, thank you so much for this amazing project! We are using
it in our project [1] to interactively visualize dependency graphs for
our pipelines across all platforms. We are mostly using screen class
directly, as a cross platform ncurses of sorts and would love to have
an ability to use _wait_for_input method directly. In order to do that
properly, we need to make it formally public, so we could rely on it in
future versions of asciimatics.
I couldn't find any docs that need to be adjusted for this(seems
auto-generated), so please let me know if I need to add/change anything.
[1] https://github.com/iterative/dvc
Signed-off-by: Ruslan Kuprieiev ruslan@iterative.ai