table: cell: added<w:tcPr>

Can now set column spans and cell shading properties.

Author: onlyjus

docx/oxml/__init__.py

@@ -12,7 +12,7 @@
 # custom element class mappings
 # ===========================================================================
 
-from docx.oxml.shared import CT_DecimalNumber, CT_OnOff, CT_String
+from docx.oxml.shared import CT_DecimalNumber, CT_OnOff, CT_String, CT_Shading
 
 from docx.oxml.shape import (
     CT_Blip, CT_BlipFillProperties, CT_GraphicalObject,
@@ -53,6 +53,8 @@
 register_custom_element_class('w:tc', CT_Tc)
 register_custom_element_class('w:tr', CT_Row)
 register_custom_element_class('w:tcPr', CT_TcPr)
+register_custom_element_class('w:gridSpan', CT_DecimalNumber)
+register_custom_element_class('w:shd', CT_Shading)
 
 from docx.oxml.text import CT_Br, CT_P, CT_PPr, CT_R, CT_RPr, CT_Text
 register_custom_element_class('w:b', CT_OnOff)

docx/oxml/shared.py

@@ -340,3 +340,92 @@ def val(self):
     @val.setter
     def val(self, val):
         return self.set(qn('w:val'), val)
+        
+        
+class CT_Shading(OxmlBaseElement):
+    @classmethod
+    def new(cls, nsptagname, valDict):
+        """
+        Return a new ``CT_Shading`` element with tagname *nsptagname* and
+        attributes set by key, value pairs in  *valDict*.
+        """
+        attrsDict = {}
+        for k, v in valDict.iteritems():
+            attrsDict[qn('w:'+str(k))] = v
+        return OxmlElement(nsptagname, attrs=attrsDict)
+        
+    @property
+    def valDict(self):
+        valDict={}
+        for val in ['val','color', 'themeColor','themeTint', 'themeShade',
+                    'fill', 'themeFill', 'themeFillTint', 'themeFillSHade']:
+            valDict[val] = self.get(qn('w:'+val))
+        return valDict
+    @valDict.setter
+    def valDict(self, valDict):
+        for k, v in valDict:
+            self.set(qn('w:'+str(k)), v)
+        return
+        
+    @property
+    def val(self):
+        return self.get(qn('w:val'))
+    @val.setter
+    def val(self, val):
+        return self.set(qn('w:val'), val)
+        
+    @property
+    def color(self):
+        return self.get(qn('w:color'))
+    @color.setter
+    def color(self, color):
+        return self.set(qn('w:color'), color)
+        
+    @property
+    def themeColor(self):
+        return self.get(qn('w:themeColor'))
+    @themeColor.setter
+    def themeColor(self, themeColor):
+        return self.set(qn('w:themeColor'), themeColor)
+        
+    @property
+    def themeTint(self):
+        return self.get(qn('w:themeTint'))
+    @themeTint.setter
+    def themeTint(self, themeTint):
+        return self.set(qn('w:themeTint'), themeTint)
+    
+    @property
+    def themeShade(self):
+        return self.get(qn('w:themeShade'))
+    @themeShade.setter
+    def themeShade(self, themeShade):
+        return self.set(qn('w:themeShade'), themeShade)
+        
+    @property
+    def fill(self):
+        return self.get(qn('w:fill'))
+    @fill.setter
+    def fill(self, fill):
+        return self.set(qn('w:fill'), fill)
+        
+    @property
+    def themeFill(self):
+        return self.get(qn('w:themFill'))
+    @themeFill.setter
+    def themeFill(self, themeFill):
+        return self.set(qn('w:themeFill'), themeFill)
+        
+    @property
+    def themeFillTint(self):
+        return self.get(qn('w:themeFillTint'))
+    @themeFillTint.setter
+    def themeFillTint(self, themeFillTint):
+        return self.set(qn('w:themeFillTint'), themeFillTint)
+        
+    @property
+    def themeFillShade(self):
+        return self.get(qn('w:themeFillShade'))
+    @themeFillShade.setter
+    def themeFillShade(self, themeFillShade):
+        return self.set(qn('w:themeFillShade'), themeFillShade)

docx/oxml/table.py

@@ -9,7 +9,7 @@
 from docx.oxml.shared import OxmlBaseElement, OxmlElement, qn
 
 from .exceptions import ValidationError
-from .shared import CT_String
+from .shared import CT_String, CT_DecimalNumber, CT_Shading
 from .text import CT_P
 
 
@@ -286,7 +286,7 @@ def add_gridSpan(self, span):
         Return a new <w:gridSpan> element newly inserted in sequence among
         the existing child elements.gridSpan
         """
-        gridSpan = CT_String.new('w:gridSpan', str(span))
+        gridSpan = CT_DecimalNumber.new('w:gridSpan', span)
         self.append(gridSpan) # append or insert?
         return gridSpan
 
@@ -297,21 +297,21 @@ def gridSpan(self):
         """
         return self.find(qn('w:gridSpan'))
 
-    def add_gridSpan(self, span):
+    def add_shading(self, argDict):
         """
-        Return a new <w:gridSpan> element newly inserted in sequence among
+        Return a new <w:shd> element newly inserted in sequence among
         the existing child elements.gridSpan
         """
-        gridSpan = CT_String.new('w:gridSpan', str(span))
-        self.append(gridSpan) # append or insert?
-        return gridSpan
+        shading = CT_Shading.new('w:shd', argDict)
+        self.append(shading) # append or insert?
+        return shading
 
     @property
-    def gridSpan(self):
+    def shading(self):
         """
-        Optional <w:gridSpan> child element, or |None| if not present.
+        Optional <w:shd> child element, or |None| if not present.
         """
-        return self.find(qn('w:gridSpan'))
+        return self.find(qn('w:shd'))
 
 
 

docx/table.py

@@ -130,7 +130,51 @@ def colSpan(self, val):
         if span is None:
             self._tc.get_or_add_tcPr().add_gridSpan(val)
         else:
-            span.val = val  
+            span.val = val
+            
+    @property
+    def shading(self):
+        """
+        Set the cell shading.
+        """
+        shading = self._tc.get_or_add_tcPr().shading
+        if shading is None:
+            return None
+        return shading.valDict
+        
+    @shading.setter
+    def shading(self, valDict):
+        shading = self._tc.get_or_add_tcPr().shading
+        if shading is None:
+            self._tc.get_or_add_tcPr().add_shading(valDict)
+        else:
+            shading.valDict = valDict
+            
+    def set_shading(self, val = None, color = None, themeColor = None,
+                    themeTint = None, themeShade = None, fill = None, 
+                    themeFill = None, themeFillTint = None, 
+                    themeFillShade = None, argDict = None):
+        """
+        Convienence method for setting individual values of the shading dict.
+        It only replaces values that are not `None`.
+        """
+        if self.shading is None:
+            valDict = {}
+            
+        argDict = {'val':val,'color':color, 'themeColor':themeColor,
+                       'themeTint':themeTint, 'themeShade':themeShade,
+                       'fill':fill, 'themeFill':themeFill,
+                       'themeFillTint':themeFillTint,
+                       'themeFillShade':themeFillShade,
+                       }
+                       
+        for k, v in argDict.iteritems():
+            if v is not None:
+                valDict[k]=v
+                
+        self.shading = valDict
+            
+                       
 
 class _Column(object):
     """

tests/test_text.py

@@ -269,7 +269,7 @@ def bool_prop_get_fixture(self, request):
         ('snap_to_grid', True), ('snap_to_grid', False),
         ('snap_to_grid', None),
         ('spec_vanish', True), ('spec_vanish', False), ('spec_vanish', None),
-        ('strike', True), ('strike', False), ('strike', None),
+        ('strike', True), ('strikregister_custom_element_class('w:tcPr', CT_TcPr)e', False), ('strike', None),
         ('web_hidden', True), ('web_hidden', False), ('web_hidden', None),
     ])
     def bool_prop_set_fixture(self, request):