tbl: add CT_Tc._span_to_width()

Author: Steve Canny

docx/oxml/table.py

@@ -314,6 +314,11 @@ def vMerge(self):
             return None
         return tcPr.vMerge_val
 
+    @vMerge.setter
+    def vMerge(self, value):
+        tcPr = self.get_or_add_tcPr()
+        tcPr.vMerge_val = value
+
     @property
     def width(self):
         """
@@ -367,6 +372,13 @@ def _insert_tcPr(self, tcPr):
         self.insert(0, tcPr)
         return tcPr
 
+    def _move_content_to(self, other_tc):
+        """
+        Append the content of this cell to *other_tc*, leaving this cell with
+        a single empty ``<w:p>`` element.
+        """
+        raise NotImplementedError
+
     def _new_tbl(self):
         return CT_Tbl.new()
 
@@ -412,6 +424,21 @@ def _span_to_width(self, grid_width, top_tc, vMerge):
         the vMerge element on the single remaining cell is set to *vMerge*.
         If *vMerge* is |None|, the vMerge element is removed if present.
         """
+        self._move_content_to(top_tc)
+        while self.grid_span < grid_width:
+            self._swallow_next_tc(grid_width, top_tc)
+        self.vMerge = vMerge
+
+    def _swallow_next_tc(self, grid_width, top_tc):
+        """
+        Extend the horizontal span of this `w:tc` element to incorporate the
+        following `w:tc` element in the row and then delete that following
+        `w:tc` element. Any content in the following `w:tc` element is
+        appended to the content of *top_tc*. The width of the following
+        `w:tc` element is added to this one, if present. Raises
+        |InvalidSpanError| if the width of the resulting cell is greater than
+        *grid_width* or if there is no next `<w:tc>` element in the row.
+        """
         raise NotImplementedError
 
     @property
@@ -515,6 +542,12 @@ def vMerge_val(self):
             return None
         return vMerge.val
 
+    @vMerge_val.setter
+    def vMerge_val(self, value):
+        self._remove_vMerge()
+        if value is not None:
+            self._add_vMerge().val = value
+
     @property
     def width(self):
         """

tests/oxml/test_table.py

@@ -66,6 +66,13 @@ def it_can_grow_itself_to_help_merge(self, grow_to_fixture):
         tc._grow_to(width, height, top_tc)
         assert tc._span_to_width.call_args_list == expected_calls
 
+    def it_can_extend_its_horz_span_to_help_merge(self, span_width_fixture):
+        tc, grid_width, top_tc, vMerge, expected_calls = span_width_fixture
+        tc._span_to_width(grid_width, top_tc, vMerge)
+        tc._move_content_to.assert_called_once_with(top_tc)
+        assert tc._swallow_next_tc.call_args_list == expected_calls
+        assert tc.vMerge == vMerge
+
     def it_raises_on_tr_above(self, tr_above_raise_fixture):
         tc = tr_above_raise_fixture
         with pytest.raises(ValueError):
@@ -154,9 +161,20 @@ def span_raise_fixture(self, request):
         tbl = self._snippet_tbl(snippet_idx)
         tc = tbl.tr_lst[row].tc_lst[col]
         tc_2 = tbl.tr_lst[row_2].tc_lst[col_2]
-        print(tc.top, tc_2.top, tc.bottom, tc_2.bottom)
         return tc, tc_2
 
+    @pytest.fixture
+    def span_width_fixture(
+            self, top_tc_, grid_span_, _move_content_to_, _swallow_next_tc_):
+        tc = element('w:tc')
+        grid_span_.side_effect = [1, 3, 4]
+        grid_width, vMerge = 4, 'continue'
+        expected_calls = [
+            call(grid_width, top_tc_),
+            call(grid_width, top_tc_)
+        ]
+        return tc, grid_width, top_tc_, vMerge, expected_calls
+
     @pytest.fixture(params=[(0, 0, 0), (4, 0, 0)])
     def tr_above_raise_fixture(self, request):
         snippet_idx, row_idx, col_idx = request.param
@@ -166,10 +184,18 @@ def tr_above_raise_fixture(self, request):
 
     # fixture components ---------------------------------------------
 
+    @pytest.fixture
+    def grid_span_(self, request):
+        return property_mock(request, CT_Tc, 'grid_span')
+
     @pytest.fixture
     def _grow_to_(self, request):
         return method_mock(request, CT_Tc, '_grow_to')
 
+    @pytest.fixture
+    def _move_content_to_(self, request):
+        return method_mock(request, CT_Tc, '_move_content_to')
+
     @pytest.fixture
     def _span_dimensions_(self, request):
         return method_mock(request, CT_Tc, '_span_dimensions')
@@ -185,6 +211,10 @@ def _snippet_tbl(self, idx):
         """
         return parse_xml(snippet_seq('tbl-cells')[idx])
 
+    @pytest.fixture
+    def _swallow_next_tc_(self, request):
+        return method_mock(request, CT_Tc, '_swallow_next_tc')
+
     @pytest.fixture
     def _tbl_(self, request):
         return property_mock(request, CT_Tc, '_tbl')