run: rewrite Run.add_picture()

Steve Canny · Steve Canny · commit e7553c2ba3bf · 2015-02-16T01:00:03.000-08:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -80,6 +80,14 @@ def inline_shapes(self):
         """
         return InlineShapes(self._element.body, self)
 
+    def new_pic_inline(self, image_descriptor, width, height):
+        """
+        Return a newly-created `w:inline` element containing the image
+        specified by *image_descriptor* and scaled based on the values of
+        *width* and *height*.
+        """
+        raise NotImplementedError
+
     @property
     def next_id(self):
         """
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -8,6 +8,7 @@
 
 from ..enum.style import WD_STYLE_TYPE
 from ..enum.text import WD_BREAK
+from ..shape import InlineShape
 from ..shared import ElementProxy, Parented
 
 
@@ -57,7 +58,9 @@ 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.
         """
-        raise NotImplementedError
+        inline = self.part.new_pic_inline(image_path_or_stream, width, height)
+        self._r.add_drawing(inline)
+        return InlineShape(inline)
 
     def add_tab(self):
         """
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
@@ -11,6 +11,7 @@
 from docx.enum.style import WD_STYLE_TYPE
 from docx.enum.text import WD_BREAK, WD_UNDERLINE
 from docx.parts.document import DocumentPart
+from docx.shape import InlineShape
 from docx.shared import Pt
 from docx.text.run import Font, Run
 
@@ -84,6 +85,17 @@ def it_can_add_a_tab(self, add_tab_fixture):
         run.add_tab()
         assert run._r.xml == expected_xml
 
+    def it_can_add_a_picture(self, add_picture_fixture):
+        run, image, width, height, inline = add_picture_fixture[:5]
+        expected_xml, InlineShape_, picture_ = add_picture_fixture[5:]
+
+        picture = run.add_picture(image, width, height)
+
+        run.part.new_pic_inline.assert_called_once_with(image, width, height)
+        assert run._r.xml == expected_xml
+        InlineShape_.assert_called_once_with(inline)
+        assert picture is picture_
+
     def it_can_remove_its_content_but_keep_formatting(self, clear_fixture):
         run, expected_xml = clear_fixture
         _run = run.clear()
@@ -118,6 +130,20 @@ def add_break_fixture(self, request):
         expected_xml = xml(expected_cxml)
         return run, break_type, expected_xml
 
+    @pytest.fixture
+    def add_picture_fixture(self, part_prop_, document_part_, InlineShape_,
+                            picture_):
+        run = Run(element('w:r/wp:x'), None)
+        image = 'foobar.png'
+        width, height, inline = 1111, 2222, element('wp:inline{id=42}')
+        expected_xml = xml('w:r/(wp:x,w:drawing/wp:inline{id=42})')
+        document_part_.new_pic_inline.return_value = inline
+        InlineShape_.return_value = picture_
+        return (
+            run, image, width, height, inline, expected_xml, InlineShape_,
+            picture_
+        )
+
     @pytest.fixture(params=[
         ('w:r/w:t"foo"', 'w:r/(w:t"foo", w:tab)'),
     ])
@@ -304,12 +330,20 @@ def Font_(self, request, font_):
     def font_(self, request):
         return instance_mock(request, Font)
 
+    @pytest.fixture
+    def InlineShape_(self, request):
+        return class_mock(request, 'docx.text.run.InlineShape')
+
     @pytest.fixture
     def part_prop_(self, request, document_part_):
         return property_mock(
             request, Run, 'part', return_value=document_part_
         )
 
+    @pytest.fixture
+    def picture_(self, request):
+        return instance_mock(request, InlineShape)
+
     @pytest.fixture
     def Text_(self, request):
         return class_mock(request, 'docx.text.run._Text')
