Skip to content

docs: Clarify default encoding behavior in documentation #2693

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.

Sign up for GitHub

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
koxudaxi merged 2 commits into from
Dec 19, 2025
Merged

docs: Clarify default encoding behavior in documentation #2693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcddedb
docs: Clarify default encoding behavior and cross-platform considerat…
koxudaxi Dec 19, 2025
43381f5
docs: update CLI reference documentation
github-actions[bot] Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/cli-reference/base-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Specify character encoding for input and output files.
The `--encoding` flag sets the character encoding used when reading
the schema file and writing the generated Python code. This is useful
for schemas containing non-ASCII characters (e.g., Japanese, Chinese).
Default is utf-8.
Default is the system's preferred encoding (via `locale.getpreferredencoding()`),
which is typically UTF-8 on Linux/macOS but may differ on Windows (e.g., cp1252).
For consistent cross-platform behavior, explicitly specify `--encoding utf-8`.

!!! tip "Usage"

Expand Down
4 changes: 3 additions & 1 deletion tests/test_main_kr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1284,7 +1284,9 @@ def test_encoding_option(output_file: Path) -> None:
The `--encoding` flag sets the character encoding used when reading
the schema file and writing the generated Python code. This is useful
for schemas containing non-ASCII characters (e.g., Japanese, Chinese).
Default is utf-8.
Default is the system's preferred encoding (via `locale.getpreferredencoding()`),
which is typically UTF-8 on Linux/macOS but may differ on Windows (e.g., cp1252).
For consistent cross-platform behavior, explicitly specify `--encoding utf-8`.
"""
run_main_and_assert(
input_path=JSON_SCHEMA_DATA_PATH / "encoding_test.json",
Expand Down
Loading