René's URL Explorer Experiment


Title: Reading Font.highlight_color raises ValueError for valid `w:highlight w:val="none"` · Issue #1559 · python-openxml/python-docx · GitHub

Open Graph Title: Reading Font.highlight_color raises ValueError for valid `w:highlight w:val="none"` · Issue #1559 · python-openxml/python-docx

X Title: Reading Font.highlight_color raises ValueError for valid `w:highlight w:val="none"` · Issue #1559 · python-openxml/python-docx

Description: Summary Reading Font.highlight_color on a run whose element has w:val="none" raises: ValueError: WD_COLOR_INDEX has no XML mapping for 'none' none is a valid ST_HighlightColor value — Word writes ...

Open Graph Description: Summary Reading Font.highlight_color on a run whose element has w:val="none" raises: ValueError: WD_COLOR_INDEX has no XML mapping for 'none' none is a valid ST_HighlightColor value —...

X Description: Summary Reading Font.highlight_color on a run whose <w:highlight> element has w:val="none" raises: ValueError: WD_COLOR_INDEX has no XML mapping for 'none' none is a valid S...

Opengraph URL: https://github.com/python-openxml/python-docx/issues/1559

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Reading Font.highlight_color raises ValueError for valid `w:highlight w:val=\"none\"`","articleBody":"## Summary\n\nReading `Font.highlight_color` on a run whose `\u003cw:highlight>` element has `w:val=\"none\"` raises:\n\n```\nValueError: WD_COLOR_INDEX has no XML mapping for 'none'\n```\n\n`none` is a valid `ST_HighlightColor` value — Word writes `\u003cw:highlight w:val=\"none\"/>` when a highlight is explicitly cleared from a run. Because the exception is raised during parsing (any access to `font.highlight_color`), it aborts processing of the entire document, not just the affected run.\n\n## Environment\n\n- python-docx 1.2.0\n- Python 3.12\n\n## Reproduction\n\n```python\nfrom docx import Document\nfrom docx.oxml.ns import qn\n\ndoc = Document()\nr = doc.add_paragraph().add_run(\"hi\")._r\nhl = r.get_or_add_rPr().makeelement(qn(\"w:highlight\"), {qn(\"w:val\"): \"none\"})\nr.get_or_add_rPr().append(hl)\n\ndoc.paragraphs[0].runs[0].font.highlight_color\n# ValueError: WD_COLOR_INDEX has no XML mapping for 'none'\n```\n\nTraceback bottoms out in `BaseXmlEnum.from_xml()` (`docx/enum/base.py`), via `CT_Highlight.val` → `highlight_val`.\n\n## Root cause\n\n`WD_COLOR_INDEX` (`docx/enum/text.py`) maps every `ST_HighlightColor` value **except** `none`. `CT_RPr.highlight_val` does `return highlight.val`, and the `RequiredAttribute(\"w:val\", WD_COLOR_INDEX)` descriptor calls `WD_COLOR_INDEX.from_xml(\"none\")`, which has no member and raises.\n\n## Proposed fix\n\n`none` semantically means \"not highlighted\" — exactly what python-docx already represents as `None` (the value returned when no `w:highlight` element is present, and the value the `highlight_val` setter writes by removing the element). So map the explicit `none` value to `None` in the getter:\n\n```python\n@property\ndef highlight_val(self) -> WD_COLOR_INDEX | None:\n    highlight = self.highlight\n    if highlight is None:\n        return None\n    if highlight.get(qn(\"w:val\")) == \"none\":\n        return None\n    return highlight.val\n```\n\n`none` is the only `ST_HighlightColor` value absent from `WD_COLOR_INDEX`, so this closes the gap completely without an enum-value collision (a `none` enum member would have no distinct MS-API integer — `AUTO` already occupies `0`).\n\nI have a branch with this fix plus a unit test and will open a PR referencing this issue.","author":{"url":"https://github.com/mithunvoe","@type":"Person","name":"mithunvoe"},"datePublished":"2026-06-10T18:45:53Z","url":"https://github.com/python-openxml/python-docx/issues/1559"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:09789f64-ff4b-74b6-73f4-18a599dbf3f7
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-id8CE2:36BC9B:231D70:2EF719:6AFF6399
html-safe-nonce6c1455e877a3f75d93fd289ce50d6808d63afb3dd49d83bdff775e4ce018ca54
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4Q0UyOjM2QkM5QjoyMzFENzA6MkVGNzE5OjZBRkY2Mzk5IiwidmlzaXRvcl9pZCI6IjUzNTkzOTE5Mzc1NzA3NTk1NzciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac47df06b16bf4261ea554e8586150567047443ea5cfef92b4eed673ce905db2c8
hovercard-subject-tagissue:4634051702
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python-openxml/python-docx/1559/issue_layout
twitter:imagehttps://opengraph.githubassets.com/1796cf656b44cd7a7205d4072659e56f95c5ebf4fda52ace9c382db03d77c559/python-openxml/python-docx/issues/1559
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/1796cf656b44cd7a7205d4072659e56f95c5ebf4fda52ace9c382db03d77c559/python-openxml/python-docx/issues/1559
og:image:altSummary Reading Font.highlight_color on a run whose element has w:val="none" raises: ValueError: WD_COLOR_INDEX has no XML mapping for 'none' none is a valid ST_HighlightColor value —...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamemithunvoe
hostnamegithub.com
expected-hostnamegithub.com
None41b58589a1c4eda1e3c8904144a412b88ca4455f63ca2ad3629f2e9f3c3a1d12
turbo-cache-controlno-preview
go-importgithub.com/python-openxml/python-docx git https://github.com/python-openxml/python-docx.git
octolytics-dimension-user_id3403760
octolytics-dimension-user_loginpython-openxml
octolytics-dimension-repository_id13592924
octolytics-dimension-repository_nwopython-openxml/python-docx
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id13592924
octolytics-dimension-repository_network_root_nwopython-openxml/python-docx
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release8968d6d6acc65d74e4df332d23932dd3fd0502a4
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python-openxml/python-docx/issues/1559#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-openxml%2Fpython-docx%2Fissues%2F1559
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython-openxml%2Fpython-docx%2Fissues%2F1559
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python-openxml%2Fpython-docx
Reloadhttps://github.com/python-openxml/python-docx/issues/1559
Reloadhttps://github.com/python-openxml/python-docx/issues/1559
Reloadhttps://github.com/python-openxml/python-docx/issues/1559
python-openxmlhttps://github.com/python-openxml
python-docxhttps://github.com/python-openxml/python-docx
Codehttps://github.com/python-openxml/python-docx
Issues387 (387)https://github.com/python-openxml/python-docx/issues
Pull requests167 (167)https://github.com/python-openxml/python-docx/pulls
Actionshttps://github.com/python-openxml/python-docx/actions
Projectshttps://github.com/python-openxml/python-docx/projects
Wikihttps://github.com/python-openxml/python-docx/wiki
Security and qualityhttps://github.com/python-openxml/python-docx/security
Insightshttps://github.com/python-openxml/python-docx/insights
https://github.com/python-openxml/python-docx
New issuehttps://github.com/login?return_to=https://github.com/python-openxml/python-docx/issues/1559
New issuehttps://github.com/login?return_to=https://github.com/python-openxml/python-docx/issues/1559
#1595https://github.com/python-openxml/python-docx/pull/1595
#1560https://github.com/python-openxml/python-docx/pull/1560
Reading Font.highlight_color raises ValueError for valid w:highlight w:val="none"https://github.com/python-openxml/python-docx/issues/1559#top
#1595https://github.com/python-openxml/python-docx/pull/1595
#1560https://github.com/python-openxml/python-docx/pull/1560
https://github.com/mithunvoe
mithunvoehttps://github.com/mithunvoe
on Jun 10, 2026https://github.com/python-openxml/python-docx/issues/1559#issue-4634051702
Sign up for freehttps://github.com/signup?return_to=https://github.com/python-openxml/python-docx/issues/1559
Sign in to commenthttps://github.com/login?return_to=https://github.com/python-openxml/python-docx/issues/1559
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.