test: add tests for footnote support

Author: tiberlas

tests/test_document.py

@@ -23,6 +23,7 @@
 from docx.table import Table
 from docx.text.paragraph import Paragraph
 from docx.text.run import Run
+from docx.footnotes import Footnotes
 
 from .unitutil.cxml import element, xml
 from .unitutil.mock import Mock, class_mock, instance_mock, method_mock, property_mock
@@ -103,6 +104,10 @@ def it_provides_access_to_its_core_properties(self, core_props_fixture):
         core_properties = document.core_properties
         assert core_properties is core_properties_
 
+    def it_provides_access_to_its_footnotes(self, footnotes_fixture):
+        document, footnotes_ = footnotes_fixture
+        assert document.footnotes is footnotes_
+
     def it_provides_access_to_its_inline_shapes(self, inline_shapes_fixture):
         document, inline_shapes_ = inline_shapes_fixture
         assert document.inline_shapes is inline_shapes_
@@ -246,6 +251,18 @@ def core_props_fixture(self, document_part_, core_properties_):
         document_part_.core_properties = core_properties_
         return document, core_properties_
 
+    @pytest.fixture(params=[
+        ('w:footnotes/(w:footnote{w:id=-1}/w:p/w:r/w:t"minus one note", w:footnote{w:id=0}/w:p/w:r/w:t"zero note")'),
+        ('w:footnotes/(w:footnote{w:id=1}/w:p/w:r/w:t"first note", w:footnote{w:id=2}/w:p/w:r/w:t"second note")'),
+        ('w:footnotes/(w:footnote{w:id=1}/w:p/w:r/w:t"first note", w:footnote{w:id=2}/w:p/w:r/w:t"second note", w:footnote{w:id=3}/w:p/w:r/w:t"third note")'),
+    ])
+    def footnotes_fixture(self, request, document_part_):
+        footnotes_cxml = request.param
+        document = Document(None, document_part_)
+        footnotes = Footnotes(element(footnotes_cxml), None)
+        document_part_.footnotes = footnotes
+        return document, footnotes
+
     @pytest.fixture
     def inline_shapes_fixture(self, document_part_, inline_shapes_):
         document = Document(None, document_part_)

tests/test_section.py

@@ -161,6 +161,63 @@ def it_can_change_whether_the_document_has_distinct_odd_and_even_headers(
 
         assert sectPr.xml == expected_xml
 
+    @pytest.mark.parametrize(
+        ("sectPr_cxml", "footnote_prop_name", "expected_value"),
+        [
+            ("w:sectPr/w:footnotePr/w:numFmt{w:val=decimal}", "footnote_number_format", "decimal"),
+            ("w:sectPr/w:footnotePr/w:numFmt{w:val=upperRoman}", "footnote_number_format", "upperRoman"),
+            ("w:sectPr/w:footnotePr/w:numFmt{w:val=lowerLetter}", "footnote_number_format", "lowerLetter"),
+            ("w:sectPr/w:footnotePr/w:numFmt{w:val=bullet}", "footnote_number_format", "bullet"),
+            ("w:sectPr/w:footnotePr/w:pos{w:val=pageBottom}", "footnote_number_format", None),
+            ("w:sectPr/w:footnotePr/w:pos{w:val=pageBottom}", "footnote_position", "pageBottom"),
+            ("w:sectPr/w:footnotePr/w:numStart{w:val=5}", "footnote_numbering_start_value", 5),
+            ("w:sectPr/w:footnotePr/w:numStart{w:val=13}", "footnote_numbering_start_value", 13),
+            ("w:sectPr/w:footnotePr/w:numRestart{w:val=eachSect}", "footnote_numbering_restart_location", "eachSect"),
+            ("w:sectPr/w:footnotePr/w:numRestart{w:val=eachPage}", "footnote_numbering_restart_location", "eachPage"),
+        ],
+    )
+    def it_knows_its_footnote_properties(
+        self,
+        sectPr_cxml: str,
+        footnote_prop_name: str,
+        expected_value: str | int | None,
+        document_part_: Mock,
+    ):
+        sectPr = cast(CT_SectPr, element(sectPr_cxml))
+        section = Section(sectPr, document_part_)
+
+        value = getattr(section, footnote_prop_name)
+
+        assert value == expected_value
+
+    @pytest.mark.parametrize(
+        ("sectPr_cxml", "footnote_prop_name", "value", "expected_cxml"),
+        [
+            ("w:sectPr", "footnote_number_format", "upperRoman", "w:sectPr/w:footnotePr/w:numFmt{w:val=upperRoman}"),
+            ("w:sectPr/w:footnotePr/w:numFmt{w:val=decimal}", "footnote_number_format", "upperRoman", "w:sectPr/w:footnotePr/w:numFmt{w:val=upperRoman}"),
+            ("w:sectPr", "footnote_position", "pageBottom", "w:sectPr/w:footnotePr/w:pos{w:val=pageBottom}"),
+            ("w:sectPr", "footnote_numbering_start_value", 1, "w:sectPr/w:footnotePr/(w:numStart{w:val=1},w:numRestart{w:val=continuous})"),
+            ("w:sectPr", "footnote_numbering_start_value", 5, "w:sectPr/w:footnotePr/(w:numStart{w:val=5},w:numRestart{w:val=continuous})"),
+            ("w:sectPr", "footnote_numbering_restart_location", "eachSect", "w:sectPr/w:footnotePr/(w:numStart{w:val=1},w:numRestart{w:val=eachSect})"),
+            ("w:sectPr", "footnote_numbering_restart_location", "continuous", "w:sectPr/w:footnotePr/(w:numStart{w:val=1},w:numRestart{w:val=continuous})"),
+        ],
+    )
+    def it_can_change_its_footnote_properties(
+        self,
+        sectPr_cxml: str,
+        footnote_prop_name: str,
+        value: str | int | None,
+        expected_cxml: str,
+        document_part_: Mock,
+    ):
+        sectPr = cast(CT_SectPr, element(sectPr_cxml))
+        expected_xml = xml(expected_cxml)
+        section = Section(sectPr, document_part_)
+
+        setattr(section, footnote_prop_name, value)
+
+        assert section._sectPr.xml == expected_xml
+
     def it_provides_access_to_its_even_page_footer(
         self, document_part_: Mock, _Footer_: Mock, footer_: Mock
     ):

tests/text/test_paragraph.py

@@ -13,6 +13,8 @@
 from docx.text.paragraph import Paragraph
 from docx.text.parfmt import ParagraphFormat
 from docx.text.run import Run
+from docx.footnotes import Footnotes
+from docx.document import Document
 
 from ..unitutil.cxml import element, xml
 from ..unitutil.mock import call, class_mock, instance_mock, method_mock, property_mock
@@ -38,6 +40,10 @@ def it_knows_whether_it_contains_a_page_break(
 
         assert paragraph.contains_page_break == expected_value
 
+    def it_provides_access_to_its_footnotes(self, footnotes_fixture):
+        paragraph, footnotes_ = footnotes_fixture
+        assert paragraph.footnotes == footnotes_
+
     @pytest.mark.parametrize(
         ("p_cxml", "count"),
         [
@@ -215,6 +221,22 @@ def it_inserts_a_paragraph_before_to_help(self, _insert_before_fixture):
 
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:p/w:r/w:footnoteReference{w:id=2}', 'w:footnotes/(w:footnote{w:id=1}/w:p/w:r/w:t"first note", w:footnote{w:id=2}/w:p/w:r/w:t"second note")', [2]),
+        ('w:p/w:r/w:footnoteReference{w:id=1}', 'w:footnotes/(w:footnote{w:id=1}/w:p/w:r/w:t"first note", w:footnote{w:id=2}/w:p/w:r/w:t"second note")', [1]),
+        ('w:p/w:r/(w:footnoteReference{w:id=1}, w:footnoteReference{w:id=2})', 'w:footnotes/(w:footnote{w:id=1}/w:p/w:r/w:t"first note", w:footnote{w:id=2}/w:p/w:r/w:t"second note")', [1,2]),
+        ('w:p/w:r/(w:footnoteReference{w:id=3}, w:footnoteReference{w:id=2})', 'w:footnotes/(w:footnote{w:id=1}/w:p/w:r/w:t"first note", w:footnote{w:id=2}/w:p/w:r/w:t"second note", w:footnote{w:id=3}/w:p/w:r/w:t"third note")', [3,2]),
+    ])
+    def footnotes_fixture(self, request, document_part_):
+        paragraph_cxml, footnotes_cxml, footnote_ids_in_p = request.param
+        document_elm = element('w:document/w:body')
+        document = Document(document_elm, document_part_)
+        paragraph = Paragraph(element(paragraph_cxml), document._body)
+        footnotes = Footnotes(element(footnotes_cxml), None)
+        footnotes_in_p = [footnotes[id] for id in footnote_ids_in_p]
+        document_part_.footnotes = footnotes
+        return paragraph, footnotes_in_p
+
     @pytest.fixture(
         params=[
             ("w:p", None, None, "w:p/w:r"),