fix: python-openxml#140 warning triggered on add_heading/table()

stevecohen42 · Steve Canny · commit b28b6cda4a94 · 2015-02-10T23:47:00.000-08:00
Legacy style ids were used in Document api methods for heading styles
and default table style. Update tests, docstrings, and values to reflect
style name instead of style id.
diff --git a/docx/api.py b/docx/api.py
@@ -38,15 +38,15 @@ def __init__(self, docx=None):
     def add_heading(self, text='', level=1):
         """
         Return a heading paragraph newly added to the end of the document,
-        populated with *text* and having the heading paragraph style
-        determined by *level*. If *level* is 0, the style is set to
-        ``'Title'``. If *level* is 1 (or not present), ``'Heading1'`` is used.
-        Otherwise the style is set to ``'Heading{level}'``. If *level* is
-        outside the range 0-9, |ValueError| is raised.
+        containing *text* and having its paragraph style determined by
+        *level*. If *level* is 0, the style is set to `Title`. If *level* is
+        1 (or omitted), `Heading 1` is used. Otherwise the style is set to
+        `Heading {level}`. Raises |ValueError| if *level* is outside the
+        range 0-9.
         """
         if not 0 <= level <= 9:
             raise ValueError("level must be in range 0-9, got %d" % level)
-        style = 'Title' if level == 0 else 'Heading%d' % level
+        style = 'Title' if level == 0 else 'Heading %d' % level
         return self.add_paragraph(text, style)
 
     def add_page_break(self):
@@ -96,15 +96,14 @@ def add_section(self, start_type=WD_SECTION.NEW_PAGE):
         """
         return self._document_part.add_section(start_type)
 
-    def add_table(self, rows, cols, style='LightShading-Accent1'):
+    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._document_part.add_table(rows, cols)
-        if style:
-            table.style = style
+        table.style = style
         return table
 
     @property
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -55,11 +55,9 @@ def it_should_raise_if_not_a_Word_file(self, Package_, package_, docx_):
             Document._open(docx_)
 
     def it_can_add_a_heading(self, add_heading_fixture):
-        document, add_paragraph_, paragraph_, text, level, style = (
-            add_heading_fixture
-        )
+        document, text, level, style, paragraph_ = add_heading_fixture
         paragraph = document.add_heading(text, level)
-        add_paragraph_.assert_called_once_with(text, style)
+        document.add_paragraph.assert_called_once_with(text, style)
         assert paragraph is paragraph_
 
     def it_should_raise_on_heading_level_out_of_range(self, document):
@@ -69,11 +67,11 @@ def it_should_raise_on_heading_level_out_of_range(self, document):
             document.add_heading(level=10)
 
     def it_can_add_a_paragraph(self, add_paragraph_fixture):
-        document, document_part_, text, style, paragraph_ = (
-            add_paragraph_fixture
-        )
+        document, text, style, paragraph_ = add_paragraph_fixture
         paragraph = document.add_paragraph(text, style)
-        document_part_.add_paragraph.assert_called_once_with(text, style)
+        document._document_part.add_paragraph.assert_called_once_with(
+            text, style
+        )
         assert paragraph is paragraph_
 
     def it_can_add_a_page_break(self, add_page_break_fixture):
@@ -101,12 +99,10 @@ def it_can_add_a_section(self, add_section_fixture):
         assert section is section_
 
     def it_can_add_a_table(self, add_table_fixture):
-        document, rows, cols, style, document_part_, expected_style, table_ = (
-            add_table_fixture
-        )
+        document, rows, cols, style, table_ = add_table_fixture
         table = document.add_table(rows, cols, style)
-        document_part_.add_table.assert_called_once_with(rows, cols)
-        assert table.style == expected_style
+        document._document_part.add_table.assert_called_once_with(rows, cols)
+        assert table.style == style
         assert table == table_
 
     def it_provides_access_to_the_document_inline_shapes(self, document):
@@ -165,21 +161,25 @@ def it_creates_numbering_part_on_first_access_if_not_present(
 
     @pytest.fixture(params=[
         ('',         None),
-        ('',         'Heading1'),
-        ('foo\rbar', 'BodyText'),
+        ('',         'Heading 1'),
+        ('foo\rbar', 'Body Text'),
     ])
-    def add_paragraph_fixture(
-            self, request, document, document_part_, paragraph_):
+    def add_paragraph_fixture(self, request, document, document_part_,
+                              paragraph_):
         text, style = request.param
-        return document, document_part_, text, style, paragraph_
+        return document, text, style, paragraph_
 
-    @pytest.fixture(params=[0, 1, 2, 5, 9])
-    def add_heading_fixture(
-            self, request, document, add_paragraph_, paragraph_):
-        level = request.param
+    @pytest.fixture(params=[
+        (0, 'Title'),
+        (1, 'Heading 1'),
+        (2, 'Heading 2'),
+        (9, 'Heading 9'),
+    ])
+    def add_heading_fixture(self, request, document, add_paragraph_,
+                            paragraph_):
+        level, style = request.param
         text = 'Spam vs. Bacon'
-        style = 'Title' if level == 0 else 'Heading%d' % level
-        return document, add_paragraph_, paragraph_, text, level, style
+        return document, text, level, style, paragraph_
 
     @pytest.fixture
     def add_page_break_fixture(
@@ -199,14 +199,11 @@ def add_picture_fixture(self, request, run_, picture_):
     def add_section_fixture(self, document, start_type_, section_):
         return document, start_type_, section_
 
-    @pytest.fixture(params=[None, 'LightShading-Accent1', 'foobar'])
+    @pytest.fixture
     def add_table_fixture(self, request, document, document_part_, table_):
         rows, cols = 4, 2
-        style = expected_style = request.param
-        return (
-            document, rows, cols, style, document_part_, expected_style,
-            table_
-        )
+        style = 'Light Shading Accent 1'
+        return document, rows, cols, style, table_
 
     @pytest.fixture
     def core_props_fixture(self, document, core_properties_):
