Add more helpful error message when metadata is malformed #695
Conversation
timkpaine
requested review from
FFY00,
gaborbernat,
layday and
henryiii
as code owners
timkpaine
force-pushed
the
tkp/malformedmeta
branch
from
0fd1d70 to
c7d4233
Compare
timkpaine
force-pushed
the
tkp/malformedmeta
branch
3 times, most recently
from
74c60a4 to
5a388a7
Compare
timkpaine
force-pushed
the
tkp/malformedmeta
branch
from
5a388a7 to
09f97cf
Compare
| @@ -21,7 +21,7 @@ | |||
|
|
|||
| DEFAULT_BACKEND = { | |||
| 'build-backend': 'setuptools.build_meta:__legacy__', | |||
| 'requires': ['setuptools >= 40.8.0'], | |||
| 'requires': ['setuptools >= 40.8.0', 'wheel'], | |||
There was a problem hiding this comment.
This seems like a regression. Why is it needed? wheel was required on older setuptools versions, but shouldn't be anymore. If our minimum setuptools version does not yet include the fix to return wheel in get_requires_for_build_wheel, we should update it.
| # Malformed dist-info or some other form of metadata corruption | ||
| # req.specifier.contains will raise TypeError, so let's do the same | ||
| # with a more helpful error message | ||
| msg = f'Package {req.name} has malformed metadata and no version information could be found' |
There was a problem hiding this comment.
nitpick: so that the name is quoted:
| msg = f'Package {req.name} has malformed metadata and no version information could be found' | |
| msg = f'Package {req.name!r} has malformed metadata and no version information could be found' |
| # req.specifier.contains will raise TypeError, so let's do the same | ||
| # with a more helpful error message | ||
| msg = f'Package {req.name} has malformed metadata and no version information could be found' | ||
| raise TypeError(msg) |
There was a problem hiding this comment.
I wonder if we shouldn't make this a warning instead and return this package as an unmet dependency. That should give more information to the user. As it stands, they would only see an error message about a specific bad dependency, instead of getting a list of all bad ones with the extra context of why this one was considered bad.
There was a problem hiding this comment.
Seems fine to me, sounds reasonable to want all issues at the same time instead of potentially having to address one-by-one
xref #558 #626