setuptools: [BUG] Please make trove classifiers validation optional
setuptools version
from git, also 70.0.0
Python version
Python 3.12
OS
Gentoo Linux
Additional environment information
No response
Description
I tried building a wheel for a package that uses a trove classifier in the very latest version of the trove_classifiers package. Setuptools detected that trove_classifiers was installed, and insisted on validating it.
Looking at the code which handles this, it offers an escape hatch only to “avoid hitting the network” if trove_classifiers is NOT installed: https://github.com/pypa/setuptools/blob/34f9518ef5b50d546893fc29386d4d11866dd9db/setuptools/config/_validate_pyproject/formats.py#L156-L214
Expected behavior
A way to disable the unwanted functionality without first uninstalling other packages. For example, instead of $VALIDATE_PYPROJECT_NO_NETWORK, I would like to see $VALIDATE_PYPROJECT_NO_TROVE_CLASSIFIERS.
How to Reproduce
- git clone https://github.com/urschrei/pyzotero
- python -m build -nwx
Output
* Building wheel...
configuration error: `project.classifiers[10]` must be trove-classifier
DESCRIPTION:
`PyPI classifier <https://pypi.org/classifiers/>`_.
GIVEN VALUE:
"License :: OSI Approved :: Blue Oak Model License (BlueOak-1.0.0)"
OFFENDING RULE: 'format'
DEFINITION:
{
"type": "string",
"format": "trove-classifier"
}
For more details about `format` see
https://validate-pyproject.readthedocs.io/en/latest/api/validate_pyproject.formats.html
Traceback (most recent call last):
File "/usr/lib/python3.12/site-packages/pyproject_hooks/_in_process/_in_process.py", line 373, in <module>
main()
File "/usr/lib/python3.12/site-packages/pyproject_hooks/_in_process/_in_process.py", line 357, in main
json_out["return_val"] = hook(**hook_input["kwargs"])
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/site-packages/pyproject_hooks/_in_process/_in_process.py", line 271, in build_wheel
return _build_backend().build_wheel(
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/site-packages/setuptools/build_meta.py", line 410, in build_wheel
return self._build_with_temp_dir(
^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/site-packages/setuptools/build_meta.py", line 395, in _build_with_temp_dir
self.run_setup()
File "/usr/lib/python3.12/site-packages/setuptools/build_meta.py", line 311, in run_setup
exec(code, locals())
File "<string>", line 12, in <module>
File "/usr/lib/python3.12/site-packages/setuptools/__init__.py", line 103, in setup
return distutils.core.setup(**attrs)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/site-packages/setuptools/_distutils/core.py", line 158, in setup
dist.parse_config_files()
File "/usr/lib/python3.12/site-packages/setuptools/dist.py", line 632, in parse_config_files
pyprojecttoml.apply_configuration(self, filename, ignore_option_errors)
File "/usr/lib/python3.12/site-packages/setuptools/config/pyprojecttoml.py", line 68, in apply_configuration
config = read_configuration(filepath, True, ignore_option_errors, dist)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.12/site-packages/setuptools/config/pyprojecttoml.py", line 133, in read_configuration
validate(subset, filepath)
File "/usr/lib/python3.12/site-packages/setuptools/config/pyprojecttoml.py", line 57, in validate
raise ValueError(f"{error}\n{summary}") from None
ValueError: invalid pyproject.toml config: `project.classifiers[10]`.
configuration error: `project.classifiers[10]` must be trove-classifier
ERROR Backend subprocess exited when trying to invoke build_wheel
About this issue
- Original URL
- State: closed
- Created 2 years ago
- Reactions: 2
- Comments: 28 (28 by maintainers)
Commits related to this issue
- Add an option to disable using trove-classifiers package As requested in https://github.com/pypa/setuptools/issues/4459, add a VALIDATE_PYPROJECT_NO_TROVE_CLASSIFIERS environment variable that can be... — committed to mgorny/validate-pyproject by mgorny 2 years ago
- dev-python/setuptools: allow disabling validation of pypi.org allowed strings Trove classifiers, and their officialness, have no effect on a wheel other than determining whether they are allowed to b... — committed to gentoo/gentoo by eli-schwartz 2 years ago
- distutils-r1.eclass: disable setuptools validation of pypi.org allowed strings In the previous commit, a change was patched into setuptools to enable skipping pypi.org specific validations we do not ... — committed to gentoo/gentoo by eli-schwartz 2 years ago
Thanks for clarifying. Minor nit: can you use the “close issue as not planned” toggle for searchability reasons?
I would suggest removing it, yes. I wouldn’t be using it myself, because it is dangerous.
Just want to reiterate here that adding trove-classifiers as build-requires for arbitrary packages throughout the python ecosystem is not a very comfortable solution in the slightest.
Especially because trove-classifiers may not need to be installed at all – and in fact the only reason I have it on my system is because hatchling required it.
It is terrible UX to have pyzotero require an additional build-requires, solely because if it doesn’t have that build-requires then installing hatchling will result in setuptools erroring out. It’s not even the kind of bug that anyone will notice for a while.
I’m pretty sure I was quite clear that the problem does not naturally go away ever, because the solver gets into a stuck state and doesn’t get unstuck until someone manually kicks it – because it will keep trying to install the failing package before trove_classifiers. That usually means patching the setuptools distro package to have a hard dependency on
trove_classifiers >= $LATEST_RELEASEwhich is kind of annoying.It would be much better if we could unstick things automatically by telling setuptools to stop performing validations we don’t want. We aren’t uploading to PyPI.
It’s confusing anyway because there’s absolutely no reason people shouldn’t be allowed to use whatever trove classifiers they like, even unofficial ones, on private self-run indexes.
Making it into a warning rather than error would also work for us.
See also: https://github.com/urschrei/pyzotero/issues/178