tbl: add Table.rows

Steve Canny · Steve Canny · commit a03a35da4276 · 2013-12-21T23:20:57.000-08:00
Also migrate _tbl_bldr() methods to module level so they can be shared
by Describe_RowCollection.
diff --git a/docx/table.py b/docx/table.py
@@ -4,6 +4,10 @@
 The |Table| object and related proxy classes.
 """
 
+from __future__ import absolute_import, print_function, unicode_literals
+
+from .shared import lazyproperty
+
 
 class Table(object):
     """
@@ -33,6 +37,10 @@ def add_row(self):
             tr.add_tc()
         return _Row(tr)
 
+    @lazyproperty
+    def rows(self):
+        return _RowCollection(self._tbl)
+
 
 class _Column(object):
     """
@@ -50,3 +58,12 @@ class _Row(object):
     def __init__(self, tr):
         super(_Row, self).__init__()
         self._tr = tr
+
+
+class _RowCollection(object):
+    """
+    Sequence of |_Row| instances corresponding to the rows in a table.
+    """
+    def __init__(self, tbl):
+        super(_RowCollection, self).__init__()
+        self._tbl = tbl
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -8,14 +8,19 @@
 
 import pytest
 
-from docx.table import _Column, _Row, Table
+from docx.table import _Column, _Row, _RowCollection, Table
 
 from .oxml.unitdata.table import a_gridCol, a_tbl, a_tblGrid, a_tc, a_tr
 from .oxml.unitdata.text import a_p
 
 
 class DescribeTable(object):
 
+    def it_provides_access_to_the_table_rows(self, row_access_fixture):
+        table = row_access_fixture
+        rows = table.rows
+        assert isinstance(rows, _RowCollection)
+
     def it_can_add_a_column(self, add_column_fixture):
         table, expected_xml = add_column_fixture
         col = table.add_column()
@@ -32,34 +37,45 @@ def it_can_add_a_row(self, add_row_fixture):
 
     @pytest.fixture
     def add_column_fixture(self):
-        tbl = self._tbl_bldr(2, 1).element
+        tbl = _tbl_bldr(2, 1).element
         table = Table(tbl)
-        expected_xml = self._tbl_bldr(2, 2).xml()
+        expected_xml = _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
+        tbl = _tbl_bldr(rows=1, cols=2).element
         table = Table(tbl)
-        expected_xml = self._tbl_bldr(rows=2, cols=2).xml()
+        expected_xml = _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):
-            tblGrid_bldr.with_child(a_gridCol())
-        tbl_bldr = a_tbl().with_nsdecls().with_child(tblGrid_bldr)
-        for i in range(rows):
-            tr_bldr = self._tr_bldr(cols)
-            tbl_bldr.with_child(tr_bldr)
-        return tbl_bldr
-
-    def _tc_bldr(self):
-        return a_tc().with_child(a_p())
-
-    def _tr_bldr(self, cols):
-        tr_bldr = a_tr()
-        for i in range(cols):
-            tc_bldr = self._tc_bldr()
-            tr_bldr.with_child(tc_bldr)
-        return tr_bldr
+    @pytest.fixture
+    def row_access_fixture(self):
+        tbl = _tbl_bldr(rows=2, cols=2).element
+        table = Table(tbl)
+        return table
+
+
+# fixtures -----------------------------------------------------------
+
+def _tbl_bldr(rows, cols):
+    tblGrid_bldr = a_tblGrid()
+    for i in range(cols):
+        tblGrid_bldr.with_child(a_gridCol())
+    tbl_bldr = a_tbl().with_nsdecls().with_child(tblGrid_bldr)
+    for i in range(rows):
+        tr_bldr = _tr_bldr(cols)
+        tbl_bldr.with_child(tr_bldr)
+    return tbl_bldr
+
+
+def _tc_bldr():
+    return a_tc().with_child(a_p())
+
+
+def _tr_bldr(cols):
+    tr_bldr = a_tr()
+    for i in range(cols):
+        tc_bldr = _tc_bldr()
+        tr_bldr.with_child(tc_bldr)
+    return tr_bldr
