font: add Font.name getter

Steve Canny · Steve Canny · commit c4ba0bd1e106 · 2015-02-08T00:01:40.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -142,7 +142,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:pPr',    CT_PPr)
 register_element_cls('w:pStyle', CT_String)
 
-from .text.run import CT_Br, CT_R, CT_RPr, CT_Text, CT_Underline
+from .text.run import CT_Br, CT_Fonts, CT_R, CT_RPr, CT_Text, CT_Underline
 register_element_cls('w:b',          CT_OnOff)
 register_element_cls('w:bCs',        CT_OnOff)
 register_element_cls('w:br',         CT_Br)
@@ -157,6 +157,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:oMath',      CT_OnOff)
 register_element_cls('w:outline',    CT_OnOff)
 register_element_cls('w:r',          CT_R)
+register_element_cls('w:rFonts',     CT_Fonts)
 register_element_cls('w:rPr',        CT_RPr)
 register_element_cls('w:rStyle',     CT_String)
 register_element_cls('w:rtl',        CT_OnOff)
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -44,11 +44,13 @@ class CT_Style(BaseOxmlElement):
     name = ZeroOrOne('w:name', successors=_tag_seq[1:])
     basedOn = ZeroOrOne('w:basedOn', successors=_tag_seq[3:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
+    rPr = ZeroOrOne('w:rPr', successors=_tag_seq[18:])
+    del _tag_seq
+
     type = OptionalAttribute('w:type', WD_STYLE_TYPE)
     styleId = OptionalAttribute('w:styleId', ST_String)
     default = OptionalAttribute('w:default', ST_OnOff)
     customStyle = OptionalAttribute('w:customStyle', ST_OnOff)
-    del _tag_seq
 
     @property
     def basedOn_val(self):
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -6,7 +6,7 @@
 
 from ...enum.text import WD_UNDERLINE
 from ..ns import qn
-from ..simpletypes import ST_BrClear, ST_BrType
+from ..simpletypes import ST_BrClear, ST_BrType, ST_String
 from ..xmlchemy import (
     BaseOxmlElement, OptionalAttribute, ZeroOrMore, ZeroOrOne
 )
@@ -20,6 +20,14 @@ class CT_Br(BaseOxmlElement):
     clear = OptionalAttribute('w:clear', ST_BrClear)
 
 
+class CT_Fonts(BaseOxmlElement):
+    """
+    ``<w:rFonts>`` element, specifying typeface name for the various language
+    types.
+    """
+    ascii = OptionalAttribute('w:ascii', ST_String)
+
+
 class CT_R(BaseOxmlElement):
     """
     ``<w:r>`` element, containing the properties and text for a run.
@@ -135,6 +143,7 @@ class CT_RPr(BaseOxmlElement):
         'w:eastAsianLayout', 'w:specVanish', 'w:oMath'
     )
     rStyle = ZeroOrOne('w:rStyle', successors=_tag_seq[1:])
+    rFonts = ZeroOrOne('w:rFonts', successors=_tag_seq[2:])
     b = ZeroOrOne('w:b', successors=_tag_seq[3:])
     bCs = ZeroOrOne('w:bCs', successors=_tag_seq[4:])
     i = ZeroOrOne('w:i', successors=_tag_seq[5:])
@@ -158,6 +167,19 @@ class CT_RPr(BaseOxmlElement):
     oMath = ZeroOrOne('w:oMath', successors=_tag_seq[39:])
     del _tag_seq
 
+    @property
+    def rFonts_ascii(self):
+        """
+        The value of `w:rFonts/@w:ascii` or |None| if not present. Represents
+        the assigned typeface name. The rFonts element also specifies other
+        special-case typeface names; this method handles the case where just
+        the common name is required.
+        """
+        rFonts = self.rFonts
+        if rFonts is None:
+            return None
+        return rFonts.ascii
+
     @property
     def style(self):
         """
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -381,6 +381,19 @@ class Font(ElementProxy):
 
     __slots__ = ()
 
+    @property
+    def name(self):
+        """
+        Get or set the typeface name for this |Font| instance, causing the
+        text it controls to appear in the named font, if a matching font is
+        found. |None| indicates the typeface is inherited from the style
+        hierarchy.
+        """
+        rPr = self._element.rPr
+        if rPr is None:
+            return None
+        return rPr.rFonts_ascii
+
 
 class _Text(object):
     """
diff --git a/features/txt-font-props.feature b/features/txt-font-props.feature
@@ -4,7 +4,6 @@ Feature: Get or set font properties
   I need a set of read/write properties on the Font object
 
 
-  @wip
   Scenario Outline: Get typeface name
     Given a font having typeface name <name>
      Then font.name is <value>
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -12,7 +12,7 @@
 from docx.parts.document import InlineShapes
 from docx.shape import InlineShape
 from docx.text.paragraph import Paragraph
-from docx.text.run import Run
+from docx.text.run import Font, Run
 
 import pytest
 
@@ -366,3 +366,23 @@ def picture_(self, request):
     @pytest.fixture
     def Text_(self, request):
         return class_mock(request, 'docx.text.run._Text')
+
+
+class DescribeFont(object):
+
+    def it_knows_its_typeface_name(self, name_get_fixture):
+        font, expected_value = name_get_fixture
+        assert font.name == expected_value
+
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture(params=[
+        ('w:r',                               None),
+        ('w:r/w:rPr',                         None),
+        ('w:r/w:rPr/w:rFonts',                None),
+        ('w:r/w:rPr/w:rFonts{w:ascii=Arial}', 'Arial'),
+    ])
+    def name_get_fixture(self, request):
+        r_cxml, expected_value = request.param
+        font = Font(element(r_cxml))
+        return font, expected_value
