Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

emitter: add "streaming brief" feature #166

Merged
merged 2 commits into from
Aug 10, 2023
Merged

Commits on Aug 9, 2023

  1. emitter: add "streaming brief" feature

    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 committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    e60af45 View commit details
    Browse the repository at this point in the history

Commits on Aug 10, 2023

  1. Configuration menu
    Copy the full SHA
    3ad948e View commit details
    Browse the repository at this point in the history