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

[FR] Warn when invalid table [tools.setuptools] is present in pyproject.toml #4150

Open
1 task done
SnoopJ opened this issue Dec 8, 2023 · 0 comments · May be fixed by #4151
Open
1 task done

[FR] Warn when invalid table [tools.setuptools] is present in pyproject.toml #4150

SnoopJ opened this issue Dec 8, 2023 · 0 comments · May be fixed by #4151
Labels
enhancement Needs Triage Issues that need to be evaluated for severity and status.

Comments

@SnoopJ
Copy link

SnoopJ commented Dec 8, 2023

What's the problem this feature will solve?

It is pretty easy to incorrectly spell the name of the table where setuptools metadata is declared, i.e. writing:

[tools.setuptools]

instead of:

[tool.setuptools]

And when setuptools metadata is not recognized because of this, it can be a slightly mysterious failure, even for experts, because the errant section is silently ignored.

Describe the solution you'd like

It would be nice if setuptools issued a warning when the invalid [tools.setuptools] table is present in a project's metadata, to provide a hint for users that their metadata has a typo.

Alternative Solutions

No response

Additional context

This has cropped up in #3803, and #3683 also includes an incidental example of this spelling error. I can also say that I have made this mistake multiple times. It feels like the kind of issue you only know to avoid when you've stubbed your toe on it a few times.

Code of Conduct

  • I agree to follow the PSF Code of Conduct
@SnoopJ SnoopJ added enhancement Needs Triage Issues that need to be evaluated for severity and status. labels Dec 8, 2023
@SnoopJ SnoopJ linked a pull request Dec 8, 2023 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Needs Triage Issues that need to be evaluated for severity and status.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant