Colorize exception notes

[StanFromIreland]

Feature or enhancement

Proposal:

For example:

They are part of the traceback, I think it would make sense for them to be coloured like the error message.
I have a patch ready.

Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Linked PRs

• gh-140049: Colorize exception notes in traceback.py #140051

[picnixz]

IMO, we shouldn't. Notes can be very long while exception messages are ususally shorter. I would find disruptive to have a fully colored wall of text (which may not necessarily be readable (I feel the purple not very readable no a dark theme if there is a very long text)).

I think we need more input here.

[StanFromIreland]

I see your point, let's wait for input from others. However, as for the colour, that can be configured. If you have a suggestion for it I am happy to apply it in the PR.

[ZeroIntensity]

I think I agree with Bénédikt. An exception note is different from the exception message, and giving it the same color hurts that distinction (especially in exceptions that contain newlines).

I wouldn't be opposed to giving the note a different color, but what color would that be?

[StanFromIreland]

Here are all of the colours currently available in _colorize.ANSIColors:

[Locked-chess-official]

I think that the color for note should be optional.

It seems that it has conflict with my plan "exception_target" (what after the exception message is "exception_target" instead of "__notes__"):

If it finally be accepted, I will try to resolve my PR for it.

[picnixz]

Even if we can configure colors, I don't like having a wall of text being colored, whatever color we choose. Sure we can disable the color itself for the given theme, but we currently have no way to properly configure themes in a configuration file.

As for "exception target" if this is something meant to be on any exception, this requires a PEP I think (but I do not see the needs of it since we can use notes..)

[Locked-chess-official]

since we can use notes

In now "test_traceback", some tests get the last line of the exception message to get the exception message and test. However, after this change, it failed. So I try to use a new way that can just get the original message. And if the Exception has its original "__notes__" that not a list, we cannot add any note on it. The "exception target" is only for "TracebackException" instead of "BaseException" to get the Exception message or the other special handle message while handle the original Exception

[picnixz]

Let us discuss this separately on the original issue. I do not think it is relevant to the colorization of notes.

[hugovk]

Do you have some examples of exception notes that are walls of text?

Do we have any stats on the variation of exception note length in open source projects?

[picnixz]

Well.. we recently improved an exception in Generic which I consider wall of text (more than one sentence is already painful to read if it is entitely colored for me). I see notes as something apart from the exception message and thus semantically different. The choice of the notes' color may also be different depending on the exception (maybe the note should be colored in red for important ones, and yellow otherwise for instance, but that is up to the user)

[Locked-chess-official]

The question is that if I add my ANSI color in my import part of the note then use "\033[0m" the text after it won't be colorized by the default color. In fact, the custom exception often use raise to raise and at that time user cannot contact traceback.TracebackException or traceback.print_exc except they use them to print it instead of raise it, so I think that the note should be only colorized by user.

[hugovk]

Kickstarting this again, here's the note in bold blue and cyan, either looks good to me: