♻️ When printing error tracebacks with Rich, default to not showing locals, which are sometimes verbose #1072
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
svlandeg
reviewed
Sep 3, 2025
| If your Typer application handles **delicate information**, for example a **password**, a **key**, a **token**, then it could be problematic if the automatic errors show the value in those <abbr title="a variable that lives only inside a function, its value is only visible inside of it">local variables</abbr>. | ||
| When using Rich, you can get more verbose output by printing the values of the <abbr title="a variable that lives only inside a function, its value is only visible inside of it">local variables</abbr> as part of the error message. | ||
|
|
||
| By default, this setting is disabled (since Typer v0.18.0) to avoid showing **delicate information**, for example a **password**, a **key** or a **token**. |
There was a problem hiding this comment.
TODO: update version number here when/if we do decide to release this change
|
📝 Docs preview for commit 97b800d at: https://f2c37e25.typertiangolo.pages.dev Modified Pages |
|
I've updated this PR by changing the documentation to explain first the (new) default setting, showing no local variables. Then, showing how to enable them. Updated the tests accordingly as well. |
svlandeg
reviewed
Sep 3, 2025
There was a problem hiding this comment.
In theory, this is a breaking change in behaviour, as the default case will now show less information in error logs. But it's not breaking in the sense of "applications downstream will be breaking", and we're now error'ing on the side of caution, so that's better IMO.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
♻️ When printing error tracebacks with Rich, default to not showing locals, which are sometimes verbose