tbl: add _Cell.vertical_alignment getter

scanny · scanny · commit 4732b99f80ae · 2018-08-18T12:54:40.000-07:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -129,7 +129,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 
 from .table import (
     CT_Height, CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblLayoutType,
-    CT_TblPr, CT_TblWidth, CT_Tc, CT_TcPr, CT_TrPr, CT_VMerge
+    CT_TblPr, CT_TblWidth, CT_Tc, CT_TcPr, CT_TrPr, CT_VerticalJc, CT_VMerge
 )
 register_element_cls('w:bidiVisual', CT_OnOff)
 register_element_cls('w:gridCol',    CT_TblGridCol)
@@ -145,6 +145,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 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:vAlign',     CT_VerticalJc)
 register_element_cls('w:vMerge',     CT_VMerge)
 
 from .text.font import (
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -1,15 +1,13 @@
 # encoding: utf-8
 
-"""
-Custom element classes for tables
-"""
+"""Custom element classes for tables"""
 
 from __future__ import (
     absolute_import, division, print_function, unicode_literals
 )
 
 from . import parse_xml
-from ..enum.table import WD_ROW_HEIGHT_RULE
+from ..enum.table import WD_CELL_VERTICAL_ALIGNMENT, WD_ROW_HEIGHT_RULE
 from ..exceptions import InvalidSpanError
 from .ns import nsdecls, qn
 from ..shared import Emu, Twips
@@ -764,6 +762,7 @@ class CT_TcPr(BaseOxmlElement):
     tcW = ZeroOrOne('w:tcW', successors=_tag_seq[2:])
     gridSpan = ZeroOrOne('w:gridSpan', successors=_tag_seq[3:])
     vMerge = ZeroOrOne('w:vMerge', successors=_tag_seq[5:])
+    vAlign = ZeroOrOne('w:vAlign', successors=_tag_seq[12:])
     del _tag_seq
 
     @property
@@ -783,6 +782,18 @@ def grid_span(self, value):
         if value > 1:
             self.get_or_add_gridSpan().val = value
 
+    @property
+    def vAlign_val(self):
+        """Value of `w:val` attribute on  `w:vAlign` child.
+
+        Value is |None| if `w:vAlign` child is not present. The `w:val`
+        attribute on `w:vAlign` is required.
+        """
+        vAlign = self.vAlign
+        if vAlign is None:
+            return None
+        return vAlign.val
+
     @property
     def vMerge_val(self):
         """
@@ -865,6 +876,11 @@ def trHeight_val(self, value):
         trHeight.val = value
 
 
+class CT_VerticalJc(BaseOxmlElement):
+    """`w:vAlign` element, specifying vertical alignment of cell."""
+    val = RequiredAttribute('w:val', WD_CELL_VERTICAL_ALIGNMENT)
+
+
 class CT_VMerge(BaseOxmlElement):
     """
     ``<w:vMerge>`` element, specifying vertical merging behavior of a cell.
diff --git a/docx/table.py b/docx/table.py
@@ -190,12 +190,11 @@ def _tblPr(self):
 
 
 class _Cell(BlockItemContainer):
-    """
-    Table cell
-    """
+    """Table cell"""
+
     def __init__(self, tc, parent):
         super(_Cell, self).__init__(tc, parent)
-        self._tc = tc
+        self._tc = self._element = tc
 
     def add_paragraph(self, text='', style=None):
         """
@@ -278,7 +277,10 @@ def vertical_alignment(self):
         inherited. Assigning |None| causes any explicitly defined vertical
         alignment to be removed, restoring inheritance.
         """
-        raise NotImplementedError
+        tcPr = self._element.tcPr
+        if tcPr is None:
+            return None
+        return tcPr.vAlign_val
 
     @property
     def width(self):
diff --git a/features/tbl-cell-props.feature b/features/tbl-cell-props.feature
@@ -4,7 +4,6 @@ Feature: Get and set table cell properties
   I need a way to get and set the properties of a table cell
 
 
-  @wip
   Scenario Outline: Get _Cell.vertical_alignment
     Given a _Cell object with <state> vertical alignment as cell
      Then cell.vertical_alignment is <value>
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -10,7 +10,7 @@
 
 from docx.enum.style import WD_STYLE_TYPE
 from docx.enum.table import (
-    WD_ROW_HEIGHT, WD_TABLE_ALIGNMENT, WD_TABLE_DIRECTION
+    WD_ALIGN_VERTICAL, WD_ROW_HEIGHT, WD_TABLE_ALIGNMENT, WD_TABLE_DIRECTION
 )
 from docx.oxml import parse_xml
 from docx.oxml.table import CT_Tc
@@ -339,6 +339,11 @@ def it_can_replace_its_content_with_a_string_of_text(
         cell.text = text
         assert cell._tc.xml == expected_xml
 
+    def it_knows_its_vertical_alignment(self, alignment_get_fixture):
+        cell, expected_value = alignment_get_fixture
+        vertical_alignment = cell.vertical_alignment
+        assert vertical_alignment == expected_value
+
     def it_knows_its_width_in_EMU(self, width_get_fixture):
         cell, expected_width = width_get_fixture
         assert cell.width == expected_width
@@ -412,6 +417,17 @@ def add_table_fixture(self, request):
         expected_xml = snippet_seq('new-tbl')[1]
         return cell, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:tc', None),
+        ('w:tc/w:tcPr', None),
+        ('w:tc/w:tcPr/w:vAlign{w:val=bottom}', WD_ALIGN_VERTICAL.BOTTOM),
+        ('w:tc/w:tcPr/w:vAlign{w:val=top}', WD_ALIGN_VERTICAL.TOP),
+    ])
+    def alignment_get_fixture(self, request):
+        tc_cxml, expected_value = request.param
+        cell = _Cell(element(tc_cxml), None)
+        return cell, expected_value
+
     @pytest.fixture
     def merge_fixture(self, tc_, tc_2_, parent_, merged_tc_):
         cell, other_cell = _Cell(tc_, parent_), _Cell(tc_2_, parent_)
