parts: add FootnotesPart

Benjamin Toornstra · scanny · commit 89678c59ae71 · 2018-12-27T19:37:59.000-08:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -109,6 +109,8 @@
 
 .. |Font| replace:: :class:`.Font`
 
+.. |FootnotesPart| replace:: :class:`.FootnotesPart`
+
 .. |Inches| replace:: :class:`.Inches`
 
 .. |InlineShape| replace:: :class:`.InlineShape`
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -13,6 +13,7 @@
 
 from docx.parts.document import DocumentPart
 from docx.parts.endnotes import EndnotesPart
+from docx.parts.footnotes import FootnotesPart
 from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.parts.image import ImagePart
 from docx.parts.numbering import NumberingPart
@@ -31,6 +32,7 @@ def part_class_selector(content_type, reltype):
 PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN] = DocumentPart
 PartFactory.part_type_for[CT.WML_ENDNOTES] = EndnotesPart
 PartFactory.part_type_for[CT.WML_FOOTER] = FooterPart
+PartFactory.part_type_for[CT.WML_FOOTNOTES] = FootnotesPart
 PartFactory.part_type_for[CT.WML_HEADER] = HeaderPart
 PartFactory.part_type_for[CT.WML_NUMBERING] = NumberingPart
 PartFactory.part_type_for[CT.WML_SETTINGS] = SettingsPart
@@ -42,6 +44,7 @@ def part_class_selector(content_type, reltype):
     DocumentPart,
     EndnotesPart,
     FooterPart,
+    FootnotesPart,
     HeaderPart,
     NumberingPart,
     PartFactory,
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -80,6 +80,9 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 from docx.oxml.endnotes import CT_Endnotes  # noqa
 register_element_cls('w:endnotes', CT_Endnotes)
 
+from docx.oxml.footnotes import CT_Footnotes  # noqa
+register_element_cls('w:footnotes', CT_Footnotes)
+
 from docx.oxml.hdrftr import CT_HdrFtr  # noqa
 register_element_cls('w:ftr', CT_HdrFtr)
 register_element_cls('w:hdr', CT_HdrFtr)
diff --git a/docx/oxml/footnotes.py b/docx/oxml/footnotes.py
@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+"""Custom element classes related to footnotes"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from docx.oxml.xmlchemy import BaseOxmlElement
+
+
+class CT_Footnotes(BaseOxmlElement):
+    """`w:footnotes` element"""
diff --git a/docx/parts/footnotes.py b/docx/parts/footnotes.py
@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+"""|FootnotesPart| and related objects"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from docx.opc.part import XmlPart
+
+
+class FootnotesPart(XmlPart):
+    """Package part containing footnotes"""
diff --git a/tests/parts/test_footnotes.py b/tests/parts/test_footnotes.py
@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+"""Unit test suite for the docx.parts.footnotes module"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+import pytest
+
+from docx.opc.constants import CONTENT_TYPE as CT, RELATIONSHIP_TYPE as RT
+from docx.opc.part import PartFactory
+from docx.package import Package
+from docx.parts.footnotes import FootnotesPart
+
+from ..unitutil.mock import instance_mock, method_mock
+
+
+class DescribeFootnotesPart(object):
+
+    def it_is_used_by_loader_to_construct_footnotes_part(
+        self, package_, FootnotesPart_load_, footnotes_part_
+    ):
+        partname = "footnotes.xml"
+        content_type = CT.WML_FOOTNOTES
+        reltype = RT.FOOTNOTES
+        blob = "<w:footnotes/>"
+        FootnotesPart_load_.return_value = footnotes_part_
+
+        part = PartFactory(partname, content_type, reltype, blob, package_)
+
+        FootnotesPart_load_.assert_called_once_with(
+            partname, content_type, blob, package_
+        )
+        assert part is footnotes_part_
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def FootnotesPart_load_(self, request):
+        return method_mock(request, FootnotesPart, "load")
+
+    @pytest.fixture
+    def footnotes_part_(self, request):
+        return instance_mock(request, FootnotesPart)
+
+    @pytest.fixture
+    def package_(self, request):
+        return instance_mock(request, Package)
