style: add _Styles._translate_special_case_names()

Steve Canny · Steve Canny · commit 884e4f17916b · 2015-02-08T00:01:14.000-08:00
* elaborate unit test to exercise new helper method
* elaborate cxml grammar to allow spaces in attribute values
diff --git a/docx/styles/styles.py b/docx/styles/styles.py
@@ -25,6 +25,7 @@ def __getitem__(self, key):
         """
         Enables dictionary-style access by style id or UI name.
         """
+        key = self._translate_special_case_names(key)
         for get in (self._element.get_by_id, self._element.get_by_name):
             style_elm = get(key)
             if style_elm is not None:
@@ -36,3 +37,24 @@ def __iter__(self):
 
     def __len__(self):
         return len(self._element.style_lst)
+
+    @staticmethod
+    def _translate_special_case_names(name):
+        """
+        Translate special-case style names from their English UI
+        counterparts. Some style names are stored differently than they
+        appear in the UI, with a leading lowercase letter, perhaps for legacy
+        reasons.
+        """
+        return {
+            'Caption':   'caption',
+            'Heading 1': 'heading 1',
+            'Heading 2': 'heading 2',
+            'Heading 3': 'heading 3',
+            'Heading 4': 'heading 4',
+            'Heading 5': 'heading 5',
+            'Heading 6': 'heading 6',
+            'Heading 7': 'heading 7',
+            'Heading 8': 'heading 8',
+            'Heading 9': 'heading 9',
+        }.get(name, name)
diff --git a/tests/styles/test_styles.py b/tests/styles/test_styles.py
@@ -64,16 +64,16 @@ def get_by_id_fixture(self, request):
         return styles, 'Foobar', expected_element
 
     @pytest.fixture(params=[
-        ('w:styles/(w:style%s/w:name{w:val=foo},w:style,w:style)', 0),
-        ('w:styles/(w:style,w:style%s/w:name{w:val=foo},w:style)', 1),
-        ('w:styles/(w:style,w:style,w:style%s/w:name{w:val=foo})', 2),
+        ('w:styles/(w:style%s/w:name{w:val=foo},w:style)', 'foo',       0),
+        ('w:styles/(w:style,w:style%s/w:name{w:val=foo})', 'foo',       1),
+        ('w:styles/w:style%s/w:name{w:val=heading 1}',     'Heading 1', 0),
     ])
     def get_by_name_fixture(self, request):
-        styles_cxml_tmpl, style_idx = request.param
+        styles_cxml_tmpl, key, style_idx = request.param
         styles_cxml = styles_cxml_tmpl % '{w:type=character}'
         styles = Styles(element(styles_cxml))
         expected_element = styles._element[style_idx]
-        return styles, 'foo', expected_element
+        return styles, key, expected_element
 
     @pytest.fixture(params=[
         ('w:styles/(w:style,w:style/w:name{w:val=foo},w:style)'),
diff --git a/tests/unitutil/cxml.py b/tests/unitutil/cxml.py
@@ -228,7 +228,7 @@ def grammar():
 
     # np:attr_name=attr_val ----------------------
     attr_name = Word(alphas + ':')
-    attr_val = Word(alphanums + '-.%')
+    attr_val = Word(alphanums + ' -.%')
     attr_def = Group(attr_name + equal + attr_val)
     attr_list = open_brace + delimitedList(attr_def) + close_brace
 
