hdr: add _Footer._add_definition()

scanny · scanny · commit 100654a89a6b · 2019-01-06T14:26:12.000-08:00
diff --git a/docx/oxml/section.py b/docx/oxml/section.py
@@ -65,11 +65,22 @@ class CT_SectPr(BaseOxmlElement):
         'w:docGrid', 'w:printerSettings', 'w:sectPrChange',
     )
     headerReference = ZeroOrMore("w:headerReference", successors=_tag_seq)
+    footerReference = ZeroOrMore("w:footerReference", successors=_tag_seq)
     type = ZeroOrOne("w:type", successors=_tag_seq[3:])
     pgSz = ZeroOrOne("w:pgSz", successors=_tag_seq[4:])
     pgMar = ZeroOrOne("w:pgMar", successors=_tag_seq[5:])
     del _tag_seq
 
+    def add_footerReference(self, type_, rId):
+        """Return newly added CT_HdrFtrRef element of *type_* with *rId*.
+
+        The element tag is `w:footerReference`.
+        """
+        footerReference = self._add_footerReference()
+        footerReference.type_ = type_
+        footerReference.rId = rId
+        return footerReference
+
     def add_headerReference(self, type_, rId):
         """Return newly added CT_HdrFtrRef element of *type_* with *rId*.
 
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -25,6 +25,10 @@ class DocumentPart(XmlPart):
     objects provides access to this part object for that purpose.
     """
 
+    def add_footer_part(self):
+        """Return (footer_part, rId) pair for newly-created footer part."""
+        raise NotImplementedError
+
     def add_header_part(self):
         """Return (header_part, rId) pair for newly-created header part."""
         header_part = HeaderPart.new(self.package)
diff --git a/docx/parts/hdrftr.py b/docx/parts/hdrftr.py
@@ -11,6 +11,10 @@
 from docx.oxml import parse_xml
 
 
+class FooterPart(XmlPart):
+    """Definition of a section footer."""
+
+
 class HeaderPart(XmlPart):
     """Definition of a section header."""
 
diff --git a/docx/section.py b/docx/section.py
@@ -260,6 +260,12 @@ def _has_definition(self):
 class _Footer(_BaseHeaderFooter):
     """Page footer."""
 
+    def _add_definition(self):
+        """Return newly-added footer part."""
+        footer_part, rId = self._document_part.add_footer_part()
+        self._sectPr.add_footerReference(WD_HEADER_FOOTER.PRIMARY, rId)
+        return footer_part
+
     def _drop_definition(self):
         """Remove footer definition (footer part) associated with this section."""
         rId = self._sectPr.remove_footerReference(WD_HEADER_FOOTER.PRIMARY)
diff --git a/tests/test_section.py b/tests/test_section.py
@@ -8,7 +8,7 @@
 
 from docx.enum.section import WD_ORIENT, WD_SECTION
 from docx.parts.document import DocumentPart
-from docx.parts.hdrftr import HeaderPart
+from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.section import _BaseHeaderFooter, _Footer, _Header, Section, Sections
 from docx.shared import Inches
 
@@ -423,6 +423,19 @@ def _has_definition_prop_(self, request):
 
 class Describe_Footer(object):
 
+    def it_can_add_a_footer_part_to_help(self, document_part_, footer_part_):
+        sectPr = element("w:sectPr{r:a=b}")
+        document_part_.add_footer_part.return_value = footer_part_, "rId3"
+        footer = _Footer(sectPr, document_part_)
+
+        footer_part = footer._add_definition()
+
+        document_part_.add_footer_part.assert_called_once_with()
+        assert sectPr.xml == xml(
+            "w:sectPr{r:a=b}/w:footerReference{w:type=default,r:id=rId3}"
+        )
+        assert footer_part is footer_part_
+
     def it_can_drop_the_related_footer_part_to_help(self, document_part_):
         sectPr = element("w:sectPr{r:a=b}/w:footerReference{w:type=default,r:id=rId42}")
         footer = _Footer(sectPr, document_part_)
@@ -458,6 +471,10 @@ def has_definition_fixture(self, request):
     def document_part_(self, request):
         return instance_mock(request, DocumentPart)
 
+    @pytest.fixture
+    def footer_part_(self, request):
+        return instance_mock(request, FooterPart)
+
 
 class Describe_Header(object):
 
