style: add Styles.latent_styles

Steve Canny · Steve Canny · commit bb169653415d · 2015-02-08T00:01:47.000-08:00
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -202,7 +202,10 @@ class CT_Styles(BaseOxmlElement):
     ``<w:styles>`` element, the root element of a styles part, i.e.
     styles.xml
     """
+    _tag_seq = ('w:docDefaults', 'w:latentStyles', 'w:style')
+    latentStyles = ZeroOrOne('w:latentStyles', successors=_tag_seq[2:])
     style = ZeroOrMore('w:style', successors=())
+    del _tag_seq
 
     def add_style_of_type(self, name, style_type, builtin):
         """
diff --git a/docx/styles/styles.py b/docx/styles/styles.py
@@ -8,6 +8,7 @@
     absolute_import, division, print_function, unicode_literals
 )
 
+from .latent import LatentStyles
 from ..shared import ElementProxy
 from .style import BaseStyle, StyleFactory
 
@@ -96,6 +97,16 @@ def get_style_id(self, style_or_name, style_type):
         else:
             return self._get_style_id_from_name(style_or_name, style_type)
 
+    @property
+    def latent_styles(self):
+        """
+        A |LatentStyles| object providing access to the default behaviors for
+        latent styles and the collection of |_LatentStyle| objects that
+        define overrides of those defaults for a particular named latent
+        style.
+        """
+        return LatentStyles(self._element.get_or_add_latentStyles())
+
     def _get_by_id(self, style_id, style_type):
         """
         Return the style of *style_type* matching *style_id*. Returns the
diff --git a/tests/styles/test_styles.py b/tests/styles/test_styles.py
@@ -12,11 +12,14 @@
 
 from docx.enum.style import WD_STYLE_TYPE
 from docx.oxml.styles import CT_Style, CT_Styles
+from docx.styles.latent import LatentStyles
 from docx.styles.style import BaseStyle
 from docx.styles.styles import Styles
 
 from ..unitutil.cxml import element
-from ..unitutil.mock import call, function_mock, instance_mock, method_mock
+from ..unitutil.mock import (
+    call, class_mock, function_mock, instance_mock, method_mock
+)
 
 
 class DescribeStyles(object):
@@ -135,6 +138,12 @@ def it_raises_on_style_type_mismatch(self, id_style_raises_fixture):
         with pytest.raises(ValueError):
             styles._get_style_id_from_style(style_, style_type)
 
+    def it_provides_access_to_the_latent_styles(self, latent_styles_fixture):
+        styles, LatentStyles_, latent_styles_ = latent_styles_fixture
+        latent_styles = styles.latent_styles
+        LatentStyles_.assert_called_once_with(styles._element.latentStyles)
+        assert latent_styles is latent_styles_
+
     # fixture --------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -319,6 +328,11 @@ def iter_fixture(self, request, StyleFactory_, style_):
         StyleFactory_.return_value = style_
         return styles, expected_count, style_, StyleFactory_, expected_calls
 
+    @pytest.fixture
+    def latent_styles_fixture(self, LatentStyles_, latent_styles_):
+        styles = Styles(element('w:styles/w:latentStyles'))
+        return styles, LatentStyles_, latent_styles_
+
     @pytest.fixture(params=[
         ('w:styles',                           0),
         ('w:styles/w:style',                   1),
@@ -352,6 +366,17 @@ def _get_style_id_from_name_(self, request):
     def _get_style_id_from_style_(self, request):
         return method_mock(request, Styles, '_get_style_id_from_style')
 
+    @pytest.fixture
+    def LatentStyles_(self, request, latent_styles_):
+        return class_mock(
+            request, 'docx.styles.styles.LatentStyles',
+            return_value=latent_styles_
+        )
+
+    @pytest.fixture
+    def latent_styles_(self, request):
+        return instance_mock(request, LatentStyles)
+
     @pytest.fixture
     def style_(self, request):
         return instance_mock(request, BaseStyle)
