parts: add EndnotesPart

Benjamin Toornstra · scanny · commit 83137112a03b · 2018-12-27T19:37:31.000-08:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('..'))
 
-from docx import __version__
+from docx import __version__  # noqa
 
 
 # -- General configuration ---------------------------------------------------
@@ -101,6 +101,8 @@
 
 .. |Emu| replace:: :class:`.Emu`
 
+.. |EndnotesPart| replace:: :class:`.EndnotesPart`
+
 .. |False| replace:: :class:`False`
 
 .. |float| replace:: :class:`.float`
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -12,6 +12,7 @@
 from docx.opc.parts.coreprops import CorePropertiesPart
 
 from docx.parts.document import DocumentPart
+from docx.parts.endnotes import EndnotesPart
 from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.parts.image import ImagePart
 from docx.parts.numbering import NumberingPart
@@ -28,6 +29,7 @@ def part_class_selector(content_type, reltype):
 PartFactory.part_class_selector = part_class_selector
 PartFactory.part_type_for[CT.OPC_CORE_PROPERTIES] = CorePropertiesPart
 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_HEADER] = HeaderPart
 PartFactory.part_type_for[CT.WML_NUMBERING] = NumberingPart
@@ -38,6 +40,7 @@ def part_class_selector(content_type, reltype):
     CT,
     CorePropertiesPart,
     DocumentPart,
+    EndnotesPart,
     FooterPart,
     HeaderPart,
     NumberingPart,
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -77,6 +77,9 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:body', CT_Body)
 register_element_cls('w:document', CT_Document)
 
+from docx.oxml.endnotes import CT_Endnotes  # noqa
+register_element_cls('w:endnotes', CT_Endnotes)
+
 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/endnotes.py b/docx/oxml/endnotes.py
@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+"""Custom element classes related to end-notes"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from docx.oxml.xmlchemy import BaseOxmlElement
+
+
+class CT_Endnotes(BaseOxmlElement):
+    """`w:endnotes` element"""
diff --git a/docx/parts/endnotes.py b/docx/parts/endnotes.py
@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+"""|EndnotesPart| and closely related objects"""
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from docx.opc.part import XmlPart
+
+
+class EndnotesPart(XmlPart):
+    """Package part containing end-notes"""
diff --git a/tests/parts/test_endnotes.py b/tests/parts/test_endnotes.py
@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+"""Unit test suite for the docx.parts.endnotes 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.endnotes import EndnotesPart
+
+from ..unitutil.mock import instance_mock, method_mock
+
+
+class DescribeEndnotesPart(object):
+
+    def it_is_used_by_loader_to_construct_endnotes_part(
+        self, package_, EndnotesPart_load_, endnotes_part_
+    ):
+        partname = "endnotes.xml"
+        content_type = CT.WML_ENDNOTES
+        reltype = RT.ENDNOTES
+        blob = "<w:endnotes/>"
+        EndnotesPart_load_.return_value = endnotes_part_
+
+        part = PartFactory(partname, content_type, reltype, blob, package_)
+
+        EndnotesPart_load_.assert_called_once_with(
+            partname, content_type, blob, package_
+        )
+        assert part is endnotes_part_
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def EndnotesPart_load_(self, request):
+        return method_mock(request, EndnotesPart, "load")
+
+    @pytest.fixture
+    def endnotes_part_(self, request):
+        return instance_mock(request, EndnotesPart)
+
+    @pytest.fixture
+    def package_(self, request):
+        return instance_mock(request, Package)
