Skip to content

♻️ When printing error tracebacks with Rich, default to not showing locals, which are sometimes verbose#1072

Merged
tiangolo merged 10 commits intomasterfrom
default-no-locals
Feb 11, 2026
Merged

♻️ When printing error tracebacks with Rich, default to not showing locals, which are sometimes verbose#1072
tiangolo merged 10 commits intomasterfrom
default-no-locals

Conversation

@tiangolo
Copy link
Member

@tiangolo tiangolo commented Dec 3, 2024

♻️ When printing error tracebacks with Rich, default to not showing locals, which are sometimes verbose

@tiangolo tiangolo added the feature New feature, enhancement or request label Dec 3, 2024
@svlandeg svlandeg self-assigned this Sep 3, 2025
svlandeg
svlandeg reviewed Sep 3, 2025
View reviewed changes
docs/tutorial/exceptions.md Outdated
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**.
Copy link
Member

@svlandeg svlandeg Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: update version number here when/if we do decide to release this change

@svlandeg svlandeg marked this pull request as ready for review September 3, 2025 14:24
@github-actions

This comment was marked as outdated.

Sign in to view
@svlandeg
Copy link
Member

svlandeg commented Sep 3, 2025

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 svlandeg removed their assignment Sep 3, 2025
svlandeg
svlandeg reviewed Sep 3, 2025
View reviewed changes
Copy link
Member

@svlandeg svlandeg left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Nov 25, 2025
@github-actions

This comment was marked as resolved.

Sign in to view
@svlandeg svlandeg self-assigned this Nov 25, 2025
@github-actions github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Nov 26, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 26, 2025 •
edited
Loading

📝 Docs preview

Last commit dac00d1 at: https://faba63ee.typertiangolo.pages.dev

Modified Pages

@svlandeg svlandeg removed their assignment Nov 26, 2025
@github-actions

This comment was marked as resolved.

Sign in to view
@github-actions github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Dec 25, 2025
@svlandeg svlandeg self-assigned this Dec 26, 2025
@github-actions github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Dec 30, 2025
@svlandeg svlandeg removed their assignment Dec 31, 2025
@github-actions github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Feb 10, 2026
@github-actions

This comment was marked as resolved.

Sign in to view
@svlandeg svlandeg self-assigned this Feb 11, 2026
@github-actions github-actions bot removed the conflicts Automatically generated when a PR has a merge conflict label Feb 11, 2026
@tiangolo tiangolo added breaking and removed feature New feature, enhancement or request labels Feb 11, 2026
@tiangolo
Copy link
Member Author

tiangolo commented Feb 11, 2026

I'll mark it as "breaking change" just in case, I don't think it will be any problem, but just to be safe. 🤓

This should be available in Typer 0.23.0, released in the next few hours. 🚀

@tiangolo tiangolo enabled auto-merge (squash) February 11, 2026 15:14
@tiangolo tiangolo merged commit 458325d into master Feb 11, 2026
28 checks passed
@tiangolo tiangolo deleted the default-no-locals branch February 11, 2026 15:17
@svlandeg svlandeg removed their assignment Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@svlandeg svlandeg svlandeg left review comments

Assignees

No one assigned

Labels

breaking

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tiangolo @svlandeg