dml: add ColorFormat.rgb getter

mavwolverine · Steve Canny · commit 1fd60776f7cb · 2015-02-19T21:40:40.000-08:00
diff --git a/docx/dml/color.py b/docx/dml/color.py
@@ -24,6 +24,32 @@ class ColorFormat(ElementProxy):
     def __init__(self, rPr_parent):
         super(ColorFormat, self).__init__(rPr_parent)
 
+    @property
+    def rgb(self):
+        """
+        An |RGBColor| value or |None| if no RGB color is specified.
+
+        When :attr:`type` is `MSO_COLOR_TYPE.RGB`, the value of this property
+        will always be an |RGBColor| value. It may also be an |RGBColor|
+        value if :attr:`type` is `MSO_COLOR_TYPE.THEME`, as Word writes the
+        current value of a theme color when one is assigned. In that case,
+        the RGB value should be interpreted as no more than a good guess
+        however, as the theme color takes precedence at rendering time. Its
+        value is |None| whenever :attr:`type` is either |None| or
+        `MSO_COLOR_TYPE.AUTO`.
+
+        Assigning an |RGBColor| value causes :attr:`type` to become
+        `MSO_COLOR_TYPE.RGB` and any theme color is removed. Assigning |None|
+        causes any color to be removed such that the effective color is
+        inherited from the style hierarchy.
+        """
+        color = self._color
+        if color is None:
+            return None
+        if color.val == ST_HexColorAuto.AUTO:
+            return None
+        return color.val
+
     @property
     def type(self):
         """
@@ -32,14 +58,22 @@ def type(self):
         |None| if no color is applied at this level, which causes the
         effective color to be inherited from the style hierarchy.
         """
-        rPr = self._element.rPr
-        if rPr is None:
-            return None
-        color = rPr.color
+        color = self._color
         if color is None:
             return None
         if color.themeColor is not None:
             return MSO_COLOR_TYPE.THEME
         if color.val == ST_HexColorAuto.AUTO:
             return MSO_COLOR_TYPE.AUTO
         return MSO_COLOR_TYPE.RGB
+
+    @property
+    def _color(self):
+        """
+        Return `w:rPr/w:color` or |None| if not present. Helper to factor out
+        repetitive element access.
+        """
+        rPr = self._element.rPr
+        if rPr is None:
+            return None
+        return rPr.color
diff --git a/features/txt-font-color.feature b/features/txt-font-color.feature
@@ -16,7 +16,6 @@ Feature: Get and set font color
       | a theme | THEME |
 
 
-  @wip
   Scenario Outline: Get font RGB color
     Given a font having <type> color
      Then font.color.rgb is <value>
diff --git a/tests/dml/test_color.py b/tests/dml/test_color.py
@@ -10,6 +10,7 @@
 
 from docx.enum.dml import MSO_COLOR_TYPE
 from docx.dml.color import ColorFormat
+from docx.shared import RGBColor
 
 from ..unitutil.cxml import element
 
@@ -22,8 +23,26 @@ def it_knows_its_color_type(self, type_fixture):
         color_format, expected_value = type_fixture
         assert color_format.type == expected_value
 
+    def it_knows_its_RGB_value(self, rgb_get_fixture):
+        color_format, expected_value = rgb_get_fixture
+        assert color_format.rgb == expected_value
+
     # fixtures ---------------------------------------------
 
+    @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}',                      '4224ff'),
+        ('w:r/w:rPr/w:color{w:val=auto,w:themeColor=accent1}',   None),
+        ('w:r/w:rPr/w:color{w:val=F00BA9,w:themeColor=accent1}', 'f00ba9'),
+    ])
+    def rgb_get_fixture(self, request):
+        r_cxml, rgb = request.param
+        color_format = ColorFormat(element(r_cxml))
+        expected_value = None if rgb is None else RGBColor.from_string(rgb)
+        return color_format, expected_value
+
     @pytest.fixture(params=[
         ('w:r',                                   None),
         ('w:r/w:rPr',                             None),
