python-cataloger: normalize package names #3069
Merged
Conversation
This file contains 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
Signed-off-by: mikcl <mikesmikes400@gmail.com>
Mikcl
force-pushed
the
mikcl/normalized-python-names
branch
from
d4a8368
to
85057d8
Compare
mariocj89
reviewed
Jul 25, 2024
| @@ -10,7 +12,16 @@ import ( | |||
| "github.com/anchore/syft/syft/pkg" | |||
| ) | |||
|
|
|||
| func normalize(name string) string { | |||
| // https://packaging.python.org/en/latest/specifications/name-normalization/ | |||
| re := regexp.MustCompile(`[-_.]+`) | |||
There was a problem hiding this comment.
For reference, the Python implementation is identical: https://github.com/pypa/packaging/blob/bb61b7bcbc429b49e6659a8b6c2966b6ebd046b6/src/packaging/utils.py#L49C13-L49C32
|
Nice! There are no matching or downstream concerns here given that we already normalize these values for the PURL when using grype. This change should help consumers of syft SBOM going forward so 🟢 |
spiffcs
approved these changes
Jul 25, 2024
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.
Fixes #3064
(provided there is agreement to normalize the names, discussion in the issue).
This PR adds a normalization function according to python packaging specification https://packaging.python.org/en/latest/specifications/name-normalization/ to each of the package types. And adds/updates existing tests.
The name and the purl are updated, the "metadata" still preserves the unnormalized name.