parfmt: add ParagraphFormat.keep_together getter

Steve Canny · Steve Canny · commit fcca0c1f1310 · 2015-02-08T00:01:44.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -137,12 +137,13 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:vMerge',    CT_VMerge)
 
 from .text.paragraph import CT_Ind, CT_Jc, CT_P, CT_PPr, CT_Spacing
-register_element_cls('w:ind',     CT_Ind)
-register_element_cls('w:jc',      CT_Jc)
-register_element_cls('w:p',       CT_P)
-register_element_cls('w:pPr',     CT_PPr)
-register_element_cls('w:pStyle',  CT_String)
-register_element_cls('w:spacing', CT_Spacing)
+register_element_cls('w:ind',             CT_Ind)
+register_element_cls('w:jc',              CT_Jc)
+register_element_cls('w:keepLines',       CT_OnOff)
+register_element_cls('w:p',               CT_P)
+register_element_cls('w:pPr',             CT_PPr)
+register_element_cls('w:pStyle',          CT_String)
+register_element_cls('w:spacing',         CT_Spacing)
 
 from .text.run import (
     CT_Br, CT_Fonts, CT_HpsMeasure, CT_R, CT_RPr, CT_Text, CT_Underline,
diff --git a/docx/oxml/text/paragraph.py b/docx/oxml/text/paragraph.py
@@ -117,6 +117,7 @@ class CT_PPr(BaseOxmlElement):
         'w:rPr', 'w:sectPr', 'w:pPrChange'
     )
     pStyle = ZeroOrOne('w:pStyle', successors=_tag_seq[1:])
+    keepLines = ZeroOrOne('w:keepLines', successors=_tag_seq[3:])
     numPr = ZeroOrOne('w:numPr', successors=_tag_seq[7:])
     spacing = ZeroOrOne('w:spacing', successors=_tag_seq[22:])
     ind = ZeroOrOne('w:ind', successors=_tag_seq[23:])
@@ -206,6 +207,16 @@ def jc_val(self, value):
             return
         self.get_or_add_jc().val = value
 
+    @property
+    def keepLines_val(self):
+        """
+        The value of `keepLines/@val` or |None| if not present.
+        """
+        keepLines = self.keepLines
+        if keepLines is None:
+            return None
+        return keepLines.val
+
     @property
     def spacing_after(self):
         """
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -177,6 +177,18 @@ def first_line_indent(self, value):
         pPr = self._element.get_or_add_pPr()
         pPr.first_line_indent = value
 
+    @property
+    def keep_together(self):
+        """
+        |True| if the paragraph should be kept "in one piece" and not broken
+        across a page boundary when the document is rendered. |None|
+        indicates its effective value is inherited from the style hierarchy.
+        """
+        pPr = self._element.pPr
+        if pPr is None:
+            return None
+        return pPr.keepLines_val
+
     @property
     def left_indent(self):
         """
diff --git a/tests/text/test_paragraph.py b/tests/text/test_paragraph.py
@@ -361,6 +361,10 @@ def it_can_change_its_right_indent(self, right_indent_set_fixture):
         paragraph_format.right_indent = value
         assert paragraph_format._element.xml == expected_xml
 
+    def it_knows_its_on_off_prop_values(self, on_off_get_fixture):
+        paragraph_format, prop_name, expected_value = on_off_get_fixture
+        assert getattr(paragraph_format, prop_name) == expected_value
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -523,6 +527,16 @@ def line_spacing_rule_set_fixture(self, request):
         expected_xml = xml(expected_p_cxml)
         return paragraph_format, value, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:p',                                  'keep_together',     None),
+        ('w:p/w:pPr/w:keepLines{w:val=on}',      'keep_together',     True),
+        ('w:p/w:pPr/w:keepLines{w:val=0}',       'keep_together',     False),
+    ])
+    def on_off_get_fixture(self, request):
+        p_cxml, prop_name, expected_value = request.param
+        paragraph_format = ParagraphFormat(element(p_cxml))
+        return paragraph_format, prop_name, expected_value
+
     @pytest.fixture(params=[
         ('w:p',                             None),
         ('w:p/w:pPr',                       None),
