tabs: add TabStops.__getitem__()

DKWoods · Steve Canny · commit e5233fdf7165 · 2016-05-25T19:01:10.000-07:00
diff --git a/docx/text/tabstops.py b/docx/text/tabstops.py
@@ -25,6 +25,16 @@ def __init__(self, element):
         super(TabStops, self).__init__(element, None)
         self._pPr = element
 
+    def __getitem__(self, idx):
+        """
+        Enables list-style access by index.
+        """
+        tabs = self._pPr.tabs
+        if tabs is None:
+            raise IndexError('TabStops object is empty')
+        tab = tabs.tab_lst[idx]
+        return TabStop(tab)
+
     def __iter__(self):
         """
         Generate a TabStop object for each of the w:tab elements, in XML
diff --git a/features/tab-access-tabs.feature b/features/tab-access-tabs.feature
@@ -14,7 +14,6 @@ Feature: Access TabStop objects
       |   3   |
 
 
-  @wip
   Scenario: Access an existing TabStop object
     Given a tab_stops having 3 tab stops
      Then I can iterate the TabStops object
diff --git a/tests/text/test_tabstops.py b/tests/text/test_tabstops.py
@@ -34,8 +34,31 @@ def it_can_iterate_over_its_tab_stops(self, iter_fixture):
         assert count == expected_count
         assert TabStop_.call_args_list == expected_calls
 
+    def it_can_get_a_tab_stop_by_index(self, index_fixture):
+        tab_stops, idx, TabStop_, tab, tab_stop_ = index_fixture
+        tab_stop = tab_stops[idx]
+        TabStop_.assert_called_once_with(tab)
+        assert tab_stop is tab_stop_
+
+    def it_raises_on_indexed_access_when_empty(self):
+        tab_stops = TabStops(element('w:pPr'))
+        with pytest.raises(IndexError):
+            tab_stops[0]
+
     # fixture --------------------------------------------------------
 
+    @pytest.fixture(params=[
+        ('w:pPr/w:tabs/w:tab{w:pos=0}',                                 0),
+        ('w:pPr/w:tabs/(w:tab{w:pos=1},w:tab{w:pos=2},w:tab{w:pos=3})', 1),
+        ('w:pPr/w:tabs/(w:tab{w:pos=4},w:tab{w:pos=5},w:tab{w:pos=6})', 2),
+    ])
+    def index_fixture(self, request, TabStop_, tab_stop_):
+        pPr_cxml, idx = request.param
+        pPr = element(pPr_cxml)
+        tab = pPr.xpath('./w:tabs/w:tab')[idx]
+        tab_stops = TabStops(pPr)
+        return tab_stops, idx, TabStop_, tab, tab_stop_
+
     @pytest.fixture(params=[
         ('w:pPr',                                              0),
         ('w:pPr/w:tabs/w:tab{w:pos=2880}',                     1),
