hdr: add HeaderPart.new()

ondrej-111 · scanny · commit 4ed8545b76b0 · 2019-01-06T14:26:12.000-08:00
diff --git a/docx/opc/package.py b/docx/opc/package.py
@@ -108,6 +108,16 @@ def main_document_part(self):
         """
         return self.part_related_by(RT.OFFICE_DOCUMENT)
 
+    def next_partname(self, template):
+        """Return a |PackURI| instance representing partname matching *template*.
+
+        The returned part-name has the next available numeric suffix to distinguish it
+        from other parts of its type. *template* is a printf (%)-style template string
+        containing a single replacement item, a '%d' to be used to insert the integer
+        portion of the partname. Example: "/word/header%d.xml"
+        """
+        raise NotImplementedError
+
     @classmethod
     def open(cls, pkg_file):
         """
diff --git a/docx/parts/hdrftr.py b/docx/parts/hdrftr.py
@@ -4,7 +4,9 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
+from docx.opc.constants import CONTENT_TYPE as CT
 from docx.opc.part import XmlPart
+from docx.oxml import parse_xml
 
 
 class HeaderPart(XmlPart):
@@ -13,4 +15,12 @@ class HeaderPart(XmlPart):
     @classmethod
     def new(cls, package):
         """Return newly created header part."""
+        partname = package.next_partname("/word/header%d.xml")
+        content_type = CT.WML_HEADER
+        element = parse_xml(cls._default_header_xml())
+        return cls(partname, content_type, element, package)
+
+    @classmethod
+    def _default_header_xml(cls):
+        """Return bytes containing XML for a default header part."""
         raise NotImplementedError
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-"""Test suite for the docx.parts.document module"""
+"""Unit test suite for the docx.parts.document module"""
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
@@ -24,9 +24,7 @@
 from ..oxml.parts.unitdata.document import a_body, a_document
 from ..oxml.unitdata.text import a_p
 from ..unitutil.file import snippet_text
-from ..unitutil.mock import (
-    instance_mock, class_mock, method_mock, property_mock
-)
+from ..unitutil.mock import class_mock, instance_mock, method_mock, property_mock
 
 
 class DescribeDocumentPart(object):
diff --git a/tests/parts/test_hdrftr.py b/tests/parts/test_hdrftr.py
@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+"""Unit test suite for the docx.parts.hdrftr module"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+import pytest
+
+from docx.opc.constants import CONTENT_TYPE as CT
+from docx.package import Package
+from docx.parts.hdrftr import HeaderPart
+
+from ..unitutil.cxml import element
+from ..unitutil.mock import function_mock, initializer_mock, instance_mock, method_mock
+
+
+class DescribeHeaderPart(object):
+
+    def it_can_create_a_new_header_part(
+        self, package_, _default_header_xml_, parse_xml_, _init_
+    ):
+        hdr = element("w:hdr")
+        package_.next_partname.return_value = "/word/header42.xml"
+        _default_header_xml_.return_value = "<w:hdr>"
+        parse_xml_.return_value = hdr
+
+        header_part = HeaderPart.new(package_)
+
+        package_.next_partname.assert_called_once_with("/word/header%d.xml")
+        _default_header_xml_.assert_called_once_with()
+        parse_xml_.assert_called_once_with("<w:hdr>")
+        _init_.assert_called_once_with(
+            header_part, "/word/header42.xml", CT.WML_HEADER, hdr, package_
+        )
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def _default_header_xml_(self, request):
+        return method_mock(request, HeaderPart, "_default_header_xml", autospec=False)
+
+    @pytest.fixture
+    def _init_(self, request):
+        return initializer_mock(request, HeaderPart, autospec=True)
+
+    @pytest.fixture
+    def package_(self, request):
+        return instance_mock(request, Package)
+
+    @pytest.fixture
+    def parse_xml_(self, request):
+        return function_mock(request, "docx.parts.hdrftr.parse_xml")
