run: add validator to Run.underline setter

Steve Canny · Steve Canny · commit 9fa9d0a4883f · 2014-05-12T23:36:14.000-07:00
diff --git a/docx/enum/text.py b/docx/enum/text.py
@@ -39,6 +39,10 @@ class WD_UNDERLINE(XmlEnumeration):
     __url__ = 'http://msdn.microsoft.com/en-us/library/office/ff822388.aspx'
 
     __members__ = (
+        XmlMappedEnumMember(
+            None, None, None, 'Inherit underline setting from containing par'
+            'agraph.'
+        ),
         XmlMappedEnumMember(
             'NONE', 0, 'none', 'No underline. This setting overrides any inh'
             'erited underline value, so can be used to remove underline from'
diff --git a/docx/text.py b/docx/text.py
@@ -6,7 +6,7 @@
 
 from __future__ import absolute_import, print_function, unicode_literals
 
-from docx.enum.text import WD_BREAK
+from docx.enum.text import WD_BREAK, WD_UNDERLINE
 
 
 def boolproperty(f):
@@ -346,6 +346,9 @@ def underline(self):
 
     @underline.setter
     def underline(self, value):
+        if not WD_UNDERLINE.is_valid_setting(value):
+            tmpl = "'%s' is not a valid setting for Run.underline"
+            raise ValueError(tmpl % value)
         self._r.underline = value
 
     @boolproperty
diff --git a/tests/test_text.py b/tests/test_text.py
@@ -161,6 +161,12 @@ def it_can_change_its_underline_type(self, underline_set_fixture):
         run.underline = underline
         assert run._r.xml == expected_xml
 
+    def it_raises_on_assign_invalid_underline_type(
+            self, underline_raise_fixture):
+        run, underline = underline_raise_fixture
+        with pytest.raises(ValueError):
+            run.underline = underline
+
     def it_can_add_text(self, add_text_fixture):
         run, text_str, expected_xml, Text_ = add_text_fixture
         _text = run.add_text(text_str)
@@ -375,6 +381,13 @@ def underline_get_fixture(self, request):
         run = Run(r)
         return run, expected_prop_value
 
+    @pytest.fixture(params=['foobar', 42, 'single'])
+    def underline_raise_fixture(self, request):
+        underline = request.param
+        r = self.r_bldr_with_underline(None).element
+        run = Run(r)
+        return run, underline
+
     @pytest.fixture(params=[
         (None,     True,                'single'),
         (None,     False,               'none'),
