Read Doxygen XML independently of the system text encoding - #4925
Open
dajiaohuang wants to merge 2 commits into
Open
Read Doxygen XML independently of the system text encoding#4925dajiaohuang wants to merge 2 commits into
dajiaohuang wants to merge 2 commits into
Conversation
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
1 participant
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 #4924.
Open the three Doxygen XML streams in binary mode so ElementTree decodes their declared encoding instead of Python's default text codec. This fixes local documentation generation under Windows cp1252 without requiring
PYTHONUTF8=1.Adds three unittest regressions for header, compound and namespace loading. They exercise the handler with UTF-8 XML and a simulated cp1252 default, without running Doxygen or depending on the host locale. All three fail with
UnicodeDecodeErrorbefore the fix and pass afterward.Validation:
python -B -X utf8=0 -m unittest discover -s support/python/tests -v: 3 passed, using the pinned documentation environment.python -X utf8=0 support/mkdocs build --site-dir <output>: passed on Windows with Doxygen 1.18.0 andPYTHONUTF8=0. The existing unrelated chrono-anchor warning remains.git diff --checkpass.No dependency, CI, C++ API, or release changes. The separate locale-description PR #4923 is unaffected.