api: add Document.paragraphs

Steve Canny · Steve Canny · commit ae1c8d1738ad · 2014-01-02T21:21:08.000-08:00
diff --git a/docx/api.py b/docx/api.py
@@ -64,6 +64,15 @@ def inline_shapes(self):
         """
         return self._document_part.inline_shapes
 
+    @property
+    def paragraphs(self):
+        """
+        A list of |Paragraph| instances corresponding to the paragraphs in
+        the document, in document order. Note that paragraphs within revision
+        marks such as inserted or deleted do not appear in this list.
+        """
+        return self._document_part.paragraphs
+
     def save(self, path_or_stream):
         """
         Save this document to *path_or_stream*, which can be either a path to
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -85,6 +85,16 @@ def next_id(self):
             if n not in used_ids:
                 return n
 
+    @property
+    def paragraphs(self):
+        """
+        A list of |Paragraph| instances corresponding to the paragraphs in
+        the document, in document order. Note that paragraphs within revision
+        marks such as inserted or deleted do not appear in this list.
+        """
+        # return self.body.paragraphs
+        raise NotImplementedError
+
     @property
     def part(self):
         """
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -65,6 +65,12 @@ def it_provides_access_to_the_document_inline_shapes(self, document):
         body = document.inline_shapes
         assert body is document._document_part.inline_shapes
 
+    def it_provides_access_to_the_document_paragraphs(
+            self, paragraphs_fixture):
+        document, paragraphs_ = paragraphs_fixture
+        paragraphs = document.paragraphs
+        assert paragraphs is paragraphs_
+
     def it_can_add_an_inline_picture(self, add_picture_fixture):
         document, inline_shapes, image_path_or_stream_, inline_picture_ = (
             add_picture_fixture
@@ -114,11 +120,12 @@ def document(self, open_):
         return Document()
 
     @pytest.fixture
-    def document_part_(self, request, p_):
+    def document_part_(self, request, p_, paragraphs_):
         document_part_ = instance_mock(
             request, DocumentPart, content_type=CT.WML_DOCUMENT_MAIN
         )
         document_part_.add_paragraph.return_value = p_
+        document_part_.paragraphs = paragraphs_
         return document_part_
 
     @pytest.fixture
@@ -158,6 +165,14 @@ def package_(self, request, document_part_):
         package_.main_document = document_part_
         return package_
 
+    @pytest.fixture
+    def paragraphs_(self, request):
+        return instance_mock(request, list)
+
+    @pytest.fixture
+    def paragraphs_fixture(self, document, paragraphs_):
+        return document, paragraphs_
+
     @pytest.fixture
     def r_(self, request):
         return instance_mock(request, Run)
