api: add Document.add_page_break()

Steve Canny · Steve Canny · commit 595cc87532d3 · 2014-01-03T23:39:55.000-08:00
diff --git a/docx/api.py b/docx/api.py
@@ -10,6 +10,7 @@
 
 import os
 
+from docx.enum.text import WD_BREAK
 from docx.opc.constants import CONTENT_TYPE as CT
 from docx.package import Package
 
@@ -45,6 +46,16 @@ def add_heading(self, text='', level=1):
         style = 'Title' if level == 0 else 'Heading%d' % level
         return self.add_paragraph(text, style)
 
+    def add_page_break(self):
+        """
+        Return a paragraph newly added to the end of the document and
+        containing only a page break.
+        """
+        p = self._document_part.add_paragraph()
+        r = p.add_run()
+        r.add_break(WD_BREAK.PAGE)
+        return p
+
     def add_paragraph(self, text='', style=None):
         """
         Return a paragraph newly added to the end of the document, populated
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -31,7 +31,7 @@ def clear(self, clear_str):
 
     @property
     def type(self):
-        self.get(qn('w:type'))
+        return self.get(qn('w:type'))
 
     @type.setter
     def type(self, type_str):
diff --git a/features/api-add-page-break.feature b/features/api-add-page-break.feature
@@ -3,7 +3,6 @@ Feature: Add a page break
   As a programmer using the basic python-docx API
   I need a method that adds a hard page break on its own paragraph
 
-  @wip
   Scenario: Add a hard page break paragraph
     Given a document
      When I add a page break to the document
diff --git a/features/steps/api.py b/features/steps/api.py
@@ -91,7 +91,7 @@ def then_last_paragraph_contains_only_a_page_break(context):
     document = context.document
     p = document.paragraphs[-1]
     assert len(p.runs) == 1
-    assert len(p.runs[0]) == 1
+    assert len(p.runs[0]._r) == 1
     assert p.runs[0]._r[0].type == 'page'
 
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -7,6 +7,7 @@
 import pytest
 
 from docx.api import Document
+from docx.enum.text import WD_BREAK
 from docx.opc.constants import CONTENT_TYPE as CT
 from docx.package import Package
 from docx.parts.document import DocumentPart, InlineShapes
@@ -71,6 +72,14 @@ def it_can_add_a_styled_paragraph(self, add_styled_paragraph_fixture):
         p = document.add_paragraph(style=style)
         assert p.style == style
 
+    def it_can_add_a_page_break(self, add_page_break_fixture):
+        document, document_part_, p_, r_ = add_page_break_fixture
+        p = document.add_page_break()
+        document_part_.add_paragraph.assert_called_once_with()
+        p_.add_run.assert_called_once_with()
+        r_.add_break.assert_called_once_with(WD_BREAK.PAGE)
+        assert p is p_
+
     def it_can_add_a_picture(self, add_picture_fixture):
         (document, image_path, width, height, inline_shapes_, expected_width,
          expected_height, picture_) = add_picture_fixture
@@ -112,6 +121,10 @@ def add_heading_fixture(self, request, document, add_paragraph_, p_):
     def add_empty_paragraph_fixture(self, document, document_part_, p_):
         return document, document_part_, p_
 
+    @pytest.fixture
+    def add_page_break_fixture(self, document, document_part_, p_, r_):
+        return document, document_part_, p_, r_
+
     @pytest.fixture
     def add_paragraph_(self, request, p_):
         return method_mock(
