sect: add Document.sections

Steve Canny · Steve Canny · commit c161243ba53c · 2014-06-18T23:16:20.000-07:00
and DocumentPart.sections
diff --git a/docx/api.py b/docx/api.py
@@ -147,6 +147,13 @@ def save(self, path_or_stream):
         """
         self._package.save(path_or_stream)
 
+    @property
+    def sections(self):
+        """
+        Return a reference to the |Sections| instance for this document.
+        """
+        return self._document_part.sections
+
     @lazyproperty
     def styles_part(self):
         """
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -110,6 +110,13 @@ def part(self):
         """
         return self
 
+    @lazyproperty
+    def sections(self):
+        """
+        The |Sections| instance organizing the sections in this document.
+        """
+        return Sections(self._element)
+
     @property
     def tables(self):
         """
@@ -221,3 +228,6 @@ class Sections(object):
     Sequence of |Section| objects corresponding to the sections in the
     document.
     """
+    def __init__(self, document_elm):
+        super(Sections, self).__init__()
+        self._document_elm = document_elm
diff --git a/features/steps/document.py b/features/steps/document.py
@@ -57,7 +57,7 @@ def then_I_can_iterate_over_the_sections(context):
 
 @then('the length of the section collection is 3')
 def then_the_length_of_the_section_collection_is_3(context):
-    sections = context.sections
+    sections = context.document.sections
     assert len(sections) == 3, (
         'expected len(sections) of 2, got %s' % len(sections)
     )
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -113,6 +113,12 @@ def it_provides_access_to_the_document_paragraphs(
         paragraphs = document_part.paragraphs
         assert paragraphs is paragraphs_
 
+    def it_provides_access_to_the_document_sections(self, sections_fixture):
+        document, document_elm, Sections_ = sections_fixture
+        sections = document.sections
+        Sections_.assert_called_once_with(document_elm)
+        assert sections is Sections_.return_value
+
     def it_provides_access_to_the_document_tables(self, tables_fixture):
         document_part, tables_ = tables_fixture
         tables = document_part.tables
@@ -300,6 +306,16 @@ def relate_to_(self, request, rId_):
     def rId_(self, request):
         return instance_mock(request, str)
 
+    @pytest.fixture
+    def Sections_(self, request):
+        return class_mock(request, 'docx.parts.document.Sections')
+
+    @pytest.fixture
+    def sections_fixture(self, request, Sections_):
+        document_elm = a_document().with_nsdecls().element
+        document = DocumentPart(None, None, document_elm, None)
+        return document, document_elm, Sections_
+
     @pytest.fixture
     def serialize_part_xml_(self, request):
         return function_mock(
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -115,6 +115,10 @@ def it_provides_access_to_the_document_paragraphs(
         paragraphs = document.paragraphs
         assert paragraphs is paragraphs_
 
+    def it_provides_access_to_the_document_sections(self, document):
+        body = document.sections
+        assert body is document._document_part.sections
+
     def it_provides_access_to_the_document_tables(self, tables_fixture):
         document, tables_ = tables_fixture
         tables = document.tables

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ def then_I_can_iterate_over_the_sections(context):`
`57`	`57`
`58`	`58`	`@then('the length of the section collection is 3')`
`59`	`59`	`def then_the_length_of_the_section_collection_is_3(context):`
`60`		`- sections = context.sections`
	`60`	`+ sections = context.document.sections`
`61`	`61`	`assert len(sections) == 3, (`
`62`	`62`	`'expected len(sections) of 2, got %s' % len(sections)`
`63`	`63`	`)`