Abort installation on metadata mismatch #3153
Conversation
xavfernandez
force-pushed
the
error_project_name_mismatch
branch
from
4595e27
to
10d1d6c
Compare
| @@ -421,6 +421,14 @@ def run_egg_info(self): | |||
| self.pkg_info()["Version"], | |||
| ])) | |||
| self._correct_build_location() | |||
| else: | |||
| metadata_name = canonicalize_name(self.pkg_info()["Name"]) | |||
| if self.req.project_name.lower() != metadata_name: | |||
There was a problem hiding this comment.
If we're canonicalizing stuff, why not canonicalize instead of .lower()'ing?
There was a problem hiding this comment.
Well self.req.project_name.lower() is equivalent to the canonical name but I agree this is not clear (and only true for the current definition of canonicalize_name). I'll canonicalize_name both terms.
xavfernandez
force-pushed
the
error_project_name_mismatch
branch
from
10d1d6c
to
7b47538
Compare
|
It might make sense to call this out as a backwards incompatible change, but I'm not dead set on it. |
If setup.py egg_info produces metadata for a different project name than self.req.project_name, abort the installation. Fixes pypa#3143
xavfernandez
force-pushed
the
error_project_name_mismatch
branch
from
7b47538
to
7e02e5c
Compare
|
@dstufft Moved the changelog to backward incompatible |
Abort installation on metadata mismatch
| metadata_name = canonicalize_name(self.pkg_info()["Name"]) | ||
| if canonicalize_name(self.req.project_name) != metadata_name: | ||
| raise InstallationError( | ||
| 'Running setup.py (path:%s) egg_info for package %s ' |
There was a problem hiding this comment.
I know this is after merge, but thinking the message should mention the url (if present) with the #egg fragment, or otherwise I'm not sure people will connect the dots that the problem is simply due to the fragment being wrong.
There was a problem hiding this comment.
pip errors just after cloning the repository, so the error seemed sufficient to me:
Obtaining djpyfs from git+https://github.com/pmitros/django-pyfs.git#egg=djpyfs (from -r /home/xfernandez/some_requirements.txt (line 7))
Cloning https://github.com/pmitros/django-pyfs.git to ./src/djpyfs
Running setup.py (path:/home/xfernandez/.virtualenvs/d694c7c01647e1aa/src/djpyfs/setup.py) egg_info for package djpyfs produced metadata for project name django-pyfs
|
I don't know for sure, but concerned this will break many builds. It could be worth only warning for the next release. |
|
A warning could indeed help with the transition but on the other end the fix is pretty simple and I'm tempted to think it isn't that frequent... |
lock
bot
added
the
auto-locked
If setup.py egg_info produces metadata for a different project name than
self.req.project_name, abort the installation.
Fixes #3143