Qix-/better-exceptions

Options for colorizing the output.

Open

#51 opened on Oct 19, 2017

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Python (4,489 stars) (210 forks)batch import
enhancementhelp wanted

Description

I just wanted to show you what I did, and secondly get your opinion on an enhancement. See https://github.com/sentientmachine/better-exceptions/blob/master/README.md

I like it when the line numbers pop out so it draws my eye, so I did that in the link above.

Enhancement suggestion: these python errors/warnings are all well documented and well known. What if better-exceptions had a feature that would read the error message, read the code that committed it and return a more easily understood error message and a quick one or two line code snippet to show you what isn't allowed.

It would be most helpful for cryptic bugs that bubble-up implementationitis when you use numpy functions incorrectly and you get blasted in the face with incomprehensible error messages. Like for example matrix multiplications that say you can't invert a singular matrix. It gives you a 5 line refresher on why singular matrices can't be inverted.

Contributor guide

Tech stack
python
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Familiarity with PythonUnderstanding of exception formattingBasic knowledge of ANSI color codes
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
25
Research direction
Investigate the current output formatting in the `better exceptions/formatter.py` file. The issue proposes adding optional colorization for line numbers and error locations. Also consider implementing a feature to parse error messages and provide more explanatory text, similar to the linked example. Review the 9 comments on the issue for any additional ideas or constraints. Start with a simple configuration toggle for color output before tackling the more complex error explanation component.