Traceback: highlight local paths

[SebCorbin]

When I look at errors, it is most likely my own code is the one messed up, so on large tracebacks it would be nice to have it bold.

It was raised in an earlier feature request but dismissed in favor of suppressing the frames. But I find it odd to suppress information, because I want to be able to look at variables across the stack. Even if my code may not be right, that may be third-party code that mess with my data.

In terms of implementation, I suggest having a highlight_local_path param to Traceback that handle bold highlight through PathHighlighter:

class Traceback:
    def __init__(
        ...,
        highlight_local_path=None
    ):
        ...
        self.path_highlighter = PathHighlighter()
        if highlight_local_path:
            self.path_highlighter.highlights = [
                rf"(?P<bold>{highlight_local_path}.+)",
                *self.path_highlighter.highlights,
            ]
        # Then use self.path_highlighter everywhere in Traceback

What do you think?

[willmcgugan]

How would Rich know what is "local code"?

[SebCorbin]

Through the parameter value, but if an extra parameter is not desirable it could also be os.getcwd()

[willmcgugan]

Your code is unlikely to be in the current working directory for the most part. It's not always clear what "your code" is.

If anything, I think highlighting selected modules would be more reliable. But I doubt emboldening the path would help much.

[SebCorbin]

Here's the result by "patching" the class directly

from rich.traceback import PathHighlighter

PathHighlighter.highlights.append(rf"(?P<bold>{settings.BASE_DIR}.+)")