body: add _Body.tables

Steve Canny · Steve Canny · commit 38eaca6a1e2b · 2013-12-21T03:17:44.000-08:00
diff --git a/docx/oxml/parts.py b/docx/oxml/parts.py
@@ -49,6 +49,13 @@ def p_lst(self):
         """
         return self.findall(qn('w:p'))
 
+    @property
+    def tbl_lst(self):
+        """
+        List of <w:tbl> child elements.
+        """
+        return self.findall(qn('w:tbl'))
+
     def _append_blocklevelelt(self, block_level_elt):
         """
         Return *block_level_elt* after appending it to end of
diff --git a/docx/parts.py b/docx/parts.py
@@ -7,6 +7,7 @@
 from docx.opc.oxml import serialize_part_xml
 from docx.opc.package import Part
 from docx.oxml.shared import oxml_fromstring
+from docx.table import Table
 from docx.text import Paragraph
 
 
@@ -63,3 +64,11 @@ def clear_content(self):
     @property
     def paragraphs(self):
         return [Paragraph(p) for p in self._body.p_lst]
+
+    @property
+    def tables(self):
+        """
+        A sequence containing all the tables in the document, in the order
+        they appear.
+        """
+        return [Table(tbl) for tbl in self._body.tbl_lst]
diff --git a/docx/table.py b/docx/table.py
@@ -7,5 +7,8 @@
 
 class Table(object):
     """
-    Proxy class for a WordprocessingML table.
+    Proxy class for a WordprocessingML ``<w:tbl>`` element.
     """
+    def __init__(self, tbl_elm):
+        super(Table, self).__init__()
+        self._tbl = tbl_elm
diff --git a/features/blk-add-table.feature b/features/blk-add-table.feature
@@ -3,7 +3,6 @@ Feature: Add a table
   As an python-docx developer
   I need the ability to add a table
 
-  @wip
   Scenario: Access a table
      Given a document containing a table
       Then I can access the table
diff --git a/tests/oxml/unitdata/table.py b/tests/oxml/unitdata/table.py
@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+"""
+Test data builders for text XML elements
+"""
+
+from ...unitdata import BaseBuilder
+
+
+class CT_TblBuilder(BaseBuilder):
+    __tag__ = 'w:tbl'
+    __nspfxs__ = ('w',)
+    __attrs__ = ()
+
+
+def a_tbl():
+    return CT_TblBuilder()
diff --git a/tests/test_parts.py b/tests/test_parts.py
@@ -12,9 +12,11 @@
 
 from mock import Mock
 
+from docx.table import Table
 from docx.text import Paragraph
 
 from .oxml.unitdata.parts import a_body
+from .oxml.unitdata.table import a_tbl
 from .oxml.unitdata.text import a_p, a_sectPr
 from .unitutil import class_mock, function_mock, initializer_mock
 
@@ -90,7 +92,6 @@ def it_can_clear_itself_of_all_content_it_holds(
         body, expected_xml = clear_content_fixture
         _body = body.clear_content()
         assert body._body.xml == expected_xml
-        print(body._body.xml)
         assert _body is body
 
     def it_provides_access_to_the_paragraphs_it_contains(
@@ -101,6 +102,14 @@ def it_provides_access_to_the_paragraphs_it_contains(
         for p in paragraphs:
             assert isinstance(p, Paragraph)
 
+    def it_provides_access_to_the_tables_it_contains(
+            self, body_with_tables):
+        body = body_with_tables
+        tables = body.tables
+        assert len(tables) == 2
+        for table in tables:
+            assert isinstance(table, Table)
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -136,6 +145,16 @@ def body_with_paragraphs(self):
         )
         return _Body(body_elm)
 
+    @pytest.fixture
+    def body_with_tables(self):
+        body_elm = (
+            a_body().with_nsdecls()
+                    .with_child(a_tbl())
+                    .with_child(a_tbl())
+                    .element
+        )
+        return _Body(body_elm)
+
     @pytest.fixture(params=[False, True])
     def clear_content_fixture(self, request):
         has_sectPr = request.param
