tbl: add Table.autofit getter

Steve Canny · Steve Canny · commit d571aaea4ef2 · 2014-07-13T15:01:15.000-07:00
* Fixed sequencing of w:tblPr/w:tblStyle child element, was defaulting
to unconditional append.
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -114,15 +114,17 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:type',   CT_SectType)
 
 from docx.oxml.table import (
-    CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblPr, CT_Tc
+    CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblLayoutType, CT_TblPr,
+    CT_Tc
 )
-register_element_cls('w:gridCol',  CT_TblGridCol)
-register_element_cls('w:tbl',      CT_Tbl)
-register_element_cls('w:tblGrid',  CT_TblGrid)
-register_element_cls('w:tblPr',    CT_TblPr)
-register_element_cls('w:tblStyle', CT_String)
-register_element_cls('w:tc',       CT_Tc)
-register_element_cls('w:tr',       CT_Row)
+register_element_cls('w:gridCol',   CT_TblGridCol)
+register_element_cls('w:tbl',       CT_Tbl)
+register_element_cls('w:tblGrid',   CT_TblGrid)
+register_element_cls('w:tblLayout', CT_TblLayoutType)
+register_element_cls('w:tblPr',     CT_TblPr)
+register_element_cls('w:tblStyle',  CT_String)
+register_element_cls('w:tc',        CT_Tc)
+register_element_cls('w:tr',        CT_Row)
 
 from docx.oxml.text import (
     CT_Br, CT_Jc, CT_P, CT_PPr, CT_R, CT_RPr, CT_Text, CT_Underline
diff --git a/docx/oxml/simpletypes.py b/docx/oxml/simpletypes.py
@@ -264,6 +264,18 @@ class ST_String(XsdString):
     pass
 
 
+class ST_TblLayoutType(XsdString):
+
+    @classmethod
+    def validate(cls, value):
+        cls.validate_string(value)
+        valid_values = ('fixed', 'autofit')
+        if value not in valid_values:
+            raise ValueError(
+                "must be one of %s, got '%s'" % (valid_values, value)
+            )
+
+
 class ST_TwipsMeasure(XsdUnsignedLong):
 
     @classmethod
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -8,7 +8,7 @@
 
 from . import parse_xml
 from .ns import nsdecls
-from .simpletypes import ST_TwipsMeasure
+from .simpletypes import ST_TblLayoutType, ST_TwipsMeasure
 from .xmlchemy import (
     BaseOxmlElement, OneAndOnlyOne, OneOrMore, OptionalAttribute, ZeroOrOne,
     ZeroOrMore
@@ -70,12 +70,40 @@ class CT_TblGridCol(BaseOxmlElement):
     w = OptionalAttribute('w:w', ST_TwipsMeasure)
 
 
+class CT_TblLayoutType(BaseOxmlElement):
+    """
+    ``<w:tblLayout>`` element, specifying whether column widths are fixed or
+    can be automatically adjusted based on content.
+    """
+    type = OptionalAttribute('w:type', ST_TblLayoutType)
+
+
 class CT_TblPr(BaseOxmlElement):
     """
     ``<w:tblPr>`` element, child of ``<w:tbl>``, holds child elements that
     define table properties such as style and borders.
     """
-    tblStyle = ZeroOrOne('w:tblStyle')
+    tblStyle = ZeroOrOne('w:tblStyle', successors=(
+        'w:tblpPr', 'w:tblOverlap', 'w:bidiVisual', 'w:tblStyleRowBandSize',
+        'w:tblStyleColBandSize', 'w:tblW', 'w:jc', 'w:tblCellSpacing',
+        'w:tblInd', 'w:tblBorders', 'w:shd', 'w:tblLayout', 'w:tblCellMar',
+        'w:tblLook', 'w:tblCaption', 'w:tblDescription', 'w:tblPrChange'
+    ))
+    tblLayout = ZeroOrOne('w:tblLayout', successors=(
+        'w:tblLayout', 'w:tblCellMar', 'w:tblLook', 'w:tblCaption',
+        'w:tblDescription', 'w:tblPrChange'
+    ))
+
+    @property
+    def autofit(self):
+        """
+        Return |False| if there is a ``<w:tblLayout>`` child with ``w:type``
+        attribute set to ``'fixed'``. Otherwise return |True|.
+        """
+        tblLayout = self.tblLayout
+        if tblLayout is None:
+            return True
+        return False if tblLayout.type == 'fixed' else True
 
     @property
     def style(self):
diff --git a/docx/table.py b/docx/table.py
@@ -46,6 +46,7 @@ def autofit(self):
         are adjusted in either case if total column width exceeds page width.
         Read/write boolean.
         """
+        return self._tblPr.autofit
 
     def cell(self, row_idx, col_idx):
         """
diff --git a/features/tbl-props.feature b/features/tbl-props.feature
@@ -4,7 +4,6 @@ Feature: Get and set table properties
   I need a way to get and set a table's properties
 
 
-  @wip
   Scenario Outline: Get autofit layout setting
     Given a table having an autofit layout of <autofit-setting>
      Then the reported autofit setting is <reported-autofit>
diff --git a/tests/test_table.py b/tests/test_table.py
@@ -60,6 +60,10 @@ def it_can_apply_a_table_style_by_name(self, table_style_set_fixture):
         table.style = style_name
         assert table._tbl.xml == expected_xml
 
+    def it_knows_whether_it_should_autofit(self, autofit_get_fixture):
+        table, expected_value = autofit_get_fixture
+        assert table.autofit is expected_value
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
@@ -76,6 +80,17 @@ def add_row_fixture(self):
         expected_xml = _tbl_bldr(rows=2, cols=2).xml()
         return table, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:tbl/w:tblPr',                             True),
+        ('w:tbl/w:tblPr/w:tblLayout',                 True),
+        ('w:tbl/w:tblPr/w:tblLayout{w:type=autofit}', True),
+        ('w:tbl/w:tblPr/w:tblLayout{w:type=fixed}',   False),
+    ])
+    def autofit_get_fixture(self, request):
+        tbl_cxml, expected_autofit = request.param
+        table = Table(element(tbl_cxml), None)
+        return table, expected_autofit
+
     @pytest.fixture(params=[
         ('w:tbl/w:tblPr', None),
         ('w:tbl/w:tblPr/w:tblStyle{w:val=foobar}', 'foobar'),
