hdr: add Section.different_first_page_header_footr

Author: scanny

docx/oxml/__init__.py

@@ -66,6 +66,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 
 from .shared import CT_DecimalNumber, CT_OnOff, CT_String  # noqa
 register_element_cls("w:evenAndOddHeaders", CT_OnOff)
+register_element_cls("w:titlePg", CT_OnOff)
 
 
 from .coreprops import CT_CoreProperties  # noqa

docx/oxml/section.py

@@ -69,6 +69,7 @@ class CT_SectPr(BaseOxmlElement):
     type = ZeroOrOne("w:type", successors=_tag_seq[3:])
     pgSz = ZeroOrOne("w:pgSz", successors=_tag_seq[4:])
     pgMar = ZeroOrOne("w:pgMar", successors=_tag_seq[5:])
+    titlePg = ZeroOrOne("w:titlePg", successors=_tag_seq[14:])
     del _tag_seq
 
     def add_footerReference(self, type_, rId):
@@ -310,6 +311,14 @@ def start_type(self, value):
         type = self.get_or_add_type()
         type.val = value
 
+    @property
+    def titlePg_val(self):
+        """Value of `w:titlePg/@val` or |None| if not present"""
+        titlePg = self.titlePg
+        if titlePg is None:
+            return False
+        return titlePg.val
+
     @property
     def top_margin(self):
         """

docx/section.py

@@ -61,6 +61,15 @@ def bottom_margin(self):
     def bottom_margin(self, value):
         self._sectPr.bottom_margin = value
 
+    @property
+    def different_first_page_header_footer(self):
+        """True if this section displays a distinct first-page header and footer.
+
+        Read/write. The definition of the first-page header and footer are accessed
+        using :attr:`.first_page_header` and :attr:`.first_page_footer` respectively.
+        """
+        return self._sectPr.titlePg_val
+
     @lazyproperty
     def footer(self):
         """|_Footer| object representing default page footer for this section.

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 Outline: Section.different_first_page_header_footer getter
     Given a Section object <with-or-without> a distinct first-page header as section
      Then section.different_first_page_header_footer is <value>

tests/test_section.py

@@ -92,6 +92,16 @@ def section_(self, request):
 
 class DescribeSection(object):
 
+    def it_knows_when_it_displays_a_distinct_first_page_header(
+        self, diff_first_header_get_fixture
+    ):
+        sectPr, expected_value = diff_first_header_get_fixture
+        section = Section(sectPr, None)
+
+        different_first_page_header_footer = section.different_first_page_header_footer
+
+        assert different_first_page_header_footer is expected_value
+
     def it_provides_access_to_its_default_footer(
         self, document_part_, _Footer_, footer_
     ):
@@ -198,6 +208,20 @@ def it_can_change_its_page_margins(self, margins_set_fixture):
 
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture(
+        params=[
+            ("w:sectPr", False),
+            ("w:sectPr/w:titlePg", True),
+            ("w:sectPr/w:titlePg{w:val=0}", False),
+            ("w:sectPr/w:titlePg{w:val=1}", True),
+            ("w:sectPr/w:titlePg{w:val=true}", True),
+        ]
+    )
+    def diff_first_header_get_fixture(self, request):
+        sectPr_cxml, expected_value = request.param
+        sectPr = element(sectPr_cxml)
+        return sectPr, expected_value
+
     @pytest.fixture(params=[
         ('w:sectPr/w:pgMar{w:left=120}',   'left_margin',      76200),
         ('w:sectPr/w:pgMar{w:right=240}',  'right_margin',    152400),