run: add Run.style setter

Victor Volle · Steve Canny · commit 16afd9b8bf6c · 2014-05-06T23:33:59.000-07:00
diff --git a/docx/oxml/shared.py b/docx/oxml/shared.py
@@ -333,6 +333,14 @@ def new_pStyle(cls, val):
         """
         return OxmlElement('w:pStyle', attrs={qn('w:val'): val})
 
+    @classmethod
+    def new_rStyle(cls, val):
+        """
+        Return a new ``<w:rStyle>`` element with ``val`` attribute set to
+        *val*.
+        """
+        return OxmlElement('w:rStyle', attrs={qn('w:val'): val})
+
     @property
     def val(self):
         return self.get(qn('w:val'))
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -270,14 +270,23 @@ def rPr(self):
     @property
     def style(self):
         """
-        String contained in w:val attribute of <w:pStyle> grandchild, or
+        String contained in w:val attribute of <w:rStyle> grandchild, or
         |None| if that element is not present.
         """
         rPr = self.rPr
         if rPr is None:
             return None
         return rPr.style
 
+    @style.setter
+    def style(self, style):
+        """
+        Set the character style of this <w:r> element to *style*. If *style*
+        is None, remove the style element.
+        """
+        rPr = self.get_or_add_rPr()
+        rPr.style = style
+
     @property
     def t_lst(self):
         """
@@ -609,6 +618,11 @@ def remove_outline(self):
         for outline in outline_lst:
             self.remove(outline)
 
+    def remove_rStyle(self):
+        rStyle = self.rStyle
+        if rStyle is not None:
+            self.remove(rStyle)
+
     def remove_rtl(self):
         rtl_lst = self.findall(qn('w:rtl'))
         for rtl in rtl_lst:
@@ -709,6 +723,20 @@ def style(self):
             return None
         return rStyle.val
 
+    @style.setter
+    def style(self, style):
+        """
+        Set val attribute of <w:rStyle> child element to *style*, adding a
+        new element if necessary. If *style* is |None|, remove the <w:rStyle>
+        element if present.
+        """
+        if style is None:
+            self.remove_rStyle()
+        elif self.rStyle is None:
+            self._add_rStyle(style)
+        else:
+            self.rStyle.val = style
+
     @property
     def vanish(self):
         """
@@ -723,6 +751,11 @@ def webHidden(self):
         """
         return self.find(qn('w:webHidden'))
 
+    def _add_rStyle(self, style):
+        rStyle = CT_String.new_rStyle(style)
+        self.insert(0, rStyle)
+        return rStyle
+
 
 class CT_Text(OxmlBaseElement):
     """
diff --git a/docx/text.py b/docx/text.py
@@ -304,10 +304,17 @@ def strike(self):
     def style(self):
         """
         Read/write. The string name of the character style applied to this
-        run, or |None| if it has no directly-applied character style.
+        run, or |None| if it has no directly-applied character style. Setting
+        this property to |None| causes any directly-applied character style
+        to be removed such that the run inherits character formatting from
+        its containing paragraph.
         """
         return self._r.style
 
+    @style.setter
+    def style(self, char_style):
+        self._r.style = char_style
+
     @property
     def text(self):
         """
diff --git a/features/run-char-style.feature b/features/run-char-style.feature
@@ -15,7 +15,6 @@ Feature: Each run has a read/write style
       | Strong     |
 
 
-  @wip
   Scenario Outline: Set the style of a run
     Given a run having style <char style>
      When I set the character style of the run to <new char style>
diff --git a/tests/test_text.py b/tests/test_text.py
@@ -139,6 +139,11 @@ def it_knows_its_character_style(self, style_get_fixture):
         run, expected_style = style_get_fixture
         assert run.style == expected_style
 
+    def it_can_change_its_character_style(self, style_set_fixture):
+        run, style, expected_xml = style_set_fixture
+        run.style = style
+        assert run._r.xml == expected_xml
+
     def it_can_add_text(self, add_text_fixture):
         run, text_str, expected_xml, Text_ = add_text_fixture
         _text = run.add_text(text_str)
@@ -313,16 +318,24 @@ def bool_prop_set_fixture(self, request):
     @pytest.fixture(params=['Foobar', None])
     def style_get_fixture(self, request):
         style = request.param
-        r_bldr = an_r().with_nsdecls()
-        if style is not None:
-            r_bldr.with_child(
-                an_rPr().with_child(
-                    an_rStyle().with_val(style))
-            )
-        r = r_bldr.element
+        r = self.r_bldr_with_style(style).element
         run = Run(r)
         return run, style
 
+    @pytest.fixture(params=[
+        (None, None),
+        (None, 'Foobar'),
+        ('Foobar', None),
+        ('Foobar', 'Foobar'),
+        ('Foobar', 'Barfoo'),
+    ])
+    def style_set_fixture(self, request):
+        before_style, after_style = request.param
+        r = self.r_bldr_with_style(before_style).element
+        run = Run(r)
+        expected_xml = self.r_bldr_with_style(after_style).xml()
+        return run, after_style, expected_xml
+
     @pytest.fixture
     def text_prop_fixture(self, Text_):
         r = (
@@ -340,6 +353,13 @@ def run(self):
         r = an_r().with_nsdecls().element
         return Run(r)
 
+    def r_bldr_with_style(self, style):
+        rPr_bldr = an_rPr()
+        if style is not None:
+            rPr_bldr.with_child(an_rStyle().with_val(style))
+        r_bldr = an_r().with_nsdecls().with_child(rPr_bldr)
+        return r_bldr
+
     @pytest.fixture
     def Text_(self, request):
         return class_mock(request, 'docx.text.Text')
