Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better error message when pyproject.toml is broken #140

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

amyreese
Copy link
Member

@amyreese amyreese commented Feb 3, 2025

Description

Catches the parse error from tomli and wraps it in a ConfigError with an
error message making it clear that the error is from parsing pyproject.toml

Fixes: #135

@amyreese
Copy link
Member Author

amyreese commented Feb 3, 2025

@lordmauve is this a helpful improvement?

try:
data = tomli.loads(content).get("tool", {}).get("thx", {})
except tomli.TOMLDecodeError as error:
raise ConfigError(f"failure parsing pyproject.toml: {str(error)}") from error
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe including the actual path could avoid confusion?

Suggested change
raise ConfigError(f"failure parsing pyproject.toml: {str(error)}") from error
raise ConfigError(f"failure parsing {pyproject}: {error}") from error

Copy link
Contributor

@lordmauve lordmauve left a comment

Choose a reason for hiding this comment

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

Looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Opaque traceback on malformed pyproject.toml
2 participants