Slugify helper function should replace hyphens (bugfix)#1754
Merged
Conversation
The slugify helper function is used in resource jobs for attributes that are then used for some job requirements. These attributes should be Python-compatible, meaning they cannot include hyphens. Modifying the slugify function to replace hyphens with an underscore. Fix #1745
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1754 +/- ##
=======================================
Coverage 49.31% 49.32%
=======================================
Files 374 374
Lines 40465 40467 +2
Branches 6835 6836 +1
=======================================
+ Hits 19957 19959 +2
Misses 19783 19783
Partials 725 725
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Hook25
approved these changes
Feb 26, 2025
Hook25
requested changes
Feb 26, 2025
Collaborator
Hook25
left a comment
There was a problem hiding this comment.
small nitpick, if the string starts with a number, put an underscore in front!
Collaborator
|
Since we are also accepting dots, and that could change the "meaning" of the variable (1 variable vs variable.attribute) |
Hook25
approved these changes
Feb 26, 2025
stanley31huang
pushed a commit
that referenced
this pull request
Mar 28, 2025
* Slugify helper function should replace hyphens The slugify helper function is used in resource jobs for attributes that are then used for some job requirements. These attributes should be Python-compatible, meaning they cannot include hyphens. Modifying the slugify function to replace hyphens with an underscore. Fix #1745 * Slugify dots as well * Prefix string with underscore if it starts with a digit * Better digit check
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
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.
Description
The slugify helper function is used in resource jobs for attributes that are then used for some job requirements. These attributes should be Python-compatible, meaning they cannot include hyphens.
Modifying the slugify function to replace hyphens with an underscore.
With this patch, strings like
usb-vendorwill be replaced withusb_vendor, making it a valid Python attribute.Resolved issues
Fix #1745
Documentation
Tests