sect: add CT_Body.add_section_break()

Steve Canny · Steve Canny · commit e464e22106cd · 2014-06-22T14:10:38.000-07:00
Removed CT_Body.add_p() test made redundant by xmlchemy.
diff --git a/docx/oxml/parts/document.py b/docx/oxml/parts/document.py
@@ -41,7 +41,11 @@ def add_section_break(self):
         sectPr in this case since we're always working at the end of the
         block content.
         """
-        raise NotImplementedError
+        sentinel_sectPr = self.get_or_add_sectPr()
+        cloned_sectPr = sentinel_sectPr.clone()
+        p = self.add_p()
+        p.set_sectPr(cloned_sectPr)
+        return sentinel_sectPr
 
     def _insert_p(self, p):
         return self._append_blocklevelelt(p)
diff --git a/docx/oxml/section.py b/docx/oxml/section.py
@@ -4,6 +4,10 @@
 Section-related custom element classes.
 """
 
+from __future__ import absolute_import, print_function
+
+from copy import deepcopy
+
 from ..enum.section import WD_ORIENTATION, WD_SECTION_START
 from .simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
 from .xmlchemy import BaseOxmlElement, OptionalAttribute, ZeroOrOne
@@ -71,6 +75,16 @@ def bottom_margin(self, value):
         pgMar = self.get_or_add_pgMar()
         pgMar.bottom = value
 
+    def clone(self):
+        """
+        Return an exact duplicate of this ``<w:sectPr>`` element tree
+        suitable for use in adding a section break. All rsid* attributes are
+        removed from the root ``<w:sectPr>`` element.
+        """
+        clone_sectPr = deepcopy(self)
+        clone_sectPr.attrib.clear()
+        return clone_sectPr
+
     @property
     def footer(self):
         """
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -32,6 +32,15 @@ def _insert_pPr(self, pPr):
         self.insert(0, pPr)
         return pPr
 
+    def set_sectPr(self, sectPr):
+        """
+        Unconditionally replace or add *sectPr* as a grandchild in the
+        correct sequence.
+        """
+        pPr = self.get_or_add_pPr()
+        pPr._remove_sectPr()
+        pPr._insert_sectPr(sectPr)
+
     @property
     def style(self):
         """
@@ -70,6 +79,7 @@ class CT_PPr(BaseOxmlElement):
     )
     pStyle = ZeroOrOne('w:pStyle')
     numPr = ZeroOrOne('w:numPr', successors=__child_sequence__[7:])
+    sectPr = ZeroOrOne('w:sectPr', successors=('w:pPrChange',))
 
     def _insert_pStyle(self, pStyle):
         self.insert(0, pStyle)
diff --git a/features/doc-add-section.feature b/features/doc-add-section.feature
@@ -4,7 +4,6 @@ Feature: Add a document section
   I need a way to add a new section to a document
 
 
-  @wip
   Scenario: Add a landscape section to a portrait document
      Given a single-section document having portrait layout
       When I add an even-page section to the document
diff --git a/tests/oxml/parts/test_document.py b/tests/oxml/parts/test_document.py
@@ -4,33 +4,17 @@
 Test suite for the docx.oxml.parts module.
 """
 
-from docx.oxml.text import CT_P
+from __future__ import absolute_import, print_function, unicode_literals
+
+import pytest
 
 from .unitdata.document import a_body
-from ..unitdata.text import a_p, a_sectPr
+from ..unitdata.section import a_type
+from ..unitdata.text import a_p, a_pPr, a_sectPr
 
 
 class DescribeCT_Body(object):
 
-    def it_can_add_a_p_to_itself(self):
-        """
-        Return a newly created |CT_P| element that has been added after any
-        existing content.
-        """
-        cases = (
-            (a_body().with_nsdecls(),
-             a_body().with_nsdecls().with_child(a_p())),
-            (a_body().with_nsdecls().with_child(a_sectPr()),
-             a_body().with_nsdecls().with_child(a_p()).with_child(a_sectPr())),
-        )
-        for before_body_bldr, after_body_bldr in cases:
-            body = before_body_bldr.element
-            # exercise -----------------
-            p = body.add_p()
-            # verify -------------------
-            assert body.xml == after_body_bldr.xml()
-            assert isinstance(p, CT_P)
-
     def it_can_clear_all_the_content_it_holds(self):
         """
         Remove all content child elements from this <w:body> element.
@@ -51,3 +35,29 @@ def it_can_clear_all_the_content_it_holds(self):
             body.clear_content()
             # verify -------------------
             assert body.xml == after_body_bldr.xml()
+
+    def it_can_add_a_section_break(self, section_break_fixture):
+        body, expected_xml = section_break_fixture
+        sectPr = body.add_section_break()
+        assert body.xml == expected_xml
+        assert sectPr is body.get_or_add_sectPr()
+
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture
+    def section_break_fixture(self):
+        body = (
+            a_body().with_nsdecls().with_child(
+                a_sectPr().with_child(
+                    a_type().with_val('foobar')))
+        ).element
+        expected_xml = (
+            a_body().with_nsdecls().with_child(
+                a_p().with_child(
+                    a_pPr().with_child(
+                        a_sectPr().with_child(
+                            a_type().with_val('foobar'))))).with_child(
+                a_sectPr().with_child(
+                    a_type().with_val('foobar')))
+        ).xml()
+        return body, expected_xml
