api: remove old Document.add_section()

Steve Canny · Steve Canny · commit 7c88a58fd9d8 · 2015-02-14T21:56:08.000-08:00
diff --git a/docx/api.py b/docx/api.py
@@ -65,13 +65,7 @@ def add_picture(self, image_descriptor, width=None, height=None):
         return self._document.add_picture(image_descriptor, width, height)
 
     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. The optional *start_type* argument must be a member
-        of the :ref:`WdSectionStart` enumeration defaulting to
-        ``WD_SECTION.NEW_PAGE`` if not provided.
-        """
-        return self._document_part.add_section(start_type)
+        return self._document.add_section(start_type)
 
     def add_table(self, rows, cols, style='Light Shading Accent 1'):
         """
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -12,7 +12,6 @@
 
 from ..blkcntnr import BlockItemContainer
 from ..document import Document
-from ..enum.section import WD_SECTION
 from ..opc.constants import RELATIONSHIP_TYPE as RT
 from ..opc.part import XmlPart
 from ..section import Section
@@ -25,15 +24,6 @@ class DocumentPart(XmlPart):
     """
     Main document part of a WordprocessingML (WML) package, aka a .docx file.
     """
-    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.
-        """
-        new_sectPr = self._element.body.add_section_break()
-        new_sectPr.start_type = start_type
-        return Section(new_sectPr)
-
     def add_table(self, rows, cols):
         """
         Return a table having *rows* rows and *cols* columns, newly appended
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -9,8 +9,7 @@
 import pytest
 
 from docx.opc.constants import RELATIONSHIP_TYPE as RT
-from docx.oxml.parts.document import CT_Body, CT_Document
-from docx.oxml.section import CT_SectPr
+from docx.oxml.parts.document import CT_Body
 from docx.oxml.text.run import CT_R
 from docx.package import ImageParts, Package
 from docx.parts.document import _Body, DocumentPart, InlineShapes, Sections
@@ -69,15 +68,6 @@ def it_provides_access_to_the_inline_shapes_in_the_document(
         InlineShapes_.assert_called_once_with(body_elm, document)
         assert inline_shapes is InlineShapes_.return_value
 
-    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)
@@ -138,16 +128,6 @@ def it_creates_default_styles_part_if_not_present_to_help(
 
     # fixtures -------------------------------------------------------
 
-    @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)
@@ -255,16 +235,6 @@ 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 document_elm_(self, request, body_elm_):
-        return instance_mock(request, CT_Document, body=body_elm_)
-
     @pytest.fixture
     def document_part_body_(self, request, body_):
         return property_mock(
@@ -326,28 +296,10 @@ 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 start_type_(self, request):
-        return instance_mock(request, int)
-
     @pytest.fixture
     def style_(self, request):
         return instance_mock(request, BaseStyle)
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -89,14 +89,6 @@ def Package_(self, request):
 
 class DescribeDocumentOld(object):
 
-    def it_can_add_a_section(self, add_section_fixture):
-        document, start_type_, section_ = add_section_fixture
-        section = document.add_section(start_type_)
-        document._document_part.add_section.assert_called_once_with(
-            start_type_
-        )
-        assert section is section_
-
     def it_can_add_a_table(self, add_table_fixture):
         document, rows, cols, style, table_ = add_table_fixture
         table = document.add_table(rows, cols, style)
@@ -158,10 +150,6 @@ def it_creates_numbering_part_on_first_access_if_not_present(
 
     # fixtures -------------------------------------------------------
 
-    @pytest.fixture
-    def add_section_fixture(self, document, start_type_, section_):
-        return document, start_type_, section_
-
     @pytest.fixture
     def add_table_fixture(self, request, document, document_part_, table_):
         rows, cols = 4, 2
@@ -222,11 +210,10 @@ def document_obj_(self, request):
         return instance_mock(request, docx.document.Document)
 
     @pytest.fixture
-    def document_part_(self, request, paragraphs_, section_, table_, tables_):
+    def document_part_(self, request, paragraphs_, table_, tables_):
         document_part_ = instance_mock(
             request, DocumentPart, content_type=CT.WML_DOCUMENT_MAIN
         )
-        document_part_.add_section.return_value = section_
         document_part_.add_table.return_value = table_
         document_part_.paragraphs = paragraphs_
         document_part_.tables = tables_
@@ -285,10 +272,6 @@ def run_(self, request):
     def section_(self, request):
         return instance_mock(request, Section)
 
-    @pytest.fixture
-    def start_type_(self, request):
-        return instance_mock(request, int)
-
     @pytest.fixture
     def styles_(self, request):
         return instance_mock(request, Styles)
