hdr: add _BaseHeaderFooter._element

Author: scanny

docx/section.py

@@ -251,6 +251,20 @@ def _drop_definition(self):
         """Remove header/footer part containing the definition of this header/footer."""
         raise NotImplementedError("must be implemented by each subclass")
 
+    @property
+    def _element(self):
+        """`w:hdr` or `w:ftr` element, root of header/footer part."""
+        return self._get_or_add_definition().element
+
+    def _get_or_add_definition(self):
+        """Return HeaderPart or FooterPart object for this section.
+
+        If this header/footer inherits its content, the part for the prior header/footer
+        is returned. If the definition cannot be inherited (it belongs to the first
+        section), a new definition is added and then returned.
+        """
+        raise NotImplementedError
+
     @property
     def _has_definition(self):
         """True if this header/footer has a related part containing its definition."""
@@ -292,12 +306,7 @@ def _drop_definition(self):
         rId = self._sectPr.remove_headerReference(WD_HEADER_FOOTER.PRIMARY)
         self._document_part.drop_header_part(rId)
 
-    @property
-    def _element(self):
-        """`w:hdr` element, root of header part."""
-        return self._get_or_add_header_part().element
-
-    def _get_or_add_header_part(self):
+    def _get_or_add_definition(self):
         """Return |HeaderPart| object for this header.
 
         If this header inherits its content, the header part for the prior header is
@@ -312,7 +321,7 @@ def _get_or_add_header_part(self):
         prior_header = self._prior_header
         # ---case-2: header inherits and belongs to second-or-later section---
         if prior_header is not None:
-            return prior_header._get_or_add_header_part()
+            return prior_header._get_or_add_definition()
         # ---case-3: header inherits, but is first header---
         return self._add_definition()
 

tests/test_section.py

@@ -387,6 +387,19 @@ 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_hdr_or_ftr_element_to_help(
+        self, _get_or_add_definition_, header_part_
+    ):
+        hdr = element("w:hdr")
+        _get_or_add_definition_.return_value = header_part_
+        header_part_.element = hdr
+        header = _BaseHeaderFooter(None, None)
+
+        hdr_elm = header._element
+
+        _get_or_add_definition_.assert_called_once_with(header)
+        assert hdr_elm is hdr
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[(False, True), (True, False)])
@@ -416,10 +429,18 @@ def _add_definition_(self, request):
     def _drop_definition_(self, request):
         return method_mock(request, _BaseHeaderFooter, "_drop_definition")
 
+    @pytest.fixture
+    def _get_or_add_definition_(self, request):
+        return method_mock(request, _BaseHeaderFooter, "_get_or_add_definition")
+
     @pytest.fixture
     def _has_definition_prop_(self, request):
         return property_mock(request, _BaseHeaderFooter, "_has_definition")
 
+    @pytest.fixture
+    def header_part_(self, request):
+        return instance_mock(request, HeaderPart)
+
 
 class Describe_Footer(object):
 
@@ -500,27 +521,14 @@ def it_can_drop_the_related_header_part_to_help(self, document_part_):
         assert sectPr.xml == xml("w:sectPr{r:a=b}")
         document_part_.drop_header_part.assert_called_once_with("rId42")
 
-    def it_provides_access_to_the_hdr_element_to_help(
-        self, _get_or_add_header_part_, header_part_
-    ):
-        hdr = element("w:hdr")
-        _get_or_add_header_part_.return_value = header_part_
-        header_part_.element = hdr
-        header = _Header(None, None)
-
-        hdr_elm = header._element
-
-        _get_or_add_header_part_.assert_called_once_with(header)
-        assert hdr_elm is hdr
-
     def it_gets_the_header_part_when_it_has_one(
         self, _has_definition_prop_, _header_part_prop_, header_part_
     ):
         _has_definition_prop_.return_value = True
         _header_part_prop_.return_value = header_part_
         header = _Header(None, None)
 
-        header_part = header._get_or_add_header_part()
+        header_part = header._get_or_add_definition()
 
         assert header_part is header_part_
 
@@ -529,12 +537,12 @@ def but_it_gets_the_prior_header_part_when_it_is_linked(
     ):
         _has_definition_prop_.return_value = False
         _prior_header_prop_.return_value = prior_header_
-        prior_header_._get_or_add_header_part.return_value = header_part_
+        prior_header_._get_or_add_definition.return_value = header_part_
         header = _Header(None, None)
 
-        header_part = header._get_or_add_header_part()
+        header_part = header._get_or_add_definition()
 
-        prior_header_._get_or_add_header_part.assert_called_once_with()
+        prior_header_._get_or_add_definition.assert_called_once_with()
         assert header_part is header_part_
 
     def and_it_adds_the_header_part_when_it_is_linked_and_the_first_section(
@@ -549,7 +557,7 @@ def and_it_adds_the_header_part_when_it_is_linked_and_the_first_section(
         _add_definition_.return_value = header_part_
         header = _Header(None, None)
 
-        header_part = header._get_or_add_header_part()
+        header_part = header._get_or_add_definition()
 
         _add_definition_.assert_called_once_with(header)
         assert header_part is header_part_
@@ -620,8 +628,8 @@ def document_part_(self, request):
         return instance_mock(request, DocumentPart)
 
     @pytest.fixture
-    def _get_or_add_header_part_(self, request):
-        return method_mock(request, _Header, "_get_or_add_header_part")
+    def _get_or_add_definition_(self, request):
+        return method_mock(request, _Header, "_get_or_add_definition")
 
     @pytest.fixture
     def _has_definition_prop_(self, request):