tbl: add _Row.height_rule getter

Author: revossen-asml

docx/oxml/__init__.py

@@ -128,8 +128,8 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:unhideWhenUsed', CT_OnOff)
 
 from .table import (
-    CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblLayoutType, CT_TblPr,
-    CT_TblWidth, CT_Tc, CT_TcPr, CT_VMerge
+    CT_Height, CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblLayoutType,
+    CT_TblPr, CT_TblWidth, CT_Tc, CT_TcPr, CT_TrPr, CT_VMerge
 )
 register_element_cls('w:bidiVisual', CT_OnOff)
 register_element_cls('w:gridCol',    CT_TblGridCol)
@@ -143,6 +143,8 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:tcPr',       CT_TcPr)
 register_element_cls('w:tcW',        CT_TblWidth)
 register_element_cls('w:tr',         CT_Row)
+register_element_cls('w:trHeight',   CT_Height)
+register_element_cls('w:trPr',       CT_TrPr)
 register_element_cls('w:vMerge',     CT_VMerge)
 
 from .text.font import (

docx/oxml/table.py

@@ -9,6 +9,7 @@
 )
 
 from . import parse_xml
+from ..enum.table import WD_ROW_HEIGHT_RULE
 from ..exceptions import InvalidSpanError
 from .ns import nsdecls, qn
 from ..shared import Emu, Twips
@@ -21,6 +22,14 @@
 )
 
 
+class CT_Height(BaseOxmlElement):
+    """
+    Used for ``<w:trHeight>`` to specify a row height and row height rule.
+    """
+    val = OptionalAttribute('w:val', ST_TwipsMeasure)
+    hRule = OptionalAttribute('w:hRule', WD_ROW_HEIGHT_RULE)
+
+
 class CT_Row(BaseOxmlElement):
     """
     ``<w:tr>`` element
@@ -51,6 +60,17 @@ def tr_idx(self):
         """
         return self.getparent().tr_lst.index(self)
 
+    @property
+    def trHeight_hRule(self):
+        """
+        Return the value of `w:trPr/w:trHeight@w:hRule`, or |None| if not
+        present.
+        """
+        trPr = self.trPr
+        if trPr is None:
+            return None
+        return trPr.trHeight_hRule
+
     def _insert_tblPrEx(self, tblPrEx):
         self.insert(0, tblPrEx)
 
@@ -776,6 +796,30 @@ def width(self, value):
         tcW.width = value
 
 
+class CT_TrPr(BaseOxmlElement):
+    """
+    ``<w:trPr>`` element, defining table row properties
+    """
+    _tag_seq = (
+        'w:cnfStyle', 'w:divId', 'w:gridBefore', 'w:gridAfter', 'w:wBefore',
+        'w:wAfter', 'w:cantSplit', 'w:trHeight', 'w:tblHeader',
+        'w:tblCellSpacing', 'w:jc', 'w:hidden', 'w:ins', 'w:del',
+        'w:trPrChange'
+    )
+    trHeight = ZeroOrOne('w:trHeight', successors=_tag_seq[8:])
+    del _tag_seq
+
+    @property
+    def trHeight_hRule(self):
+        """
+        Return the value of `w:trHeight@w:hRule`, or |None| if not present.
+        """
+        trHeight = self.trHeight
+        if trHeight is None:
+            return None
+        return trHeight.hRule
+
+
 class CT_VMerge(BaseOxmlElement):
     """
     ``<w:vMerge>`` element, specifying vertical merging behavior of a cell.

docx/table.py

@@ -383,6 +383,15 @@ def cells(self):
         """
         return tuple(self.table.row_cells(self._index))
 
+    @property
+    def height_rule(self):
+        """
+        Return the height rule of this cell as a member of the
+        :ref:`WdRowHeightRule` enumeration, or |None| if no explicit
+        height_rule is set.
+        """
+        return self._tr.trHeight_hRule
+
     @property
     def table(self):
         """

features/tbl-row-props.feature

@@ -4,7 +4,6 @@ Feature: Get and set table row properties
   I need a way to get and set the properties of a table row
 
 
-  @wip
   Scenario Outline: Get Row.height_rule
     Given a table row having height rule <state>
      Then row.height_rule is <value>

tests/test_table.py

@@ -9,7 +9,9 @@
 import pytest
 
 from docx.enum.style import WD_STYLE_TYPE
-from docx.enum.table import WD_TABLE_ALIGNMENT, WD_TABLE_DIRECTION
+from docx.enum.table import (
+    WD_ROW_HEIGHT, WD_TABLE_ALIGNMENT, WD_TABLE_DIRECTION
+)
 from docx.oxml import parse_xml
 from docx.oxml.table import CT_Tc
 from docx.parts.document import DocumentPart
@@ -651,6 +653,10 @@ def table_(self, request):
 
 class Describe_Row(object):
 
+    def it_knows_its_height_rule(self, height_rule_get_fixture):
+        row, expected_rule = height_rule_get_fixture
+        assert row.height_rule == expected_rule
+
     def it_provides_access_to_its_cells(self, cells_fixture):
         row, row_idx, expected_cells = cells_fixture
         cells = row.cells
@@ -675,6 +681,21 @@ def cells_fixture(self, _index_, table_prop_, table_):
         table_.row_cells.return_value = list(expected_cells)
         return row, row_idx, expected_cells
 
+    @pytest.fixture(params=[
+        ('w:tr',        None),
+        ('w:tr/w:trPr', None),
+        ('w:tr/w:trPr/w:trHeight{w:val=0, w:hRule=auto}',
+         WD_ROW_HEIGHT.AUTO),
+        ('w:tr/w:trPr/w:trHeight{w:val=1440, w:hRule=atLeast}',
+         WD_ROW_HEIGHT.AT_LEAST),
+        ('w:tr/w:trPr/w:trHeight{w:val=2880, w:hRule=exact}',
+         WD_ROW_HEIGHT.EXACTLY),
+    ])
+    def height_rule_get_fixture(self, request):
+        tr_cxml, expected_rule = request.param
+        row = _Row(element(tr_cxml), None)
+        return row, expected_rule
+
     @pytest.fixture
     def idx_fixture(self):
         tbl = element('w:tbl/(w:tr,w:tr,w:tr)')