sect: add Sections.__iter__()

Steve Canny · Steve Canny · commit e7fb78a561c0 · 2014-06-19T00:10:04.000-07:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -14,6 +14,7 @@
 from ..opc.oxml import serialize_part_xml
 from ..opc.package import Part
 from ..oxml import parse_xml
+from ..section import Section
 from ..shape import InlineShape
 from ..shared import lazyproperty, Parented
 from ..table import Table
@@ -237,5 +238,9 @@ def __init__(self, document_elm):
     def __getitem__(self, key):
         pass
 
+    def __iter__(self):
+        for sectPr in self._document_elm.sectPr_lst:
+            yield Section(sectPr)
+
     def __len__(self):
         return len(self._document_elm.sectPr_lst)
diff --git a/docx/section.py b/docx/section.py
@@ -11,3 +11,6 @@ class Section(object):
     """
     Document section, providing access to section and page setup settings.
     """
+    def __init__(self, sectPr):
+        super(Section, self).__init__()
+        self._sectPr = sectPr
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -18,6 +18,7 @@
 from docx.package import ImageParts, Package
 from docx.parts.document import _Body, DocumentPart, InlineShapes, Sections
 from docx.parts.image import ImagePart
+from docx.section import Section
 from docx.shape import InlineShape
 from docx.table import Table
 from docx.text import Paragraph
@@ -626,17 +627,35 @@ def it_knows_how_many_sections_it_contains(self, len_fixture):
         print(sections._document_elm.xml)
         assert len(sections) == expected_len
 
+    def it_can_iterate_over_its_Section_instances(self, iter_fixture):
+        sections, expected_count = iter_fixture
+        section_count = 0
+        for section in sections:
+            section_count += 1
+            assert isinstance(section, Section)
+        assert section_count == expected_count
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
-    def len_fixture(self):
-        document_elm = (
+    def iter_fixture(self, document_elm):
+        sections = Sections(document_elm)
+        return sections, 2
+
+    @pytest.fixture
+    def len_fixture(self, document_elm):
+        sections = Sections(document_elm)
+        return sections, 2
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def document_elm(self):
+        return (
             a_document().with_nsdecls().with_child(
                 a_body().with_child(
                     a_p().with_child(
                         a_pPr().with_child(
                             a_sectPr()))).with_child(
                     a_sectPr()))
         ).element
-        sections = Sections(document_elm)
-        return sections, 2
