Capture command return value in Result / CliRunner #1312
Merged
+45
−12
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.
I'm using click (with
standalone_mode=False) as the command-parsing module for a chat bot. It's awesome! In the simplest case, I have commands structured like this:For more complex stuff there's other ways to send messages back from the bot, but using the return value of the command to send simple messages has worked really well.
Testing commands like this is a bit of a pain. I can use the
CliRunnerand see that the "exit code" is 0, however, while theCliRunner(via the Result object) allows access to stdout, stderr, exit code etc, it doesn't capture the invocation result/return value. While it's a fairly unusual use case, it looked like it might be fairly straightforward to do and it turns out it is (at least... I think so!).With this PR, I can more easily test my simple commands' return values (the new test in
test_testing.pyis exactly what I want to do for my own simple commands.)