added a new parameter for method capture(echo) #2697
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
|
@willmcgugan I do not think that requiring approval to even run CI is making rich very welcoming to new folks. There is the risk the might lose interest before even having the first successful contribution. I am not usable to approve... |
ssbarnea
approved these changes
Dec 20, 2022
jankatins
reviewed
Jan 12, 2023
| @@ -313,10 +313,10 @@ Note that when writing to a file you may want to explicitly set the ``width`` ar | |||
| Capturing output | |||
| ---------------- | |||
|
|
|||
| There may be situations where you want to *capture* the output from a Console rather than writing it directly to the terminal. You can do this with the :meth:`~rich.console.Console.capture` method which returns a context manager. On exit from this context manager, call :meth:`~rich.console.Capture.get` to return the string that would have been written to the terminal. Here's an example:: | |||
| There may be situations where you want to *capture* the output from a Console without writing it directly to the terminal. You can do this with the :meth:`~rich.console.Console.capture` method using echo parameter which returns a context manager. If echo value is set to True(default) text is captured and written to the terminal. When echo value is set to False text captured but not written to the terminal. On exit from this context manager, call :meth:`~rich.console.Capture.get` to return the string that would have been written to the terminal. Here's an example:: | |||
There was a problem hiding this comment.
default should be False, given that this was the default before
There was a problem hiding this comment.
Check #2338 "The capture method should have an echo parameter. When echo=True (the default) text should be captured and written to the terminal. When echo=False the text should be captured but not written to the terminal." @willmcgugan wants it true default.
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.
Type of changes
Checklist
Description
Added echo parameter for capture method. If value of echo is true, text is captured and showed in the terminal. If value of echo is false, text is captured but not showed in the terminal. Fixed earlier test for new argument and added new test. Changed documentation for capture. #2338