doc: add Document.sections

Steve Canny · Steve Canny · commit 118c43855270 · 2015-02-15T03:15:40.000-08:00
diff --git a/docx/document.py b/docx/document.py
@@ -11,7 +11,7 @@
 from .blkcntnr import BlockItemContainer
 from .enum.section import WD_SECTION
 from .enum.text import WD_BREAK
-from .section import Section
+from .section import Section, Sections
 from .shared import ElementProxy
 
 
@@ -139,6 +139,14 @@ def save(self, path_or_stream):
         """
         self._part.save(path_or_stream)
 
+    @property
+    def sections(self):
+        """
+        A |Sections| object providing access to each section in this
+        document.
+        """
+        return Sections(self._element)
+
     @property
     def _body(self):
         """
diff --git a/tests/test_document.py b/tests/test_document.py
@@ -15,6 +15,7 @@
 from docx.enum.text import WD_BREAK
 from docx.opc.coreprops import CoreProperties
 from docx.parts.document import DocumentPart, InlineShapes
+from docx.section import Sections
 from docx.shape import InlineShape
 from docx.table import Table
 from docx.text.paragraph import Paragraph
@@ -99,6 +100,12 @@ def it_provides_access_to_its_paragraphs(self, paragraphs_fixture):
         paragraphs = document.paragraphs
         assert paragraphs is paragraphs_
 
+    def it_provides_access_to_its_sections(self, sections_fixture):
+        document, Sections_, sections_ = sections_fixture
+        sections = document.sections
+        Sections_.assert_called_once_with(document._element)
+        assert sections is sections_
+
     def it_provides_access_to_the_document_part(self, part_fixture):
         document, part_ = part_fixture
         assert document.part is part_
@@ -212,6 +219,13 @@ def save_fixture(self, document_part_):
         file_ = 'foobar.docx'
         return document, file_
 
+    @pytest.fixture
+    def sections_fixture(self, Sections_, sections_):
+        document_elm = element('w:document')
+        document = Document(document_elm, None)
+        Sections_.return_value = sections_
+        return document, Sections_, sections_
+
     # fixture components ---------------------------------------------
 
     @pytest.fixture
@@ -262,6 +276,14 @@ def run_(self, request):
     def Section_(self, request):
         return class_mock(request, 'docx.document.Section')
 
+    @pytest.fixture
+    def Sections_(self, request):
+        return class_mock(request, 'docx.document.Sections')
+
+    @pytest.fixture
+    def sections_(self, request):
+        return instance_mock(request, Sections)
+
     @pytest.fixture
     def table_(self, request):
         return instance_mock(request, Table, style='UNASSIGNED')
