tbl: add Table.add_row()

Steve Canny · Steve Canny · commit 09a4e9b6e99c · 2013-12-21T13:55:05.000-08:00
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -24,6 +24,13 @@ def add_tc(self):
         tc = CT_Tc.new()
         return self._append_tc(tc)
 
+    @classmethod
+    def new(cls):
+        """
+        Return a new ``<w:tr>`` element.
+        """
+        return OxmlElement('w:tr')
+
     def _append_tc(self, tc):
         """
         Return *tc* after appending it to end of tc sequence.
@@ -36,6 +43,14 @@ class CT_Tbl(OxmlBaseElement):
     """
     ``<w:tbl>`` element
     """
+    def add_tr(self):
+        """
+        Return a new <w:tr> element that has been added at the end of any
+        existing tr elements.
+        """
+        tr = CT_Row.new()
+        return self._append_tr(tr)
+
     @property
     def tblGrid(self):
         tblGrid = self.find(qn('w:tblGrid'))
@@ -51,6 +66,13 @@ def tr_lst(self):
         """
         return self.findall(qn('w:tr'))
 
+    def _append_tr(self, tr):
+        """
+        Return *tr* after appending it to end of tr sequence.
+        """
+        self.append(tr)
+        return tr
+
 
 class CT_TblGrid(OxmlBaseElement):
     """
@@ -65,6 +87,14 @@ def add_gridCol(self):
         gridCol = CT_TblGridCol.new()
         return self._append_gridCol(gridCol)
 
+    @property
+    def gridCol_lst(self):
+        """
+        Sequence containing the ``<w:gridCol>`` child elements in this
+        ``<w:tblGrid>``.
+        """
+        return self.findall(qn('w:gridCol'))
+
     def _append_gridCol(self, gridCol):
         """
         Return *gridCol* after appending it to end of gridCol sequence.
diff --git a/docx/table.py b/docx/table.py
@@ -23,6 +23,16 @@ def add_column(self):
             tr.add_tc()
         return _Column(gridCol)
 
+    def add_row(self):
+        """
+        Return a |_Row| instance, newly added bottom-most to the table.
+        """
+        tbl = self._tbl
+        tr = tbl.add_tr()
+        for gridCol in tbl.tblGrid.gridCol_lst:
+            tr.add_tc()
+        return _Row(tr)
+
 
 class _Column(object):
     """
@@ -31,3 +41,12 @@ class _Column(object):
     def __init__(self, gridCol):
         super(_Column, self).__init__()
         self._gridCol = gridCol
+
+
+class _Row(object):
+    """
+    Table row
+    """
+    def __init__(self, tr):
+        super(_Row, self).__init__()
+        self._tr = tr
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -8,7 +8,7 @@
 
 import pytest
 
-from docx.table import _Column, Table
+from docx.table import _Column, _Row, Table
 
 from .oxml.unitdata.table import a_gridCol, a_tbl, a_tblGrid, a_tc, a_tr
 from .oxml.unitdata.text import a_p
@@ -19,10 +19,15 @@ class DescribeTable(object):
     def it_can_add_a_column(self, add_column_fixture):
         table, expected_xml = add_column_fixture
         col = table.add_column()
-        print('\n%s' % table._tbl.xml)
         assert table._tbl.xml == expected_xml
         assert isinstance(col, _Column)
 
+    def it_can_add_a_row(self, add_row_fixture):
+        table, expected_xml = add_row_fixture
+        row = table.add_row()
+        assert table._tbl.xml == expected_xml
+        assert isinstance(row, _Row)
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
@@ -32,6 +37,13 @@ def add_column_fixture(self):
         expected_xml = self._tbl_bldr(2, 2).xml()
         return table, expected_xml
 
+    @pytest.fixture
+    def add_row_fixture(self):
+        tbl = self._tbl_bldr(rows=1, cols=2).element
+        table = Table(tbl)
+        expected_xml = self._tbl_bldr(rows=2, cols=2).xml()
+        return table, expected_xml
+
     def _tbl_bldr(self, rows, cols):
         tblGrid_bldr = a_tblGrid()
         for i in range(cols):
