IOColor (IOContext part 2?) #27430

vtjnash · 2018-06-04T22:38:46Z

While working on the original IOContext PR, I had created a PoC of fully handling nested color. Here, I'm working on finally reviving and finishing that, building on all of the other new work towards better color handling.

Some color / format nesting in action:

julia> let buf = IOBuffer()
           Base.with_output_color(:red, IOContext(buf, :color => true)) do io; print(io, "red",
               Base.text_colors[:underline], " underline") # emit some formatting code directly too
           Base.with_output_color(:blue, io) do io; print(io, " blue") # nested blue
           Base.with_output_color(:bold, io) do io; print(io, " bold") # nested bold
           Base.with_output_color(:green, io) do io; print(io, " green\ngreen") # with a newline!
           end; print(io, " bold",
               Base.text_colors[:underline], " underline")
           end; print(io, " blue")
           end; print(io, " red")
           end
           String(take!(buf))
       end
"\e[31mred\e[4m underline\e[34m blue\e[1m bold\e[32m green\e[22m\e[39m\n\e[32m\e[1mgreen\e[34m bold\e[4m underline\e[22m blue\e[31m red\e[39m"

There's also some demo code in here of how that output could also be turned into html (ref #5239), which was probably the real purpose behind this work (although not actually finished or enabled here).

ararslan · 2018-06-04T23:00:05Z

base/formatio.jl

+pipe_writer(io::IOFormatBuffer) = io.buf
+pipe_reader(io::IOFormatBuffer) = error("IOFormatBuffer not readable")
+
+function with_output_color(f::Function, color::Union{Int, Symbol}, io::IO, args...; bold::Bool = false)


Perhaps a good opportunity to rename with_output_color to something less ugly?

I had some recollection that we'd already renamed it to styled or something like that?

We changed print_with_color to printstyled, but left with_output_color unchanged, I forget why.

Maybe withstyle(f, io, color=..., bold=...)?

Or perhaps just styled(f, io, color=, bold=)?

bold being some arbitrary special kwarg should probably be deprecated

Why's that? In printstyled we have color and bold keyword arguments and that seems to work quite nicely.

vtjnash · 2018-06-09T06:20:34Z

Anyone seen this error before?
https://ci.appveyor.com/project/JuliaLang/julia/build/1.0.27586/job/9s6uqvwkwn1ebl8q#L3277

The global RNG seed was 0xd11701fbc3bda26f50d41cb8a2efb875.
3278
3279Error in testset SuiteSparse:
3280Error During Test at C:\projects\julia\julia-6ae2e7d268\share\julia\stdlib\v0.7\SuiteSparse\test\umfpack.jl:92
3281  Got exception LinearAlgebra.SingularException(0) outside of a @test
3282  LinearAlgebra.SingularException(0)
3283  Stacktrace:
3284   [1] #lu#1(::Bool, ::Function, ::SparseArrays.SparseMatrixCSC{Float64,Int32}) at C:\projects\julia\usr\share\julia\stdlib\v0.7\SuiteSparse\src\umfpack.jl:159
3285   [2] lu(::SparseArrays.SparseMatrixCSC{Float64,Int32}) at C:\projects\julia\usr\share\julia\stdlib\v0.7\SuiteSparse\src\umfpack.jl:152
3286   [3] macro expansion at C:\projects\julia\julia-6ae2e7d268\share\julia\stdlib\v0.7\SuiteSparse\test\umfpack.jl:76 [inlined]
3287   [4] macro expansion at C:\projects\julia\usr\share\julia\stdlib\v0.7\Test\src\Test.jl:1153 [inlined]
3288   [5] macro expansion at C:\projects\julia\julia-6ae2e7d268\share\julia\stdlib\v0.7\SuiteSparse\test\umfpack.jl:17 [inlined]
3289   [6] macro expansion at C:\projects\julia\usr\share\julia\stdlib\v0.7\Test\src\Test.jl:1080 [inlined]
3290   [7] top-level scope at C:\projects\julia\julia-6ae2e7d268\share\julia\stdlib\v0.7\SuiteSparse\test\umfpack.jl:7 [inlined]

…from type hierarchy

And handle the attribute more consistently. Also, ensure that `Terminals.supports_color` asks `tput` the right question, and checks for getting back the required answer.

fully support nesting of ANSI color and format codes, and provide a scaffold which could be used for supporting more complex formatting (or other rich side information).

This is a port of `_truncate_at_width_or_chars` to any IO object.

While building complex output, it is sometimes useful to be able to stage content in a separate buffer, then append it to the final output. Support that, by deferring the final render when simply transfering content between IOFormatBuffers with write

fix #27540

Also some move some code to more preferred locations

The call `with_format(io) do io; end` is very beneficial for mono-morphizing IO code (enabling it to be precompiled) and buffering it (potentially making it faster and reducing interleaving of output) And try to improve some IO code to utilize it more / better

KristofferC · 2024-05-13T11:00:58Z

I think this can be closed since my guess is that this will be incompatible with the styled strings stuff.

vtjnash · 2024-05-13T12:27:22Z

It is mostly all compatible, as they have similar designs, but a lot of work possibly to filter through here and pick up any fixes that didn't already get separately put in master

vtjnash added the io Involving the I/O subsystem: libuv, read, write, etc. label Jun 4, 2018

ararslan reviewed Jun 4, 2018

View reviewed changes

vtjnash force-pushed the jn/iocolor2 branch from f38e992 to ee1fb62 Compare June 8, 2018 22:25

vtjnash force-pushed the jn/iocolor2 branch from ee1fb62 to 9318557 Compare June 11, 2018 20:35

vtjnash mentioned this pull request Jun 12, 2018

Incorrect alignment of nested colored output #27540

Closed

vtjnash force-pushed the jn/iocolor2 branch from 9318557 to 6f76f78 Compare June 22, 2018 22:05

vtjnash added 9 commits June 23, 2018 18:17

REPL: remove unused abstract type TextTerminal (== AbstractTerminal) …

f7161e1

…from type hierarchy

IOContext: make color just another normal attribute

b5f5229

And handle the attribute more consistently. Also, ensure that `Terminals.supports_color` asks `tput` the right question, and checks for getting back the required answer.

format-io: support fully structured color formats

ddedb6e

fully support nesting of ANSI color and format codes, and provide a scaffold which could be used for supporting more complex formatting (or other rich side information).

io-format: demonstrate html formatted output

e742717

remove Dict show code from Core.Compiler

9b9fe48

IO: add support for truncate-to-textwidth

bc6f1e8

This is a port of `_truncate_at_width_or_chars` to any IO object.

wip

ddef45c

make test file

dd1260a

vtjnash force-pushed the jn/iocolor2 branch from 6f76f78 to a3434b9 Compare June 23, 2018 23:10

vtjnash mentioned this pull request Jun 23, 2018

Julep: extended proposal for fixing show, print, & friends #14052

Closed

vtjnash added 3 commits June 23, 2018 19:43

show: support color nesting for Dict better

4585af2

fix #27540

move code [ci skip]

335d244

print aligned: use textwidth not length

063808c

Also some move some code to more preferred locations

vtjnash force-pushed the jn/iocolor2 branch 2 times, most recently from be2cfa7 to da14d3c Compare June 24, 2018 00:21

vtjnash added 3 commits June 23, 2018 20:49

[ci skip]

f49dde2

fixup! rename with_output_color to with_format

36d7ad4

vtjnash force-pushed the jn/iocolor2 branch from da14d3c to 36d7ad4 Compare June 24, 2018 01:21

c42f mentioned this pull request Nov 20, 2018

Allow logging meta-formatter to set suffix color #29397

Closed

c42f mentioned this pull request Apr 29, 2019

List of Tensorboard Plugins and Julia Types JuliaLogging/TensorBoardLogger.jl#10

Open

vtjnash mentioned this pull request Nov 26, 2019

Improve how some kind of Expr are displayed by the show method #32423

Merged

vtjnash mentioned this pull request Apr 26, 2020

IOContext property to switch XML declaration #35586

Open

vtjnash mentioned this pull request Sep 15, 2020

Containers that limit the output does not reset the terminal state (e.g. colors) when printing a new line #37564

Open

vtjnash mentioned this pull request Nov 23, 2020

HTML constructor should only accept AbstractString #38540

Closed

StefanKarpinski mentioned this pull request May 10, 2021

show(::String): elide long strings (close #40724) #40736

Merged

StefanKarpinski mentioned this pull request Jun 24, 2021

Overhaul display of a Trial JuliaCI/BenchmarkTools.jl#217

Merged

This was referenced May 15, 2023

Depth-limited printing of types in stacktraces take 2! #49795

Merged

AnnotatedStrings, and a string styling stdlib #49586

Merged

KristofferC closed this May 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IOColor (IOContext part 2?) #27430

IOColor (IOContext part 2?) #27430

vtjnash commented Jun 4, 2018

ararslan Jun 4, 2018

StefanKarpinski Jun 4, 2018

ararslan Jun 4, 2018

ararslan Jun 5, 2018

ararslan Jun 5, 2018

vtjnash Jun 13, 2018

ararslan Jun 13, 2018

vtjnash commented Jun 9, 2018

KristofferC commented May 13, 2024

vtjnash commented May 13, 2024

IOColor (IOContext part 2?) #27430

IOColor (IOContext part 2?) #27430

Conversation

vtjnash commented Jun 4, 2018

ararslan Jun 4, 2018

Choose a reason for hiding this comment

StefanKarpinski Jun 4, 2018

Choose a reason for hiding this comment

ararslan Jun 4, 2018

Choose a reason for hiding this comment

ararslan Jun 5, 2018

Choose a reason for hiding this comment

ararslan Jun 5, 2018

Choose a reason for hiding this comment

vtjnash Jun 13, 2018

Choose a reason for hiding this comment

ararslan Jun 13, 2018

Choose a reason for hiding this comment

vtjnash commented Jun 9, 2018

KristofferC commented May 13, 2024

vtjnash commented May 13, 2024