doc: add Document.tables

Steve Canny · Steve Canny · commit 8f7f4fac1949 · 2015-02-15T12:35:24.000-08:00
diff --git a/docx/document.py b/docx/document.py
@@ -154,6 +154,17 @@ def styles(self):
         """
         return self._part.styles
 
+    @property
+    def tables(self):
+        """
+        A list of |Table| instances corresponding to the tables in the
+        document, in document order. Note that only tables appearing at the
+        top level of the document appear in this list; a table nested inside
+        a table cell does not appear. A table within revision marks such as
+        ``<w:ins>`` or ``<w:del>`` will also not appear in the list.
+        """
+        return self._body.tables
+
     @property
     def _body(self):
         """
diff --git a/tests/test_document.py b/tests/test_document.py
@@ -110,6 +110,11 @@ def it_provides_access_to_its_styles(self, styles_fixture):
         document, styles_ = styles_fixture
         assert document.styles is styles_
 
+    def it_provides_access_to_its_tables(self, tables_fixture):
+        document, tables_ = tables_fixture
+        tables = document.tables
+        assert tables is tables_
+
     def it_provides_access_to_the_document_part(self, part_fixture):
         document, part_ = part_fixture
         assert document.part is part_
@@ -236,6 +241,12 @@ def styles_fixture(self, document_part_, styles_):
         document_part_.styles = styles_
         return document, styles_
 
+    @pytest.fixture
+    def tables_fixture(self, body_prop_, tables_):
+        document = Document(None, None)
+        body_prop_.return_value.tables = tables_
+        return document, tables_
+
     # fixture components ---------------------------------------------
 
     @pytest.fixture
@@ -301,3 +312,7 @@ def styles_(self, request):
     @pytest.fixture
     def table_(self, request):
         return instance_mock(request, Table, style='UNASSIGNED')
+
+    @pytest.fixture
+    def tables_(self, request):
+        return instance_mock(request, list)
