font: add Font.superscript setter

Steve Canny · Steve Canny · commit 42ed65d41e94 · 2015-02-08T00:01:42.000-08:00
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -267,6 +267,17 @@ def superscript(self):
             return True
         return False
 
+    @superscript.setter
+    def superscript(self, value):
+        if value is None:
+            self._remove_vertAlign()
+        elif bool(value) is True:
+            self.get_or_add_vertAlign().val = ST_VerticalAlignRun.SUPERSCRIPT
+        elif self.vertAlign is None:
+            return
+        elif self.vertAlign.val == ST_VerticalAlignRun.SUPERSCRIPT:
+            self._remove_vertAlign()
+
     @property
     def sz_val(self):
         """
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -509,6 +509,11 @@ def superscript(self):
             return None
         return rPr.superscript
 
+    @superscript.setter
+    def superscript(self, value):
+        rPr = self._element.get_or_add_rPr()
+        rPr.superscript = value
+
     @property
     def underline(self):
         """
diff --git a/features/txt-font-props.feature b/features/txt-font-props.feature
@@ -91,7 +91,6 @@ Feature: Get or set font properties
       | superscript     | False     | True        |
 
 
-  @wip
   Scenario Outline: Change font sub/superscript
     Given a font having <vertAlign-state> vertical alignment
      When I assign <value> to font.<name>script
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -382,6 +382,11 @@ def it_knows_whether_it_is_superscript(self, superscript_get_fixture):
         font, expected_value = superscript_get_fixture
         assert font.superscript == expected_value
 
+    def it_can_change_whether_it_is_superscript(self, superscript_set_fixture):
+        font, value, expected_xml = superscript_set_fixture
+        font.superscript = 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
@@ -580,6 +585,34 @@ def superscript_get_fixture(self, request):
         font = Font(element(r_cxml))
         return font, expected_value
 
+    @pytest.fixture(params=[
+        ('w:r',                                       True,
+         'w:r/w:rPr/w:vertAlign{w:val=superscript}'),
+        ('w:r',                                       False,
+         'w:r/w:rPr'),
+        ('w:r',                                       None,
+         'w:r/w:rPr'),
+        ('w:r/w:rPr/w:vertAlign{w:val=superscript}',  True,
+         'w:r/w:rPr/w:vertAlign{w:val=superscript}'),
+        ('w:r/w:rPr/w:vertAlign{w:val=superscript}',  False,
+         'w:r/w:rPr'),
+        ('w:r/w:rPr/w:vertAlign{w:val=superscript}',  None,
+         'w:r/w:rPr'),
+        ('w:r/w:rPr/w:vertAlign{w:val=subscript}',    True,
+         'w:r/w:rPr/w:vertAlign{w:val=superscript}'),
+        ('w:r/w:rPr/w:vertAlign{w:val=subscript}',    False,
+         'w:r/w:rPr/w:vertAlign{w:val=subscript}'),
+        ('w:r/w:rPr/w:vertAlign{w:val=subscript}',    None,
+         'w:r/w:rPr'),
+        ('w:r/w:rPr/w:vertAlign{w:val=baseline}',     True,
+         'w:r/w:rPr/w:vertAlign{w:val=superscript}'),
+    ])
+    def superscript_set_fixture(self, request):
+        r_cxml, value, expected_r_cxml = request.param
+        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),
