font: add Font.subscript getter

Steve Canny · Steve Canny · commit 1904119f67db · 2015-02-08T00:01:42.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -143,7 +143,8 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:pStyle', CT_String)
 
 from .text.run import (
-    CT_Br, CT_Fonts, CT_HpsMeasure, CT_R, CT_RPr, CT_Text, CT_Underline
+    CT_Br, CT_Fonts, CT_HpsMeasure, CT_R, CT_RPr, CT_Text, CT_Underline,
+    CT_VerticalAlignRun
 )
 register_element_cls('w:b',          CT_OnOff)
 register_element_cls('w:bCs',        CT_OnOff)
@@ -172,4 +173,5 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:t',          CT_Text)
 register_element_cls('w:u',          CT_Underline)
 register_element_cls('w:vanish',     CT_OnOff)
+register_element_cls('w:vertAlign',  CT_VerticalAlignRun)
 register_element_cls('w:webHidden',  CT_OnOff)
diff --git a/docx/oxml/simpletypes.py b/docx/oxml/simpletypes.py
@@ -361,3 +361,14 @@ def convert_from_xml(cls, str_value):
         }[units_part]
         emu_value = Emu(int(round(quantity * multiplier)))
         return emu_value
+
+
+class ST_VerticalAlignRun(XsdStringEnumeration):
+    """
+    Valid values for `w:vertAlign/@val`.
+    """
+    BASELINE = 'baseline'
+    SUPERSCRIPT = 'superscript'
+    SUBSCRIPT = 'subscript'
+
+    _members = (BASELINE, SUPERSCRIPT, SUBSCRIPT)
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -6,7 +6,9 @@
 
 from ...enum.text import WD_UNDERLINE
 from ..ns import qn
-from ..simpletypes import ST_BrClear, ST_BrType, ST_HpsMeasure, ST_String
+from ..simpletypes import (
+    ST_BrClear, ST_BrType, ST_HpsMeasure, ST_String, ST_VerticalAlignRun
+)
 from ..xmlchemy import (
     BaseOxmlElement, OptionalAttribute, RequiredAttribute, ZeroOrMore,
     ZeroOrOne
@@ -156,6 +158,7 @@ class CT_RPr(BaseOxmlElement):
     webHidden = ZeroOrOne('w:webHidden', successors=_tag_seq[18:])
     sz = ZeroOrOne('w:sz', successors=_tag_seq[24:])
     u = ZeroOrOne('w:u', successors=_tag_seq[27:])
+    vertAlign = ZeroOrOne('w:vertAlign', successors=_tag_seq[32:])
     rtl = ZeroOrOne('w:rtl', successors=_tag_seq[33:])
     cs = ZeroOrOne('w:cs', successors=_tag_seq[34:])
     specVanish = ZeroOrOne('w:specVanish', successors=_tag_seq[38:])
@@ -225,6 +228,20 @@ def style(self, style):
         else:
             self.rStyle.val = style
 
+    @property
+    def subscript(self):
+        """
+        |True| if `w:vertAlign/@w:val` is 'subscript'. |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.SUBSCRIPT:
+            return True
+        return False
+
     @property
     def sz_val(self):
         """
@@ -314,6 +331,13 @@ def val(self, value):
         self.set(qn('w:val'), val)
 
 
+class CT_VerticalAlignRun(BaseOxmlElement):
+    """
+    ``<w:vertAlign>`` element, specifying subscript or superscript.
+    """
+    val = RequiredAttribute('w:val', ST_VerticalAlignRun)
+
+
 class _RunContentAppender(object):
     """
     Service object that knows how to translate a Python string into run
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -480,6 +480,18 @@ def strike(self):
     def strike(self, value):
         self._set_bool_prop('strike', value)
 
+    @property
+    def subscript(self):
+        """
+        Boolean indicating whether the characters in this |Font| appear as
+        subscript. |None| indicates the subscript/subscript value is
+        inherited from the style hierarchy.
+        """
+        rPr = self._element.rPr
+        if rPr is None:
+            return None
+        return rPr.subscript
+
     @property
     def underline(self):
         """
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -369,6 +369,10 @@ def it_can_change_its_bool_prop_settings(self, bool_prop_set_fixture):
         setattr(font, prop_name, value)
         assert font._element.xml == expected_xml
 
+    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_its_underline_type(self, underline_get_fixture):
         font, expected_value = underline_get_fixture
         assert font.underline is expected_value
@@ -515,6 +519,18 @@ def size_set_fixture(self, request):
         expected_xml = xml(expected_r_cxml)
         return font, value, expected_xml
 
+    @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}',   True),
+        ('w:r/w:rPr/w:vertAlign{w:val=superscript}', False),
+    ])
+    def subscript_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),
