hdr: add DocumentPart.add_footer_part()

scanny · scanny · commit 7f4e820cbd06 · 2019-01-06T14:26:12.000-08:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -8,7 +8,7 @@
 from docx.opc.constants import RELATIONSHIP_TYPE as RT
 from docx.opc.part import XmlPart
 from docx.oxml.shape import CT_Inline
-from docx.parts.hdrftr import HeaderPart
+from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.parts.numbering import NumberingPart
 from docx.parts.settings import SettingsPart
 from docx.parts.styles import StylesPart
@@ -27,7 +27,9 @@ class DocumentPart(XmlPart):
 
     def add_footer_part(self):
         """Return (footer_part, rId) pair for newly-created footer part."""
-        raise NotImplementedError
+        footer_part = FooterPart.new(self.package)
+        rId = self.relate_to(footer_part, RT.FOOTER)
+        return footer_part, rId
 
     def add_header_part(self):
         """Return (header_part, rId) pair for newly-created header part."""
diff --git a/docx/parts/hdrftr.py b/docx/parts/hdrftr.py
@@ -14,6 +14,11 @@
 class FooterPart(XmlPart):
     """Definition of a section footer."""
 
+    @classmethod
+    def new(cls, package):
+        """Return newly created footer part."""
+        raise NotImplementedError
+
 
 class HeaderPart(XmlPart):
     """Definition of a section header."""
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -11,7 +11,7 @@
 from docx.opc.coreprops import CoreProperties
 from docx.package import Package
 from docx.parts.document import DocumentPart
-from docx.parts.hdrftr import HeaderPart
+from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.parts.image import ImagePart
 from docx.parts.numbering import NumberingPart
 from docx.parts.settings import SettingsPart
@@ -29,6 +29,18 @@
 
 class DescribeDocumentPart(object):
 
+    def it_can_add_a_footer_part(self, package_, FooterPart_, footer_part_, relate_to_):
+        FooterPart_.new.return_value = footer_part_
+        relate_to_.return_value = "rId12"
+        document_part = DocumentPart(None, None, None, package_)
+
+        footer_part, rId = document_part.add_footer_part()
+
+        FooterPart_.new.assert_called_once_with(package_)
+        relate_to_.assert_called_once_with(document_part, footer_part_, RT.FOOTER)
+        assert footer_part is footer_part_
+        assert rId == "rId12"
+
     def it_can_add_a_header_part(self, package_, HeaderPart_, header_part_, relate_to_):
         HeaderPart_.new.return_value = header_part_
         relate_to_.return_value = "rId7"
@@ -296,6 +308,14 @@ def core_properties_(self, request):
     def drop_rel_(self, request):
         return method_mock(request, DocumentPart, "drop_rel", autospec=True)
 
+    @pytest.fixture
+    def FooterPart_(self, request):
+        return class_mock(request, 'docx.parts.document.FooterPart')
+
+    @pytest.fixture
+    def footer_part_(self, request):
+        return instance_mock(request, FooterPart)
+
     @pytest.fixture
     def get_or_add_image_(self, request):
         return method_mock(request, DocumentPart, 'get_or_add_image')
