text: add Run.bold getter

Steve Canny · Steve Canny · commit b08f691190a7 · 2014-01-04T06:52:06.000-08:00
Along the way:

* extract oxml exceptions to docx.oxml.exceptions to avoid import loop
diff --git a/docs/dev/analysis/features/run-properties.rst b/docs/dev/analysis/features/run-properties.rst
@@ -87,7 +87,7 @@ below when it writes the file.::
   <xsd:complexType name="CT_R">  <!-- denormalized -->
     <xsd:sequence>
       <xsd:element name="rPr" type="CT_RPr" minOccurs="0"/>
-      <xsd:group   ref="EG_RunInnerContent"   minOccurs="0" maxOccurs="unbounded"/>
+      <xsd:group   ref="EG_RunInnerContent" minOccurs="0" maxOccurs="unbounded"/>
     </xsd:sequence>
     <xsd:attribute name="rsidRPr" type="ST_LongHexNumber"/>
     <xsd:attribute name="rsidDel" type="ST_LongHexNumber"/>
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -8,18 +8,11 @@
 from docx.oxml.shared import register_custom_element_class
 
 
-class ValidationError(Exception):
-    """
-    Raised when invalid XML is encountered, such as on attempt to access a
-    missing required child element
-    """
-
-
 # ===========================================================================
 # custom element class mappings
 # ===========================================================================
 
-from docx.oxml.shared import CT_String
+from docx.oxml.shared import CT_OnOff, CT_String
 
 from docx.oxml.shape import (
     CT_Blip, CT_BlipFillProperties, CT_GraphicalObject,
@@ -45,10 +38,12 @@ class ValidationError(Exception):
 register_custom_element_class('w:tc', CT_Tc)
 register_custom_element_class('w:tr', CT_Row)
 
-from docx.oxml.text import CT_Br, CT_P, CT_PPr, CT_R, CT_Text
+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)
 register_custom_element_class('w:br', CT_Br)
 register_custom_element_class('w:p', CT_P)
 register_custom_element_class('w:pPr', CT_PPr)
 register_custom_element_class('w:pStyle', CT_String)
 register_custom_element_class('w:r', CT_R)
+register_custom_element_class('w:rPr', CT_RPr)
 register_custom_element_class('w:t', CT_Text)
diff --git a/docx/oxml/exceptions.py b/docx/oxml/exceptions.py
@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+"""
+Exceptions for oxml sub-package
+"""
+
+
+class ValidationError(Exception):
+    """
+    Raised when invalid XML is encountered, such as on attempt to access a
+    missing required child element
+    """
diff --git a/docx/oxml/shared.py b/docx/oxml/shared.py
@@ -6,6 +6,8 @@
 
 from lxml import etree
 
+from .exceptions import ValidationError
+
 
 nsmap = {
     'a':   ('http://schemas.openxmlformats.org/drawingml/2006/main'),
@@ -168,6 +170,23 @@ def xml(self):
         return serialize_for_reading(self)
 
 
+class CT_OnOff(OxmlBaseElement):
+    """
+    Used for ``<w:b>``, ``<w:i>`` elements and others, containing a bool-ish
+    string in its ``val`` attribute, xsd:boolean plus 'on' and 'off'.
+    """
+    @property
+    def val(self):
+        val = self.get(qn('w:val'))
+        if val is None:
+            return True
+        elif val in ('0', 'false', 'off'):
+            return False
+        elif val in ('1', 'true', 'on'):
+            return True
+        raise ValidationError("expected xsd:boolean, got '%s'" % val)
+
+
 class CT_String(OxmlBaseElement):
     """
     Used for ``<w:pStyle>`` and ``<w:tblStyle>`` elements and others,
diff --git a/docx/oxml/table.py b/docx/oxml/table.py
@@ -8,7 +8,7 @@
 
 from docx.oxml.shared import OxmlBaseElement, OxmlElement, qn
 
-from . import ValidationError
+from .exceptions import ValidationError
 from .shared import CT_String
 from .text import CT_P
 
diff --git a/docx/oxml/text.py b/docx/oxml/text.py
@@ -216,6 +216,13 @@ def new(cls):
         """
         return OxmlElement('w:r')
 
+    @property
+    def rPr(self):
+        """
+        ``<w:rPr>`` child element or None if not present.
+        """
+        return self.find(qn('w:rPr'))
+
     @property
     def t_lst(self):
         """
@@ -224,6 +231,18 @@ def t_lst(self):
         return self.findall(qn('w:t'))
 
 
+class CT_RPr(OxmlBaseElement):
+    """
+    ``<w:rPr>`` element, containing the properties for a run.
+    """
+    @property
+    def b(self):
+        """
+        First ``<w:b>`` child element or None if none are present.
+        """
+        return self.find(qn('w:b'))
+
+
 class CT_Text(OxmlBaseElement):
     """
     ``<w:t>`` element, containing a sequence of characters within a run.
diff --git a/docx/text.py b/docx/text.py
@@ -98,7 +98,13 @@ def bold(self):
         |None|, the run will inherit its bold setting from its style
         hierarchy.
         """
-        raise NotImplementedError
+        rPr = self._r.rPr
+        if rPr is None:
+            return None
+        b = rPr.b
+        if b is None:
+            return None
+        return b.val
 
     @property
     def text(self):
diff --git a/tests/oxml/unitdata/shared.py b/tests/oxml/unitdata/shared.py
@@ -7,6 +7,19 @@
 from ...unitdata import BaseBuilder
 
 
+class CT_OnOffBuilder(BaseBuilder):
+    __nspfxs__ = ('w',)
+    __attrs__ = ('w:val')
+
+    def __init__(self, tag):
+        self.__tag__ = tag
+        super(CT_OnOffBuilder, self).__init__()
+
+    def with_val(self, value):
+        self._set_xmlattr('w:val', str(value))
+        return self
+
+
 class CT_StringBuilder(BaseBuilder):
     __nspfxs__ = ('w',)
     __attrs__ = ()
diff --git a/tests/oxml/unitdata/text.py b/tests/oxml/unitdata/text.py
@@ -5,7 +5,7 @@
 """
 
 from ...unitdata import BaseBuilder
-from .shared import CT_StringBuilder
+from .shared import CT_OnOffBuilder, CT_StringBuilder
 
 
 class CT_BrBuilder(BaseBuilder):
@@ -32,6 +32,12 @@ class CT_RBuilder(BaseBuilder):
     __attrs__ = ()
 
 
+class CT_RPrBuilder(BaseBuilder):
+    __tag__ = 'w:rPr'
+    __nspfxs__ = ('w',)
+    __attrs__ = ()
+
+
 class CT_SectPrBuilder(BaseBuilder):
     __tag__ = 'w:sectPr'
     __nspfxs__ = ('w',)
@@ -44,6 +50,10 @@ class CT_TextBuilder(BaseBuilder):
     __attrs__ = ()
 
 
+def a_b():
+    return CT_OnOffBuilder('w:b')
+
+
 def a_br():
     return CT_BrBuilder()
 
@@ -70,3 +80,7 @@ def a_t():
 
 def an_r():
     return CT_RBuilder()
+
+
+def an_rPr():
+    return CT_RPrBuilder()
diff --git a/tests/test_text.py b/tests/test_text.py
@@ -14,7 +14,7 @@
 
 from mock import call, create_autospec, Mock
 
-from .oxml.unitdata.text import a_br, a_t, a_p, an_r
+from .oxml.unitdata.text import a_b, a_br, a_t, a_p, an_r, an_rPr
 from .unitutil import class_mock
 
 
@@ -90,6 +90,11 @@ def text_prop_fixture(self):
 
 class DescribeRun(object):
 
+    def it_knows_if_its_bold(self, bold_fixture):
+        run, is_bold = bold_fixture
+        print('\n%s' % run._r.xml)
+        assert run.bold == is_bold
+
     def it_can_add_text(self, add_text_fixture):
         run, text_str, expected_xml, Text_ = add_text_fixture
         _text = run.add_text(text_str)
@@ -137,6 +142,20 @@ def add_text_fixture(self, run, Text_):
         ).xml()
         return run, text_str, expected_xml, Text_
 
+    @pytest.fixture(params=[True, False, None])
+    def bold_fixture(self, request):
+        is_bold = request.param
+        r_bldr = an_r().with_nsdecls()
+        if is_bold is not None:
+            b_bldr = a_b()
+            if is_bold is False:
+                b_bldr.with_val('off')
+            rPr_bldr = an_rPr().with_child(b_bldr)
+            r_bldr.with_child(rPr_bldr)
+        r = r_bldr.element
+        run = Run(r)
+        return run, is_bold
+
     @pytest.fixture
     def run(self):
         r = an_r().with_nsdecls().element
