Skip to content

Add showelapsed and showeta options to Progress #356

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.

Sign up for GitHub

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

Open
lgoettgens wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add showelapsed and showeta options to Progress #356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,37 @@ next!(p; showvalues = generate_showvalues(iter, x))
end
```

### Showing elapsed time

When using a `Progress`, it might be useful to show the elapsed time
in addition to or instead of the estimated time.
You can include elapsed time in your progress meter
by setting the optional keyword argument `showelapsed=true`.
If you want to additionally disable the estimated time,
you can set the optional keyword argument `showeta=false`.

```julia
x,n = 1,10
p = Progress(n; showselapsed=true)
for iter in 1:n
x *= 2
sleep(0.5)
next!(p; showvalues = [(:iter,iter), (:x,x)])
end
```

will yield something like:

```
Progress: XX%|███████████████████████████ | Time: XX:YY:ZZ ETA: XX:YY:ZZ
```

instead of

```
Progress: XX%|███████████████████████████ | ETA: XX:YY:ZZ
```

### Showing average time per iteration

You can include an average per-iteration duration in your progress meter
Expand Down
40 changes: 28 additions & 12 deletions src/ProgressMeter.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,19 +90,23 @@ end

"""
`prog = Progress(n; dt=0.1, desc="Progress: ", color=:green,
output=stderr, barlen=tty_width(desc), start=0)` creates a progress meter for a
output=stderr, start=0)` creates a progress meter for a
task with `n` iterations or stages starting from `start`. Output will be
generated at intervals at least `dt` seconds apart, and perhaps longer if each
iteration takes longer than `dt`. `desc` is a description of
the current task. Optionally you can disable the progress bar by setting
`enabled=false`. You can also append a per-iteration average duration like
"(12.34 ms/it)" to the description by setting `showspeed=true`.
By setting `showelapsed=true`, elapsed time will additionally be shown.
To disable the eta display, set `showeta=false`.
"""
mutable struct Progress <: AbstractProgress
n::Int # total number of iterations
start::Int # which iteration number to start from
barlen::Union{Int,Nothing} # progress bar size (default is available terminal width)
barglyphs::BarGlyphs # the characters to be used in the bar
showelapsed::Bool # whether to show elapsed time
showeta::Bool # whether to show eta time
# internals
core::ProgressCore

Expand All @@ -111,10 +115,12 @@ mutable struct Progress <: AbstractProgress
start::Integer=0,
barlen::Union{Int,Nothing}=nothing,
barglyphs::BarGlyphs=defaultglyphs,
showelapsed::Bool=false,
showeta::Bool=true,
kwargs...)
CLEAR_IJULIA[] = clear_ijulia()
core = ProgressCore(;kwargs...)
new(n, start, barlen, barglyphs, core)
new(n, start, barlen, barglyphs, showelapsed, showeta, core)
end
end

Expand Down Expand Up @@ -170,13 +176,15 @@ mutable struct ProgressUnknown <: AbstractProgress
end
end

#...length of percentage and ETA string with days is 29 characters, speed string is always 14 extra characters
function tty_width(desc, output, showspeed::Bool)
function tty_width(desc, output, showelapsed::Bool, showeta::Bool, showspeed::Bool)
full_width = displaysize(output)[2]
desc_width = length(desc)
eta_width = 29
speed_width = showspeed ? 14 : 0
return max(0, full_width - desc_width - eta_width - speed_width)
percent_width = 5 # " NNN%" at most
barend_width = 2 # "||"
elapsed_width = showelapsed ? 23 : 0 # " Time: D days, HH:MM:SS" at most
eta_width = showeta ? 23 : 0 # " ETA: D days, HH:MM:SS" at most
speed_width = showspeed ? 14 : 0 # " (NN.NN s/it)"
return max(0, full_width - desc_width - percent_width - barend_width - elapsed_width - eta_width - speed_width)
end

# Package level behavior of IJulia clear output
Expand Down Expand Up @@ -235,14 +243,16 @@ function _updateProgress!(p::Progress; showvalues = (),
if p.counter >= p.n
if p.counter == p.n && p.printed
t = time()
barlen = p.barlen isa Nothing ? tty_width(p.desc, p.output, p.showspeed) : p.barlen
barlen = p.barlen isa Nothing ? tty_width(p.desc, p.output, p.showelapsed, p.showeta, p.showspeed) : p.barlen
percentage_complete = 100.0 * p.counter / p.n
percentage_rounded = 100
bar = barstring(barlen, percentage_complete, barglyphs=p.barglyphs)
elapsed_time = t - p.tinit
dur = durationstring(elapsed_time)
spacer = endswith(p.desc, " ") ? "" : " "
msg = @sprintf "%s%s%3u%%%s Time: %s" p.desc spacer percentage_rounded bar dur
msg = @sprintf "%s%s%3u%%%s" p.desc spacer percentage_rounded bar
if p.showelapsed || p.showeta
msg = @sprintf "%s Time: %s" msg durationstring(elapsed_time)
end
if p.showspeed
sec_per_iter = elapsed_time / (p.counter - p.start)
msg = @sprintf "%s (%s)" msg speedstring(sec_per_iter)
Expand All @@ -266,7 +276,7 @@ function _updateProgress!(p::Progress; showvalues = (),
p.check_iterations = calc_check_iterations(p, t)
end
if force || (t > p.tlast+p.dt)
barlen = p.barlen isa Nothing ? tty_width(p.desc, p.output, p.showspeed) : p.barlen
barlen = p.barlen isa Nothing ? tty_width(p.desc, p.output, p.showelapsed, p.showeta, p.showspeed) : p.barlen
percentage_complete = 100.0 * p.counter / p.n
percentage_rounded = min(99, round(Int, percentage_complete)) # don't round up to 100% if not finished (#300)
bar = barstring(barlen, percentage_complete, barglyphs=p.barglyphs)
Expand All @@ -279,7 +289,13 @@ function _updateProgress!(p::Progress; showvalues = (),
eta = "N/A"
end
spacer = endswith(p.desc, " ") ? "" : " "
msg = @sprintf "%s%s%3u%%%s ETA: %s" p.desc spacer percentage_rounded bar eta
msg = @sprintf "%s%s%3u%%%s" p.desc spacer percentage_rounded bar
if p.showelapsed
msg = @sprintf "%s Time: %s" msg durationstring(elapsed_time)
end
if p.showeta
msg = @sprintf "%s ETA: %s" msg eta
end
if p.showspeed
sec_per_iter = elapsed_time / (p.counter - p.start)
msg = @sprintf "%s (%s)" msg speedstring(sec_per_iter)
Expand Down
18 changes: 18 additions & 0 deletions test/test.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,3 +579,21 @@ function testfunc23(N, range, dt, tsleep)
end
println("Testing rounding (#300)")
testfunc23(1000, [980;982;985;989;995;999;1000], 0.1, 1)

function testfunc24(n, dt, tsleep; kwargs...)
p = Progress(n; dt, kwargs...)
for i in 1:n
sleep(tsleep)
next!(p)
end
end

println("Testing showelapsed and showeta options")
testfunc24(1_000, 0.01, 0.002; desc="nothing", showelapsed=false, showeta=false)
testfunc24(1_000, 0.01, 0.002; desc="ETA only", showelapsed=false, showeta=true)
testfunc24(1_000, 0.01, 0.002; desc="Elapsed only", showelapsed=true, showeta=false)
testfunc24(1_000, 0.01, 0.002; desc="Elapsed + ETA", showelapsed=true, showeta=true)
testfunc24(1_000, 0.01, 0.002; desc="speed only", showelapsed=false, showeta=false, showspeed=true)
testfunc24(1_000, 0.01, 0.002; desc="ETA + speed", showelapsed=false, showeta=true, showspeed=true)
testfunc24(1_000, 0.01, 0.002; desc="Elapsed + speed", showelapsed=true, showeta=false, showspeed=true)
testfunc24(1_000, 0.01, 0.002; desc="Elapsed + ETA + speed", showelapsed=true, showeta=true, showspeed=true)