Issue with filename for wheel with epoch version

[wenkokke]

• I am on the latest Poetry version.
• I have searched the issues of this repo and believe that this is not a duplicate.
• If an exception occurs when executing a command, I executed it again in debug mode (-vvv option).

• OS version and name: macOS 11
• Poetry version: 1.2.0
• Link of a Gist with the contents of your pyproject.toml file: n/a

Issue

When using a version number such as "1!1.0.0", the wheels generated by poetry have a filename with "1_1.0.0". This causes pip install to crash with the following error:
"ERROR: Could not build wheels for *, which is required to install pyproject.toml-based projects".

I believe that the following regular expression is at fault as it replaces the ! with _:

poetry/poetry/masonry/builders/wheel.py

Lines 197 to 203 in 6fe7f54

	@property
	def wheel_filename(self): # type: () -> str
	return "{}-{}-{}.whl".format(
	re.sub(r"[^\w\d.]+", "_", self._package.pretty_name, flags=re.UNICODE),
	re.sub(r"[^\w\d.]+", "_", self._meta.version, flags=re.UNICODE),
	self.tag,
	)

[dimbleby]

That seems to be what the spec says should be done: https://peps.python.org/pep-0427/#escaping-and-unicode

Each component of the filename is escaped by replacing runs of non-alphanumeric characters with an underscore

(I think you are confusing hyphens and underscores in your report, I don't think hyphens should be introduced)

[wenkokke]

Yeah, it's an underscore, that was a typo.

Unfortunately, that does break installing with the latest pip. Is there any way to make that work?

[dimbleby]

I dunno, I'm curious about whether PEP-427 is really the final word here. If it is then I guess you should report this to pip.

However I could believe that there's more to be said about this and that poetry might not be right.

Would be interesting to know what other tooling does when building a wheel with a version that contains an epoch, or to see any published examples on pypi of such a wheel...

[wenkokke]

I've also submitted this to pip, hopefully we can figure out which implementation is correct.

[wenkokke]

See pypa/pip#11443 (comment).

The rule you referenced from PEP 427 is outdated. The most up-to-date and canonical specification of wheel file names (among other things) can be found on packaging.python.org:

Version numbers should be normalised according to PEP 440. Normalised version numbers cannot contain -.

A wheel builder should retain the ! character, and Poetry’s current implementation is incorrect.

[dimbleby]

Then I expect an MR fixing this would be welcome

I see you've linked above to some truly ancient code, the fix should now be over in poetry-core, something like this

• copy the existing fixture and testcase for localversionlabel, but switching in a version with an epoch to hit your case
• fix escape_version()
• job done

[radoering]

Version numbers should be normalised according to PEP 440. Normalised version numbers cannot contain -.

Sounds like we should just do return str(Version.parse(version)) in escape_version().

[dimbleby]

I'm now pretty sure that the version being passed to escape_version() is already normalized and escape_version() is simply counterproductive and wants removing altogether.

[dimbleby]

fixed in python-poetry/poetry-core#469, this can be closed

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.