parfmt: add ParaFormat.line_spacing_rule getter

Steve Canny · Steve Canny · commit 752f52fd72fb · 2015-02-08T00:01:43.000-08:00
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -11,7 +11,7 @@
 from ..enum.style import WD_STYLE_TYPE
 from ..enum.text import WD_LINE_SPACING
 from .run import Run
-from ..shared import ElementProxy, Parented, Pt
+from ..shared import ElementProxy, Parented, Pt, Twips
 
 
 class Paragraph(Parented):
@@ -175,6 +175,22 @@ def line_spacing(self):
             return None
         return self._line_spacing(pPr.spacing_line, pPr.spacing_lineRule)
 
+    @property
+    def line_spacing_rule(self):
+        """
+        A member of the :ref:`WdLineSpacing` enumeration indicating how the
+        value of :attr:`line_spacing` should be interpreted. Assigning any of
+        the :ref:`WdLineSpacing` members :attr:`SINGLE`, :attr:`DOUBLE`, or
+        :attr:`ONE_POINT_FIVE` will cause the value of :attr:`line_spacing`
+        to be updated to produce the corresponding line spacing.
+        """
+        pPr = self._element.pPr
+        if pPr is None:
+            return None
+        return self._line_spacing_rule(
+            pPr.spacing_line, pPr.spacing_lineRule
+        )
+
     @property
     def space_after(self):
         """
@@ -227,3 +243,20 @@ def _line_spacing(spacing_line, spacing_lineRule):
         if spacing_lineRule == WD_LINE_SPACING.MULTIPLE:
             return spacing_line / Pt(12)
         return spacing_line
+
+    @staticmethod
+    def _line_spacing_rule(line, lineRule):
+        """
+        Return the line spacing rule value calculated from the combination of
+        *line* and *lineRule*. Returns special members of the
+        :ref:`WdLineSpacing` enumeration when line spacing is single, double,
+        or 1.5 lines.
+        """
+        if lineRule == WD_LINE_SPACING.MULTIPLE:
+            if line == Twips(240):
+                return WD_LINE_SPACING.SINGLE
+            if line == Twips(360):
+                return WD_LINE_SPACING.ONE_POINT_FIVE
+            if line == Twips(480):
+                return WD_LINE_SPACING.DOUBLE
+        return lineRule
diff --git a/features/txt-parfmt-props.feature b/features/txt-parfmt-props.feature
@@ -54,7 +54,6 @@ Feature: Get or set paragraph formatting properties
       | after  | 42 pt     | None      | None   |
 
 
-  @wip
   Scenario Outline: Get line spacing
     Given a paragraph format having <setting> line spacing
      Then paragraph_format.line_spacing is <value>
diff --git a/tests/text/test_paragraph.py b/tests/text/test_paragraph.py
@@ -9,7 +9,7 @@
 )
 
 from docx.enum.style import WD_STYLE_TYPE
-from docx.enum.text import WD_ALIGN_PARAGRAPH
+from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
 from docx.oxml.text.paragraph import CT_P
 from docx.oxml.text.run import CT_R
 from docx.parts.document import DocumentPart
@@ -319,6 +319,10 @@ def it_knows_its_line_spacing(self, line_spacing_get_fixture):
         paragraph_format, expected_value = line_spacing_get_fixture
         assert paragraph_format.line_spacing == expected_value
 
+    def it_knows_its_line_spacing_rule(self, line_spacing_rule_get_fixture):
+        paragraph_format, expected_value = line_spacing_rule_get_fixture
+        assert paragraph_format.line_spacing_rule == expected_value
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -362,6 +366,26 @@ def line_spacing_get_fixture(self, request):
         paragraph_format = ParagraphFormat(element(p_cxml))
         return paragraph_format, expected_value
 
+    @pytest.fixture(params=[
+        ('w:p',                             None),
+        ('w:p/w:pPr',                       None),
+        ('w:p/w:pPr/w:spacing',             None),
+        ('w:p/w:pPr/w:spacing{w:line=240}', WD_LINE_SPACING.SINGLE),
+        ('w:p/w:pPr/w:spacing{w:line=360}', WD_LINE_SPACING.ONE_POINT_FIVE),
+        ('w:p/w:pPr/w:spacing{w:line=480}', WD_LINE_SPACING.DOUBLE),
+        ('w:p/w:pPr/w:spacing{w:line=420}', WD_LINE_SPACING.MULTIPLE),
+        ('w:p/w:pPr/w:spacing{w:lineRule=auto}',
+         WD_LINE_SPACING.MULTIPLE),
+        ('w:p/w:pPr/w:spacing{w:lineRule=exact}',
+         WD_LINE_SPACING.EXACTLY),
+        ('w:p/w:pPr/w:spacing{w:lineRule=atLeast}',
+         WD_LINE_SPACING.AT_LEAST),
+    ])
+    def line_spacing_rule_get_fixture(self, request):
+        p_cxml, expected_value = request.param
+        paragraph_format = ParagraphFormat(element(p_cxml))
+        return paragraph_format, expected_value
+
     @pytest.fixture(params=[
         ('w:p',                              None),
         ('w:p/w:pPr',                        None),
