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.

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

Jump to bottom

Default to printing progress bar to sterr, rather than stdout. #47

Merged
merged 3 commits into from
Aug 12, 2021
Merged

Default to printing progress bar to sterr, rather than stdout. #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30d0c6c
Default to printing progress bar to sterr, rather than stdout.
InnovativeInventor Jul 26, 2021
53f4bb1
Remove hardcoded stderrs
InnovativeInventor Jul 27, 2021
65ca254
Add extra test to check if println(iter, stderr, ..) works
InnovativeInventor Jul 27, 2021
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
82 changes: 41 additions & 41 deletions src/ProgressBars.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,20 @@ mutable struct ProgressBar
description::AbstractString
multilinepostfix::AbstractString
mutex::Threads.SpinLock
output_stream::IO

function ProgressBar(wrapped::Any;
total::Int=-2,
width::Union{UInt, Nothing}=nothing,
leave::Bool=true,
unit::AbstractString="",
unit_scale::Bool=true,
printing_delay::Number=0.05)
printing_delay::Number=0.05,
output_stream::IO=stderr)
this = new()
this.wrapped = wrapped
if width == nothing
this.width = displaysize(stdout)[2]
this.width = displaysize(output_stream)[2]
this.fixwidth = false
else
this.width = width
Expand All @@ -78,6 +80,7 @@ mutable struct ProgressBar
this.extra_lines = 0
this.mutex = Threads.SpinLock()
this.current = 0
this.output_stream = output_stream

if total == -2 # No total given
try
Expand Down Expand Up @@ -150,13 +153,13 @@ function display_progress(t::ProgressBar)

# Reset Cursor to beginning of the line
for line in 1:t.extra_lines
move_up_1_line()
move_up_1_line(t.output_stream)
end
go_to_start_of_line()
go_to_start_of_line(t.output_stream)

if t.description != ""
barwidth -= length(t.description) + 1
print(t.description * " ")
print(t.output_stream, t.description * " ")
end

if (t.total <= 0)
Expand All @@ -167,10 +170,10 @@ function display_progress(t::ProgressBar)
barwidth = 0
end

print("┣")
print(join(IDLE[1 + ((i + t.current) % length(IDLE))] for i in 1:barwidth))
print("┫ ")
print(status_string)
print(t.output_stream, "┣")
print(t.output_stream, join(IDLE[1 + ((i + t.current) % length(IDLE))] for i in 1:barwidth))
print(t.output_stream, "┫ ")
print(t.output_stream, status_string)
else
ETA = (t.total-t.current) / speed

Expand All @@ -189,32 +192,32 @@ function display_progress(t::ProgressBar)
cellvalue = t.total / barwidth
full_cells, remain = divrem(t.current, cellvalue)

print(percentage_string)
print("┣")
print(repeat("█", Int(full_cells)))
print(t.output_stream, percentage_string)
print(t.output_stream, "┣")
print(t.output_stream, repeat("█", Int(full_cells)))
if (full_cells < barwidth)
part = Int(floor(9 * remain / cellvalue))
print(EIGHTS[part])
print(repeat(" ", Int(barwidth - full_cells - 1)))
print(t.output_stream, EIGHTS[part])
print(t.output_stream, repeat(" ", Int(barwidth - full_cells - 1)))
end

print("┫ ")
print(status_string)
print(t.output_stream, "┫ ")
print(t.output_stream, status_string)
end
multiline_postfix_string = newline_to_spaces(t.multilinepostfix, t.width)
t.extra_lines = ceil(Int, length(multiline_postfix_string) / t.width) + 1
print(multiline_postfix_string)
println()
print(t.output_stream, multiline_postfix_string)
println(t.output_stream)
end

function clear_progress(t::ProgressBar)
# Reset cursor, fill width with empty spaces, and then reset again
print("\r", " "^t.width, "\r")
print(t.output_stream, "\r", " "^t.width, "\r")
for line in 1:(t.extra_lines)
erase_line()
move_up_1_line()
erase_line(t.output_stream)
move_up_1_line(t.output_stream)
end
erase_line()
erase_line(t.output_stream)
end

function set_description(t::ProgressBar, description::AbstractString)
Expand All @@ -237,14 +240,14 @@ function postfix_repr(postfix::NamedTuple)::AbstractString
return join(map(tpl -> ", $(tpl[1]): $(tpl[2])", zip(keys(postfix), postfix)))
end

make_space_after_progress_bar(extra_lines) = print("\n"^(extra_lines + 2))
erase_to_end_of_line() = print("\033[K")
move_up_1_line() = print("\033[1A")
move_down_1_line() = print("\033[1B")
go_to_start_of_line() = print("\r")
erase_line() = begin
go_to_start_of_line()
erase_to_end_of_line()
make_space_after_progress_bar(output_stream::IO, extra_lines) = print(output_stream, "\n"^(extra_lines + 2))
erase_to_end_of_line(output_stream::IO) = print(output_stream, "\033[K")
move_up_1_line(output_stream::IO) = print(output_stream, "\033[1A")
move_down_1_line(output_stream::IO) = print(output_stream, "\033[1B")
go_to_start_of_line(output_stream::IO) = print(output_stream, "\r")
erase_line(output_stream::IO) = begin
go_to_start_of_line(output_stream)
erase_to_end_of_line(output_stream)
end


Expand Down Expand Up @@ -279,11 +282,11 @@ function Base.iterate(iter::ProgressBar,s)
iter.current += 1
if(time_ns() - iter.last_print > iter.printing_delay)
if !iter.fixwidth
current_terminal_width = displaysize(stdout)[2]
current_terminal_width = displaysize(iter.output_stream)[2]
terminal_width_changed = current_terminal_width != iter.width
if terminal_width_changed
iter.width = current_terminal_width
make_space_after_progress_bar(iter.extra_lines)
make_space_after_progress_bar(iter.output_stream, iter.extra_lines)
end
end
display_progress(iter)
Expand Down Expand Up @@ -363,16 +366,13 @@ end
function Base.println(t::ProgressBar, xs...)
# Reset Cursor to beginning of the line
for line in 1:t.extra_lines
move_up_1_line()
erase_line()
move_up_1_line(t.output_stream)
erase_line(t.output_stream)
end
go_to_start_of_line()
println(xs...)
for line in 1:t.extra_lines
move_down_1_line()
end
println()
display_progress(t)
go_to_start_of_line(t.output_stream)
println(xs...) # goes to stdout, by default
println(t.output_stream)
display_progress(t) # goes to stdout, by default
end

end # module
41 changes: 24 additions & 17 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,58 @@ bar = ProgressBar(1:10)
pre = "Testing Progress Bars. All progress bars should end "
post = " here ▕"
num_dots = bar.width - length(pre) - length(post)
println(pre * repeat(".", num_dots) * post)
println(stderr, pre * repeat(".", num_dots) * post)

println("> Basic pbar test")
println(stderr, "> Basic pbar test")
for i in bar
end
@test true

println("> Test time taken for a fast iteration (printing only every 50ms)")
println(stderr, "> Test time taken for a fast iteration (printing only every 50ms)")
iter = ProgressBar(1:10000, printing_delay=0.05)
tic = time_ns()
for i in iter
i = i * 2
end
toc = time_ns()
@test (toc - tic) / 1e9 < 0.2
println("> Took $((toc - tic) * 1e-6)ms")
println(stderr, "> Took $((toc - tic) * 1e-6)ms")

println("> Test time taken when printing every iteration, should be much longer than previous one")
println(stderr, "> Test time taken when printing every iteration, should be much longer than previous one")
iter = ProgressBar(1:10000, printing_delay=0)
tic = time_ns()
for i in iter
i = i * 2
end
toc = time_ns()
@test true
println("> Took $((toc - tic) * 1e-6)ms")
println(stderr, "> Took $((toc - tic) * 1e-6)ms")

println("> Test special case of single iteration progress bar")
println(stderr, "> Test special case of single iteration progress bar")
for i in ProgressBar(1:1)
end

println("> Test tqdm alias")
println(stderr, "> Test tqdm alias")
for i in tqdm(1:1000)
sleep(0.0001)
end
@test true

println("> Test print from within a ProgressBar Loop")
println(stderr, "> Test print to stdout from within a ProgressBar Loop")
iter = ProgressBar(1:5)
for i in iter
println(iter, "Printing from iteration $i")
sleep(0.2)
end

println("> Test with description")
println(stderr, "> Test print to stderr from within a ProgressBar Loop")
iter = ProgressBar(1:5)
for i in iter
println(iter, stderr, "Printing from iteration $i")
sleep(0.2)
end

println(stderr, "> Test with description")
iter = ProgressBar(1:1000)
for i in iter
# ... Neural Network Training Code
Expand All @@ -59,7 +66,7 @@ for i in iter
end
@test true

println("> Test with regular postfix")
println(stderr, "> Test with regular postfix")
iter = ProgressBar(1:1000)
for i in iter
sleep(0.0001)
Expand All @@ -68,7 +75,7 @@ for i in iter
end
@test true

println("> Test with multiline postfix")
println(stderr, "> Test with multiline postfix")
iter = ProgressBar(1:1000)
for i in iter
sleep(0.0001)
Expand All @@ -77,7 +84,7 @@ for i in iter
end
@test true

println("> Test with regular postfix and multiline postfix")
println(stderr, "> Test with regular postfix and multiline postfix")
iter = ProgressBar(1:1000)
for i in iter
sleep(0.0001)
Expand All @@ -87,20 +94,20 @@ for i in iter
end
@test true

println("> Test with leave=false, there should be no pbar left below this!")
println(stderr, "> Test with leave=false, there should be no pbar left below this!")
iter = ProgressBar(1:1000, leave=false)
for i in iter
sleep(0.0001)
end
@test true

println("> Testing pbar without total number specified")
println(stderr, "> Testing pbar without total number specified")
for i in ProgressBar(1:100, total=-1)
sleep(0.001)
end
@test true

println("> Testing Threads for Julia 1.3")
println(stderr, "> Testing Threads for Julia 1.3")
if VERSION >= v"1.3.0"
a = []
Threads.@threads for i in ProgressBar(1:1000)
Expand All @@ -109,7 +116,7 @@ if VERSION >= v"1.3.0"
end
@test true

println("> Testing pbar with custom units")
println(stderr, "> Testing pbar with custom units")
for i in ProgressBar(1:100, unit="flobberwobbles")
sleep(0.001)
end
Expand Down