fix(config): handle UTF-8 BOM in config files on Windows (#499)#500
Merged
MaojiaSheng merged 1 commit intovolcengine:mainfrom Mar 10, 2026
Merged
Conversation
) Windows text editors (Notepad, VS Code with certain settings) may save UTF-8 files with a Byte Order Mark (BOM, U+FEFF). Opening such files with encoding='utf-8' causes json.load() to fail because the BOM character appears before the opening '{'. Change encoding from 'utf-8' to 'utf-8-sig' in load_json_config(). Python's utf-8-sig codec automatically strips the BOM when present, while behaving identically to utf-8 for BOM-less files.
MaojiaSheng
approved these changes
Mar 10, 2026
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.
Problem
Windows text editors (Notepad, VS Code with certain settings) save UTF-8 files with a Byte Order Mark (BOM,
\xef\xbb\xbf). Whenload_json_config()opens such a file withencoding='utf-8', the BOM appears as the first character, causingjson.load()to fail with a JSON parse error.Reported in #499 (Windows 11 startup crash).
Fix
Change
encoding='utf-8'→encoding='utf-8-sig'inconfig_loader.py.Python's
utf-8-sigcodec automatically strips the BOM when present, and behaves identically toutf-8for BOM-less files — so this is a zero-risk, backward-compatible change.Change
Fixes #499