parfmt: add ParaFormat.first_line_indent getter

Steve Canny · Steve Canny · commit 931012d0fa98 · 2015-02-08T00:01:43.000-08:00
diff --git a/docx/oxml/__init__.py b/docx/oxml/__init__.py
@@ -136,7 +136,8 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:tr',        CT_Row)
 register_element_cls('w:vMerge',    CT_VMerge)
 
-from .text.paragraph import CT_Jc, CT_P, CT_PPr, CT_Spacing
+from .text.paragraph import CT_Ind, CT_Jc, CT_P, CT_PPr, CT_Spacing
+register_element_cls('w:ind',     CT_Ind)
 register_element_cls('w:jc',      CT_Jc)
 register_element_cls('w:p',       CT_P)
 register_element_cls('w:pPr',     CT_PPr)
diff --git a/docx/oxml/text/paragraph.py b/docx/oxml/text/paragraph.py
@@ -6,13 +6,22 @@
 
 from ...enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
 from ..ns import qn
+from ...shared import Length
 from ..simpletypes import ST_SignedTwipsMeasure, ST_TwipsMeasure
 from ..xmlchemy import (
     BaseOxmlElement, OptionalAttribute, OxmlElement, RequiredAttribute,
     ZeroOrMore, ZeroOrOne
 )
 
 
+class CT_Ind(BaseOxmlElement):
+    """
+    ``<w:ind>`` element, specifying paragraph indentation.
+    """
+    firstLine = OptionalAttribute('w:firstLine', ST_TwipsMeasure)
+    hanging = OptionalAttribute('w:hanging', ST_TwipsMeasure)
+
+
 class CT_Jc(BaseOxmlElement):
     """
     ``<w:jc>`` element, specifying paragraph justification.
@@ -108,10 +117,29 @@ class CT_PPr(BaseOxmlElement):
     pStyle = ZeroOrOne('w:pStyle', successors=_tag_seq[1:])
     numPr = ZeroOrOne('w:numPr', successors=_tag_seq[7:])
     spacing = ZeroOrOne('w:spacing', successors=_tag_seq[22:])
+    ind = ZeroOrOne('w:ind', successors=_tag_seq[23:])
     jc = ZeroOrOne('w:jc', successors=_tag_seq[27:])
     sectPr = ZeroOrOne('w:sectPr', successors=_tag_seq[35:])
     del _tag_seq
 
+    @property
+    def first_line_indent(self):
+        """
+        A |Length| value calculated from the values of `w:ind/@w:firstLine`
+        and `w:ind/@w:hanging`. Returns |None| if the `w:ind` child is not
+        present.
+        """
+        ind = self.ind
+        if ind is None:
+            return None
+        hanging = ind.hanging
+        if hanging is not None:
+            return Length(-hanging)
+        firstLine = ind.firstLine
+        if firstLine is None:
+            return None
+        return firstLine
+
     @property
     def jc_val(self):
         """
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -158,6 +158,20 @@ def alignment(self, value):
         pPr = self._element.get_or_add_pPr()
         pPr.jc_val = value
 
+    @property
+    def first_line_indent(self):
+        """
+        |Length| value specifying the relative difference in indentation for
+        the first line of the paragraph. A positive value causes the first
+        line to be indented. A negative value produces a hanging indent.
+        |None| indicates first line indentation is inherited from the style
+        hierarchy.
+        """
+        pPr = self._element.pPr
+        if pPr is None:
+            return None
+        return pPr.first_line_indent
+
     @property
     def line_spacing(self):
         """
diff --git a/tests/text/test_paragraph.py b/tests/text/test_paragraph.py
@@ -334,6 +334,10 @@ def it_can_change_its_line_spacing_rule(self,
         paragraph_format.line_spacing_rule = value
         assert paragraph_format._element.xml == expected_xml
 
+    def it_knows_its_first_line_indent(self, first_indent_get_fixture):
+        paragraph_format, expected_value = first_indent_get_fixture
+        assert paragraph_format.first_line_indent == expected_value
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -364,6 +368,18 @@ def alignment_set_fixture(self, request):
         expected_xml = xml(expected_cxml)
         return paragraph_format, value, expected_xml
 
+    @pytest.fixture(params=[
+        ('w:p',                              None),
+        ('w:p/w:pPr',                        None),
+        ('w:p/w:pPr/w:ind',                  None),
+        ('w:p/w:pPr/w:ind{w:firstLine=240}', Pt(12)),
+        ('w:p/w:pPr/w:ind{w:hanging=240}',   Pt(-12)),
+    ])
+    def first_indent_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),
