font: add Font.underline getter

Steve Canny · Steve Canny · commit 601216c28eb4 · 2015-02-08T00:01:41.000-08:00
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -259,6 +259,16 @@ def sz_val(self, value):
         sz = self.get_or_add_sz()
         sz.val = value
 
+    @property
+    def u_val(self):
+        """
+        Value of `w:u/@val`, or None if not present.
+        """
+        u = self.u
+        if u is None:
+            return None
+        return u.val
+
     @property
     def underline(self):
         """
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -426,6 +426,21 @@ def size(self, emu):
         rPr = self._element.get_or_add_rPr()
         rPr.sz_val = emu
 
+    @property
+    def underline(self):
+        """
+        The underline style for this |Font|, one of |None|, |True|, |False|,
+        or a value from :ref:`WdUnderline`. |None| indicates the font
+        inherits its underline value from the style hierarchy. |False|
+        indicates no underline. |True| indicates single underline. The values
+        from :ref:`WdUnderline` are used to specify other outline styles such
+        as double, wavy, and dotted.
+        """
+        rPr = self._element.rPr
+        if rPr is None:
+            return None
+        return rPr.u_val
+
 
 class _Text(object):
     """
diff --git a/features/txt-font-props.feature b/features/txt-font-props.feature
@@ -48,7 +48,6 @@ Feature: Get or set font properties
       | 18 pt       | None   |
 
 
-  @wip
   Scenario Outline: Get font underline value
     Given a font having <underline-type> underline
      Then font.underline is <value>
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -390,6 +390,10 @@ def it_can_change_its_size(self, size_set_fixture):
         font.size = value
         assert font._element.xml == expected_xml
 
+    def it_knows_its_underline_type(self, underline_get_fixture):
+        font, expected_value = underline_get_fixture
+        assert font.underline is expected_value
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -440,3 +444,16 @@ def size_set_fixture(self, request):
         font = Font(element(r_cxml))
         expected_xml = xml(expected_r_cxml)
         return font, value, expected_xml
+
+    @pytest.fixture(params=[
+        ('w:r',                         None),
+        ('w:r/w:rPr/w:u',               None),
+        ('w:r/w:rPr/w:u{w:val=single}', True),
+        ('w:r/w:rPr/w:u{w:val=none}',   False),
+        ('w:r/w:rPr/w:u{w:val=double}', WD_UNDERLINE.DOUBLE),
+        ('w:r/w:rPr/w:u{w:val=wave}',   WD_UNDERLINE.WAVY),
+    ])
+    def underline_get_fixture(self, request):
+        r_cxml, expected_value = request.param
+        run = Font(element(r_cxml), None)
+        return run, expected_value
