fix: handle paths with non-utf-8 bytes#91
Merged
AyanSinhaMahapatra merged 3 commits intoaboutcode-org:mainfrom Oct 22, 2025
abraemer:fix-path-encoding-for-hash
Merged
fix: handle paths with non-utf-8 bytes#91AyanSinhaMahapatra merged 3 commits intoaboutcode-org:mainfrom abraemer:fix-path-encoding-for-hash
AyanSinhaMahapatra merged 3 commits intoaboutcode-org:mainfrom
abraemer:fix-path-encoding-for-hash
Conversation
Signed-off-by: Adrian Braemer <adrian.braemer@tngtech.com>
AyanSinhaMahapatra
approved these changes
Oct 22, 2025
Member
There was a problem hiding this comment.
Thanks! @abraemer LGTM
Keeping these links here for reference:
There were some formatting test failures, I've fixed them for you (since the tests does not run automatically for first-time contributors).
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
2 participants
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.
Context
On Unix systems, paths may contain arbitrary bytes. This can cause the string encoding to fail if the path contains bytes that are not valid UTF-8 codepoints. I ran into this bug while scanning a large code base with ScanCode. In this circumstance, this bug caused ScanCode to abort entirely and not produce any output.
Summary of changes
This PR add the option
"surrogateescape"to the.encodecall. This means that bytes that cannot be encoded properly are escaped instead. Since we only use the encoding to convert a string to a byte sequence for hashing, this simple change should be sufficient to fix the problem and does not require further changes.