tbl: add Table.style getter

Steve Canny · Steve Canny · commit 836bd552f608 · 2013-12-23T11:35:53.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -19,17 +19,21 @@ class ValidationError(Exception):
 # custom element class mappings
 # ===========================================================================
 
+from docx.oxml.shared import CT_String
+
 from docx.oxml.parts import CT_Body, CT_Document
 register_custom_element_class('w:body', CT_Body)
 register_custom_element_class('w:document', CT_Document)
 
-from docx.oxml.table import CT_Row, CT_Tbl, CT_TblGrid, CT_Tc
+from docx.oxml.table import CT_Row, CT_Tbl, CT_TblGrid, CT_TblPr, CT_Tc
 register_custom_element_class('w:tbl', CT_Tbl)
 register_custom_element_class('w:tblGrid', CT_TblGrid)
+register_custom_element_class('w:tblPr', CT_TblPr)
+register_custom_element_class('w:tblStyle', CT_String)
 register_custom_element_class('w:tc', CT_Tc)
 register_custom_element_class('w:tr', CT_Row)
 
-from docx.oxml.text import CT_P, CT_PPr, CT_R, CT_String, CT_Text
+from docx.oxml.text import CT_P, CT_PPr, CT_R, CT_Text
 register_custom_element_class('w:p', CT_P)
 register_custom_element_class('w:pPr', CT_PPr)
 register_custom_element_class('w:pStyle', CT_String)
diff --git a/docx/oxml/shared.py b/docx/oxml/shared.py
@@ -87,3 +87,29 @@ def xml(self):
         top.
         """
         return serialize_for_reading(self)
+
+
+# ===========================================================================
+# shared custom element classes
+# ===========================================================================
+
+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_pStyle(cls, val):
+        """
+        Return a new ``<w:pStyle>`` element with ``val`` attribute set to
+        *val*.
+        """
+        return OxmlElement('w:pStyle', attrs={qn('w:val'): val})
+
+    @property
+    def val(self):
+        return self.get(qn('w:val'))
+
+    @val.setter
+    def val(self, val):
+        return self.set(qn('w:val'), val)
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -78,6 +78,13 @@ def tblGrid(self):
             raise ValidationError('required w:tblGrid child not found')
         return tblGrid
 
+    @property
+    def tblPr(self):
+        tblPr = self.find(qn('w:tblPr'))
+        if tblPr is None:
+            raise ValidationError('required w:tblPr child not found')
+        return tblPr
+
     @property
     def tr_lst(self):
         """
@@ -170,6 +177,13 @@ def new(cls):
         """
         return OxmlElement('w:tblPr')
 
+    @property
+    def tblStyle(self):
+        """
+        Optional <w:tblStyle> child element, or |None| if not present.
+        """
+        return self.find(qn('w:tblStyle'))
+
 
 class CT_Tc(OxmlBaseElement):
     """
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -6,7 +6,7 @@
 """
 
 from docx.oxml.shared import (
-    nsdecls, OxmlBaseElement, OxmlElement, oxml_fromstring, qn
+    CT_String, nsdecls, OxmlBaseElement, oxml_fromstring, qn
 )
 
 
@@ -179,28 +179,6 @@ def t_lst(self):
         return self.findall(qn('w:t'))
 
 
-class CT_String(OxmlBaseElement):
-    """
-    Used for ``<w:pStyle>`` element, containing a style name in its ``val``
-    attribute.
-    """
-    @classmethod
-    def new_pStyle(cls, val):
-        """
-        Return a new ``<w:pStyle>`` element with ``val`` attribute set to
-        *val*.
-        """
-        return OxmlElement('w:pStyle', attrs={qn('w:val'): val})
-
-    @property
-    def val(self):
-        return self.get(qn('w:val'))
-
-    @val.setter
-    def val(self, val):
-        return self.set(qn('w:val'), val)
-
-
 class CT_Text(OxmlBaseElement):
     """
     ``<w:t>`` element, containing a sequence of characters within a run.
diff --git a/docx/table.py b/docx/table.py
@@ -34,6 +34,17 @@ def columns(self):
     def rows(self):
         return _RowCollection(self._tbl)
 
+    @property
+    def style(self):
+        tblStyle = self._tblPr.tblStyle
+        if tblStyle is None:
+            return None
+        return tblStyle.val
+
+    @property
+    def _tblPr(self):
+        return self._tbl.tblPr
+
 
 class _Cell(object):
     """
diff --git a/features/steps/table.py b/features/steps/table.py
@@ -185,7 +185,8 @@ def then_can_get_length_of_row_cell_collection(context):
 @then('I can get the table style name')
 def then_can_get_table_style_name(context):
     table = context.table_
-    assert table.style == 'foobar', "got '%s'" % table.style
+    msg = "got '%s'" % table.style
+    assert table.style == 'LightShading-Accent1', msg
 
 
 @then('I can iterate over the column cells')
diff --git a/features/tbl-style.feature b/features/tbl-style.feature
@@ -3,7 +3,6 @@ Feature: Query and apply a table style
   As an python-docx developer
   I need the ability to query and apply a table style
 
-  @wip
   Scenario: Access table style
      Given a table having an applied style
       Then I can get the table style name
diff --git a/tests/oxml/unitdata/shared.py b/tests/oxml/unitdata/shared.py
@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+"""
+Test data builders shared by more than one other module
+"""
+
+from ...unitdata import BaseBuilder
+
+
+class CT_StringBuilder(BaseBuilder):
+    __nspfxs__ = ('w',)
+    __attrs__ = ()
+
+    def __init__(self, tag):
+        self.__tag__ = tag
+        super(CT_StringBuilder, self).__init__()
+
+    def with_val(self, value):
+        self._set_xmlattr('w:val', str(value))
+        return self
diff --git a/tests/oxml/unitdata/table.py b/tests/oxml/unitdata/table.py
@@ -5,6 +5,7 @@
 """
 
 from ...unitdata import BaseBuilder
+from .shared import CT_StringBuilder
 
 
 class CT_RowBuilder(BaseBuilder):
@@ -59,6 +60,10 @@ def a_tblPr():
     return CT_TblPrBuilder()
 
 
+def a_tblStyle():
+    return CT_StringBuilder('w:tblStyle')
+
+
 def a_tc():
     return CT_TcBuilder()
 
diff --git a/tests/oxml/unitdata/text.py b/tests/oxml/unitdata/text.py
@@ -5,6 +5,7 @@
 """
 
 from ...unitdata import BaseBuilder
+from .shared import CT_StringBuilder
 
 
 class CT_PBuilder(BaseBuilder):
@@ -31,16 +32,6 @@ class CT_SectPrBuilder(BaseBuilder):
     __attrs__ = ()
 
 
-class CT_StringBuilder(BaseBuilder):
-    __tag__ = 'w:pStyle'
-    __nspfxs__ = ('w',)
-    __attrs__ = ()
-
-    def with_val(self, value):
-        self._set_xmlattr('w:val', str(value))
-        return self
-
-
 class CT_TextBuilder(BaseBuilder):
     __tag__ = 'w:t'
     __nspfxs__ = ('w',)
@@ -56,7 +47,7 @@ def a_pPr():
 
 
 def a_pStyle():
-    return CT_StringBuilder()
+    return CT_StringBuilder('w:pStyle')
 
 
 def a_sectPr():
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -14,7 +14,9 @@
 )
 from docx.text import Paragraph
 
-from .oxml.unitdata.table import a_gridCol, a_tbl, a_tblGrid, a_tc, a_tr
+from .oxml.unitdata.table import (
+    a_gridCol, a_tbl, a_tblGrid, a_tblPr, a_tblStyle, a_tc, a_tr
+)
 from .oxml.unitdata.text import a_p
 
 
@@ -37,6 +39,10 @@ def it_provides_access_to_a_cell_by_row_and_col_indices(self, table):
                 tc = tr.tc_lst[col_idx]
                 assert tc is cell._tc
 
+    def it_knows_its_table_style(self, table_style_fixture):
+        table, style = table_style_fixture
+        assert table.style == style
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
@@ -45,6 +51,17 @@ def table(self):
         table = Table(tbl)
         return table
 
+    @pytest.fixture
+    def table_style_fixture(self):
+        style = 'foobar'
+        tbl = (
+            a_tbl().with_nsdecls().with_child(
+                a_tblPr().with_child(
+                    a_tblStyle().with_val(style)))
+        ).element
+        table = Table(tbl)
+        return table, style
+
 
 class Describe_Cell(object):
 
