shp: refactor InlineShapes.add_picture()

Steve Canny · Steve Canny · commit 7df532354a2b · 2014-07-11T18:20:53.000-07:00
Key change is adding *run* parameter to InlineShapes.add_picture()
rather than adding a run to the document in the method, so picture can
be added to an arbitrary run.
diff --git a/docx/api.py b/docx/api.py
@@ -87,7 +87,8 @@ def add_picture(self, image_path_or_stream, width=None, height=None):
         (dpi) value specified in the image file, defaulting to 72 dpi if no
         value is specified, as is often the case.
         """
-        picture = self.inline_shapes.add_picture(image_path_or_stream)
+        run = self.add_paragraph().add_run()
+        picture = self.inline_shapes.add_picture(image_path_or_stream, run)
 
         # scale picture dimensions if width and/or height provided
         if width is not None or height is not None:
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -190,17 +190,18 @@ def __iter__(self):
     def __len__(self):
         return len(self._inline_lst)
 
-    def add_picture(self, image_descriptor):
+    def add_picture(self, image_descriptor, run):
         """
-        Add the image identified by *image_descriptor* to the document at its
-        native size. The picture is placed inline in a new paragraph at the
-        end of the document. *image_descriptor* can be a path (a string) or a
-        file-like object containing a binary image.
+        Return an |InlineShape| instance containing the picture identified by
+        *image_descriptor* and added to the end of *run*. The picture shape
+        has the native size of the image. *image_descriptor* can be a path (a
+        string) or a file-like object containing a binary image.
         """
         image_part, rId = self.part.get_or_add_image_part(image_descriptor)
         shape_id = self.part.next_id
-        r = self._body.add_p().add_r()
-        return InlineShape.new_picture(r, image_part, rId, shape_id)
+        r = run._r
+        picture = InlineShape.new_picture(r, image_part, rId, shape_id)
+        return picture
 
     @property
     def _inline_lst(self):
diff --git a/features/steps/shape.py b/features/steps/shape.py
@@ -58,15 +58,17 @@ def given_inline_shape_known_to_be_shape_of_type(context, shp_of_type):
 @when('I add an inline picture from a file-like object')
 def when_add_inline_picture_from_file_like_object(context):
     document = context.document
+    run = document.add_paragraph().add_run()
     with open(test_file_path('monty-truth.png'), 'rb') as f:
-        context.inline_shape = document.inline_shapes.add_picture(f)
+        context.inline_shape = document.inline_shapes.add_picture(f, run)
 
 
 @when('I add an inline picture to the document')
 def when_add_inline_picture_to_document(context):
     document = context.document
+    run = document.add_paragraph().add_run()
     context.inline_shape = (document.inline_shapes.add_picture(
-        test_file_path('monty-truth.png')
+        test_file_path('monty-truth.png'), run
     ))
 
 
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -18,7 +18,7 @@
 from docx.section import Section
 from docx.shape import InlineShape
 from docx.table import Table
-from docx.text import Paragraph
+from docx.text import Paragraph, Run
 
 from ..oxml.parts.unitdata.document import a_body, a_document
 from ..oxml.unitdata.table import (
@@ -448,10 +448,10 @@ def it_can_add_an_inline_picture_to_the_document(
             self, add_picture_fixture):
         # fixture ----------------------
         (inline_shapes, image_descriptor_, document_, InlineShape_,
-         r_, image_part_, rId_, shape_id_, new_picture_shape_
+         run, r_, image_part_, rId_, shape_id_, new_picture_shape_
          ) = add_picture_fixture
         # exercise ---------------------
-        picture_shape = inline_shapes.add_picture(image_descriptor_)
+        picture_shape = inline_shapes.add_picture(image_descriptor_, run)
         # verify -----------------------
         document_.get_or_add_image_part.assert_called_once_with(
             image_descriptor_
@@ -474,9 +474,10 @@ def add_picture_fixture(
             r_, image_part_, rId_, shape_id_, new_picture_shape_):
         inline_shapes = InlineShapes(body_, None)
         property_mock(request, InlineShapes, 'part', return_value=document_)
+        run = Run(r_, None)
         return (
-            inline_shapes, image_descriptor_, document_, InlineShape_, r_,
-            image_part_, rId_, shape_id_, new_picture_shape_
+            inline_shapes, image_descriptor_, document_, InlineShape_, run,
+            r_, image_part_, rId_, shape_id_, new_picture_shape_
         )
 
     @pytest.fixture
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -22,7 +22,7 @@
 from docx.text import Paragraph, Run
 
 from .unitutil.mock import (
-    instance_mock, class_mock, method_mock, property_mock, var_mock
+    ANY, instance_mock, class_mock, method_mock, property_mock, var_mock
 )
 
 
@@ -93,7 +93,7 @@ def it_can_add_a_picture(self, add_picture_fixture):
         (document, image_path, width, height, inline_shapes_, expected_width,
          expected_height, picture_) = add_picture_fixture
         picture = document.add_picture(image_path, width, height)
-        inline_shapes_.add_picture.assert_called_once_with(image_path)
+        inline_shapes_.add_picture.assert_called_once_with(image_path, ANY)
         assert picture.width == expected_width
         assert picture.height == expected_height
         assert picture is picture_
diff --git a/tests/unitutil/mock.py b/tests/unitutil/mock.py
@@ -14,7 +14,7 @@
     from unittest.mock import create_autospec, Mock, patch, PropertyMock
 else:
     import mock  # noqa
-    from mock import call, MagicMock  # noqa
+    from mock import ANY, call, MagicMock  # noqa
     from mock import create_autospec, Mock, patch, PropertyMock
 
 
