SNOW-986249-console-output-tools: cli_console for intermediate output #659
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
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
3 times, most recently
from
275a283 to
f36855c
Compare
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
2 times, most recently
from
975b465 to
790c90e
Compare
sfc-gh-mraba
changed the title
sfc-gh-mraba
requested review from
sfc-gh-turbaszek,
sfc-gh-pjob,
sfc-gh-jsikorski,
sfc-gh-astus and
sfc-gh-pczajka
as code owners
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
from
813710e to
a3b98b3
Compare
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
from
a3b98b3 to
e52a5e9
Compare
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
4 times, most recently
from
928ece5 to
055efbd
Compare
sfc-gh-turbaszek
previously approved these changes
Jan 26, 2024
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
4 times, most recently
from
3a0eb87 to
c768626
Compare
…CliConsole and AbstractConsole
… added error output type
…e type to Optional str with default
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
from
35641a8 to
00b2ca4
Compare
| def test_step_indented_in_phase(cli_console, capsys): | ||
| with cli_console.phase("42"): | ||
| cli_console.step("73") | ||
| assert_output_matches("42\n 73\n", capsys) |
There was a problem hiding this comment.
nit: for readability, I'd probably modify the helper so that it accepts individual lines instead. For simple examples it's not too bad, but more complex ones are tricky to read quickly.
There was a problem hiding this comment.
IMO more complex ones should be handled with syrupy snapshots.
sfc-gh-mraba
force-pushed
the
SNOW-986249-console-output-tools
branch
from
6a63c1d to
f574219
Compare
Comment on lines
+188
to
+193
| with cc.phase("Long sequence of actions"): | ||
| cc.step("Phased step 1") | ||
| cc.step("Phased step 2") | ||
| if something_important: | ||
| cc.warning("It's important") | ||
| cc.step("Final step") |
There was a problem hiding this comment.
Let's add business logic to this example to show how it should relate with steps and phases. WDYT?
There was a problem hiding this comment.
I'll submit update in separate PR 👍
sfc-gh-turbaszek
approved these changes
Feb 7, 2024
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.
SNOW-986249
Pre-review checklist
Changes description
snowflake.cli.api.outputpackage introducessnow_cliobject for displaying console intermediate outputphaseandstepprovide displaying output to consolestepmethod for displaying messages to userswarningmethod for displaying important messages to usersphasemethod for grouping messages in distinctive way