fix: return None for w:highlight w:val="none" instead of raising ValueError - #1595
Open
VenkateswarluNagineni wants to merge 1 commit into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
…eError Word writes `<w:highlight w:val="none"/>` when highlight is explicitly cleared from a run. This value is valid per ST_HighlightColor but absent from WD_COLOR_INDEX, so CT_RPr.highlight_val raised ValueError on any access to Font.highlight_color for such runs. Treat w:val="none" as "no highlight" (same semantics as the no-element case) by checking the raw attribute before the enum lookup. Fixes python-openxml#1559 Co-Authored-By: Claude <noreply@anthropic.com>
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.
Summary
Fixes #1559.
Reading Font.highlight_color on a run whose <w:highlight> element has w:val="none" raised ValueError: WD_COLOR_INDEX has no XML mapping for 'none'. This crashed processing of the entire document even though none is a valid ST_HighlightColor value that Word writes when explicitly clearing a highlight from a run.
Root cause
CT_RPr.highlight_val forwarded highlight.val directly to the RequiredAttribute("w:val", WD_COLOR_INDEX) descriptor, which calls WD_COLOR_INDEX.from_xml("none"). Since "none" is absent from WD_COLOR_INDEX (it has no distinct MS-API integer), from_xml raised.
Fix
Check the raw w:val attribute before the enum lookup. w:val="none" means "not highlighted" — semantically identical to the no-element case — so return None:
Testing
Added a parametrized test case ("w:r/w:rPr/w:highlight{w:val=none}", None) to it_knows_its_highlight_color. All 11 highlight-related tests pass; no regressions.
[This is Claude Code on behalf of Venkateswarlu Nagineni]