fix: escape name segment of stamped wheel files #2741
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mattem
force-pushed
the
fix/escape_pywheel_name_segment
branch
from
6bc8b25 to
1856170
Compare
mattem
commented
Apr 5, 2025
| @@ -440,7 +440,7 @@ def test_rule_creates_directory_and_is_included_in_wheel(self): | |||
|
|
|||
| def test_rule_expands_workspace_status_keys_in_wheel_metadata(self): | |||
| filename = self._get_path( | |||
| "example_minimal_library{BUILD_USER}-0.1.{BUILD_TIMESTAMP}-py3-none-any.whl" | |||
| "example_minimal_library{BUILD_USER}-0.1._BUILD_TIMESTAMP_-py3-none-any.whl" | |||
There was a problem hiding this comment.
The distribution likely needs escaping too.
rickeylev
requested changes
Apr 20, 2025
| abi = _replace_make_variables(ctx.attr.abi, ctx) | ||
| python_tag = _replace_make_variables(ctx.attr.python_tag, ctx) | ||
| version = _replace_make_variables(ctx.attr.version, ctx) | ||
|
|
||
| filename_segments = [ | ||
| _escape_filename_distribution_name(ctx.attr.distribution), | ||
| normalize_pep440(version), | ||
| _escape_filename_segment(normalize_pep440(version)) if is_stamping else normalize_pep440(version), |
There was a problem hiding this comment.
Something strange is going on, or I'm missing something.
The net code change is the same as before: normalize(...) if ... else normalize(...)
The test was updated, though? Which would mean it's working?? Is the test not covering something...?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
~1 year ago
py_wheelchanged to enforce PEP440, however the resulting stamp vars are no longer escaped.For example:
Before:
bazel-bin/xxxx/xxxx-_STABLE_BUILD_SCM_VERSION_-py3-none-any.whlAfter:
bazel-bin/xxxx/xxxx-{STABLE_BUILD_SCM_VERSION}-py3-none-any.whlThis results in downstream consumers of the wheel that are publishing, or generating "manifest" stye files of release artifacts and other metadata will now incorrectly replace the
{STABLE_BUILD_SCM_VERSION}in the artifact name and path, leading to the incorrect artifact metadata and pathing.Original reported here, however this could be seen as breaking, as it changes the unstamped wheel file names.
https://bazelbuild.slack.com/archives/C0174UDLAF3/p1706726049830819