shp: add InlineShapes.__getitem__()

Steve Canny · Steve Canny · commit f85ab04caac2 · 2013-12-24T22:44:34.000-08:00
diff --git a/docx/parts.py b/docx/parts.py
@@ -118,6 +118,17 @@ def __init__(self, body_elm):
         super(InlineShapes, self).__init__()
         self._body = body_elm
 
+    def __getitem__(self, idx):
+        """
+        Provide indexed access, e.g. 'inline_shapes[idx]'
+        """
+        try:
+            inline = self._inline_lst[idx]
+        except IndexError:
+            msg = "inline shape index [%d] out of range" % idx
+            raise IndexError(msg)
+        return InlineShape(inline)
+
     def __iter__(self):
         return (InlineShape(inline) for inline in self._inline_lst)
 
diff --git a/features/shp-inline-shape-access.feature b/features/shp-inline-shape-access.feature
@@ -8,7 +8,6 @@ Feature: Access inline shapes in document
       Then I can access the inline shape collection of the document
        And the length of the inline shape collection is 2
 
-  @wip
   Scenario: Access shape in inline shape collection
      Given an inline shape collection containing two shapes
       Then I can iterate over the inline shape collection
diff --git a/tests/test_parts.py b/tests/test_parts.py
@@ -273,6 +273,23 @@ def it_can_iterate_over_its_InlineShape_instances(
             actual_count += 1
         assert actual_count == inline_shape_count
 
+    def it_provides_indexed_access_to_inline_shapes(
+            self, inline_shapes_fixture):
+        inline_shapes, inline_shape_count = inline_shapes_fixture
+        for idx in range(-inline_shape_count, inline_shape_count):
+            inline_shape = inline_shapes[idx]
+            assert isinstance(inline_shape, InlineShape)
+
+    def it_raises_on_indexed_access_out_of_range(
+            self, inline_shapes_fixture):
+        inline_shapes, inline_shape_count = inline_shapes_fixture
+        with pytest.raises(IndexError):
+            too_low = -1 - inline_shape_count
+            inline_shapes[too_low]
+        with pytest.raises(IndexError):
+            too_high = inline_shape_count
+            inline_shapes[too_high]
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
