sect: add DocumentPart.add_section()

Steve Canny · Steve Canny · commit f4e62575e86d · 2014-06-22T14:10:37.000-07:00
Also, reorder fixtures in test_document.py
diff --git a/docx/oxml/parts/document.py b/docx/oxml/parts/document.py
@@ -33,6 +33,16 @@ class CT_Body(BaseOxmlElement):
     p = ZeroOrMore('w:p', successors=('w:sectPr',))
     tbl = ZeroOrMore('w:tbl', successors=('w:sectPr',))
 
+    def add_section_break(self):
+        """
+        Return the current ``<w:sectPr>`` element after adding a clone of it
+        in a new ``<w:p>`` element appended to the block content elements.
+        Note that the "current" ``<w:sectPr>`` will always be the sentinel
+        sectPr in this case since we're always working at the end of the
+        block content.
+        """
+        raise NotImplementedError
+
     def _insert_p(self, p):
         return self._append_blocklevelelt(p)
 
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -43,7 +43,9 @@ def add_section(self, start_type=WD_SECTION.NEW_PAGE):
         Return a |Section| object representing a new section added at the end
         of the document.
         """
-        raise NotImplementedError
+        new_sectPr = self._element.body.add_section_break()
+        new_sectPr.start_type = start_type
+        return Section(new_sectPr)
 
     def add_table(self, rows, cols):
         """
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -14,6 +14,7 @@
 from docx.opc.package import PartFactory
 from docx.opc.packuri import PackURI
 from docx.oxml.parts.document import CT_Body, CT_Document
+from docx.oxml.section import CT_SectPr
 from docx.oxml.text import CT_R
 from docx.package import ImageParts, Package
 from docx.parts.document import _Body, DocumentPart, InlineShapes, Sections
@@ -76,6 +77,15 @@ def it_can_add_a_paragraph(self, add_paragraph_fixture):
         body_.add_paragraph.assert_called_once_with()
         assert p is p_
 
+    def it_can_add_a_section(self, add_section_fixture):
+        (document_part, start_type_, body_elm_, new_sectPr_, Section_,
+         section_) = add_section_fixture
+        section = document_part.add_section(start_type_)
+        body_elm_.add_section_break.assert_called_once_with()
+        assert new_sectPr_.start_type == start_type_
+        Section_.assert_called_once_with(new_sectPr_)
+        assert section is section_
+
     def it_can_add_a_table(self, add_table_fixture):
         document_part, rows, cols, body_, table_ = add_table_fixture
         table = document_part.add_table(rows, cols)
@@ -146,6 +156,16 @@ def add_paragraph_fixture(self, document_part_body_, body_, p_):
         document_part = DocumentPart(None, None, None, None)
         return document_part, body_, p_
 
+    @pytest.fixture
+    def add_section_fixture(
+            self, document_elm_, start_type_, body_elm_, sectPr_, Section_,
+            section_):
+        document_part = DocumentPart(None, None, document_elm_, None)
+        return (
+            document_part, start_type_, body_elm_, sectPr_, Section_,
+            section_
+        )
+
     @pytest.fixture
     def add_table_fixture(self, document_part_body_, body_, table_):
         document_part = DocumentPart(None, None, None, None)
@@ -223,6 +243,12 @@ def body_(self, request, p_, table_):
         body_.add_table.return_value = table_
         return body_
 
+    @pytest.fixture
+    def body_elm_(self, request, sectPr_):
+        body_elm_ = instance_mock(request, CT_Body)
+        body_elm_.add_section_break.return_value = sectPr_
+        return body_elm_
+
     @pytest.fixture
     def blob_(self, request):
         return instance_mock(request, str)
@@ -235,6 +261,10 @@ def content_type_(self, request):
     def document(self):
         return DocumentPart(None, None, None, None)
 
+    @pytest.fixture
+    def document_elm_(self, request, body_elm_):
+        return instance_mock(request, CT_Document, body=body_elm_)
+
     @pytest.fixture
     def document_part_(self, request):
         return instance_mock(request, DocumentPart)
@@ -321,16 +351,34 @@ def relate_to_(self, request, rId_):
     def rId_(self, request):
         return instance_mock(request, str)
 
+    @pytest.fixture
+    def Section_(self, request, section_):
+        return class_mock(
+            request, 'docx.parts.document.Section', return_value=section_
+        )
+
+    @pytest.fixture
+    def section_(self, request):
+        return instance_mock(request, Section)
+
     @pytest.fixture
     def Sections_(self, request):
         return class_mock(request, 'docx.parts.document.Sections')
 
+    @pytest.fixture
+    def sectPr_(self, request):
+        return instance_mock(request, CT_SectPr)
+
     @pytest.fixture
     def serialize_part_xml_(self, request):
         return function_mock(
             request, 'docx.parts.document.serialize_part_xml'
         )
 
+    @pytest.fixture
+    def start_type_(self, request):
+        return instance_mock(request, int)
+
     @pytest.fixture
     def table_(self, request):
         return instance_mock(request, Table)
