oxml: add CT_PPr.style getter

Steve Canny · Steve Canny · commit 99b8a661b14e · 2013-12-20T20:12:40.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -14,7 +14,7 @@
 
 from docx.oxml.base import register_custom_element_class
 from docx.oxml.parts import CT_Body, CT_Document
-from docx.oxml.text import CT_P, CT_R, CT_Text
+from docx.oxml.text import CT_P, CT_PPr, CT_R, CT_Text
 
 
 # ===========================================================================
@@ -24,5 +24,6 @@
 register_custom_element_class('w:body',     CT_Body)
 register_custom_element_class('w:document', CT_Document)
 register_custom_element_class('w:p',        CT_P)
+register_custom_element_class('w:pPr',      CT_PPr)
 register_custom_element_class('w:r',        CT_R)
 register_custom_element_class('w:t',        CT_Text)
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -12,7 +12,7 @@
 (CT_R).
 """
 
-from docx.oxml.base import nsdecls, OxmlBaseElement, oxml_fromstring
+from docx.oxml.base import nsdecls, OxmlBaseElement, oxml_fromstring, qn
 
 
 class CT_P(OxmlBaseElement):
@@ -46,6 +46,21 @@ def r_elms(self):
         return tuple([r for r in self.r])
 
 
+class CT_PPr(OxmlBaseElement):
+    """
+    ``<w:pPr>`` element, containing the properties for a paragraph.
+    """
+    @property
+    def style(self):
+        """
+        String contained in <w:pStyle> child, or None if that element is not
+        present.
+        """
+        if not hasattr(self, 'pStyle'):
+            return None
+        return self.pStyle.get(qn('w:val'))
+
+
 class CT_R(OxmlBaseElement):
     """
     ``<w:r>`` element, containing the properties and text for a run.
diff --git a/tests/oxml/test_text.py b/tests/oxml/test_text.py
@@ -11,7 +11,7 @@
 
 from docx.oxml.text import CT_P, CT_R, CT_Text
 
-from ..unitdata import a_p, a_t, an_r
+from ..unitdata import a_p, a_pPr, a_t, an_r
 
 
 class DescribeCT_P(object):
@@ -36,6 +36,19 @@ def it_can_add_an_r_to_itself(self):
         assert isinstance(r, CT_R)
 
 
+class DescribeCT_PPr(object):
+
+    def it_knows_the_paragraph_style(self):
+        cases = (
+            (a_pPr(), None),
+            (a_pPr().with_style('foobar'), 'foobar'),
+        )
+        for builder, expected_value in cases:
+            print builder.with_nsdecls().xml
+            pPr = builder.with_nsdecls().element
+            assert pPr.style == expected_value
+
+
 class DescribeCT_R(object):
 
     def it_can_construct_a_new_r_element(self):
diff --git a/tests/unitdata.py b/tests/unitdata.py
@@ -147,6 +147,39 @@ def xml(self):
         return xml
 
 
+class CT_PPrBuilder(BaseBuilder):
+    """
+    Test data builder for a CT_PPr (<w:pPr>) XML element that appears as a
+    child of a <w:p> element in a document.xml file.
+    """
+    def __init__(self):
+        """Establish instance variables with default values"""
+        super(CT_PPrBuilder, self).__init__()
+        self._pStyle = None
+
+    @property
+    def is_empty(self):
+        return self._pStyle is None
+
+    def with_style(self, style='foobar'):
+        """Add pStyle child with inner text *style*"""
+        self._pStyle = '<w:pStyle w:val="%s"/>' % style
+        return self
+
+    @property
+    def xml(self):
+        """Return element XML based on attribute settings"""
+        indent = ' ' * self._indent
+        if self.is_empty:
+            xml = '%s<w:pPr%s/>\n' % (indent, self._nsdecls)
+        else:
+            xml = '%s<w:pPr%s>\n' % (indent, self._nsdecls)
+            if self._pStyle:
+                xml += '%s%s\n' % (indent+'  ', self._pStyle)
+            xml += '%s</w:pPr>\n' % indent
+        return xml
+
+
 class CT_RBuilder(BaseBuilder):
     """
     Test data builder for a CT_R (<w:r>) XML element that appears within the
@@ -229,6 +262,11 @@ def a_p():
     return CT_PBuilder()
 
 
+def a_pPr():
+    """Return a CT_PPrBuilder instance"""
+    return CT_PPrBuilder()
+
+
 def a_t(text):
     """Return a CT_TextBuilder instance"""
     return CT_TextBuilder(text)
