shp: add InlineShapes.part

Steve Canny · Steve Canny · commit 10f171818cb6 · 2013-12-27T00:18:35.000-08:00
Added via parent protocol, implemented via docx.shared.Parented
superclass
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -8,7 +8,7 @@
 from docx.opc.oxml import serialize_part_xml
 from docx.opc.package import Part
 from docx.oxml.shared import nsmap, oxml_fromstring
-from docx.shared import lazyproperty
+from docx.shared import lazyproperty, Parented
 from docx.table import Table
 from docx.text import Paragraph
 
@@ -50,7 +50,7 @@ def inline_shapes(self):
         The |InlineShapes| instance containing the inline shapes in the
         document.
         """
-        return InlineShapes(self._element.body)
+        return InlineShapes(self._element.body, self)
 
     @staticmethod
     def load(partname, content_type, blob, package):
@@ -67,6 +67,15 @@ def next_id(self):
         """
         raise NotImplementedError
 
+    @property
+    def part(self):
+        """
+        Part of the parent protocol, "children" of the document will not know
+        the part that contains them so must ask their parent object. That
+        chain of delegation ends here for document child objects.
+        """
+        return self
+
 
 class _Body(object):
     """
@@ -160,13 +169,13 @@ def type(self):
         return WD_INLINE_SHAPE.NOT_IMPLEMENTED
 
 
-class InlineShapes(object):
+class InlineShapes(Parented):
     """
     Sequence of |InlineShape| instances, supporting len(), iteration, and
     indexed access.
     """
-    def __init__(self, body_elm):
-        super(InlineShapes, self).__init__()
+    def __init__(self, body_elm, parent):
+        super(InlineShapes, self).__init__(parent)
         self._body = body_elm
 
     def __getitem__(self, idx):
@@ -198,15 +207,6 @@ def add_picture(self, image_descriptor):
         r = self._body.add_p().add_r()
         return InlineShape.new_picture(r, image, rId, shape_id)
 
-    @property
-    def part(self):
-        """
-        The package part containing this object, a |_Document| instance in
-        this case.
-        """
-        # return self._parent.part
-        raise NotImplementedError
-
     @property
     def _inline_lst(self):
         body = self._body
diff --git a/docx/shared.py b/docx/shared.py
@@ -35,3 +35,22 @@ def write_only_property(f):
     docstring = f.__doc__
 
     return property(fset=f, doc=docstring)
+
+
+class Parented(object):
+    """
+    Provides common services for document elements that occur below a part
+    but may occasionally require an ancestor object to provide a service,
+    such as add or drop a relationship. Provides ``self._parent`` attribute
+    to subclasses.
+    """
+    def __init__(self, parent):
+        super(Parented, self).__init__()
+        self._parent = parent
+
+    @property
+    def part(self):
+        """
+        The package part containing this object
+        """
+        return self._parent.part
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -28,7 +28,8 @@
 )
 from ..oxml.unitdata.text import a_p, a_sectPr, an_r
 from ..unitutil import (
-    function_mock, class_mock, initializer_mock, instance_mock, property_mock
+    function_mock, class_mock, initializer_mock, instance_mock, loose_mock,
+    property_mock
 )
 
 
@@ -68,11 +69,18 @@ def it_provides_access_to_the_inline_shapes_in_the_document(
             self, inline_shapes_fixture):
         document, InlineShapes_, body_elm = inline_shapes_fixture
         inline_shapes = document.inline_shapes
-        InlineShapes_.assert_called_once_with(body_elm)
+        InlineShapes_.assert_called_once_with(body_elm, document)
         assert inline_shapes is InlineShapes_.return_value
 
+    def it_knows_it_is_the_part_its_child_objects_belong_to(self, document):
+        assert document.part is document
+
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture
+    def document(self):
+        return _Document(None, None, None, None)
+
     @pytest.fixture
     def document_blob_fixture(self, request, serialize_part_xml_):
         document_elm = instance_mock(request, CT_Document)
@@ -375,13 +383,18 @@ def it_can_add_an_inline_picture_to_the_document(
         )
         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_, rId_, shape_id_, new_picture_shape_):
-        inline_shapes = InlineShapes(body_)
+        inline_shapes = InlineShapes(body_, None)
         property_mock(request, InlineShapes, 'part', return_value=document_)
         return (
             inline_shapes, image_descriptor_, document_, InlineShape_, r_,
@@ -431,9 +444,15 @@ def inline_shapes_fixture(self):
                 )
             )
         ).element
-        inline_shapes = InlineShapes(body)
+        inline_shapes = InlineShapes(body, None)
         return inline_shapes, inline_shape_count
 
+    @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)
