sect: add Section.orientation getter

Steve Canny · Steve Canny · commit 7b5e96163f70 · 2014-06-21T00:23:43.000-07:00
diff --git a/docx/oxml/section.py b/docx/oxml/section.py
@@ -4,7 +4,7 @@
 Section-related custom element classes.
 """
 
-from ..enum.section import WD_SECTION_START
+from ..enum.section import WD_ORIENTATION, WD_SECTION_START
 from .simpletypes import ST_TwipsMeasure
 from .xmlchemy import BaseOxmlElement, OptionalAttribute, ZeroOrOne
 
@@ -15,6 +15,9 @@ class CT_PageSz(BaseOxmlElement):
     """
     w = OptionalAttribute('w:w', ST_TwipsMeasure)
     h = OptionalAttribute('w:h', ST_TwipsMeasure)
+    orient = OptionalAttribute(
+        'w:orient', WD_ORIENTATION, default=WD_ORIENTATION.PORTRAIT
+    )
 
 
 class CT_SectPr(BaseOxmlElement):
@@ -35,6 +38,18 @@ class CT_SectPr(BaseOxmlElement):
         __child_sequence__[__child_sequence__.index('w:pgSz')+1:]
     ))
 
+    @property
+    def orientation(self):
+        """
+        The member of the ``WD_ORIENTATION`` enumeration corresponding to the
+        value of the ``orient`` attribute of the ``<w:pgSz>`` child element,
+        or ``WD_ORIENTATION.PORTRAIT`` if not present.
+        """
+        pgSz = self.pgSz
+        if pgSz is None:
+            return WD_ORIENTATION.PORTRAIT
+        return pgSz.orient
+
     @property
     def page_height(self):
         """
diff --git a/docx/section.py b/docx/section.py
@@ -15,6 +15,14 @@ def __init__(self, sectPr):
         super(Section, self).__init__()
         self._sectPr = sectPr
 
+    @property
+    def orientation(self):
+        """
+        Page orientation for this section, one of ``WD_ORIENT.PORTRAIT`` or
+        ``WD_ORIENT.LANDSCAPE``.
+        """
+        return self._sectPr.orientation
+
     @property
     def page_height(self):
         """
diff --git a/features/sct-section-props.feature b/features/sct-section-props.feature
@@ -43,7 +43,6 @@ Feature: Access and change section properties
       And the reported page height is 8.5 inches
 
 
-  @wip
   Scenario Outline: Get section orientation
     Given a section known to have <orientation> orientation
      Then the reported page orientation is <reported-orientation>
diff --git a/tests/test_section.py b/tests/test_section.py
@@ -8,7 +8,7 @@
 
 import pytest
 
-from docx.enum.section import WD_SECTION
+from docx.enum.section import WD_ORIENT, WD_SECTION
 from docx.section import Section
 from docx.shared import Inches
 
@@ -43,8 +43,25 @@ def it_can_change_its_page_height(self, page_height_set_fixture):
         section.page_height = new_page_height
         assert section._sectPr.xml == expected_xml
 
+    def it_knows_its_page_orientation(self, orientation_get_fixture):
+        section, expected_orientation = orientation_get_fixture
+        assert section.orientation is expected_orientation
+
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture(params=[
+        (True,  'landscape', WD_ORIENT.LANDSCAPE),
+        (True,  'portrait',  WD_ORIENT.PORTRAIT),
+        (True,  None,        WD_ORIENT.PORTRAIT),
+        (False, None,        WD_ORIENT.PORTRAIT),
+    ])
+    def orientation_get_fixture(self, request):
+        has_pgSz_child, orient, expected_orientation = request.param
+        pgSz_bldr = self.pgSz_bldr(has_pgSz_child, orient=orient)
+        sectPr = self.sectPr_bldr(pgSz_bldr).element
+        section = Section(sectPr)
+        return section, expected_orientation
+
     @pytest.fixture(params=[
         (True,  2880, Inches(2)),
         (True,  None, None),
@@ -135,14 +152,16 @@ def start_type_set_fixture(self, request):
 
     # fixture components ---------------------------------------------
 
-    def pgSz_bldr(self, has_pgSz=True, w=None, h=None):
+    def pgSz_bldr(self, has_pgSz=True, w=None, h=None, orient=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)
+        if orient is not None:
+            pgSz_bldr.with_orient(orient)
         return pgSz_bldr
 
     def sectPr_bldr(self, *child_bldrs):
