Parse run highlights

Author: mwilliamson

NEWS

@@ -1,3 +1,7 @@
+# 1.8.0
+
+* Support parsing of run highlights.
+
 # 1.7.1
 
 * Switch the precedence of numbering properties in paragraph properties and the

mammoth/documents.py

@@ -53,6 +53,7 @@ class Run(HasChildren):
     vertical_alignment = cobble.field()
     font = cobble.field()
     font_size = cobble.field()
+    highlight = cobble.field()
 
 @cobble.data
 class Text(Element):
@@ -128,6 +129,7 @@ def run(
     vertical_alignment=None,
     font=None,
     font_size=None,
+    highlight=None,
 ):
     if vertical_alignment is None:
         vertical_alignment = VerticalAlignment.baseline
@@ -144,6 +146,7 @@ def run(
         vertical_alignment=vertical_alignment,
         font=font,
         font_size=font_size,
+        highlight=highlight,
     )
 
 class VerticalAlignment(object):

mammoth/docx/body_xml.py

@@ -102,6 +102,7 @@ def run(element):
         is_strikethrough = read_boolean_element(properties.find_child("w:strike"))
         is_all_caps = read_boolean_element(properties.find_child("w:caps"))
         is_small_caps = read_boolean_element(properties.find_child("w:smallCaps"))
+        highlight = properties.find_child_or_null("w:highlight").attributes.get("w:val")
 
         def add_complex_field_hyperlink(children):
             hyperlink_kwargs = current_hyperlink_kwargs()
@@ -126,6 +127,7 @@ def add_complex_field_hyperlink(children):
                 vertical_alignment=vertical_alignment,
                 font=font,
                 font_size=font_size,
+                highlight=highlight,
             ))
 
     def _read_run_style(properties):

tests/docx/body_xml_tests.py

@@ -405,6 +405,15 @@ def test_run_with_invalid_w_sz_has_none_font_size(self):
         run = self._read_run_with_properties([font_size_xml])
         assert_equal(None, run.font_size)
 
+    def test_run_has_no_highlight_by_default(self):
+        run = self._read_run_with_properties([])
+        assert_equal(None, run.highlight)
+
+    def test_run_has_highlight_read_from_properties(self):
+        highlight_xml = xml_element("w:highlight", {"w:val": "yellow"})
+        run = self._read_run_with_properties([highlight_xml])
+        assert_equal("yellow", run.highlight)
+
     def _read_run_with_properties(self, properties, styles=None):
         properties_xml = xml_element("w:rPr", {}, properties)
         run_xml = xml_element("w:r", {}, [properties_xml])