🤖 Add Encoding Detection to File Reading in Code Search #1495
+133
−37
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
![sentry-autofix[bot]](https://avatars.githubusercontent.com/in/801464?s=60&v=4){kind=small}
|
Going to pull locally and double-check/tweak. Looks good! |
trillville
reviewed
Nov 25, 2024
requirements-constraints.txt
Outdated
| @@ -115,3 +115,4 @@ prophet==1.1.* | |||
| rapidfuzz==3.10.* | |||
| pytest-vcr==1.* | |||
| vcrpy==6.* | |||
| chardet | |||
|
If tests pass then this should be good |
trillville
reviewed
Nov 25, 2024
| assert "Hello in UTF-8" in result1.matches[0].context | ||
| assert "Hello in Latin-1" in result2.matches[0].context | ||
|
|
||
| def test_read_file_with_invalid_encoding(self): |
There was a problem hiding this comment.
would love if we used production error examples here ;)
trillville
approved these changes
Nov 25, 2024
jennmueng
deleted the
autofix/add-encoding-detection-to-file-reading-in-code-search/kZK9lq
branch
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.
👋 Hi there! This PR was automatically generated by Autofix 🤖
This fix was triggered by Rohan Agarwal
Fixes SEER-9E
This update introduces enhancements to the file reading functionality in the code search module, allowing it to detect and handle various file encodings gracefully. The changes include:
Dependency Addition: The
chardetlibrary is now added as a dependency in thepyproject.tomlfile to facilitate encoding detection.Default Encoding Parameter: A new parameter
default_encodinghas been added to theCodeSearchclass constructor, allowing users to specify a fallback encoding when file reading fails.Encoding-Aware File Reading: The method
_read_file_with_encodinghas been introduced to read files intelligently by first attempting to auto-detect the encoding and then falling back on common encodings if detection fails. This method improves robustness when dealing with diverse file types.Error Handling Improvements: Enhanced error handling within the
search_filemethod to gracefully log issues and avoid crashes during encoding errors, providing a smoother experience when handling files.If you have any questions or feedback for the Sentry team about this fix, please email [email protected] with the Run ID: 1579.