hdr: add _Footer._definition

scanny · scanny · commit bacf9fd5cbaf · 2019-01-06T14:26:12.000-08:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -56,6 +56,10 @@ def drop_header_part(self, rId):
         """Remove related header part identified by *rId*."""
         self.drop_rel(rId)
 
+    def footer_part(self, rId):
+        """Return |FooterPart| related by *rId*."""
+        raise NotImplementedError
+
     def get_or_add_image(self, image_descriptor):
         """
         Return an (rId, image) 2-tuple for the image identified by
diff --git a/docx/section.py b/docx/section.py
@@ -304,6 +304,12 @@ def _add_definition(self):
         self._sectPr.add_footerReference(WD_HEADER_FOOTER.PRIMARY, rId)
         return footer_part
 
+    @property
+    def _definition(self):
+        """|FooterPart| object containing content of this footer."""
+        footerReference = self._sectPr.get_footerReference(WD_HEADER_FOOTER.PRIMARY)
+        return self._document_part.footer_part(footerReference.rId)
+
     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
@@ -514,6 +514,18 @@ def it_can_add_a_footer_part_to_help(self, document_part_, footer_part_):
         )
         assert footer_part is footer_part_
 
+    def it_provides_access_to_its_footer_part_to_help(
+        self, document_part_, footer_part_
+    ):
+        sectPr = element("w:sectPr/w:footerReference{w:type=default,r:id=rId3}")
+        document_part_.footer_part.return_value = footer_part_
+        footer = _Footer(sectPr, document_part_)
+
+        footer_part = footer._definition
+
+        document_part_.footer_part.assert_called_once_with("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_)
