test_text: Update, cleanup

Cleaned up code to follow standards.

Author: onlyjus

docx/oxml/shared.py

@@ -342,11 +342,11 @@ def val(self, val):
         return self.set(qn('w:val'), val)
 
 
-class CT_Shading(OxmlBaseElement):
+class CT_Shd(OxmlBaseElement):
     @classmethod
     def new(cls, nsptagname, valDict):
         """
-        Return a new ``CT_Shading`` element with tagname *nsptagname* and
+        Return a new ``CT_Shd`` element with tagname *nsptagname* and
         attributes set by key, value pairs in  *valDict*.
         """
         attrsDict = {}

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, CT_DecimalNumber, CT_Shading
+from .shared import CT_String, CT_DecimalNumber, CT_Shd
 from .text import CT_P
 
 
@@ -287,7 +287,7 @@ def add_gridSpan(self, span):
         the existing child elements.gridSpan
         """
         gridSpan = CT_DecimalNumber.new('w:gridSpan', span)
-        self.append(gridSpan) # append or insert?
+        self.insert(0, gridSpan)
         return gridSpan
 
     @property
@@ -302,8 +302,8 @@ def add_shading(self, argDict):
         Return a new <w:shd> element newly inserted in sequence among
         the existing child elements.gridSpan
         """
-        shading = CT_Shading.new('w:shd', argDict)
-        self.append(shading) # append or insert?
+        shading = CT_Shd.new('w:shd', argDict)
+        self.insert(0, shading)
         return shading
 
     @property

docx/oxml/text.py

@@ -288,20 +288,7 @@ class CT_RPr(OxmlBaseElement):
     ``<w:rPr>`` element, containing the properties for a run.
     """
 
-    @property
-    def underline(self):
-        """
-        First ``<w:u>`` child element or None if none are present.
-        """
-        return self.find(qn('w:u'))
-        
-    def add_underline(self, style):
-        """
-        Return a newly added <w:u w:val=style/> child element.
-        """
-        u = CT_String.new('w:u', WD_UNDERLINE.stringDict[style])
-        self.insert(0, u)
-        return u
+    
 
     def add_b(self):
         """
@@ -462,6 +449,14 @@ def add_webHidden(self):
         webHidden = OxmlElement('w:webHidden')
         self.insert(0, webHidden)
         return webHidden
+        
+    def add_underline(self, utype):
+        """
+        Return a newly added <w:u w:val=utype/> child element.
+        """
+        u = CT_String.new('w:u', WD_UNDERLINE.stringDict[utype])
+        self.insert(0, u)
+        return u
 
     @property
     def b(self):
@@ -653,6 +648,11 @@ def remove_webHidden(self):
         webHidden_lst = self.findall(qn('w:webHidden'))
         for webHidden in webHidden_lst:
             self.remove(webHidden)
+            
+    def remove_underline(self):
+        underline_lst = self.findall(qn('w:u'))
+        for underline in underline_lst:
+            self.remove(underline)
 
     @property
     def rtl(self):
@@ -709,6 +709,13 @@ def webHidden(self):
         First ``<w:webHidden>`` child element or None if none are present.
         """
         return self.find(qn('w:webHidden'))
+        
+    @property
+    def underline(self):
+        """
+        First ``<w:u>`` child element or None if none are present.
+        """
+        return self.find(qn('w:u'))
 
 
 class CT_Text(OxmlBaseElement):

docx/table.py

@@ -156,7 +156,7 @@ def set_shading(self, val = None, color = None, themeColor = None,
                     themeFillShade = None, argDict = None):
         """
         Convienence method for setting individual values of the shading dict.
-        It only replaces values that are not `None`.
+        It only replaces values that are not None.
         """
         if self.shading is None:
             valDict = {}

docx/text.py

@@ -230,18 +230,18 @@ def underline(self):
         return u.val
 
     @underline.setter
-    def underline(self, style):
+    def underline(self, utype):
         # interperate style
-        if style is None:
-            style = WD_UNDERLINE.NONE
-        if type(style)==bool:
-            style = WD_UNDERLINE.SINGLE if style else WD_UNDERLINE.NONE
+        if utype is None:
+            utype = WD_UNDERLINE.NONE
+        if type(utype)==bool:
+            utype = WD_UNDERLINE.SINGLE if utype else WD_UNDERLINE.NONE
 
         u = self._r.get_or_add_rPr().underline
         if u is None:
-            self._r.get_or_add_rPr().add_underline(style)
+            self._r.get_or_add_rPr().add_underline(utype)
         else:
-            u.val = style
+            u.val = utype
 
     @boolproperty
     def imprint(self):

tests/oxml/unitdata/shared.py

@@ -31,3 +31,15 @@ def __init__(self, tag):
     def with_val(self, value):
         self._set_xmlattr('w:val', str(value))
         return self
+
+class CT_Underline(BaseBuilder):
+    __nspfxs__ = ('w',)
+    __attrs__ = ('w:val')
+
+    def __init__(self, tag):
+        self.__tag__ = tag
+        super(CT_Underline, self).__init__()
+
+    def with_val(self, value):
+        self._set_xmlattr('w:val', str(value))
+        return self

tests/oxml/unitdata/text.py

@@ -5,7 +5,7 @@
 """
 
 from ...unitdata import BaseBuilder
-from .shared import CT_OnOffBuilder, CT_StringBuilder
+from .shared import CT_OnOffBuilder, CT_StringBuilder, CT_Underline
 
 
 class CT_BrBuilder(BaseBuilder):
@@ -137,8 +137,8 @@ def an_emboss():
 def an_i():
     return CT_OnOffBuilder('w:i')
 
-def an_u():
-    return CT_StringBuilder('w:u')
+def a_u():
+    return CT_Underline('w:u')
 
 def an_iCs():
     return CT_OnOffBuilder('w:iCs')

tests/test_text.py

@@ -20,7 +20,7 @@
     a_b, a_bCs, a_br, a_caps, a_cs, a_dstrike, a_p, a_shadow, a_smallCaps,
     a_snapToGrid, a_specVanish, a_strike, a_t, a_vanish, a_webHidden,
     an_emboss, an_i, an_iCs, an_imprint, an_oMath, a_noProof, an_outline,
-    an_r, an_rPr, an_rtl, an_u
+    an_r, an_rPr, an_rtl, a_u
 )
 from .unitutil import class_mock, instance_mock
 
@@ -164,26 +164,26 @@ def it_knows_the_text_it_contains(self, text_prop_fixture):
     ])
     def add_underline_fixture(self, request, run):
         underline_type = {
-            'dash':WD_UNDERLINE.DASH,
-            'dashHeavy':WD_UNDERLINE.DASH_HEAVY,
-            'dashLong':WD_UNDERLINE.DASH_LONG,
-            'longHeavy':WD_UNDERLINE.LONG_HEAVY,
-            'dotDash':WD_UNDERLINE.DOT_DASH,
-            'dotDashHeavy':WD_UNDERLINE.DOT_DASH_HEAVY,
-            'dotDotDash':WD_UNDERLINE.DOT_DOT_DASH,
-            'dotDotDashHeavy':WD_UNDERLINE.DOT_DOT_DASH_HEAVY,
-            'dotted':WD_UNDERLINE.DOTTED,
-            'dottedHeavy':WD_UNDERLINE.DOTTED_HEAVY,
-            'double':WD_UNDERLINE.DOUBLE,
-            'none':WD_UNDERLINE.NONE,
-            'single':WD_UNDERLINE.SINGLE,
-            'thick':WD_UNDERLINE.THICK,
-            'wavy':WD_UNDERLINE.WAVY,
-            'wavyDouble':WD_UNDERLINE.WAVY_DOUBLE,
-            'wavyHeavy':WD_UNDERLINE.WAVY_HEAVY,
-            'words':WD_UNDERLINE.WORDS,
+            'dash':            WD_UNDERLINE.DASH,
+            'dashHeavy':       WD_UNDERLINE.DASH_HEAVY,
+            'dashLong':        WD_UNDERLINE.DASH_LONG,
+            'longHeavy':       WD_UNDERLINE.LONG_HEAVY,
+            'dotDash':         WD_UNDERLINE.DOT_DASH,
+            'dotDashHeavy':    WD_UNDERLINE.DOT_DASH_HEAVY,
+            'dotDotDash':      WD_UNDERLINE.DOT_DOT_DASH,
+            'dotDotDashHeavy': WD_UNDERLINE.DOT_DOT_DASH_HEAVY,
+            'dotted':          WD_UNDERLINE.DOTTED,
+            'dottedHeavy':     WD_UNDERLINE.DOTTED_HEAVY,
+            'double':          WD_UNDERLINE.DOUBLE,
+            'none':            WD_UNDERLINE.NONE,
+            'single':          WD_UNDERLINE.SINGLE,
+            'thick':           WD_UNDERLINE.THICK,
+            'wavy':            WD_UNDERLINE.WAVY,
+            'wavyDouble':      WD_UNDERLINE.WAVY_DOUBLE,
+            'wavyHeavy':       WD_UNDERLINE.WAVY_HEAVY,
+            'words':           WD_UNDERLINE.WORDS,
         }[request.param]
-        u_bldr = an_u()
+        u_bldr = a_u()
         expected_xml = an_r().with_nsdecls().with_child(u_bldr).xml()
         return run, underline_type, expected_xml