blkct: add BlockItemContainer.paragraphs

Steve Canny · Steve Canny · commit 15d4218cb759 · 2014-07-17T23:42:21.000-07:00
* remove implementation from _Body to allow inheritance
diff --git a/docx/blkcntnr.py b/docx/blkcntnr.py
@@ -51,3 +51,11 @@ def add_table(self, rows, cols):
         for i in range(rows):
             table.add_row()
         return table
+
+    @property
+    def paragraphs(self):
+        """
+        A list containing the paragraphs in this container, in document
+        order. Read-only.
+        """
+        return [Paragraph(p, self) for p in self._element.p_lst]
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -18,7 +18,6 @@
 from ..shape import InlineShape
 from ..shared import lazyproperty, Parented
 from ..table import Table
-from ..text import Paragraph
 
 
 class DocumentPart(XmlPart):
@@ -132,10 +131,6 @@ def clear_content(self):
         self._body.clear_content()
         return self
 
-    @property
-    def paragraphs(self):
-        return [Paragraph(p, self) for p in self._body.p_lst]
-
     @property
     def tables(self):
         """
diff --git a/tests/test_blkcntnr.py b/tests/test_blkcntnr.py
@@ -29,6 +29,19 @@ def it_can_add_a_table(self, add_table_fixture):
         assert blkcntnr._element.xml == expected_xml
         assert isinstance(table, Table)
 
+    def it_provides_access_to_the_paragraphs_it_contains(
+            self, paragraphs_fixture):
+        # test len(), iterable, and indexed access
+        blkcntnr, expected_count = paragraphs_fixture
+        paragraphs = blkcntnr.paragraphs
+        assert len(paragraphs) == expected_count
+        count = 0
+        for idx, paragraph in enumerate(paragraphs):
+            assert isinstance(paragraph, Paragraph)
+            assert paragraphs[idx] is paragraph
+            count += 1
+        assert count == expected_count
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -62,3 +75,15 @@ def add_table_fixture(self, request):
         blkcntnr = BlockItemContainer(element(blkcntnr_cxml), None)
         expected_xml = xml(after_cxml)
         return blkcntnr, rows, cols, expected_xml
+
+    @pytest.fixture(params=[
+        ('w:body',                 0),
+        ('w:body/w:p',             1),
+        ('w:body/(w:p,w:p)',       2),
+        ('w:body/(w:p,w:tbl)',     1),
+        ('w:body/(w:p,w:tbl,w:p)', 2),
+    ])
+    def paragraphs_fixture(self, request):
+        blkcntnr_cxml, expected_count = request.param
+        blkcntnr = BlockItemContainer(element(blkcntnr_cxml), None)
+        return blkcntnr, expected_count
