From adb4f82f813875680c8426cad6112fbcb144c9a2 Mon Sep 17 00:00:00 2001 From: jawwad-ali Date: Fri, 31 Jul 2026 13:03:28 +0500 Subject: [PATCH] fix(scripts): stop setup-tasks text mode crashing on a legacy code page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit _check_file/_check_dir hard-code U+2713/U+2717 and print() them to sys.stdout. On Windows sys.stdout falls back to the ANSI code page whenever stdout is not a console — which is every time an agent or a workflow step captures the output — and U+2713 is unencodable in cp1252, so the document listing aborted mid-report with UnicodeEncodeError. This is the byte-identical twin of the block in scripts/python/check_prerequisites.py, which I flagged in the PR for that file rather than widening its scope. Fall back to ASCII when stdout cannot encode the glyph. "[OK]"/"[FAIL]" is the rendering these markers already have in-tree: Test-FileExists in scripts/powershell/common.ps1 emits exactly those, and normalize_status_text in tests/parity_helpers.py maps the glyphs onto them. Co-Authored-By: Claude Opus 5 (1M context) --- scripts/python/setup_tasks.py | 25 +++++++++++++++++++++---- tests/test_setup_tasks_python_parity.py | 25 +++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 4 deletions(-) diff --git a/scripts/python/setup_tasks.py b/scripts/python/setup_tasks.py index b3abb6dc1a..21b0018620 100644 --- a/scripts/python/setup_tasks.py +++ b/scripts/python/setup_tasks.py @@ -55,14 +55,31 @@ def _available_docs(paths: FeaturePaths) -> list[str]: return docs +def _status_marker(ok: bool) -> str: + """Return the status glyph, downgraded to ASCII when stdout cannot encode it. + + On Windows sys.stdout falls back to the ANSI code page whenever it is not a + console - a pipe or a file redirect, which is how agents and workflow steps + invoke these scripts - and U+2713 is unencodable in cp1252, so printing it + raised UnicodeEncodeError and aborted the report mid-listing. + "[OK]"/"[FAIL]" is the ASCII rendering these markers already have in-tree: + see Test-FileExists in scripts/powershell/common.ps1 and + normalize_status_text in tests/parity_helpers.py. + """ + glyph = "✓" if ok else "✗" + try: + glyph.encode(getattr(sys.stdout, "encoding", None) or "utf-8") + except (LookupError, UnicodeEncodeError): + return "[OK]" if ok else "[FAIL]" + return glyph + + def _check_file(path: Path, description: str) -> None: - marker = "✓" if path.is_file() else "✗" - print(f" {marker} {description}") + print(f" {_status_marker(path.is_file())} {description}") def _check_dir(path: Path, description: str) -> None: - marker = "✓" if _dir_has_entries(path) else "✗" - print(f" {marker} {description}") + print(f" {_status_marker(_dir_has_entries(path))} {description}") def main(argv: list[str] | None = None) -> int: diff --git a/tests/test_setup_tasks_python_parity.py b/tests/test_setup_tasks_python_parity.py index 29d0e2b5aa..afa303b6bd 100644 --- a/tests/test_setup_tasks_python_parity.py +++ b/tests/test_setup_tasks_python_parity.py @@ -205,3 +205,28 @@ def test_missing_template_error_matches_all_variants(repo: Path) -> None: assert bash.returncode == ps.returncode == py.returncode == 1 assert bash.stdout == ps.stdout == py.stdout == "" assert bash.stderr == ps.stderr == py.stderr + + +def test_python_text_output_survives_a_legacy_stdout_code_page(repo: Path) -> None: + """Text mode must not crash when stdout cannot encode the status glyphs. + + On Windows sys.stdout falls back to the ANSI code page whenever it is not a + console — which is every time an agent or a workflow step captures the + output. U+2713 is unencodable in cp1252, so printing it raised + UnicodeEncodeError and truncated the document listing. The ASCII fallback is + the rendering these markers already have in-tree (Test-FileExists in + scripts/powershell/common.ps1, and normalize_status_text). + """ + feature = repo / "specs" / "001-my-feature" + (feature / "research.md").write_text("# research\n", encoding="utf-8") + (feature / "contracts").mkdir() + + env = clean_env() + env["PYTHONIOENCODING"] = "cp1252" + result = run(py_cmd(repo, SCRIPT), repo, env=env) + + assert result.returncode == 0, result.stderr + assert "UnicodeEncodeError" not in result.stderr + for doc in ("research.md", "data-model.md", "contracts/", "quickstart.md"): + assert doc in result.stdout, (doc, result.stdout) + assert "[OK] research.md" in normalize_status_text(result.stdout), result.stdout