tbl: add Table.style setter

Steve Canny · Steve Canny · commit b618bf988773 · 2013-12-23T12:14:34.000-08:00
diff --git a/docs/dev/analysis/features/table.rst b/docs/dev/analysis/features/table.rst
@@ -165,17 +165,7 @@ Schema Definitions
     </xsd:sequence>
   </xsd:complexType>
 
-  <xsd:complexType name="CT_TblPr">
-    <xsd:complexContent>
-      <xsd:extension base="CT_TblPrBase">
-        <xsd:sequence>
-          <xsd:element name="tblPrChange" type="CT_TblPrChange" minOccurs="0"/>
-        </xsd:sequence>
-      </xsd:extension>
-    </xsd:complexContent>
-  </xsd:complexType>
-
-  <xsd:complexType name="CT_TblPrBase">
+  <xsd:complexType name="CT_TblPr">  <!-- denormalized -->
     <xsd:sequence>
       <xsd:element name="tblStyle"            type="CT_String"        minOccurs="0"/>
       <xsd:element name="tblpPr"              type="CT_TblPPr"        minOccurs="0" maxOccurs="1"/>
@@ -194,8 +184,8 @@ Schema Definitions
       <xsd:element name="tblLook"             type="CT_TblLook"       minOccurs="0" maxOccurs="1"/>
       <xsd:element name="tblCaption"          type="CT_String"        minOccurs="0" maxOccurs="1"/>
       <xsd:element name="tblDescription"      type="CT_String"        minOccurs="0" maxOccurs="1"/>
+      <xsd:element name="tblPrChange"         type="CT_TblPrChange"   minOccurs="0"/>
     </xsd:sequence>
-  </xsd:complexType>
 
   <xsd:complexType name="CT_TblWidth">
     <xsd:attribute name="w"    type="ST_MeasurementOrPercent"/>
diff --git a/docx/oxml/shared.py b/docx/oxml/shared.py
@@ -98,6 +98,14 @@ class CT_String(OxmlBaseElement):
     Used for ``<w:pStyle>`` and ``<w:tblStyle>`` elements and others,
     containing a style name in its ``val`` attribute.
     """
+    @classmethod
+    def new(cls, nsptagname, val):
+        """
+        Return a new ``CT_String`` element with tagname *nsptagname* and
+        ``val`` attribute set to *val*.
+        """
+        return OxmlElement(nsptagname, attrs={qn('w:val'): val})
+
     @classmethod
     def new_pStyle(cls, val):
         """
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -9,6 +9,7 @@
 from docx.oxml.shared import OxmlBaseElement, OxmlElement, qn
 
 from . import ValidationError
+from .shared import CT_String
 from .text import CT_P
 
 
@@ -170,6 +171,14 @@ class CT_TblPr(OxmlBaseElement):
     ``<w:tblPr>`` element, child of ``<w:tbl>``, holds child elements that
     define table properties such as style and borders.
     """
+    def add_tblStyle(self, style_name):
+        """
+        Return a new <w:tblStyle> element newly inserted in sequence among
+        the existing child elements, respecting the schema definition.
+        """
+        tblStyle = CT_String.new('w:tblStyle', style_name)
+        return self._insert_tblStyle(tblStyle)
+
     @classmethod
     def new(cls):
         """
@@ -184,6 +193,15 @@ def tblStyle(self):
         """
         return self.find(qn('w:tblStyle'))
 
+    def _insert_tblStyle(self, tblStyle):
+        """
+        Return *tblStyle* after inserting it in sequence among the existing
+        child elements. Assumes no ``<w:tblStyle>`` element is present.
+        """
+        assert self.tblStyle is None
+        self.insert(0, tblStyle)
+        return tblStyle
+
 
 class CT_Tc(OxmlBaseElement):
     """
diff --git a/docx/table.py b/docx/table.py
@@ -41,6 +41,14 @@ def style(self):
             return None
         return tblStyle.val
 
+    @style.setter
+    def style(self, style_name):
+        tblStyle = self._tblPr.tblStyle
+        if tblStyle is None:
+            self._tblPr.add_tblStyle(style_name)
+        else:
+            tblStyle.val = style_name
+
     @property
     def _tblPr(self):
         return self._tbl.tblPr
diff --git a/features/tbl-style.feature b/features/tbl-style.feature
@@ -7,7 +7,6 @@ Feature: Query and apply a table style
      Given a table having an applied style
       Then I can get the table style name
 
-  @wip
   Scenario: Apply table style
      Given a table
       When I apply a style to the table
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -43,6 +43,11 @@ def it_knows_its_table_style(self, table_style_fixture):
         table, style = table_style_fixture
         assert table.style == style
 
+    def it_can_apply_a_table_style_by_name(self, table_style_set_fixture):
+        table, style_name, expected_xml = table_style_set_fixture
+        table.style = style_name
+        assert table._tbl.xml == expected_xml
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
@@ -62,6 +67,21 @@ def table_style_fixture(self):
         table = Table(tbl)
         return table, style
 
+    @pytest.fixture
+    def table_style_set_fixture(self):
+        # table ------------------------
+        tbl = a_tbl().with_nsdecls().with_child(a_tblPr()).element
+        table = Table(tbl)
+        # style_name -------------------
+        style_name = 'foobar'
+        # expected_xml -----------------
+        expected_xml = (
+            a_tbl().with_nsdecls().with_child(
+                a_tblPr().with_child(
+                    a_tblStyle().with_val(style_name)))
+        ).xml()
+        return table, style_name, expected_xml
+
 
 class Describe_Cell(object):
 
