emitter: add "streaming brief" feature #166
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
tigarmo
force-pushed
the
CRAFT-1951-stream-log-brief
branch
2 times, most recently
from
e9cf33a
to
289925b
Compare
Codecov Report
@@ Coverage Diff @@
## main #166 +/- ##
==========================================
+ Coverage 94.40% 94.54% +0.13%
==========================================
Files 7 7
Lines 1019 1044 +25
Branches 187 192 +5
==========================================
+ Hits 962 987 +25
Misses 53 53
Partials 4 4
|
tigarmo
force-pushed
the
CRAFT-1951-stream-log-brief
branch
4 times, most recently
from
5f99e52
to
5fe64cf
Compare
This commit adds a new feature to the Emitter, tentatively called
"streaming brief". It is initially disabled, and can be enabled in
the Emitter's init() call.
Once enabled, the feature will leverage the "multi-action" nature of
progress() calls to "stream", in a single line, info-level log messages
and text written to the open_stream()'s pipe when in BRIEF mode. For
example, the following sequence of calls (in BRIEF mode):
```
emit.progress("Starting stage 1", permanent=False)
...
log.info("Doing first step")
...
log.info("Doing second step")
...
emit.progress("Finished stage 1", permanent=True)
```
... will cause the two 'info' messages to "stream" on the terminal,
prefixed by "Starting stage 1 ::" to indicate that they are related to
that progress message. All these three messages are ephemeral which
means that in the end only the final progress() call will be visible
on the terminal.
Fixes #165
tigarmo
force-pushed
the
CRAFT-1951-stream-log-brief
branch
from
5fe64cf
to
e60af45
Compare
tigarmo
changed the title
lengau
reviewed
Aug 10, 2023
cmatsuoka
approved these changes
Aug 10, 2023
lengau
approved these changes
Aug 10, 2023
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.
This commit adds a new feature to the Emitter, tentatively called "streaming brief". It is initially disabled, and can be enabled in the Emitter's init() call.
Once enabled, the feature will leverage the "multi-action" nature of progress() calls to "stream", in a single line, info-level log messages and text written to the open_stream()'s pipe. For example, the following sequence of calls in BRIEF mode:
... will cause the two 'info' messages to "stream" on the terminal, prefixed by "Starting stage 1 ::" to indicate that they are related to that progress message. All these three messages are ephemeral which means that in the end only the final progress() call will be visible on the terminal.
Fixes #165
tox?