run: remove prior Run.add_picture() Implementation

Steve Canny · Steve Canny · commit 71c657db4bba · 2015-02-16T00:51:14.000-08:00
In preparation for a complete rewrite.
diff --git a/docx/shape.py b/docx/shape.py
@@ -10,7 +10,6 @@
 )
 
 from .enum.shape import WD_INLINE_SHAPE
-from .oxml.shape import CT_Inline, CT_Picture
 from .oxml.ns import nsmap
 from .shared import Parented
 
@@ -41,19 +40,6 @@ def __iter__(self):
     def __len__(self):
         return len(self._inline_lst)
 
-    def add_picture(self, image_descriptor, run):
-        """
-        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 = run._r
-        picture = InlineShape.new_picture(r, image_part, rId, shape_id)
-        return picture
-
     @property
     def _inline_lst(self):
         body = self._body
@@ -84,22 +70,6 @@ def height(self, cy):
         assert 0 < cy
         self._inline.extent.cy = cy
 
-    @classmethod
-    def new_picture(cls, r, image_part, rId, shape_id):
-        """
-        Return a new |InlineShape| instance containing an inline picture
-        placement of *image_part* appended to run *r* and uniquely identified
-        by *shape_id*.
-        """
-        cx, cy, filename = (
-            image_part.default_cx, image_part.default_cy, image_part.filename
-        )
-        pic_id = 0
-        pic = CT_Picture.new(pic_id, filename, rId, cx, cy)
-        inline = CT_Inline.new(cx, cy, shape_id, pic)
-        r.add_drawing(inline)
-        return cls(inline)
-
     @property
     def type(self):
         """
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -57,23 +57,7 @@ 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.
         """
-        inline_shapes = self.part.inline_shapes
-        picture = inline_shapes.add_picture(image_path_or_stream, self)
-
-        # scale picture dimensions if width and/or height provided
-        if width is not None or height is not None:
-            native_width, native_height = picture.width, picture.height
-            if width is None:
-                scaling_factor = float(height) / float(native_height)
-                width = int(round(native_width * scaling_factor))
-            elif height is None:
-                scaling_factor = float(width) / float(native_width)
-                height = int(round(native_height * scaling_factor))
-            # set picture to scaled dimensions
-            picture.width = width
-            picture.height = height
-
-        return picture
+        raise NotImplementedError
 
     def add_tab(self):
         """
diff --git a/features/doc-add-picture.feature b/features/doc-add-picture.feature
@@ -4,26 +4,30 @@ Feature: Append an inline picture in its own paragraph
   I need a way to add a picture in its own paragraph
 
 
+  @wip
   Scenario: Add a picture at native size
     Given a blank document
      When I add a picture specifying only the image file
      Then the document contains the inline picture
       And the picture has its native width and height
 
 
+  @wip
   Scenario: Add a picture specifying both width and height
     Given a blank document
      When I add a picture specifying 1.75" width and 2.5" height
      Then picture.width is 1.75 inches
       And picture.height is 2.5 inches
 
 
+  @wip
   Scenario: Add a picture specifying only width
     Given a blank document
      When I add a picture specifying a width of 1.5 inches
      Then picture.height is 2.14 inches
 
 
+  @wip
   Scenario: Add a picture specifying only height
     Given a blank document
      When I add a picture specifying a height of 1.5 inches
diff --git a/features/run-add-picture.feature b/features/run-add-picture.feature
@@ -3,13 +3,16 @@ Feature: Add picture to a run
   As a developer using python-docx
   I need a way to add a picture to a run
 
+
+  @wip
   Scenario: Add a picture to a body paragraph run
     Given a run
      When I add a picture to the run
      Then the picture appears at the end of the run
       And the document contains the inline picture
 
 
+  @wip
   Scenario Outline: Add a picture to a run in a table cell
     Given a run inside a table cell retrieved from <cell-source>
      When I add a picture to the run
diff --git a/features/shp-add-inline-picture.feature b/features/shp-add-inline-picture.feature
diff --git a/features/steps/shape.py b/features/steps/shape.py
@@ -15,7 +15,7 @@
 from docx.shape import InlineShape
 from docx.shared import Inches
 
-from helpers import test_docx, test_file
+from helpers import test_docx
 
 
 # given ===================================================
@@ -49,23 +49,6 @@ def given_inline_shape_known_to_be_shape_of_type(context, shp_of_type):
 
 # when =====================================================
 
-@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('monty-truth.png'), 'rb') as 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('monty-truth.png'), run
-    ))
-
-
 @when('I change the dimensions of the inline shape')
 def when_change_dimensions_of_inline_shape(context):
     inline_shape = context.inline_shape
diff --git a/tests/test_shape.py b/tests/test_shape.py
@@ -9,26 +9,15 @@
 import pytest
 
 from docx.enum.shape import WD_INLINE_SHAPE
-from docx.oxml.document import CT_Body
 from docx.oxml.ns import nsmap
-from docx.oxml.text.run import CT_R
-from docx.parts.document import DocumentPart
-from docx.parts.image import ImagePart
 from docx.shape import InlineShape, InlineShapes
 from docx.shared import Length
-from docx.text.run import Run
 
 from .oxml.unitdata.dml import (
-    a_blip, a_blipFill, a_cNvGraphicFramePr, a_cNvPr, a_cNvPicPr, a_docPr,
-    a_fillRect, a_graphic, a_graphicData, a_graphicFrameLocks, a_pic,
-    a_prstGeom, a_stretch, an_ext, an_extent, an_inline, an_nvPicPr, an_off,
-    an_spPr, an_xfrm
+    a_blip, a_blipFill, a_graphic, a_graphicData, a_pic, an_inline,
 )
-from .oxml.unitdata.text import an_r
 from .unitutil.cxml import element, xml
-from .unitutil.mock import (
-    class_mock, instance_mock, loose_mock, property_mock
-)
+from .unitutil.mock import loose_mock
 
 
 class DescribeInlineShapes(object):
@@ -64,42 +53,13 @@ def it_raises_on_indexed_access_out_of_range(
             too_high = inline_shape_count
             inline_shapes[too_high]
 
-    def it_can_add_an_inline_picture_to_the_document(
-            self, add_picture_fixture):
-        # fixture ----------------------
-        (inline_shapes, image_descriptor_, document_, InlineShape_,
-         run, r_, image_part_, rId_, shape_id_, new_picture_shape_
-         ) = add_picture_fixture
-        # exercise ---------------------
-        picture_shape = inline_shapes.add_picture(image_descriptor_, run)
-        # verify -----------------------
-        document_.get_or_add_image_part.assert_called_once_with(
-            image_descriptor_
-        )
-        InlineShape_.new_picture.assert_called_once_with(
-            r_, image_part_, rId_, shape_id_
-        )
-        assert picture_shape is new_picture_shape_
-
     def it_knows_the_part_it_belongs_to(self, inline_shapes_with_parent_):
         inline_shapes, parent_ = inline_shapes_with_parent_
         part = inline_shapes.part
         assert part is parent_.part
 
     # fixtures -------------------------------------------------------
 
-    @pytest.fixture
-    def add_picture_fixture(
-            self, request, body_, document_, image_descriptor_, InlineShape_,
-            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_, run,
-            r_, image_part_, rId_, shape_id_, new_picture_shape_
-        )
-
     @pytest.fixture
     def inline_shapes_fixture(self):
         body = element(
@@ -111,71 +71,19 @@ def inline_shapes_fixture(self):
 
     # fixture components ---------------------------------------------
 
-    @pytest.fixture
-    def body_(self, request, r_):
-        body_ = instance_mock(request, CT_Body)
-        body_.add_p.return_value.add_r.return_value = r_
-        return body_
-
-    @pytest.fixture
-    def document_(self, request, rId_, image_part_, shape_id_):
-        document_ = instance_mock(request, DocumentPart, name='document_')
-        document_.get_or_add_image_part.return_value = image_part_, rId_
-        document_.next_id = shape_id_
-        return document_
-
-    @pytest.fixture
-    def image_part_(self, request):
-        return instance_mock(request, ImagePart)
-
-    @pytest.fixture
-    def image_descriptor_(self, request):
-        return instance_mock(request, str)
-
-    @pytest.fixture
-    def InlineShape_(self, request, new_picture_shape_):
-        InlineShape_ = class_mock(request, 'docx.shape.InlineShape')
-        InlineShape_.new_picture.return_value = new_picture_shape_
-        return InlineShape_
-
     @pytest.fixture
     def inline_shapes_with_parent_(self, request):
         parent_ = loose_mock(request, name='parent_')
         inline_shapes = InlineShapes(None, parent_)
         return inline_shapes, parent_
 
-    @pytest.fixture
-    def new_picture_shape_(self, request):
-        return instance_mock(request, InlineShape)
-
-    @pytest.fixture
-    def r_(self, request):
-        return instance_mock(request, CT_R)
-
-    @pytest.fixture
-    def rId_(self, request):
-        return instance_mock(request, str)
-
-    @pytest.fixture
-    def shape_id_(self, request):
-        return instance_mock(request, int)
-
 
 class DescribeInlineShape(object):
 
     def it_knows_what_type_of_shape_it_is(self, shape_type_fixture):
         inline_shape, inline_shape_type = shape_type_fixture
         assert inline_shape.type == inline_shape_type
 
-    def it_can_contruct_a_new_inline_picture_shape(
-            self, new_picture_fixture):
-        inline_shape, r, image_part_, rId, shape_id, expected_inline_xml = (
-            new_picture_fixture
-        )
-        picture = inline_shape.new_picture(r, image_part_, rId, shape_id)
-        assert picture._inline.xml == expected_inline_xml
-        assert r[0][0] is picture._inline
-
     def it_knows_its_display_dimensions(self, dimensions_get_fixture):
         inline_shape, cx, cy = dimensions_get_fixture
         width = inline_shape.width
@@ -211,29 +119,6 @@ def dimensions_set_fixture(self):
         expected_xml = xml(expected_cxml)
         return inline_shape, new_cx, new_cy, expected_xml
 
-    @pytest.fixture
-    def new_picture_fixture(self, request, image_part_, image_params):
-        filename, rId, cx, cy = image_params
-        inline_shape = InlineShape(None)
-        r = an_r().with_nsdecls().element
-        shape_id = 7
-        name = 'Picture %d' % shape_id
-        uri = nsmap['pic']
-        expected_inline = (
-            an_inline().with_nsdecls('wp', 'a', 'pic', 'r', 'w').with_child(
-                an_extent().with_cx(cx).with_cy(cy)).with_child(
-                a_docPr().with_id(shape_id).with_name(name)).with_child(
-                a_cNvGraphicFramePr().with_child(
-                    a_graphicFrameLocks().with_noChangeAspect(1))).with_child(
-                a_graphic().with_child(
-                    a_graphicData().with_uri(uri).with_child(
-                        self._pic_bldr(filename, rId, cx, cy))))
-        ).element
-        expected_inline_xml = expected_inline.xml
-        return (
-            inline_shape, r, image_part_, rId, shape_id, expected_inline_xml
-        )
-
     @pytest.fixture(params=[
         'embed pic', 'link pic', 'link+embed pic', 'chart', 'smart art',
         'not implemented'
@@ -267,22 +152,6 @@ def shape_type_fixture(self, request):
 
     # fixture components ---------------------------------------------
 
-    @pytest.fixture
-    def image_params(self):
-        filename = 'foobar.garf'
-        rId = 'rId42'
-        cx, cy = 914422, 223344
-        return filename, rId, cx, cy
-
-    @pytest.fixture
-    def image_part_(self, request, image_params):
-        filename, rId, cx, cy = image_params
-        image_part_ = instance_mock(request, ImagePart)
-        image_part_.default_cx = cx
-        image_part_.default_cy = cy
-        image_part_.filename = filename
-        return image_part_
-
     def _inline_with_picture(self, embed=False, link=False):
         picture_ns = nsmap['pic']
 
@@ -309,20 +178,3 @@ def _inline_with_uri(self, uri):
                     a_graphicData().with_uri(uri)))
         ).element
         return inline
-
-    def _pic_bldr(self, name, rId, cx, cy):
-        return (
-            a_pic().with_child(
-                an_nvPicPr().with_child(
-                    a_cNvPr().with_id(0).with_name(name)).with_child(
-                    a_cNvPicPr())).with_child(
-                a_blipFill().with_child(
-                    a_blip().with_embed(rId)).with_child(
-                    a_stretch().with_child(
-                        a_fillRect()))).with_child(
-                an_spPr().with_child(
-                    an_xfrm().with_child(
-                        an_off().with_x(0).with_y(0)).with_child(
-                        an_ext().with_cx(cx).with_cy(cy))).with_child(
-                    a_prstGeom().with_prst('rect')))
-        )
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
