doc: add Document.add_table()

Steve Canny · Steve Canny · commit b00a46bf4f9c · 2015-02-14T22:54:08.000-08:00
diff --git a/docx/document.py b/docx/document.py
@@ -88,6 +88,16 @@ def add_section(self, start_type=WD_SECTION.NEW_PAGE):
         new_sectPr.start_type = start_type
         return Section(new_sectPr)
 
+    def add_table(self, rows, cols, style='Light Shading Accent 1'):
+        """
+        Add a table having row and column counts of *rows* and *cols*
+        respectively and table style of *style*. If *style* is |None|, a
+        table with no style is produced.
+        """
+        table = self._body.add_table(rows, cols)
+        table.style = style
+        return table
+
     @property
     def part(self):
         """
diff --git a/tests/test_document.py b/tests/test_document.py
@@ -15,6 +15,7 @@
 from docx.enum.text import WD_BREAK
 from docx.parts.document import DocumentPart
 from docx.shape import InlineShape
+from docx.table import Table
 from docx.text.paragraph import Paragraph
 from docx.text.run import Run
 
@@ -70,6 +71,13 @@ def it_can_add_a_section(self, add_section_fixture):
         Section_.assert_called_once_with(sectPr)
         assert section is section_
 
+    def it_can_add_a_table(self, add_table_fixture):
+        document, rows, cols, style, table_ = add_table_fixture
+        table = document.add_table(rows, cols, style)
+        document._body.add_table.assert_called_once_with(rows, cols)
+        assert table == table_
+        assert table.style == style
+
     def it_provides_access_to_the_document_part(self, part_fixture):
         document, part_ = part_fixture
         assert document.part is part_
@@ -140,6 +148,13 @@ def add_section_fixture(self, request, Section_):
         section_ = Section_.return_value
         return document, start_type, Section_, section_, expected_xml
 
+    @pytest.fixture
+    def add_table_fixture(self, body_prop_, table_):
+        document = Document(None, None)
+        rows, cols, style = 4, 2, 'Light Shading Accent 1'
+        body_prop_.return_value.add_table.return_value = table_
+        return document, rows, cols, style, table_
+
     @pytest.fixture
     def body_fixture(self, _Body_, body_):
         document_elm = element('w:document/w:body')
@@ -167,8 +182,8 @@ def body_(self, request):
         return instance_mock(request, _Body)
 
     @pytest.fixture
-    def body_prop_(self, request):
-        return property_mock(request, Document, '_body')
+    def body_prop_(self, request, body_):
+        return property_mock(request, Document, '_body', return_value=body_)
 
     @pytest.fixture
     def document_part_(self, request):
@@ -189,3 +204,7 @@ def run_(self, request):
     @pytest.fixture
     def Section_(self, request):
         return class_mock(request, 'docx.document.Section')
+
+    @pytest.fixture
+    def table_(self, request):
+        return instance_mock(request, Table, style='UNASSIGNED')
