Improve the default excepthook formatting for multi-line and exception notes
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 77.2k
- Forks
- 35.9k
- Métriques de merge des PR
- Métriques de PR en attente
Description
Proposal:
Currently, it is possible to add notes to exceptions, see BaseException.add_note, but this feature is underutilized.
One of the reasons for that, I believe, is the poor formatting in the default excepthook:
Current Output
(single note)
$ ./python
Python 3.14.0a2+ experimental free-threading build (heads/gh-127429-dirty:cc4f57a74d0, Dec 1 2024, 07:06:51) [GCC 14.2.1 20240910] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> try:
... raise Exception('error')
... except Exception as e:
... e.add_note('some context')
... raise
...
Traceback (most recent call last):
File "<python-input-0>", line 2, in <module>
raise Exception('error')
Exception: error
some context
(with multiple notes)
$ ./python
Python 3.14.0a2+ experimental free-threading build (heads/gh-127429-dirty:cc4f57a74d0, Dec 1 2024, 07:06:51) [GCC 14.2.1 20240910] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> try:
... raise Exception('error')
... except Exception as e:
... e.add_note('some context')
... e.add_note('some context 2')
... e.add_note('some context 3')
... raise
...
Traceback (most recent call last):
File "<python-input-0>", line 2, in <module>
raise Exception('error')
Exception: error
some context
some context 2
some context 3
I think if we formatted it better, making the output easier to understand, we could start seeing better adoption of this feature.
(with multiple notes)
$ ./python
Python 3.14.0a2+ experimental free-threading build (heads/gh-127429-dirty:cc4f57a74d0, Dec 1 2024, 07:06:51) [GCC 14.2.1 20240910] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> try:
... raise Exception('error')
... except Exception as e:
... e.add_note('some context')
... e.add_note('some context 2')
... e.add_note('some context 3')
... raise
...
Traceback (most recent call last):
File "<python-input-0>", line 2, in <module>
raise Exception('error')
Exception: error
├── Note: some context
├── Note: some context 2
└── Note: some context 3
In addition to this, multiline exception messages could also be improved.
Current Output
(multi-line string, with no notes)
$./python
Python 3.14.0a2+ experimental free-threading build (heads/gh-127429-dirty:cc4f57a74d0, Dec 1 2024, 07:06:51) [GCC 14.2.1 20240910] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> raise Exception('some error\n\nsome context\nsome context (cont.)\n\nsome extra context')
Traceback (most recent call last):
File "<python-input-0>", line 1, in <module>
raise Exception('some error\n\nsome context\nsome context (cont.)\n\nsome extra context')
Exception: some error
some context
some context (cont.)
some extra context
(multi-line string, with multi-line notes)
$ ./python
Python 3.14.0a2+ experimental free-threading build (heads/gh-127429-dirty:cc4f57a74d0, Dec 1 2024, 07:06:51) [GCC 14.2.1 20240910] on linux
>>> try:
... raise Exception('some error\n\nsome error text\nsome error text (cont.)\n\nsome more error text')
... except Exception as e:
... e.add_note('some context\nsome context (cont.)')
... e.add_note('some context 2\n\nsome extra context 2')
... e.add_note('some context 3\nsome context 3 (cont.)\n\nsome extra context 3')
... raise
...
Traceback (most recent call last):
File "<python-input-0>", line 2, in <module>
raise Exception('some error\n\nsome error text\nsome error text (cont.)\n\nsome more error text')
Exception: some error
some error text
some error text (cont.)
some more error text
some context
some context (cont.)
some context 2
some extra context 2
some context 3
some context 3 (cont.)
some extra context 3
The first example IMO isn't optimal, but it's okay enough, but the second example is very confusing. We could format it something like:
$ ./python
Python 3.14.0a2+ experimental free-threading build (heads/gh-127429-dirty:cc4f57a74d0, Dec 1 2024, 07:06:51) [GCC 14.2.1 20240910] on linux
>>> try:
... raise Exception('some error\n\nsome error text\nsome error text (cont.)\n\nsome more error text')
... except Exception as e:
... e.add_note('some context\nsome context (cont.)')
... e.add_note('some context 2\n\nsome extra context 2')
... e.add_note('some context 3\nsome context 3 (cont.)\n\nsome extra context 3')
... raise
...
Traceback (most recent call last):
File "<python-input-0>", line 2, in <module>
raise Exception('some error\n\nsome error text\nsome error text (cont.)\n\nsome more error text')
Exception:
│ │ some error
│ │
│ │ some error text
│ │ some error text (cont.)
│ │
│ └ some more error text
│
├── Note:
│ │ some context
│ └ some context (cont.)
│
├── Note:
│ │ some context 2
│ │
│ └ some extra context 2
│
└── Note:
│ some context 3
│ some context 3 (cont.)
│
└ some extra context 3
Has this already been discussed elsewhere?
No response given
Links to previous discussion of this feature:
No response
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par les points d’entrée par défaut de CPython pour excepthook et le formatage des exceptions ; l’issue ne nomme ni fichier ni test. Comparez la sortie actuelle aux exemples de notes proposés sur une seule ligne et sur plusieurs lignes, et considérez que c’est terminé lorsque le formatage arborescent prévu est obtenu sans perdre le contenu du message.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- backend
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100