hdr: add FooterPart._default_footer_xml()

scanny · scanny · commit 11e0fb3ba846 · 2019-01-06T14:26:12.000-08:00
diff --git a/docx/parts/hdrftr.py b/docx/parts/hdrftr.py
@@ -25,7 +25,12 @@ def new(cls, package):
     @classmethod
     def _default_footer_xml(cls):
         """Return bytes containing XML for a default footer part."""
-        raise NotImplementedError
+        path = os.path.join(
+            os.path.split(__file__)[0], '..', 'templates', 'default-footer.xml'
+        )
+        with open(path, 'rb') as f:
+            xml_bytes = f.read()
+        return xml_bytes
 
 
 class HeaderPart(XmlPart):
diff --git a/docx/templates/default-footer.xml b/docx/templates/default-footer.xml
@@ -0,0 +1,27 @@
+<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
+<w:ftr
+    xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:mo="http://schemas.microsoft.com/office/mac/office/2008/main"
+    xmlns:mv="urn:schemas-microsoft-com:mac:vml"
+    xmlns:o="urn:schemas-microsoft-com:office:office"
+    xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"
+    xmlns:v="urn:schemas-microsoft-com:vml"
+    xmlns:w10="urn:schemas-microsoft-com:office:word"
+    xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml"
+    xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+    xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml"
+    xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing"
+    xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing"
+    xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas"
+    xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup"
+    xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk"
+    xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape"
+    mc:Ignorable="w14 wp14"
+    >
+  <w:p>
+    <w:pPr>
+      <w:pStyle w:val="Footer"/>
+    </w:pPr>
+  </w:p>
+</w:ftr>
diff --git a/features/hdr-header-footer.feature b/features/hdr-header-footer.feature
@@ -44,7 +44,6 @@ Feature: Header and footer behaviors
       | with no    | True  |
 
 
-  @wip
   Scenario Outline: _Footer.is_linked_to_previous setter
     Given a _Footer object <with-or-no> footer definition as footer
      When I assign <value> to footer.is_linked_to_previous
diff --git a/tests/parts/test_hdrftr.py b/tests/parts/test_hdrftr.py
@@ -34,6 +34,15 @@ def it_can_create_a_new_footer_part(
             footer_part, "/word/footer24.xml", CT.WML_FOOTER, ftr, package_
         )
 
+    def it_loads_default_footer_XML_from_a_template_to_help(self):
+        # ---tests integration with OS---
+        xml_bytes = FooterPart._default_footer_xml()
+
+        assert xml_bytes.startswith(
+            b"<?xml version='1.0' encoding='UTF-8' standalone='yes'?>\n<w:ftr\n"
+        )
+        assert len(xml_bytes) == 1395
+
     # fixture components ---------------------------------------------
 
     @pytest.fixture
