hdr: add _BaseHeaderFooter.part

scanny · scanny · commit faccb45568c8 · 2019-01-06T14:26:12.000-08:00
diff --git a/docx/section.py b/docx/section.py
@@ -243,6 +243,17 @@ def is_linked_to_previous(self, value):
         else:
             self._add_definition()
 
+    @property
+    def part(self):
+        """The |HeaderPart| or |FooterPart| for this header/footer.
+
+        This overrides `BlockItemContainer.part` and is required to support image
+        insertion and perhaps other content like hyperlinks.
+        """
+        # ---should not appear in documentation;
+        # ---not an interface property, even though public
+        return self._get_or_add_definition()
+
     def _add_definition(self):
         """Return newly-added header/footer part."""
         raise NotImplementedError("must be implemented by each subclass")
diff --git a/tests/test_section.py b/tests/test_section.py
@@ -387,6 +387,18 @@ def it_can_change_whether_it_is_linked_to_previous_header_or_footer(
         assert _drop_definition_.call_args_list == [call(header)] * drop_calls
         assert _add_definition_.call_args_list == [call(header)] * add_calls
 
+    def it_provides_access_to_the_header_or_footer_part_for_BlockItemContainer(
+        self, _get_or_add_definition_, header_part_
+    ):
+        # ---this override fulfills part of the BlockItemContainer subclass interface---
+        _get_or_add_definition_.return_value = header_part_
+        header = _BaseHeaderFooter(None, None)
+
+        header_part = header.part
+
+        _get_or_add_definition_.assert_called_once_with(header)
+        assert header_part is header_part_
+
     def it_provides_access_to_the_hdr_or_ftr_element_to_help(
         self, _get_or_add_definition_, header_part_
     ):
