check-yaml opens each file as UTF-8 text, but the parse is only guarded against ruamel.yaml.YAMLError. A file that is not valid UTF-8 (for example latin-1) makes load_fn raise UnicodeDecodeError, which escapes main():
The exception aborts the loop, so any remaining files are never checked, and the user gets a stack trace instead of a diagnostic.
The sibling hooks already handle this cleanly: check-json catches ValueError (a superclass of UnicodeDecodeError), and check-toml gets a TOMLDecodeError from tomllib.
Change
Catch UnicodeDecodeError next to YAMLError and report filename: invalid UTF-8: ..., so the hook marks the file as failed with a readable message and still checks the rest of the arguments.
Testing
New regression test test_main_non_utf8_file fails on main (UnicodeDecodeError propagates) and passes with the fix.
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
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.
Problem
check-yaml opens each file as UTF-8 text, but the parse is only guarded against ruamel.yaml.YAMLError. A file that is not valid UTF-8 (for example latin-1) makes load_fn raise UnicodeDecodeError, which escapes main():
The exception aborts the loop, so any remaining files are never checked, and the user gets a stack trace instead of a diagnostic.
The sibling hooks already handle this cleanly: check-json catches ValueError (a superclass of UnicodeDecodeError), and check-toml gets a TOMLDecodeError from tomllib.
Change
Catch UnicodeDecodeError next to YAMLError and report filename: invalid UTF-8: ..., so the hook marks the file as failed with a readable message and still checks the rest of the arguments.
Testing