dml: add ColorFormat.theme_color getter

Steve Canny · Steve Canny · commit 063396b36368 · 2015-02-19T21:40:57.000-08:00
diff --git a/docx/dml/color.py b/docx/dml/color.py
@@ -59,6 +59,26 @@ def rgb(self, value):
         if value is not None:
             rPr.get_or_add_color().val = value
 
+    @property
+    def theme_color(self):
+        """
+        A member of :ref:`MsoThemeColorIndex` or |None| if no theme color is
+        specified. When :attr:`type` is `MSO_COLOR_TYPE.THEME`, the value of
+        this property will always be a member of :ref:`MsoThemeColorIndex`.
+        When :attr:`type` has any other value, the value of this property is
+        |None|.
+
+        Assigning a member of :ref:`MsoThemeColorIndex` causes :attr:`type`
+        to become `MSO_COLOR_TYPE.THEME`. Any existing RGB value is retained
+        but ignored by Word. Assigning |None| causes any color specification
+        to be removed such that the effective color is inherited from the
+        style hierarchy.
+        """
+        color = self._color
+        if color is None or color.themeColor is None:
+            return None
+        return color.themeColor
+
     @property
     def type(self):
         """
diff --git a/features/txt-font-color.feature b/features/txt-font-color.feature
@@ -44,7 +44,6 @@ Feature: Get and set font color
       | a theme | None   | None       | None      |
 
 
-  @wip
   Scenario Outline: Get font theme color
     Given a font having <type> color
      Then font.color.theme_color is <value>
diff --git a/tests/dml/test_color.py b/tests/dml/test_color.py
@@ -8,7 +8,7 @@
     absolute_import, division, print_function, unicode_literals
 )
 
-from docx.enum.dml import MSO_COLOR_TYPE
+from docx.enum.dml import MSO_COLOR_TYPE, MSO_THEME_COLOR
 from docx.dml.color import ColorFormat
 from docx.shared import RGBColor
 
@@ -32,6 +32,10 @@ def it_can_change_its_RGB_value(self, rgb_set_fixture):
         color_format.rgb = new_value
         assert color_format._element.xml == expected_xml
 
+    def it_knows_its_theme_color(self, theme_color_get_fixture):
+        color_format, expected_value = theme_color_get_fixture
+        assert color_format.theme_color == expected_value
+
     # fixtures ---------------------------------------------
 
     @pytest.fixture(params=[
@@ -67,6 +71,22 @@ def rgb_set_fixture(self, request):
         expected_xml = xml(expected_cxml)
         return color_format, new_value, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:r',                                                None),
+        ('w:r/w:rPr',                                          None),
+        ('w:r/w:rPr/w:color{w:val=auto}',                      None),
+        ('w:r/w:rPr/w:color{w:val=4224FF}',                    None),
+        ('w:r/w:rPr/w:color{w:themeColor=accent1}',            'ACCENT_1'),
+        ('w:r/w:rPr/w:color{w:val=F00BA9,w:themeColor=dark1}', 'DARK_1'),
+    ])
+    def theme_color_get_fixture(self, request):
+        r_cxml, value = request.param
+        color_format = ColorFormat(element(r_cxml))
+        expected_value = (
+            None if value is None else getattr(MSO_THEME_COLOR, value)
+        )
+        return color_format, expected_value
+
     @pytest.fixture(params=[
         ('w:r',                                   None),
         ('w:r/w:rPr',                             None),
