hdr: add _Footer._drop_definition()

Author: scanny

docx/oxml/__init__.py

@@ -92,6 +92,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
     CT_SectPr,
     CT_SectType,
 )
+register_element_cls("w:footerReference", CT_HdrFtrRef)
 register_element_cls("w:hdr", CT_HdrFtr)
 register_element_cls("w:headerReference", CT_HdrFtrRef)
 register_element_cls("w:pgMar", CT_PageMar)

docx/oxml/section.py

@@ -192,30 +192,6 @@ def left_margin(self, value):
         pgMar = self.get_or_add_pgMar()
         pgMar.left = value
 
-    def remove_headerReference(self, type_):
-        """Return rId of w:headerReference child of *type_* after removing it."""
-        headerReference = self.get_headerReference(type_)
-        rId = headerReference.rId
-        self.remove(headerReference)
-        return rId
-
-    @property
-    def right_margin(self):
-        """
-        The value of the ``w:right`` attribute in the ``<w:pgMar>`` child
-        element, as a |Length| object, or |None| if either the element or the
-        attribute is not present.
-        """
-        pgMar = self.pgMar
-        if pgMar is None:
-            return None
-        return pgMar.right
-
-    @right_margin.setter
-    def right_margin(self, value):
-        pgMar = self.get_or_add_pgMar()
-        pgMar.right = value
-
     @property
     def orientation(self):
         """
@@ -272,6 +248,37 @@ def preceding_sectPr(self):
         preceding_sectPrs = self.xpath("./preceding::w:sectPr[1]")
         return preceding_sectPrs[0] if len(preceding_sectPrs) > 0 else None
 
+    def remove_footerReference(self, type_):
+        """Return rId of w:footerReference child of *type_* after removing it."""
+        footerReference = self.get_footerReference(type_)
+        rId = footerReference.rId
+        self.remove(footerReference)
+        return rId
+
+    def remove_headerReference(self, type_):
+        """Return rId of w:headerReference child of *type_* after removing it."""
+        headerReference = self.get_headerReference(type_)
+        rId = headerReference.rId
+        self.remove(headerReference)
+        return rId
+
+    @property
+    def right_margin(self):
+        """
+        The value of the ``w:right`` attribute in the ``<w:pgMar>`` child
+        element, as a |Length| object, or |None| if either the element or the
+        attribute is not present.
+        """
+        pgMar = self.pgMar
+        if pgMar is None:
+            return None
+        return pgMar.right
+
+    @right_margin.setter
+    def right_margin(self, value):
+        pgMar = self.get_or_add_pgMar()
+        pgMar.right = value
+
     @property
     def start_type(self):
         """

docx/section.py

@@ -260,6 +260,11 @@ def _has_definition(self):
 class _Footer(_BaseHeaderFooter):
     """Page footer."""
 
+    def _drop_definition(self):
+        """Remove footer definition (footer part) associated with this section."""
+        rId = self._sectPr.remove_footerReference(WD_HEADER_FOOTER.PRIMARY)
+        self._document_part.drop_rel(rId)
+
     @property
     def _has_definition(self):
         """True if a footer is defined for this section."""

tests/test_section.py

@@ -423,6 +423,15 @@ def _has_definition_prop_(self, request):
 
 class Describe_Footer(object):
 
+    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_)
+
+        footer._drop_definition()
+
+        assert sectPr.xml == xml("w:sectPr{r:a=b}")
+        document_part_.drop_rel.assert_called_once_with("rId42")
+
     def it_knows_when_it_has_a_definition_to_help(self, has_definition_fixture):
         sectPr, expected_value = has_definition_fixture
         footer = _Footer(sectPr, None)
@@ -443,6 +452,12 @@ def has_definition_fixture(self, request):
         sectPr = element(sectPr_cxml)
         return sectPr, expected_value
 
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def document_part_(self, request):
+        return instance_mock(request, DocumentPart)
+
 
 class Describe_Header(object):