fix: specify UTF-8 encoding for file I/O to prevent UnicodeEncodeError on Windows#432
Open
octo-patch wants to merge 1 commit into
Open
Conversation
…r on Windows (fixes stanford-oval#352)
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.
Fixes #352
Problem
On Windows, Python uses the system default encoding (e.g.
cp1252) when opening files without an explicit encoding. This encoding cannot represent many Unicode characters such as Greek letters (β,α,μ, etc.), causingUnicodeEncodeErrorwhen STORM generates articles containing such characters.Example error:
Solution
Added
encoding="utf-8"to all file open calls that were missing it:FileIOHelper.write_str()inknowledge_storm/utils.py— used to write article.mdfiles and outlinesFileIOHelper.load_str()inknowledge_storm/utils.py— used to read saved articlesknowledge_storm/storm_wiki/engine.pyexamples/costorm_examples/run_costorm_gpt.pyThe
encodingparameter is exposed as an optional argument with"utf-8"as the default, maintaining backward compatibility.Testing
The fix ensures consistent UTF-8 encoding across all platforms (Windows, macOS, Linux), preventing encoding errors when articles contain non-ASCII characters like Greek letters, Chinese characters, or other Unicode symbols.