run: add Run.style getter

Victor Volle · Steve Canny · commit b0e3c80c2851 · 2014-05-05T21:22:29.000-07:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -72,6 +72,7 @@
 register_custom_element_class('w:pStyle', CT_String)
 register_custom_element_class('w:r', CT_R)
 register_custom_element_class('w:rPr', CT_RPr)
+register_custom_element_class('w:rStyle', CT_String)
 register_custom_element_class('w:rtl', CT_OnOff)
 register_custom_element_class('w:shadow', CT_OnOff)
 register_custom_element_class('w:smallCaps', CT_OnOff)
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -267,6 +267,17 @@ def rPr(self):
         """
         return self.find(qn('w:rPr'))
 
+    @property
+    def style(self):
+        """
+        String contained in w:val attribute of <w:pStyle> grandchild, or
+        |None| if that element is not present.
+        """
+        rPr = self.rPr
+        if rPr is None:
+            return None
+        return rPr.style
+
     @property
     def t_lst(self):
         """
@@ -638,6 +649,13 @@ def remove_webHidden(self):
         for webHidden in webHidden_lst:
             self.remove(webHidden)
 
+    @property
+    def rStyle(self):
+        """
+        ``<w:rStyle>`` child element or None if not present.
+        """
+        return self.find(qn('w:rStyle'))
+
     @property
     def rtl(self):
         """
@@ -680,6 +698,17 @@ def strike(self):
         """
         return self.find(qn('w:strike'))
 
+    @property
+    def style(self):
+        """
+        String contained in <w:rStyle> child, or None if that element is not
+        present.
+        """
+        rStyle = self.rStyle
+        if rStyle is None:
+            return None
+        return rStyle.val
+
     @property
     def vanish(self):
         """
diff --git a/docx/text.py b/docx/text.py
@@ -303,10 +303,10 @@ def strike(self):
     @property
     def style(self):
         """
-        The string name of the character style applied to this run, or |None|
-        if it has no directly-applied character style.
+        Read/write. The string name of the character style applied to this
+        run, or |None| if it has no directly-applied character style.
         """
-        raise NotImplementedError
+        return self._r.style
 
     @property
     def text(self):
diff --git a/features/run-char-style.feature b/features/run-char-style.feature
@@ -4,7 +4,6 @@ Feature: Each run has a read/write style
   I need the ability to get and set the character style of a run
 
 
-  @wip
   Scenario Outline: Get the character style of a run
     Given a run having style <char style>
      Then the style of the run is <char style>
diff --git a/tests/oxml/unitdata/text.py b/tests/oxml/unitdata/text.py
@@ -162,5 +162,9 @@ def an_rPr():
     return CT_RPrBuilder()
 
 
+def an_rStyle():
+    return CT_StringBuilder('w:rStyle')
+
+
 def an_rtl():
     return CT_OnOffBuilder('w:rtl')
diff --git a/tests/test_text.py b/tests/test_text.py
@@ -20,7 +20,7 @@
     a_b, a_bCs, a_br, a_caps, a_cs, a_dstrike, a_p, a_shadow, a_smallCaps,
     a_snapToGrid, a_specVanish, a_strike, a_t, a_vanish, a_webHidden,
     an_emboss, an_i, an_iCs, an_imprint, an_oMath, a_noProof, an_outline,
-    an_r, an_rPr, an_rtl
+    an_r, an_rPr, an_rStyle, an_rtl
 )
 from .unitutil import class_mock, instance_mock
 
@@ -135,6 +135,10 @@ def it_can_change_its_bool_prop_settings(self, bool_prop_set_fixture):
         setattr(run, prop_name, value)
         assert run._r.xml == expected_xml
 
+    def it_knows_its_character_style(self, style_get_fixture):
+        run, expected_style = style_get_fixture
+        assert run.style == expected_style
+
     def it_can_add_text(self, add_text_fixture):
         run, text_str, expected_xml, Text_ = add_text_fixture
         _text = run.add_text(text_str)
@@ -306,14 +310,18 @@ def bool_prop_set_fixture(self, request):
         expected_xml = an_r().with_nsdecls().with_child(rPr_bldr).xml()
         return run, bool_prop_name, value, expected_xml
 
-    @pytest.fixture
-    def run(self):
-        r = an_r().with_nsdecls().element
-        return Run(r)
-
-    @pytest.fixture
-    def Text_(self, request):
-        return class_mock(request, 'docx.text.Text')
+    @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
+        run = Run(r)
+        return run, style
 
     @pytest.fixture
     def text_prop_fixture(self, Text_):
@@ -324,3 +332,14 @@ def text_prop_fixture(self, Text_):
         ).element
         run = Run(r)
         return run, 'foobar'
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def run(self):
+        r = an_r().with_nsdecls().element
+        return Run(r)
+
+    @pytest.fixture
+    def Text_(self, request):
+        return class_mock(request, 'docx.text.Text')
