api: add Document.tables

Steve Canny · Steve Canny · commit 885e33237a1b · 2014-01-03T23:39:55.000-08:00
diff --git a/docx/api.py b/docx/api.py
@@ -127,7 +127,7 @@ def paragraphs(self):
         """
         A list of |Paragraph| instances corresponding to the paragraphs in
         the document, in document order. Note that paragraphs within revision
-        marks such as inserted or deleted do not appear in this list.
+        marks such as ``<w:ins>`` or ``<w:del>`` do not appear in this list.
         """
         return self._document_part.paragraphs
 
@@ -138,6 +138,15 @@ def save(self, path_or_stream):
         """
         self._package.save(path_or_stream)
 
+    @property
+    def tables(self):
+        """
+        A list of |Table| instances corresponding to the tables in the
+        document, in document order. Note that tables within revision marks
+        such as ``<w:ins>`` or ``<w:del>`` do not appear in this list.
+        """
+        return self._document_part.tables
+
     @staticmethod
     def _open(docx):
         """
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -39,7 +39,7 @@ def add_table(self, rows, cols):
         Return a table having *rows* rows and *cols* columns, newly appended
         to the main document story.
         """
-        raise NotImplementedError
+        return self.body.add_table(rows, cols)
 
     @property
     def blob(self):
@@ -110,6 +110,15 @@ def part(self):
         """
         return self
 
+    @property
+    def tables(self):
+        """
+        A list of |Table| instances corresponding to the tables in the
+        document, in document order. Note that tables within revision marks
+        such as ``<w:ins>`` or ``<w:del>`` do not appear in this list.
+        """
+        raise NotImplementedError
+
 
 class _Body(object):
     """
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -76,6 +76,12 @@ def it_can_add_a_paragraph(self, add_paragraph_fixture):
         body_.add_paragraph.assert_called_once_with()
         assert p is p_
 
+    def it_can_add_a_table(self, add_table_fixture):
+        document_part, rows, cols, body_, table_ = add_table_fixture
+        table = document_part.add_table(rows, cols)
+        body_.add_table.assert_called_once_with(rows, cols)
+        assert table is table_
+
     def it_can_add_an_image_part_to_the_document(
             self, get_or_add_image_fixture):
         (document, image_descriptor_, image_parts_, relate_to_, image_part_,
@@ -129,14 +135,21 @@ def add_paragraph_fixture(self, document_part_body_, body_, p_):
         document_part = DocumentPart(None, None, None, None)
         return document_part, body_, p_
 
+    @pytest.fixture
+    def add_table_fixture(self, document_part_body_, body_, table_):
+        document_part = DocumentPart(None, None, None, None)
+        rows, cols = 2, 4
+        return document_part, rows, cols, body_, table_
+
     @pytest.fixture
     def _Body_(self, request):
         return class_mock(request, 'docx.parts.document._Body')
 
     @pytest.fixture
-    def body_(self, request, p_):
+    def body_(self, request, p_, table_):
         body_ = instance_mock(request, _Body)
         body_.add_paragraph.return_value = p_
+        body_.add_table.return_value = table_
         return body_
 
     @pytest.fixture
@@ -289,6 +302,10 @@ def serialize_part_xml_(self, request):
             request, 'docx.parts.document.serialize_part_xml'
         )
 
+    @pytest.fixture
+    def table_(self, request):
+        return instance_mock(request, Table)
+
 
 class Describe_Body(object):
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -118,6 +118,11 @@ def it_provides_access_to_the_document_paragraphs(
         paragraphs = document.paragraphs
         assert paragraphs is paragraphs_
 
+    def it_provides_access_to_the_document_tables(self, tables_fixture):
+        document, tables_ = tables_fixture
+        tables = document.tables
+        assert tables is tables_
+
     def it_can_save_the_package(self, save_fixture):
         document, package_, file_ = save_fixture
         document.save(file_)
@@ -198,13 +203,14 @@ def document(self, open_):
         return Document()
 
     @pytest.fixture
-    def document_part_(self, request, p_, paragraphs_, table_):
+    def document_part_(self, request, p_, paragraphs_, table_, tables_):
         document_part_ = instance_mock(
             request, DocumentPart, content_type=CT.WML_DOCUMENT_MAIN
         )
         document_part_.add_paragraph.return_value = p_
         document_part_.add_table.return_value = table_
         document_part_.paragraphs = paragraphs_
+        document_part_.tables = tables_
         return document_part_
 
     @pytest.fixture
@@ -269,3 +275,11 @@ def save_fixture(self, request, open_, package_):
     @pytest.fixture
     def table_(self, request):
         return instance_mock(request, Table, style=None)
+
+    @pytest.fixture
+    def tables_(self, request):
+        return instance_mock(request, list)
+
+    @pytest.fixture
+    def tables_fixture(self, document, tables_):
+        return document, tables_
