style: add BaseStyle.priority getter

Steve Canny · Steve Canny · commit 0b612d326583 · 2015-02-08T00:01:46.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -119,6 +119,7 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:semiHidden',     CT_OnOff)
 register_element_cls('w:style',          CT_Style)
 register_element_cls('w:styles',         CT_Styles)
+register_element_cls('w:uiPriority',     CT_DecimalNumber)
 
 from .table import (
     CT_Row, CT_Tbl, CT_TblGrid, CT_TblGridCol, CT_TblLayoutType, CT_TblPr,
diff --git a/docx/oxml/styles.py b/docx/oxml/styles.py
@@ -43,6 +43,7 @@ class CT_Style(BaseOxmlElement):
     )
     name = ZeroOrOne('w:name', successors=_tag_seq[1:])
     basedOn = ZeroOrOne('w:basedOn', successors=_tag_seq[3:])
+    uiPriority = ZeroOrOne('w:uiPriority', successors=_tag_seq[8:])
     semiHidden = ZeroOrOne('w:semiHidden', successors=_tag_seq[9:])
     pPr = ZeroOrOne('w:pPr', successors=_tag_seq[17:])
     rPr = ZeroOrOne('w:rPr', successors=_tag_seq[18:])
@@ -125,6 +126,16 @@ def semiHidden_val(self, value):
             semiHidden = self._add_semiHidden()
             semiHidden.val = value
 
+    @property
+    def uiPriority_val(self):
+        """
+        Value of ``<w:uiPriority>`` child or |None| if not present.
+        """
+        uiPriority = self.uiPriority
+        if uiPriority is None:
+            return None
+        return uiPriority.val
+
 
 class CT_Styles(BaseOxmlElement):
     """
diff --git a/docx/styles/style.py b/docx/styles/style.py
@@ -87,6 +87,16 @@ def name(self):
     def name(self, value):
         self._element.name_val = value
 
+    @property
+    def priority(self):
+        """
+        The integer sort key governing display sequence of this style in the
+        Word UI. |None| indicates no setting is defined, causing Word to use
+        the default value of 0. Style name is used as a secondary sort key to
+        resolve ordering of styles having the same priority value.
+        """
+        return self._element.uiPriority_val
+
     @property
     def style_id(self):
         """
diff --git a/features/sty-style-props.feature b/features/sty-style-props.feature
@@ -59,7 +59,6 @@ Feature: Get and set style properties
      Then style.name is the new name
 
 
-  @wip
   Scenario Outline: Get style display sort order
     Given a style having priority of <setting>
      Then style.priority is <value>
diff --git a/tests/styles/test_style.py b/tests/styles/test_style.py
@@ -132,6 +132,10 @@ def it_can_change_whether_its_hidden(self, hidden_set_fixture):
         style.hidden = value
         assert style._element.xml == expected_xml
 
+    def it_knows_its_sort_order(self, priority_get_fixture):
+        style, expected_value = priority_get_fixture
+        assert style.priority == expected_value
+
     def it_can_delete_itself_from_the_document(self, delete_fixture):
         style, styles, expected_xml = delete_fixture
         style.delete()
@@ -224,6 +228,15 @@ def name_set_fixture(self, request):
         expected_xml = xml(expected_style_cxml)
         return style, new_value, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:style',                        None),
+        ('w:style/w:uiPriority{w:val=42}', 42),
+    ])
+    def priority_get_fixture(self, request):
+        style_cxml, expected_value = request.param
+        style = BaseStyle(element(style_cxml))
+        return style, expected_value
+
     @pytest.fixture(params=[
         ('w:style',                   WD_STYLE_TYPE.PARAGRAPH),
         ('w:style{w:type=paragraph}', WD_STYLE_TYPE.PARAGRAPH),
