blkct: add BlockItemContainer.add_paragraph()

Steve Canny · Steve Canny · commit e2d631165f44 · 2014-07-17T23:10:47.000-07:00
* remove _Body.add_paragraph(), inheriting that method from
BlockItemContainer
diff --git a/docx/blkcntnr.py b/docx/blkcntnr.py
@@ -9,6 +9,7 @@
 from __future__ import absolute_import, print_function
 
 from .shared import Parented
+from .text import Paragraph
 
 
 class BlockItemContainer(Parented):
@@ -21,3 +22,18 @@ class BlockItemContainer(Parented):
     def __init__(self, element, parent):
         super(BlockItemContainer, self).__init__(parent)
         self._element = element
+
+    def add_paragraph(self, text='', style=None):
+        """
+        Return a paragraph newly added to the end of the content in this
+        container, having *text* in a single run if present, and having
+        paragraph style *style*. If *style* is |None|, no paragraph style is
+        applied, which has the same effect as applying the 'Normal' style.
+        """
+        p = self._element.add_p()
+        paragraph = Paragraph(p, self)
+        if text:
+            paragraph.add_run(text)
+        if style is not None:
+            paragraph.style = style
+        return paragraph
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -123,21 +123,6 @@ def __init__(self, body_elm, parent):
         super(_Body, self).__init__(body_elm, parent)
         self._body = body_elm
 
-    def add_paragraph(self, text='', style=None):
-        """
-        Return a paragraph newly added to the end of body content, having
-        *text* in a single run if present, and having paragraph style
-        *style*. If *style* is |None|, no paragraph style is applied, which
-        has the same effect as applying the 'Normal' style.
-        """
-        p = self._body.add_p()
-        paragraph = Paragraph(p, self)
-        if text:
-            paragraph.add_run(text)
-        if style is not None:
-            paragraph.style = style
-        return paragraph
-
     def add_table(self, rows, cols):
         """
         Return a table having *rows* rows and *cols* cols, newly appended to
diff --git a/tests/test_blkcntnr.py b/tests/test_blkcntnr.py
@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+"""
+Test suite for the docx.blkcntnr (block item container) module
+"""
+
+from __future__ import absolute_import, print_function, unicode_literals
+
+import pytest
+
+from docx.blkcntnr import BlockItemContainer
+from docx.text import Paragraph
+
+from .unitutil.cxml import element, xml
+
+
+class DescribeBlockItemContainer(object):
+
+    def it_can_add_a_paragraph(self, add_paragraph_fixture):
+        blkcntnr, text, style, expected_xml = add_paragraph_fixture
+        paragraph = blkcntnr.add_paragraph(text, style)
+        assert blkcntnr._element.xml == expected_xml
+        assert isinstance(paragraph, Paragraph)
+
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture(params=[
+        ('w:body', '', None,
+         'w:body/w:p'),
+        ('w:body', 'foobar', None,
+         'w:body/w:p/w:r/w:t"foobar"'),
+        ('w:body', '', 'Heading1',
+         'w:body/w:p/w:pPr/w:pStyle{w:val=Heading1}'),
+        ('w:body', 'barfoo', 'BodyText',
+         'w:body/w:p/(w:pPr/w:pStyle{w:val=BodyText},w:r/w:t"barfoo")'),
+    ])
+    def add_paragraph_fixture(self, request):
+        blkcntnr_cxml, text, style, after_cxml = request.param
+        blkcntnr = BlockItemContainer(element(blkcntnr_cxml), None)
+        expected_xml = xml(after_cxml)
+        return blkcntnr, text, style, expected_xml
