Skip to content

fix: return None for w:highlight w:val="none" instead of raising ValueError #1595

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

Open
VenkateswarluNagineni wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: return None for w:highlight w:val="none" instead of raising ValueError #1595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion src/docx/oxml/text/font.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

from docx.enum.dml import MSO_THEME_COLOR
from docx.enum.text import WD_COLOR_INDEX, WD_UNDERLINE
from docx.oxml.ns import nsdecls
from docx.oxml.ns import nsdecls, qn
from docx.oxml.parser import parse_xml
from docx.oxml.simpletypes import (
ST_HexColor,
Expand Down Expand Up @@ -159,6 +159,10 @@ def highlight_val(self) -> WD_COLOR_INDEX | None:
highlight = self.highlight
if highlight is None:
return None
# w:val="none" is a valid ST_HighlightColor value meaning "no highlight";
# it's not in WD_COLOR_INDEX so we return None to match the no-element case.
if highlight.get(qn("w:val")) == "none":
return None
return highlight.val

@highlight_val.setter
Expand Down
2 changes: 2 additions & 0 deletions tests/text/test_font.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,8 @@ def it_can_change_its_underline_type(
("w:r/w:rPr", None),
("w:r/w:rPr/w:highlight{w:val=default}", WD_COLOR.AUTO),
("w:r/w:rPr/w:highlight{w:val=blue}", WD_COLOR.BLUE),
# w:val="none" is a valid ST_HighlightColor meaning "no highlight"
("w:r/w:rPr/w:highlight{w:val=none}", None),
],
)
def it_knows_its_highlight_color(self, r_cxml: str, expected_value: WD_COLOR | None):
Expand Down