-
Notifications
You must be signed in to change notification settings - Fork 104
fix: centralize YAML I/O with UTF-8 encoding for cross-platform safety #433
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
6aa5827
fix: centralize YAML I/O with UTF-8 encoding for cross-platform safety
danielmeppiel 3b4b9e3
fix: remove dead yaml imports and fix CI guard regex
danielmeppiel e80df96
Merge branch 'main' into fix/yaml-utf8-encoding
danielmeppiel 0551178
Merge branch 'main' into fix/yaml-utf8-encoding
danielmeppiel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| """Cross-platform YAML I/O with guaranteed UTF-8 encoding. | ||
|
|
||
| All YAML file operations in apm_cli should use these helpers to ensure | ||
| consistent encoding (UTF-8) and formatting (unicode, block style, key | ||
| order preserved). This prevents silent mojibake on Windows where the | ||
| default file encoding is cp1252, not UTF-8. | ||
|
|
||
| Public API:: | ||
|
|
||
| load_yaml(path) -- read a .yml/.yaml file -> dict | None | ||
| dump_yaml(data, path) -- write dict -> .yml/.yaml file | ||
| yaml_to_str(data) -- serialize dict -> YAML string | ||
| """ | ||
|
|
||
| from pathlib import Path | ||
| from typing import Any, Dict, Optional, Union | ||
|
|
||
| import yaml | ||
|
|
||
| # Shared defaults matching existing codebase convention. | ||
| _DUMP_DEFAULTS: Dict[str, Any] = dict( | ||
| default_flow_style=False, | ||
| sort_keys=False, | ||
| allow_unicode=True, | ||
| ) | ||
|
|
||
|
|
||
| def load_yaml(path: Union[str, Path]) -> Optional[Dict[str, Any]]: | ||
| """Load a YAML file with explicit UTF-8 encoding. | ||
|
|
||
| Returns parsed data or ``None`` for empty files. | ||
| Raises ``FileNotFoundError`` or ``yaml.YAMLError`` on failure. | ||
| """ | ||
| with open(path, "r", encoding="utf-8") as fh: | ||
| return yaml.safe_load(fh) | ||
|
danielmeppiel marked this conversation as resolved.
|
||
|
|
||
|
|
||
| def dump_yaml( | ||
| data: Any, | ||
| path: Union[str, Path], | ||
| *, | ||
| sort_keys: bool = False, | ||
| ) -> None: | ||
| """Write data to a YAML file with UTF-8 encoding and unicode support.""" | ||
| with open(path, "w", encoding="utf-8") as fh: | ||
| yaml.safe_dump(data, fh, **{**_DUMP_DEFAULTS, "sort_keys": sort_keys}) | ||
|
|
||
|
|
||
| def yaml_to_str(data: Any, *, sort_keys: bool = False) -> str: | ||
| """Serialize data to a YAML string with unicode support. | ||
|
|
||
| Use instead of bare ``yaml.dump()`` when building YAML content | ||
| for later file writes or string returns. | ||
| """ | ||
| return yaml.safe_dump(data, **{**_DUMP_DEFAULTS, "sort_keys": sort_keys}) | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.