acpt: add scenario for Styles.latent_styles

Steve Canny · Steve Canny · commit b8b736738361 · 2015-02-08T00:01:47.000-08:00
diff --git a/docx/styles/latent.py b/docx/styles/latent.py
@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+"""
+Latent style-related objects.
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from ..shared import ElementProxy
+
+
+class LatentStyles(ElementProxy):
+    """
+    Provides access to the default behaviors for latent styles in this
+    document and to the collection of |_LatentStyle| objects that define
+    overrides of those defaults for a particular named latent style.
+    """
+
+    __slots__ = ()
+
+
+class _LatentStyle(ElementProxy):
+    """
+    Proxy for an `w:lsdException` element, which specifies display behaviors
+    for a built-in style when no definition for that style is stored yet in
+    the `styles.xml` part. The values in this element override the defaults
+    specified in the parent `w:latentStyles` element.
+    """
+
+    __slots__ = ()
diff --git a/features/steps/styles.py b/features/steps/styles.py
@@ -8,6 +8,7 @@
 
 from docx import Document
 from docx.enum.style import WD_STYLE_TYPE
+from docx.styles.latent import _LatentStyle, LatentStyles
 from docx.styles.styles import Styles
 from docx.styles.style import BaseStyle
 from docx.text.paragraph import ParagraphFormat
@@ -56,6 +57,12 @@ def given_a_document_having_no_styles_part(context):
     context.document = Document(docx_path)
 
 
+@given('a latent style collection')
+def given_a_latent_style_collection(context):
+    document = Document(test_docx('sty-known-styles'))
+    context.latent_styles = document.styles.latent_styles
+
+
 @given('a style based on {base_style}')
 def given_a_style_based_on_setting(context, base_style):
     style_name = {
@@ -141,6 +148,12 @@ def given_a_style_of_type(context, style_type):
     context.style = document.styles[name]
 
 
+@given('the style collection of a document')
+def given_the_style_collection_of_a_document(context):
+    document = Document(test_docx('sty-known-styles'))
+    context.styles = document.styles
+
+
 # when =====================================================
 
 @when('I assign a new name to the style')
@@ -209,6 +222,13 @@ def when_I_delete_a_style(context):
 
 # then =====================================================
 
+@then('I can access a latent style by name')
+def then_I_can_access_a_latent_style_by_name(context):
+    latent_styles = context.latent_styles
+    latent_style = latent_styles['Colorful Shading']
+    assert isinstance(latent_style, _LatentStyle)
+
+
 @then('I can access a style by its UI name')
 def then_I_can_access_a_style_by_its_UI_name(context):
     styles = context.document.styles
@@ -237,6 +257,18 @@ def then_I_can_iterate_over_its_styles(context):
     assert all(isinstance(s, BaseStyle) for s in styles)
 
 
+@then('I can iterate over the latent styles')
+def then_I_can_iterate_over_the_latent_styles(context):
+    latent_styles = [ls for ls in context.latent_styles]
+    assert len(latent_styles) == 137
+    assert all(isinstance(ls, _LatentStyle) for ls in latent_styles)
+
+
+@then('len(latent_styles) is 137')
+def then_len_latent_styles_is_137(context):
+    assert len(context.latent_styles) == 137
+
+
 @then('len(styles) is {style_count_str}')
 def then_len_styles_is_style_count(context, style_count_str):
     assert len(context.document.styles) == int(style_count_str)
@@ -340,6 +372,14 @@ def then_style_unhide_when_used_is_value(context, value):
     assert style.unhide_when_used is expected_value
 
 
+@then('styles.latent_styles is the LatentStyles object for the document')
+def then_styles_latent_styles_is_the_LatentStyles_object(context):
+    styles = context.styles
+    context.latent_styles = latent_styles = styles.latent_styles
+    assert isinstance(latent_styles, LatentStyles)
+    assert latent_styles.element is styles.element.latentStyles
+
+
 @then('styles[\'{name}\'] is a style')
 def then_styles_name_is_a_style(context, name):
     styles = context.document.styles
diff --git a/features/sty-access-latent-styles.feature b/features/sty-access-latent-styles.feature
@@ -0,0 +1,18 @@
+Feature: Access latent styles for a document
+  In order to operate on the latent styles for a document
+  As a developer using python-docx
+  I need access to the latent styles collection
+
+
+  @wip
+  Scenario: Access latent styles collection
+    Given the style collection of a document
+     Then styles.latent_styles is the LatentStyles object for the document
+      And len(latent_styles) is 137
+
+
+  @wip
+  Scenario: Access latent style in collection
+     Given a latent style collection
+      Then I can iterate over the latent styles
+       And I can access a latent style by name
