convert to dual outputs: pager and stdout #1388
Open
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
teepark
force-pushed
the
bug/status-to-stdout
branch
from
558299b
to
3434f8d
Compare
j-bennet
reviewed
Jan 3, 2023
regular output (mainly query results) goes to the pager. status output goes directly to stdout. Both implement a consistent interface for easy mocking in tests.
teepark
force-pushed
the
bug/status-to-stdout
branch
from
b8cdf44
to
5902d2a
Compare
Stdout and Pager can just be the same thing "OutputHandler" that just wraps a function which handles output, this way the CLI can create instances for each by passing `click.echo` and `self.echo_via_pager` and the output module avoids unnecessary knowledge/coupling. Log is a little trickier to de-couple from CLI, because it can't just wrap a file path (the only thing it knew about on CLI) since that gets changed all the time mid-process. So it grows a method for updating it's target path and CLI can use that instead of changing `self.output_file`.
teepark
force-pushed
the
bug/status-to-stdout
branch
from
5902d2a
to
6446600
Compare
|
@teepark Would you be able to resolve the conflicts? |
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.
regular output (mainly query results) goes to the pager. status output goes directly to stdout.
both implement a consistent interface for easy mocking in tests.
Description
Picking up where #1383 left off.
We agreed on the need to separate normal query result output from status output. The previous PR used stdout and stderr, but we decided instead to use the pager's stdin and pgcli's stdout as the two streams.
Further, because there's a need to maintain order in the output lines even across the two streams, this PR inverts control and takes a DI approach, pushing "output emitters" down into the PGCli object. The previously pure "format_output" function is now "emit_output" which takes the injected emitters. For tests, we mock out the emitters with an implementation that collects the output lines in order for later assertions.
Checklist
changelog.rst.AUTHORSfile (or it's already there).pip install pre-commit && pre-commit install), and ranblackon my code.