Trigger deprecation warning when find_packages() finds reserved name #3259
Conversation
Trigger SetuptoolsDeprecationWarning whenever find_packages() finds a top-level package whose name is found in reserved package name list, e.g. "tests". Installing these packages is probably always wrong, yet it is still a frequent mistake in packages using setuptools. This warning should increase the chance of the mistake being caught before releasing. Fixes pypa#3243
mgorny
force-pushed
the
find-package-deprecated
branch
from
0f937b1
to
3344ff4
Compare
|
I have to admit that I went with the "minimal change" approach. If you prefer it done some other way, please let me know. |
| f"{top_package!r} is a reserved package name. " | ||
| "Please add it to find_package(exclude=...)", | ||
| setuptools.SetuptoolsDeprecationWarning, | ||
| ) |
There was a problem hiding this comment.
Is it really the case these patterns should be deprecated?
What if the user is the owner of the package tasks or changelog (those are perfectly valid entries for PyPI right?) and is explicitly using [options.packages.find] include = tasks*?
I am also not sure if this is the best place to implement the check..
This code path is traversed by the auto-discovery algorithm that will already error if the distribution contains multiple top-level packages... It is also traversed when the src-layout is being used (and my opinion is that if the src-layout is used, there should be no warning...).
I think that an alternative would be modifying setuptools.find_packages, setuptools.find_namespace_packages, setuptools.config.setupcfg.ConfigOptionsHandler._parse_packages and setuptools.pyprojecttoml._ConfigExpander._expand_packages to check for one of these patterns only if there is more than one top-level package.
|
I'm sorry but due to health issues I'll have to limit my computer activity for some time (apparently up to 4 weeks), so I won't be able to look into it any time soon. |
|
Sorry to hear that... |
|
Thank you very much. |
jaraco
force-pushed
the
main
branch
3 times, most recently
from
a85759c
to
93ce5a0
Compare
|
@mgorny I hope you're back to health. I thought I'd check in on this PR and see if you wanted to continue with it? |
Summary of changes
Trigger SetuptoolsDeprecationWarning whenever find_packages() finds
a top-level package whose name is found in reserved package name list,
e.g. "tests". Installing these packages is probably always wrong,
yet it is still a frequent mistake in packages using setuptools. This
warning should increase the chance of the mistake being caught before
releasing.
Closes #3243
Pull Request Checklist
changelog.d/.(See documentation for details)