sect: add Section.page_width getter

Steve Canny · Steve Canny · commit 6202ca6210cf · 2014-06-20T23:02:06.000-07:00
diff --git a/docx/oxml/section.py b/docx/oxml/section.py
@@ -14,6 +14,7 @@ class CT_PageSz(BaseOxmlElement):
     ``<w:pgSz>`` element, defining page dimensions and orientation.
     """
     w = OptionalAttribute('w:w', ST_TwipsMeasure)
+    h = OptionalAttribute('w:h', ST_TwipsMeasure)
 
 
 class CT_SectPr(BaseOxmlElement):
@@ -34,6 +35,17 @@ class CT_SectPr(BaseOxmlElement):
         __child_sequence__[__child_sequence__.index('w:pgSz')+1:]
     ))
 
+    @property
+    def page_height(self):
+        """
+        Value in EMU of the ``h`` attribute of the ``<w:pgSz>`` child
+        element, or |None| if not present.
+        """
+        pgSz = self.pgSz
+        if pgSz is None:
+            return None
+        return pgSz.h
+
     @property
     def page_width(self):
         """
diff --git a/docx/section.py b/docx/section.py
@@ -15,6 +15,16 @@ def __init__(self, sectPr):
         super(Section, self).__init__()
         self._sectPr = sectPr
 
+    @property
+    def page_height(self):
+        """
+        Total page height used for this section, inclusive of all edge spacing
+        values such as margins. Page orientation is taken into account, so
+        for example, its expected value would be ``Inches(8.5)`` for
+        letter-sized paper when orientation is landscape.
+        """
+        return self._sectPr.page_height
+
     @property
     def page_width(self):
         """
diff --git a/features/sct-section-props.feature b/features/sct-section-props.feature
@@ -29,7 +29,6 @@ Feature: Access and change section properties
       | NEW_COLUMN         | None           | NEW_PAGE            |
 
 
-  @wip
   Scenario: Get section page width
     Given a section having known page dimension
      Then the reported page width is 8.5 inches
diff --git a/tests/test_section.py b/tests/test_section.py
@@ -30,16 +30,32 @@ def it_knows_its_page_width(self, page_width_get_fixture):
         section, expected_page_width = page_width_get_fixture
         assert section.page_width == expected_page_width
 
+    def it_knows_its_page_height(self, page_height_get_fixture):
+        section, expected_page_height = page_height_get_fixture
+        assert section.page_height == expected_page_height
+
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture(params=[
+        (True,  2880, Inches(2)),
+        (True,  None, None),
+        (False, None, None),
+    ])
+    def page_height_get_fixture(self, request):
+        has_pgSz_child, h, expected_page_height = request.param
+        pgSz_bldr = self.pgSz_bldr(has_pgSz_child, h=h)
+        sectPr = self.sectPr_bldr(pgSz_bldr).element
+        section = Section(sectPr)
+        return section, expected_page_height
+
     @pytest.fixture(params=[
         (True,  1440, Inches(1)),
         (True,  None, None),
         (False, None, None),
     ])
     def page_width_get_fixture(self, request):
         has_pgSz_child, w, expected_page_width = request.param
-        pgSz_bldr = self.pgSz_bldr(has_pgSz_child, w)
+        pgSz_bldr = self.pgSz_bldr(has_pgSz_child, w=w)
         sectPr = self.sectPr_bldr(pgSz_bldr).element
         section = Section(sectPr)
         return section, expected_page_width
@@ -82,12 +98,14 @@ def start_type_set_fixture(self, request):
 
     # fixture components ---------------------------------------------
 
-    def pgSz_bldr(self, has_pgSz, w):
+    def pgSz_bldr(self, has_pgSz, w=None, h=None):
         if not has_pgSz:
             return None
         pgSz_bldr = a_pgSz()
         if w is not None:
             pgSz_bldr.with_w(w)
+        if h is not None:
+            pgSz_bldr.with_h(h)
         return pgSz_bldr
 
     def sectPr_bldr(self, *child_bldrs):
