tbl: add _Cell.add_table()

Steve Canny · Steve Canny · commit 2214533fe1ef · 2014-07-18T00:21:08.000-07:00
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -165,6 +165,7 @@ class CT_Tc(BaseOxmlElement):
     """
     tcPr = ZeroOrOne('w:tcPr')  # bunches of successors, overriding insert
     p = OneOrMore('w:p')
+    tbl = OneOrMore('w:tbl')
 
     def _insert_tcPr(self, tcPr):
         """
@@ -175,13 +176,16 @@ def _insert_tcPr(self, tcPr):
         self.insert(0, tcPr)
         return tcPr
 
+    def _new_tbl(self):
+        return CT_Tbl.new()
+
     def clear_content(self):
         """
         Remove all content child elements, preserving the ``<w:tcPr>``
         element if present. Note that this leaves the ``<w:tc>`` element in
         an invalid state because it doesn't contain at least one block-level
-        element. It's up to the caller to add a ``<w:p>`` or ``<w:tbl>``
-        child element.
+        element. It's up to the caller to add a ``<w:p>``child element as the
+        last content element.
         """
         new_children = []
         tcPr = self.tcPr
diff --git a/docx/table.py b/docx/table.py
@@ -114,6 +114,17 @@ def add_paragraph(self, text='', style=None):
         """
         return super(_Cell, self).add_paragraph(text, style)
 
+    def add_table(self, rows, cols):
+        """
+        Return a table newly added to this cell after any existing cell
+        content, having *rows* rows and *cols* columns. An empty paragraph is
+        added after the table because Word requires a paragraph element as
+        the last element in every cell.
+        """
+        new_table = super(_Cell, self).add_table(rows, cols)
+        self.add_paragraph()
+        return new_table
+
     @property
     def paragraphs(self):
         """
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -157,6 +157,12 @@ def it_can_add_a_paragraph(self, add_paragraph_fixture):
         assert cell._tc.xml == expected_xml
         assert isinstance(p, Paragraph)
 
+    def it_can_add_a_table(self, add_table_fixture):
+        cell, expected_xml = add_table_fixture
+        table = cell.add_table(rows=0, cols=0)
+        assert cell._tc.xml == expected_xml
+        assert isinstance(table, Table)
+
     def it_provides_access_to_the_paragraphs_it_contains(
             self, paragraphs_fixture):
         cell = paragraphs_fixture
@@ -198,6 +204,21 @@ def add_paragraph_fixture(self, request):
         expected_xml = xml(after_tc_cxml)
         return cell, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:tc',     'w:tc/(w:tbl'),
+        ('w:tc/w:p', 'w:tc/(w:p, w:tbl'),
+    ])
+    def add_table_fixture(self, request):
+        tc_cxml, after_tc_cxml = request.param
+        # the table has some overhead elements, also a blank para after since
+        # it's in a cell.
+        after_tc_cxml += (
+            '/(w:tblPr/w:tblW{w:type=auto,w:w=0},w:tblGrid),w:p)'
+        )
+        cell = _Cell(element(tc_cxml), None)
+        expected_xml = xml(after_tc_cxml)
+        return cell, expected_xml
+
     @pytest.fixture
     def paragraphs_fixture(self):
         return _Cell(element('w:tc/(w:p, w:p)'), None)
