run: remove direct access to Run bool props

Steve Canny · Steve Canny · commit 208a9cf5c93a · 2015-02-08T00:01:41.000-08:00
Access via Run.font instead.
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -10,51 +10,6 @@
 from ..shared import ElementProxy, Parented
 
 
-def boolproperty(f):
-    """
-    @boolproperty decorator. Decorated method must return the XML element
-    name of the boolean property element occuring under rPr. Causes
-    a read/write tri-state property to be added to the class having the name
-    of the decorated function.
-    """
-    def _get_prop_value(parent, attr_name):
-        return getattr(parent, attr_name)
-
-    def _remove_prop(parent, attr_name):
-        remove_method_name = '_remove_%s' % attr_name
-        remove_method = getattr(parent, remove_method_name)
-        remove_method()
-
-    def _add_prop(parent, attr_name):
-        add_method_name = '_add_%s' % attr_name
-        add_method = getattr(parent, add_method_name)
-        return add_method()
-
-    def getter(obj):
-        r, attr_name = obj._r, f(obj)
-        if r.rPr is None:
-            return None
-        prop_value = _get_prop_value(r.rPr, attr_name)
-        if prop_value is None:
-            return None
-        return prop_value.val
-
-    def setter(obj, value):
-        if value not in (True, False, None):
-            raise ValueError(
-                "assigned value must be True, False, or None, got '%s'"
-                % value
-            )
-        r, attr_name = obj._r, f(obj)
-        rPr = r.get_or_add_rPr()
-        _remove_prop(rPr, attr_name)
-        if value is not None:
-            elm = _add_prop(rPr, attr_name)
-            elm.val = value
-
-    return property(getter, setter, doc=f.__doc__)
-
-
 class Run(Parented):
     """
     Proxy object wrapping ``<w:r>`` element. Several of the properties on Run
@@ -136,13 +91,6 @@ def add_text(self, text):
         t = self._r.add_t(text)
         return _Text(t)
 
-    @boolproperty
-    def all_caps(self):
-        """
-        Read/write. Causes the text of the run to appear in capital letters.
-        """
-        return 'caps'
-
     @property
     def bold(self):
         """
@@ -162,47 +110,6 @@ def clear(self):
         self._r.clear_content()
         return self
 
-    @boolproperty
-    def complex_script(self):
-        """
-        Read/write tri-state value. When |True|, causes the characters in the
-        run to be treated as complex script regardless of their Unicode
-        values.
-        """
-        return 'cs'
-
-    @boolproperty
-    def cs_bold(self):
-        """
-        Read/write tri-state value. When |True|, causes the complex script
-        characters in the run to be displayed in bold typeface.
-        """
-        return 'bCs'
-
-    @boolproperty
-    def cs_italic(self):
-        """
-        Read/write tri-state value. When |True|, causes the complex script
-        characters in the run to be displayed in italic typeface.
-        """
-        return 'iCs'
-
-    @boolproperty
-    def double_strike(self):
-        """
-        Read/write tri-state value. When |True|, causes the text in the run
-        to appear with double strikethrough.
-        """
-        return 'dstrike'
-
-    @boolproperty
-    def emboss(self):
-        """
-        Read/write tri-state value. When |True|, causes the text in the run
-        to appear as if raised off the page in relief.
-        """
-        return 'emboss'
-
     @property
     def font(self):
         """
@@ -211,15 +118,6 @@ def font(self):
         """
         return Font(self._element)
 
-    @boolproperty
-    def hidden(self):
-        """
-        Read/write tri-state value. When |True|, causes the text in the run
-        to be hidden from display, unless applications settings force hidden
-        text to be shown.
-        """
-        return 'vanish'
-
     @property
     def italic(self):
         """
@@ -232,94 +130,6 @@ def italic(self):
     def italic(self, value):
         self.font.italic = value
 
-    @boolproperty
-    def imprint(self):
-        """
-        Read/write tri-state value. When |True|, causes the text in the run
-        to appear as if pressed into the page.
-        """
-        return 'imprint'
-
-    @boolproperty
-    def math(self):
-        """
-        Read/write tri-state value. When |True|, specifies this run contains
-        WML that should be handled as though it was Office Open XML Math.
-        """
-        return 'oMath'
-
-    @boolproperty
-    def no_proof(self):
-        """
-        Read/write tri-state value. When |True|, specifies that the contents
-        of this run should not report any errors when the document is scanned
-        for spelling and grammar.
-        """
-        return 'noProof'
-
-    @boolproperty
-    def outline(self):
-        """
-        Read/write tri-state value. When |True| causes the characters in the
-        run to appear as if they have an outline, by drawing a one pixel wide
-        border around the inside and outside borders of each character glyph.
-        """
-        return 'outline'
-
-    @boolproperty
-    def rtl(self):
-        """
-        Read/write tri-state value. When |True| causes the text in the run
-        to have right-to-left characteristics.
-        """
-        return 'rtl'
-
-    @boolproperty
-    def shadow(self):
-        """
-        Read/write tri-state value. When |True| causes the text in the run
-        to appear as if each character has a shadow.
-        """
-        return 'shadow'
-
-    @boolproperty
-    def small_caps(self):
-        """
-        Read/write tri-state value. When |True| causes the lowercase
-        characters in the run to appear as capital letters two points smaller
-        than the font size specified for the run.
-        """
-        return 'smallCaps'
-
-    @boolproperty
-    def snap_to_grid(self):
-        """
-        Read/write tri-state value. When |True| causes the run to use the
-        document grid characters per line settings defined in the docGrid
-        element when laying out the characters in this run.
-        """
-        return 'snapToGrid'
-
-    @boolproperty
-    def spec_vanish(self):
-        """
-        Read/write tri-state value. When |True|, specifies that the given run
-        shall always behave as if it is hidden, even when hidden text is
-        being displayed in the current document. The property has a very
-        narrow, specialized use related to the table of contents. Consult the
-        spec (§17.3.2.36) for more details.
-        """
-        return 'specVanish'
-
-    @boolproperty
-    def strike(self):
-        """
-        Read/write tri-state value. When |True| causes the text in the run
-        to appear with a single horizontal line through the center of the
-        line.
-        """
-        return 'strike'
-
     @property
     def style(self):
         """
@@ -378,15 +188,6 @@ def underline(self):
     def underline(self, value):
         self.font.underline = value
 
-    @boolproperty
-    def web_hidden(self):
-        """
-        Read/write tri-state value. When |True|, specifies that the contents
-        of this run shall be hidden when the document is displayed in web
-        page view.
-        """
-        return 'webHidden'
-
 
 class Font(ElementProxy):
     """
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -163,30 +163,12 @@ def add_text_fixture(self, request, Text_):
         return run, text, expected_xml, Text_
 
     @pytest.fixture(params=[
-        ('w:r/w:rPr',                          'all_caps',       None),
-        ('w:r/w:rPr/w:caps',                   'all_caps',       True),
-        ('w:r/w:rPr/w:caps{w:val=on}',         'all_caps',       True),
-        ('w:r/w:rPr/w:caps{w:val=off}',        'all_caps',       False),
-        ('w:r/w:rPr/w:b{w:val=1}',             'bold',           True),
-        ('w:r/w:rPr/w:i{w:val=0}',             'italic',         False),
-        ('w:r/w:rPr/w:cs{w:val=true}',         'complex_script', True),
-        ('w:r/w:rPr/w:bCs{w:val=false}',       'cs_bold',        False),
-        ('w:r/w:rPr/w:iCs{w:val=on}',          'cs_italic',      True),
-        ('w:r/w:rPr/w:dstrike{w:val=off}',     'double_strike',  False),
-        ('w:r/w:rPr/w:emboss{w:val=1}',        'emboss',         True),
-        ('w:r/w:rPr/w:vanish{w:val=0}',        'hidden',         False),
-        ('w:r/w:rPr/w:i{w:val=true}',          'italic',         True),
-        ('w:r/w:rPr/w:imprint{w:val=false}',   'imprint',        False),
-        ('w:r/w:rPr/w:oMath{w:val=on}',        'math',           True),
-        ('w:r/w:rPr/w:noProof{w:val=off}',     'no_proof',       False),
-        ('w:r/w:rPr/w:outline{w:val=1}',       'outline',        True),
-        ('w:r/w:rPr/w:rtl{w:val=0}',           'rtl',            False),
-        ('w:r/w:rPr/w:shadow{w:val=true}',     'shadow',         True),
-        ('w:r/w:rPr/w:smallCaps{w:val=false}', 'small_caps',     False),
-        ('w:r/w:rPr/w:snapToGrid{w:val=on}',   'snap_to_grid',   True),
-        ('w:r/w:rPr/w:specVanish{w:val=off}',  'spec_vanish',    False),
-        ('w:r/w:rPr/w:strike{w:val=1}',        'strike',         True),
-        ('w:r/w:rPr/w:webHidden{w:val=0}',     'web_hidden',     False),
+        ('w:r/w:rPr',                  'bold',   None),
+        ('w:r/w:rPr/w:b',              'bold',   True),
+        ('w:r/w:rPr/w:b{w:val=on}',    'bold',   True),
+        ('w:r/w:rPr/w:b{w:val=off}',   'bold',   False),
+        ('w:r/w:rPr/w:b{w:val=1}',     'bold',   True),
+        ('w:r/w:rPr/w:i{w:val=0}',     'italic', False),
     ])
     def bool_prop_get_fixture(self, request):
         r_cxml, bool_prop_name, expected_value = request.param
@@ -195,52 +177,22 @@ def bool_prop_get_fixture(self, request):
 
     @pytest.fixture(params=[
         # nothing to True, False, and None ---------------------------
-        ('w:r',                             'all_caps',       True,
-         'w:r/w:rPr/w:caps'),
-        ('w:r',                             'bold',           False,
-         'w:r/w:rPr/w:b{w:val=0}'),
-        ('w:r',                             'italic',         None,
-         'w:r/w:rPr'),
+        ('w:r', 'bold',   True,  'w:r/w:rPr/w:b'),
+        ('w:r', 'bold',   False, 'w:r/w:rPr/w:b{w:val=0}'),
+        ('w:r', 'italic', None,  'w:r/w:rPr'),
         # default to True, False, and None ---------------------------
-        ('w:r/w:rPr/w:cs',                  'complex_script', True,
-         'w:r/w:rPr/w:cs'),
-        ('w:r/w:rPr/w:bCs',                 'cs_bold',        False,
-         'w:r/w:rPr/w:bCs{w:val=0}'),
-        ('w:r/w:rPr/w:iCs',                 'cs_italic',      None,
-         'w:r/w:rPr'),
+        ('w:r/w:rPr/w:b', 'bold',   True,  'w:r/w:rPr/w:b'),
+        ('w:r/w:rPr/w:b', 'bold',   False, 'w:r/w:rPr/w:b{w:val=0}'),
+        ('w:r/w:rPr/w:i', 'italic', None,  'w:r/w:rPr'),
         # True to True, False, and None ------------------------------
-        ('w:r/w:rPr/w:dstrike{w:val=1}',    'double_strike',  True,
-         'w:r/w:rPr/w:dstrike'),
-        ('w:r/w:rPr/w:emboss{w:val=on}',    'emboss',         False,
-         'w:r/w:rPr/w:emboss{w:val=0}'),
-        ('w:r/w:rPr/w:vanish{w:val=1}',     'hidden',         None,
-         'w:r/w:rPr'),
+        ('w:r/w:rPr/w:b{w:val=on}', 'bold', True,  'w:r/w:rPr/w:b'),
+        ('w:r/w:rPr/w:b{w:val=1}',  'bold', False, 'w:r/w:rPr/w:b{w:val=0}'),
+        ('w:r/w:rPr/w:b{w:val=1}',  'bold', None,  'w:r/w:rPr'),
         # False to True, False, and None -----------------------------
-        ('w:r/w:rPr/w:i{w:val=false}',      'italic',         True,
-         'w:r/w:rPr/w:i'),
-        ('w:r/w:rPr/w:imprint{w:val=0}',    'imprint',        False,
-         'w:r/w:rPr/w:imprint{w:val=0}'),
-        ('w:r/w:rPr/w:oMath{w:val=off}',    'math',           None,
-         'w:r/w:rPr'),
-        # random mix -------------------------------------------------
-        ('w:r/w:rPr/w:noProof{w:val=1}',    'no_proof',       False,
-         'w:r/w:rPr/w:noProof{w:val=0}'),
-        ('w:r/w:rPr',                       'outline',        True,
-         'w:r/w:rPr/w:outline'),
-        ('w:r/w:rPr/w:rtl{w:val=true}',     'rtl',            False,
-         'w:r/w:rPr/w:rtl{w:val=0}'),
-        ('w:r/w:rPr/w:shadow{w:val=on}',    'shadow',         True,
-         'w:r/w:rPr/w:shadow'),
-        ('w:r/w:rPr/w:smallCaps',           'small_caps',     False,
-         'w:r/w:rPr/w:smallCaps{w:val=0}'),
-        ('w:r/w:rPr/w:snapToGrid',          'snap_to_grid',   True,
-         'w:r/w:rPr/w:snapToGrid'),
-        ('w:r/w:rPr/w:specVanish',          'spec_vanish',    None,
-         'w:r/w:rPr'),
-        ('w:r/w:rPr/w:strike{w:val=foo}',   'strike',         True,
-         'w:r/w:rPr/w:strike'),
-        ('w:r/w:rPr/w:webHidden',           'web_hidden',     False,
-         'w:r/w:rPr/w:webHidden{w:val=0}'),
+        ('w:r/w:rPr/w:i{w:val=false}', 'italic', True,  'w:r/w:rPr/w:i'),
+        ('w:r/w:rPr/w:i{w:val=0}',     'italic', False,
+         'w:r/w:rPr/w:i{w:val=0}'),
+        ('w:r/w:rPr/w:i{w:val=off}',   'italic', None,  'w:r/w:rPr'),
     ])
     def bool_prop_set_fixture(self, request):
         initial_r_cxml, bool_prop_name, value, expected_cxml = request.param
@@ -397,7 +349,6 @@ def it_knows_its_typeface_name(self, name_get_fixture):
     def it_can_change_its_typeface_name(self, name_set_fixture):
         font, value, expected_xml = name_set_fixture
         font.name = value
-        print(font._element.xml)
         assert font._element.xml == expected_xml
 
     def it_knows_its_size(self, size_get_fixture):
