progress bar in jupyter notebook

[samsja]

Hey,

I discover a issue while using ProgressBar in a notebook, the progress bar is print at each new iteration instead of refreshing as excepted.

How to reproduce the error:

launch the following code in either jupyter lab or jupyter notebook.

using ProgressBars
for i in tqdm(0:3)
    sleep(0.1)
end

here is the output:

Is there a way to proprely use progress bar in notebook ? Maybe like tqdm.auto_notebook ?

Otherwise I would be glad to work on a PR.

Thanks in advance

[khdlr]

Hi samsja, that's odd. It might be that Jupyter doesn't support some of the ANSI escape sequences used. The way tqdm.auto_notebook does this is by providing a custom ipywidget. This might be quite a lot of work to implement for ProgressBars.jl. But the newlines should definitely be addressed.

I don't have much time to work on this library at the moment, but I'll gladly accept a PR :)

[dnadlinger]

@samsja: Did you get a chance to look into this? Seems to be the same issue as #44.

[samsja]

Hey @dnadlinger I did not pursue further on this issue

[oameye]

Would be nice if someone got it working.

[MilesCranmer]

I'm trying to get this working. In principle this snippet:

ProgressBars.jl/src/ProgressBars.jl

Line 247 in 4392f2b

go_to_start_of_line(output_stream::IO) = print(output_stream, "\r")

should work fine. But I think the other ansi escape sequences:

ProgressBars.jl/src/ProgressBars.jl

Lines 244 to 246 in 4392f2b

	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")

do not work for Jupyter, so need to be tweaked if a notebook is detected.

[MilesCranmer]

My sense is that these ANSI symbols are not supported in Jupyter: jupyter/notebook#2567. So this will not work without modifications. It looks like ANSI sequences are simply stripped: jupyter/notebook#444, rather than printed - which is why nothing else shows up.

One hacky solution to get this working is to print the entire progress bar (including multi-line prefixes/postfixes) to a single line of text, and then overwrite it with \r followed by spaces. However, for this, you would need to know the width of the Jupyter cell output, and update the width if the user changes the window size. I don't think this is possible for Jupyter (?).

A cleaner solution would be to use https://github.com/JuliaGizmos/Interact.jl to implement an actual Jupyter widget (like tqdm does). Or even just normal IJulia.jl display and clear_output.

[3f6a]

Related: timholy/ProgressMeter.jl#271, microsoft/vscode#118833

[dev10110]

https://github.com/timholy/ProgressMeter.jl works for me :)