parfmt: add ParagraphFormat.tab_stops

DKWoods · Steve Canny · commit 9113b49c7df8 · 2016-05-25T18:46:52.000-07:00
diff --git a/docx/text/parfmt.py b/docx/text/parfmt.py
@@ -9,7 +9,8 @@
 )
 
 from ..enum.text import WD_LINE_SPACING
-from ..shared import ElementProxy, Emu, Length, Pt, Twips
+from ..shared import ElementProxy, Emu, lazyproperty, Length, Pt, Twips
+from .tabstops import TabStops
 
 
 class ParagraphFormat(ElementProxy):
@@ -19,7 +20,7 @@ class ParagraphFormat(ElementProxy):
     control.
     """
 
-    __slots__ = ()
+    __slots__ = ('_tab_stops',)
 
     @property
     def alignment(self):
@@ -243,6 +244,15 @@ def space_before(self):
     def space_before(self, value):
         self._element.get_or_add_pPr().spacing_before = value
 
+    @lazyproperty
+    def tab_stops(self):
+        """
+        |TabStops| object providing access to the tab stops defined for this
+        paragraph format.
+        """
+        pPr = self._element.get_or_add_pPr()
+        return TabStops(pPr)
+
     @property
     def widow_control(self):
         """
diff --git a/docx/text/tabstops.py b/docx/text/tabstops.py
@@ -18,3 +18,9 @@ class TabStops(ElementProxy):
     using the `tab_stops` property of ParagraphFormat; it is not intended to
     be constructed directly.
     """
+
+    __slots__ = ('_pPr')
+
+    def __init__(self, element):
+        super(TabStops, self).__init__(element, None)
+        self._pPr = element
diff --git a/features/txt-parfmt-props.feature b/features/txt-parfmt-props.feature
@@ -4,7 +4,6 @@ Feature: Get or set paragraph formatting properties
   I need a ParagraphFormat object with read/write formatting properties
 
 
-  @wip
   Scenario: Get tab stops
     Given a paragraph format
      Then paragraph_format.tab_stops is a TabStops object
diff --git a/tests/text/test_parfmt.py b/tests/text/test_parfmt.py
@@ -12,10 +12,12 @@
 from docx.enum.text import WD_ALIGN_PARAGRAPH, WD_LINE_SPACING
 from docx.shared import Pt
 from docx.text.parfmt import ParagraphFormat
+from docx.text.tabstops import TabStops
 
 import pytest
 
 from ..unitutil.cxml import element, xml
+from ..unitutil.mock import class_mock, instance_mock
 
 
 class DescribeParagraphFormat(object):
@@ -102,6 +104,12 @@ def it_can_change_its_on_off_props(self, on_off_set_fixture):
         setattr(paragraph_format, prop_name, value)
         assert paragraph_format._element.xml == expected_xml
 
+    def it_provides_access_to_its_tab_stops(self, tab_stops_fixture):
+        paragraph_format, TabStops_, pPr, tab_stops_ = tab_stops_fixture
+        tab_stops = paragraph_format.tab_stops
+        TabStops_.assert_called_once_with(pPr)
+        assert tab_stops is tab_stops_
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture(params=[
@@ -393,3 +401,22 @@ def space_before_set_fixture(self, request):
         paragraph_format = ParagraphFormat(element(p_cxml))
         expected_xml = xml(expected_p_cxml)
         return paragraph_format, value, expected_xml
+
+    @pytest.fixture
+    def tab_stops_fixture(self, TabStops_, tab_stops_):
+        p = element('w:p/w:pPr')
+        pPr = p.pPr
+        paragraph_format = ParagraphFormat(p, None)
+        return paragraph_format, TabStops_, pPr, tab_stops_
+
+    # fixture components ---------------------------------------------
+
+    @pytest.fixture
+    def TabStops_(self, request, tab_stops_):
+        return class_mock(
+            request, 'docx.text.parfmt.TabStops', return_value=tab_stops_
+        )
+
+    @pytest.fixture
+    def tab_stops_(self, request):
+        return instance_mock(request, TabStops)
