ConsoleProgressMonitor.jl: A ProgressMeter.jl-Logging.jl bridge

NOTE:TerminalLoggers.jl supersedes this package. Please use TerminalLoggers.jl.

Usage

Setup

julia> using ConsoleProgressMonitor

julia> ConsoleProgressMonitor.install_logger();

Alternatively, use ConsoleProgressMonitor.with_progresslogger to temporary enable ConsoleProgressMonitor.

Print progress meter

Any logging events that are compatible with Juno.progress specification are displayed using ProgressMeter.Progress.

julia> using Logging: @logmsg, LogLevel

julia> let id = gensym(:id)
           for i = 1:10
               sleep(0.1)
               @logmsg LogLevel(-1) "iterating" progress=i/10 _id=id
           end
           @logmsg LogLevel(-1) "iterating" progress="done" _id=id
       end

ProgressLogger(; colors, progress_options...)

Keyword Arguments

• colors :: Vector{Symbol}: a list of colors used for progress meters.
• Other keyword arguments are used for constructing ProgressMeter.Progress.

install_logger(; options...)
install_logger(logger::ProgressLogger)

Install ProgressLogger to global logger.

Keyword arguments options are passed to ProgressLogger constructor.

uninstall_logger()

Rollback the global logger to the one before last call of install_logger.

with_progresslogger(f; options...)

Run f with ProgressLogger enabled.