font: add Font.superscript getter

Steve Canny · Steve Canny · commit 7d04ac900193 · 2015-02-08T00:01:42.000-08:00
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -242,6 +242,20 @@ def subscript(self):
             return True
         return False
 
+    @property
+    def superscript(self):
+        """
+        |True| if `w:vertAlign/@w:val` is 'superscript'. |False| if
+        `w:vertAlign/@w:val` contains any other value. |None| if
+        `w:vertAlign` is not present.
+        """
+        vertAlign = self.vertAlign
+        if vertAlign is None:
+            return None
+        if vertAlign.val == ST_VerticalAlignRun.SUPERSCRIPT:
+            return True
+        return False
+
     @property
     def sz_val(self):
         """
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -492,6 +492,18 @@ def subscript(self):
             return None
         return rPr.subscript
 
+    @property
+    def superscript(self):
+        """
+        Boolean indicating whether the characters in this |Font| appear as
+        superscript. |None| indicates the subscript/superscript value is
+        inherited from the style hierarchy.
+        """
+        rPr = self._element.rPr
+        if rPr is None:
+            return None
+        return rPr.superscript
+
     @property
     def underline(self):
         """
diff --git a/features/txt-font-props.feature b/features/txt-font-props.feature
@@ -79,7 +79,6 @@ Feature: Get or set font properties
       | single         | WD_UNDERLINE.DOUBLE | WD_UNDERLINE.DOUBLE |
 
 
-  @wip
   Scenario Outline: Get font sub/superscript value
     Given a font having <vertAlign-state> vertical alignment
      Then font.subscript is <sub-value>
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -373,6 +373,10 @@ def it_knows_whether_it_is_subscript(self, subscript_get_fixture):
         font, expected_value = subscript_get_fixture
         assert font.subscript == expected_value
 
+    def it_knows_whether_it_is_superscript(self, superscript_get_fixture):
+        font, expected_value = superscript_get_fixture
+        assert font.superscript == expected_value
+
     def it_knows_its_underline_type(self, underline_get_fixture):
         font, expected_value = underline_get_fixture
         assert font.underline is expected_value
@@ -531,6 +535,18 @@ def subscript_get_fixture(self, request):
         font = Font(element(r_cxml))
         return font, expected_value
 
+    @pytest.fixture(params=[
+        ('w:r',                                      None),
+        ('w:r/w:rPr',                                None),
+        ('w:r/w:rPr/w:vertAlign{w:val=baseline}',    False),
+        ('w:r/w:rPr/w:vertAlign{w:val=subscript}',   False),
+        ('w:r/w:rPr/w:vertAlign{w:val=superscript}', True),
+    ])
+    def superscript_get_fixture(self, request):
+        r_cxml, expected_value = request.param
+        font = Font(element(r_cxml))
+        return font, expected_value
+
     @pytest.fixture(params=[
         ('w:r',                         None),
         ('w:r/w:rPr/w:u',               None),
