hdr: add _Header._drop_header_part()

Author: ondrej-111

docx/oxml/__init__.py

@@ -84,7 +84,8 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:numbering',     CT_Numbering)
 register_element_cls('w:startOverride', CT_DecimalNumber)
 
-from .section import CT_PageMar, CT_PageSz, CT_SectPr, CT_SectType  # noqa
+from .section import CT_HdrFtrRef, CT_PageMar, CT_PageSz, CT_SectPr, CT_SectType  # noqa
+register_element_cls('w:headerReference', CT_HdrFtrRef)
 register_element_cls('w:pgMar', CT_PageMar)
 register_element_cls('w:pgSz', CT_PageSz)
 register_element_cls('w:sectPr', CT_SectPr)

docx/oxml/section.py

@@ -7,14 +7,22 @@
 from copy import deepcopy
 
 from docx.enum.section import WD_HEADER_FOOTER, WD_ORIENTATION, WD_SECTION_START
-from docx.oxml.simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
+from docx.oxml.simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure, XsdString
 from docx.oxml.xmlchemy import (
     BaseOxmlElement,
     OptionalAttribute,
+    RequiredAttribute,
     ZeroOrOne,
 )
 
 
+class CT_HdrFtrRef(BaseOxmlElement):
+    """`w:headerReference` and `w:footerReference` elements"""
+
+    type_ = RequiredAttribute('w:type', WD_HEADER_FOOTER)
+    rId = RequiredAttribute('r:id', XsdString)
+
+
 class CT_PageMar(BaseOxmlElement):
     """
     ``<w:pgMar>`` element, defining page margins.
@@ -157,6 +165,13 @@ 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):
         """

docx/parts/document.py

@@ -39,6 +39,10 @@ def document(self):
         """
         return Document(self._element, self)
 
+    def drop_header_part(self, rId):
+        """Remove related header part identified by *rId*."""
+        raise NotImplementedError
+
     def get_or_add_image(self, image_descriptor):
         """
         Return an (rId, image) 2-tuple for the image identified by

docx/section.py

@@ -257,7 +257,8 @@ def _add_header_part(self):
 
     def _drop_header_part(self):
         """Remove header definition associated with this section."""
-        raise NotImplementedError
+        rId = self._sectPr.remove_headerReference(WD_HEADER_FOOTER.PRIMARY)
+        self._document_part.drop_header_part(rId)
 
     @property
     def _has_header_part(self):

tests/test_section.py

@@ -386,6 +386,15 @@ def it_can_change_whether_it_is_linked_to_previous_header(
         assert _drop_header_part_.call_args_list == [call(header)] * drop_calls
         assert _add_header_part_.call_args_list == [call(header)] * add_calls
 
+    def it_can_drop_the_related_header_part_to_help(self, document_part_):
+        sectPr = element("w:sectPr{r:a=b}/w:headerReference{w:type=default,r:id=rId42}")
+        header = _Header(sectPr, document_part_)
+
+        header._drop_header_part()
+
+        assert sectPr.xml == xml("w:sectPr{r:a=b}")
+        document_part_.drop_header_part.assert_called_once_with("rId42")
+
     def it_knows_when_it_has_a_header_part_to_help(self, has_header_part_fixture):
         sectPr, expected_value = has_header_part_fixture
         header = _Header(sectPr, None)
@@ -429,6 +438,10 @@ def is_linked_set_fixture(self, request):
     def _add_header_part_(self, request):
         return method_mock(request, _Header, "_add_header_part", autospec=True)
 
+    @pytest.fixture
+    def document_part_(self, request):
+        return instance_mock(request, DocumentPart)
+
     @pytest.fixture
     def _drop_header_part_(self, request):
         return method_mock(request, _Header, "_drop_header_part", autospec=True)

tests/text/test_run.py

@@ -69,9 +69,12 @@ def it_provides_access_to_its_font(self, font_fixture):
         Font_.assert_called_once_with(run._element)
         assert font is font_
 
-    def it_can_add_text(self, add_text_fixture):
-        run, text_str, expected_xml, Text_ = add_text_fixture
+    def it_can_add_text(self, add_text_fixture, Text_):
+        r, text_str, expected_xml = add_text_fixture
+        run = Run(r, None)
+
         _text = run.add_text(text_str)
+
         assert run._r.xml == expected_xml
         assert _text is Text_.return_value
 
@@ -159,11 +162,11 @@ def add_tab_fixture(self, request):
         ('w:r',          'fo ', 'w:r/w:t{xml:space=preserve}"fo "'),
         ('w:r',          'f o', 'w:r/w:t"f o"'),
     ])
-    def add_text_fixture(self, request, Text_):
+    def add_text_fixture(self, request):
         r_cxml, text, expected_cxml = request.param
-        run = Run(element(r_cxml), None)
+        r = element(r_cxml)
         expected_xml = xml(expected_cxml)
-        return run, text, expected_xml, Text_
+        return r, text, expected_xml
 
     @pytest.fixture(params=[
         ('w:r/w:rPr',                  'bold',   None),

tests/unitutil/cxml.py

@@ -1,16 +1,27 @@
 # encoding: utf-8
 
-"""
-Parser for Compact XML Expression Language (CXEL) ('see-ex-ell'), a compact
-XML specification language I made up that's useful for producing XML element
-trees suitable for unit testing.
+"""Parser for Compact XML Expression Language (CXEL) ('see-ex-ell').
+
+CXEL is a compact XML specification language I made up that's useful for producing XML
+element trees suitable for unit testing.
 """
 
-from __future__ import print_function
+from __future__ import absolute_import, division, print_function, unicode_literals
 
 from pyparsing import (
-    alphas, alphanums, Combine, dblQuotedString, delimitedList, Forward,
-    Group, Literal, Optional, removeQuotes, stringEnd, Suppress, Word
+    alphas,
+    alphanums,
+    Combine,
+    dblQuotedString,
+    delimitedList,
+    Forward,
+    Group,
+    Literal,
+    Optional,
+    removeQuotes,
+    stringEnd,
+    Suppress,
+    Word,
 )
 
 from docx.oxml import parse_xml
@@ -105,16 +116,25 @@ def is_root(self, value):
         self._is_root = bool(value)
 
     @property
-    def nspfx(self):
+    def local_nspfxs(self):
         """
-        The namespace prefix of this element, the empty string (``''``) if
-        the tag is in the default namespace.
+        The namespace prefixes local to this element, both on the tagname and
+        all of its attributes. An empty string (``''``) is used to represent
+        the default namespace for an element tag having no prefix.
         """
-        tagname = self._tagname
-        idx = tagname.find(':')
-        if idx == -1:
-            return ''
-        return tagname[:idx]
+        def nspfx(name, is_element=False):
+            idx = name.find(':')
+            if idx == -1:
+                return '' if is_element else None
+            return name[:idx]
+
+        nspfxs = [nspfx(self._tagname, True)]
+        for name, val in self._attrs:
+            pfx = nspfx(name)
+            if pfx is None or pfx in nspfxs or pfx == "xml":
+                continue
+            nspfxs.append(pfx)
+        return nspfxs
 
     @property
     def nspfxs(self):
@@ -129,7 +149,7 @@ def merge(seq, seq_2):
                     continue
                 seq.append(item)
 
-        nspfxs = [self.nspfx]
+        nspfxs = self.local_nspfxs
         for child in self._children:
             merge(nspfxs, child.nspfxs)
         return nspfxs
@@ -223,12 +243,12 @@ def grammar():
 
     # np:tagName ---------------------------------
     nspfx = Word(alphas)
-    local_name = Word(alphas)
+    local_name = Word(alphanums)
     tagname = Combine(nspfx + colon + local_name)
 
     # np:attr_name=attr_val ----------------------
     attr_name = Word(alphas + ':')
-    attr_val = Word(alphanums + ' -.%')
+    attr_val = Word(alphanums + ' %-./:_')
     attr_def = Group(attr_name + equal + attr_val)
     attr_list = open_brace + delimitedList(attr_def) + close_brace