dml: add ColorFormat.type

Steve Canny · Steve Canny · commit 96273f27c91b · 2015-02-19T21:39:39.000-08:00
diff --git a/docx/dml/color.py b/docx/dml/color.py
@@ -8,6 +8,8 @@
     absolute_import, division, print_function, unicode_literals
 )
 
+from ..enum.dml import MSO_COLOR_TYPE
+from ..oxml.simpletypes import ST_HexColorAuto
 from ..shared import ElementProxy
 
 
@@ -21,3 +23,23 @@ class ColorFormat(ElementProxy):
 
     def __init__(self, rPr_parent):
         super(ColorFormat, self).__init__(rPr_parent)
+
+    @property
+    def type(self):
+        """
+        Read-only. A member of :ref:`MsoColorType`, one of RGB, THEME, or
+        AUTO, corresponding to the way this color is defined. Its value is
+        |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
+        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
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -145,11 +145,13 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:vMerge',    CT_VMerge)
 
 from .text.font import (
-    CT_Fonts, CT_HpsMeasure, CT_RPr, CT_Underline, CT_VerticalAlignRun
+    CT_Color, CT_Fonts, CT_HpsMeasure, CT_RPr, CT_Underline,
+    CT_VerticalAlignRun
 )
 register_element_cls('w:b',          CT_OnOff)
 register_element_cls('w:bCs',        CT_OnOff)
 register_element_cls('w:caps',       CT_OnOff)
+register_element_cls('w:color',      CT_Color)
 register_element_cls('w:cs',         CT_OnOff)
 register_element_cls('w:dstrike',    CT_OnOff)
 register_element_cls('w:emboss',     CT_OnOff)
diff --git a/docx/oxml/simpletypes.py b/docx/oxml/simpletypes.py
@@ -11,7 +11,7 @@
 )
 
 from ..exceptions import InvalidXmlError
-from ..shared import Emu, Pt, Twips
+from ..shared import Emu, Pt, RGBColor, Twips
 
 
 class BaseSimpleType(object):
@@ -237,6 +237,41 @@ class ST_DrawingElementId(XsdUnsignedInt):
     pass
 
 
+class ST_HexColor(BaseStringType):
+
+    @classmethod
+    def convert_from_xml(cls, str_value):
+        if str_value == 'auto':
+            return ST_HexColorAuto.AUTO
+        return RGBColor.from_string(str_value)
+
+    @classmethod
+    def convert_to_xml(cls, value):
+        """
+        Keep alpha hex numerals all uppercase just for consistency.
+        """
+        # expecting 3-tuple of ints in range 0-255
+        return '%02X%02X%02X' % value
+
+    @classmethod
+    def validate(cls, value):
+        # must be an RGBColor object ---
+        if not isinstance(value, RGBColor):
+            raise ValueError(
+                "rgb color value must be RGBColor object, got %s %s"
+                % (type(value), value)
+            )
+
+
+class ST_HexColorAuto(XsdStringEnumeration):
+    """
+    Value for `w:color/[@val="auto"] attribute setting
+    """
+    AUTO = 'auto'
+
+    _members = (AUTO,)
+
+
 class ST_HpsMeasure(XsdUnsignedLong):
     """
     Half-point measure, e.g. 24.0 represents 12.0 points.
diff --git a/docx/oxml/text/font.py b/docx/oxml/text/font.py
@@ -4,14 +4,26 @@
 Custom element classes related to run properties (font).
 """
 
+from ...enum.dml import MSO_THEME_COLOR
 from ...enum.text import WD_UNDERLINE
 from ..ns import qn
-from ..simpletypes import ST_HpsMeasure, ST_String, ST_VerticalAlignRun
+from ..simpletypes import (
+    ST_HexColor, ST_HpsMeasure, ST_String, ST_VerticalAlignRun
+)
 from ..xmlchemy import (
     BaseOxmlElement, OptionalAttribute, RequiredAttribute, ZeroOrOne
 )
 
 
+class CT_Color(BaseOxmlElement):
+    """
+    `w:color` element, specifying the color of a font and perhaps other
+    objects.
+    """
+    val = RequiredAttribute('w:val', ST_HexColor)
+    themeColor = OptionalAttribute('w:themeColor', MSO_THEME_COLOR)
+
+
 class CT_Fonts(BaseOxmlElement):
     """
     ``<w:rFonts>`` element, specifying typeface name for the various language
@@ -60,6 +72,7 @@ class CT_RPr(BaseOxmlElement):
     snapToGrid = ZeroOrOne('w:snapToGrid', successors=_tag_seq[16:])
     vanish = ZeroOrOne('w:vanish', successors=_tag_seq[17:])
     webHidden = ZeroOrOne('w:webHidden', successors=_tag_seq[18:])
+    color = ZeroOrOne('w:color', successors=_tag_seq[19:])
     sz = ZeroOrOne('w:sz', successors=_tag_seq[24:])
     u = ZeroOrOne('w:u', successors=_tag_seq[27:])
     vertAlign = ZeroOrOne('w:vertAlign', successors=_tag_seq[32:])
diff --git a/features/txt-font-color.feature b/features/txt-font-color.feature
@@ -4,7 +4,6 @@ Feature: Get and set font color
   I need a way to get and set the text color
 
 
-  @wip
   Scenario Outline: Get font color type
     Given a font having <type> color
      Then font.color.type is <value>
diff --git a/tests/dml/__init__.py b/tests/dml/__init__.py
diff --git a/tests/dml/test_color.py b/tests/dml/test_color.py
@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+"""
+Test suite for docx.dml.color module.
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from docx.enum.dml import MSO_COLOR_TYPE
+from docx.dml.color import ColorFormat
+
+from ..unitutil.cxml import element
+
+import pytest
+
+
+class DescribeColorFormat(object):
+
+    def it_knows_its_color_type(self, type_fixture):
+        color_format, expected_value = type_fixture
+        assert color_format.type == expected_value
+
+    # fixtures ---------------------------------------------
+
+    @pytest.fixture(params=[
+        ('w:r',                                   None),
+        ('w:r/w:rPr',                             None),
+        ('w:r/w:rPr/w:color{w:val=auto}',         MSO_COLOR_TYPE.AUTO),
+        ('w:r/w:rPr/w:color{w:val=4224FF}',       MSO_COLOR_TYPE.RGB),
+        ('w:r/w:rPr/w:color{w:themeColor=dark1}', MSO_COLOR_TYPE.THEME),
+        ('w:r/w:rPr/w:color{w:val=F00BA9,w:themeColor=accent1}',
+         MSO_COLOR_TYPE.THEME),
+    ])
+    def type_fixture(self, request):
+        r_cxml, expected_value = request.param
+        color_format = ColorFormat(element(r_cxml))
+        return color_format, expected_value
