shp: migrate InlineShapes to docx.shape

Steve Canny · Steve Canny · commit e648135d98f1 · 2015-02-15T14:07:25.000-08:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -12,14 +12,19 @@
 from .numbering import NumberingPart
 from ..opc.constants import RELATIONSHIP_TYPE as RT
 from ..opc.part import XmlPart
-from ..shape import InlineShape
-from ..shared import lazyproperty, Parented
+from ..shape import InlineShapes
+from ..shared import lazyproperty
 from .styles import StylesPart
 
 
 class DocumentPart(XmlPart):
     """
     Main document part of a WordprocessingML (WML) package, aka a .docx file.
+    Acts as broker to other parts such as image, core properties, and style
+    parts. It also acts as a convenient delegate when a mid-document object
+    needs a service involving a remote ancestor. The `Parented.part` property
+    inherited by many content objects provides access to this part object for
+    that purpose.
     """
     @property
     def core_properties(self):
@@ -129,49 +134,3 @@ def _styles_part(self):
             styles_part = StylesPart.default(self.package)
             self.relate_to(styles_part, RT.STYLES)
             return styles_part
-
-
-class InlineShapes(Parented):
-    """
-    Sequence of |InlineShape| instances, supporting len(), iteration, and
-    indexed access.
-    """
-    def __init__(self, body_elm, parent):
-        super(InlineShapes, self).__init__(parent)
-        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)
-
-    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
-        xpath = '//w:p/w:r/w:drawing/wp:inline'
-        return body.xpath(xpath)
diff --git a/docx/shape.py b/docx/shape.py
@@ -12,6 +12,53 @@
 from .enum.shape import WD_INLINE_SHAPE
 from .oxml.shape import CT_Inline, CT_Picture
 from .oxml.ns import nsmap
+from .shared import Parented
+
+
+class InlineShapes(Parented):
+    """
+    Sequence of |InlineShape| instances, supporting len(), iteration, and
+    indexed access.
+    """
+    def __init__(self, body_elm, parent):
+        super(InlineShapes, self).__init__(parent)
+        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)
+
+    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
+        xpath = '//w:p/w:r/w:drawing/wp:inline'
+        return body.xpath(xpath)
 
 
 class InlineShape(object):
diff --git a/features/steps/document.py b/features/steps/document.py
@@ -10,7 +10,7 @@
 
 from docx import Document
 from docx.enum.section import WD_ORIENT, WD_SECTION
-from docx.parts.document import InlineShapes
+from docx.shape import InlineShapes
 from docx.shared import Inches
 from docx.section import Sections
 from docx.styles.styles import Styles
diff --git a/features/steps/shape.py b/features/steps/shape.py
@@ -12,7 +12,7 @@
 
 from docx import Document
 from docx.enum.shape import WD_INLINE_SHAPE
-from docx.parts.document import InlineShape
+from docx.shape import InlineShape
 from docx.shared import Inches
 
 from helpers import test_docx, test_file
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -10,24 +10,19 @@
 
 from docx.opc.constants import RELATIONSHIP_TYPE as RT
 from docx.opc.coreprops import CoreProperties
-from docx.oxml.parts.document import CT_Body
-from docx.oxml.text.run import CT_R
 from docx.package import ImageParts, Package
-from docx.parts.document import DocumentPart, InlineShapes
+from docx.parts.document import DocumentPart
 from docx.parts.image import ImagePart
 from docx.parts.numbering import NumberingPart
 from docx.parts.styles import StylesPart
-from docx.shape import InlineShape
 from docx.styles.style import BaseStyle
 from docx.styles.styles import Styles
 from docx.text.paragraph import Paragraph
-from docx.text.run import Run
 
 from ..oxml.parts.unitdata.document import a_body, a_document
 from ..oxml.unitdata.text import a_p
-from ..unitutil.cxml import element
 from ..unitutil.mock import (
-    instance_mock, class_mock, loose_mock, method_mock, property_mock
+    instance_mock, class_mock, method_mock, property_mock
 )
 
 
@@ -300,133 +295,3 @@ def styles_prop_(self, request, styles_):
     @pytest.fixture
     def _styles_part_prop_(self, request):
         return property_mock(request, DocumentPart, '_styles_part')
-
-
-class DescribeInlineShapes(object):
-
-    def it_knows_how_many_inline_shapes_it_contains(
-            self, inline_shapes_fixture):
-        inline_shapes, expected_count = inline_shapes_fixture
-        assert len(inline_shapes) == expected_count
-
-    def it_can_iterate_over_its_InlineShape_instances(
-            self, inline_shapes_fixture):
-        inline_shapes, inline_shape_count = inline_shapes_fixture
-        actual_count = 0
-        for inline_shape in inline_shapes:
-            assert isinstance(inline_shape, InlineShape)
-            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]
-
-    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(
-            'w:body/w:p/(w:r/w:drawing/wp:inline, w:r/w:drawing/wp:inline)'
-        )
-        inline_shapes = InlineShapes(body, None)
-        expected_count = 2
-        return inline_shapes, expected_count
-
-    # 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.parts.document.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)
diff --git a/tests/test_document.py b/tests/test_document.py
@@ -14,9 +14,9 @@
 from docx.enum.section import WD_SECTION
 from docx.enum.text import WD_BREAK
 from docx.opc.coreprops import CoreProperties
-from docx.parts.document import DocumentPart, InlineShapes
+from docx.parts.document import DocumentPart
 from docx.section import Sections
-from docx.shape import InlineShape
+from docx.shape import InlineShape, InlineShapes
 from docx.styles.styles import Styles
 from docx.table import Table
 from docx.text.paragraph import Paragraph
diff --git a/tests/test_shape.py b/tests/test_shape.py
diff --git a/tests/text/test_run.py b/tests/text/test_run.py
