Notebook output must support more ANSI sequences

[jrieken]

follow up from https://github.com/microsoft/vscode/pull/116416#discussion_r593259173 and other discussions

Kernels often print stdout/stderr content with the assumption of being connected to a terminal. With that mindset they send ANSI sequences. Some of those sequences we support, like colors. We current don't support the sequence that clears the screen and that forces the jupyter extension to employ funny workarounds: they scan all output for that sequence, remember that so that they can clear the output before appending the next chunk. Things would be much simpler for them if we would simply support that ANSI sequence.

[vscode-triage-bot]

Pinging notebook topic followers: @claudiaregio @rchiodo @greazer @donjayamanne @jilljac

[jrieken]

cc @DonJayamanne for the sequence in question

[DonJayamanne]

I'll update this issue with samples of the special characters that we support today.

[DonJayamanne]

Here are the special cases we have today (3 of them), anything beyond these would be an added bonus for anyone using VSCode to render streams.

Control Characters reference https://en.wikipedia.org/wiki/ANSI_escape_code#Control_characters

^	C0	Abbr	Name	Effect
^H	8	BS	Backspace	Moves the cursor left (but may "backwards wrap" if cursor is at start of line). Used here in our code https://github.com/microsoft/vscode-jupyter/blob/b368ea9326c13d6497e0f070d89d810d4ff86416/src/datascience-ui/common/index.ts#L94-L94
^M	0xD	CR	Carriage Return	Moves the cursor to column zero. Used here in our code https://github.com/microsoft/vscode-jupyter/blob/b368ea9326c13d6497e0f070d89d810d4ff86416/src/datascience-ui/common/index.ts#L105-L105

Control Sequence reference https://en.wikipedia.org/wiki/ANSI_escape_code#CSI_(Control_Sequence_Introducer)_sequences

CSI Character	Abbr	Name	Effect
CSI n A	CUU	Cursor Up	Moves the cursor n (default 1) cells in the given direction. If the cursor is already at the edge of the screen, this has no effect, Used here https://github.com/microsoft/vscode-jupyter/blob/77d6162044e691085fb90dc12112ede8951b6ef7/src/client/datascience/jupyter/kernels/cellExecution.ts#L658-L658

[DonJayamanne]

FYI - In our older webview we have support for general ANSI color codes as well.

[bpasero]

Moved to Backlog since this has no owner, please change as appropriate.

[roblourens]

@DonJayamanne did you implement this as part of that streaming output perf issue?

[davidanthoff]

Bump, I would also be interested in a status update on this for the Julia extension :)

[DonJayamanne]

@davidanthoff please could you share more information about the specific ANSI codes that Julia extension would need support for Thanks

[T-256]

I just noticed https://code.visualstudio.com/updates/v1_80#_terminal-output-support last day, Is it possible to have terminal as notebook output renderer? (As separated extension)

[davidanthoff]

@DonJayamanne so I think in general the more the better, at the end of the day any package might just assume that things are run in a terminal that supports a lot of stuff.

Having said that, there is one extremely popular package in the Julia ecosystem that shows progress bars that is really broken at the moment, and if we just added support for the sequences that are needed there it would go a very, very long way to improve things. The specific sequences that are need are ESC [K, ESC [An (where n is a number) and ESC [A and generally support for \r. More details over at https://github.com/timholy/ProgressMeter.jl/issues/271.

[MilesCranmer]

Putting in another vote of support for this. Relevant ProgressBars.jl issue: https://github.com/cloud-oak/ProgressBars.jl/issues/49. ProgressBars.jl needs basically the same ANSI sequences as ProgressMeter.jl (only difference is it also needs vertical movement via [1A and [1B):

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

It's used as the main printing utility for the Python package pysr (1.4k⭐️) and Julia package SymbolicRegression.jl (450⭐️). Currently these packages cannot use progress bars in notebooks, so they have to fall back to regular printing.

[davidanthoff]

@DonJayamanne and @amunger just wanted to check in on this again, this is probably the number one pain point I have right now with the notebook stuff for Julia :) Is there anything from our end we could do to help move this forward? At least the limited set of ANSI sequences I indicated above? Thanks :)

[DonJayamanne]

@davidanthoff sorry there hasn't been any update since, lets wait for @amunger to get back

[amunger]

The current limited escape codes we handle are handled manually here with some related tests.

We should be handling this more holistically, and I think there was a plan to do just that, but I'm not sure when we'll be able to get around to that. If you see a somewhat straightforward way to add in the set of escape codes that you need, I'd be happy to help review a contribution.

[DonJayamanne]

@davidanthoff I just tried the following code and it works as expected

p = Progress(10)
for i in 1:10
    sleep(0.5)
    next!(p)
end

Also tried almost all the samples here https://github.com/timholy/ProgressMeter.jl and they all work as expected. FYI = I'm using the Julia kernel isntalled via IJulia

It only fails to work when using the Julia VS Code extension Is it not possible to update the Julia VS Code extension accordingly. Given that it works natively when using IJulia, it feels like updating Julia VS Code extension might be one of the ways to get this addressed.

[davidanthoff]

I looked a bit more, and I think if we could fix https://github.com/julia-vscode/julia-vscode/issues/3561 it would already be great progress. @DonJayamanne or @amunger if you could point me in the right direction for that issue it would be great!

That still won't cover all cases: as soon as ProgressMeter.jl has a progress bar that also outputs additional info that would trigger a multi-line output (essentially next!(p, showvalues=[(:foo, 4), (:bar, 6)]) style) then things start to look bad on any Jupyter implementation because then ProgressMeter.jl resorts to just clearing the entire cell output with every update, so any output before the progress bar is lost. While it would obviously be nice to fix that also (and more complete support for ANSI sequences would be the solution there) that seems maybe less urgent.

[CreatorZZY]

同样地，在R中使用purrr::map(.progress=TRUE)时候产生的进度条也不是正确的。

[3f6a]

Friendly bump. If I understand correctly fixing this is a prerequisite for https://github.com/timholy/ProgressMeter.jl/issues/271 ?