sect: add Section.footer

ondrej-111 · scanny · commit d3b8eb705236 · 2019-01-06T14:25:22.000-08:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -107,6 +107,8 @@
 
 .. |Font| replace:: :class:`.Font`
 
+.. |_Footer| replace:: :class:`._Footer`
+
 .. |_Header| replace:: :class:`._Header`
 
 .. |ImageParts| replace:: :class:`.ImageParts`
diff --git a/docx/section.py b/docx/section.py
@@ -6,6 +6,9 @@
 
 from collections import Sequence
 
+from docx.blkcntnr import BlockItemContainer
+from docx.shared import lazyproperty
+
 
 class Sections(Sequence):
     """Sequence of |Section| objects corresponding to the sections in the document.
@@ -57,6 +60,15 @@ def bottom_margin(self):
     def bottom_margin(self, value):
         self._sectPr.bottom_margin = value
 
+    @lazyproperty
+    def footer(self):
+        """|_Footer| object representing default page footer for this section.
+
+        The default footer is used for odd-numbered pages when separate odd/even footers
+        are enabled. It is used for both odd and even-numbered pages otherwise.
+        """
+        return _Footer(self._sectPr, self._document_part)
+
     @property
     def footer_distance(self):
         """
@@ -187,3 +199,11 @@ def top_margin(self):
     @top_margin.setter
     def top_margin(self, value):
         self._sectPr.top_margin = value
+
+
+class _Footer(BlockItemContainer):
+    """Page footer."""
+
+    def __init__(self, sectPr, document_part):
+        self._sectPr = sectPr
+        self._document_part = document_part
diff --git a/features/sct-section.feature b/features/sct-section.feature
@@ -4,7 +4,6 @@ Feature: Access and change section properties
   I need a way to get and set the properties of a section
 
 
-  @wip
   Scenario: Section.footer
     Given a Section object as section
      Then section.footer is a _Footer object
diff --git a/tests/test_section.py b/tests/test_section.py
@@ -8,7 +8,7 @@
 
 from docx.enum.section import WD_ORIENT, WD_SECTION
 from docx.parts.document import DocumentPart
-from docx.section import Section, Sections
+from docx.section import _Footer, Section, Sections
 from docx.shared import Inches
 
 from .unitutil.cxml import element, xml
@@ -91,6 +91,18 @@ def section_(self, request):
 
 class DescribeSection(object):
 
+    def it_provides_access_to_its_default_footer(
+        self, document_part_, _Footer_, footer_
+    ):
+        sectPr = element('w:sectPr')
+        _Footer_.return_value = footer_
+        section = Section(sectPr, document_part_)
+
+        footer = section.footer
+
+        _Footer_.assert_called_once_with(sectPr, document_part_)
+        assert footer is footer_
+
     def it_knows_its_start_type(self, start_type_get_fixture):
         sectPr, expected_start_type = start_type_get_fixture
         section = Section(sectPr, None)
@@ -309,3 +321,17 @@ def start_type_set_fixture(self, request):
         sectPr = element(initial_cxml)
         expected_xml = xml(expected_cxml)
         return sectPr, new_start_type, expected_xml
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def document_part_(self, request):
+        return instance_mock(request, DocumentPart)
+
+    @pytest.fixture
+    def _Footer_(self, request):
+        return class_mock(request, "docx.section._Footer")
+
+    @pytest.fixture
+    def footer_(self, request):
+        return instance_mock(request, _Footer)
