parts: add _Document.inline_shapes

Steve Canny · Steve Canny · commit 9c05418832d2 · 2013-12-24T21:01:29.000-08:00
Along the way:

* refactor Describe_Document.it_can_serialize_to_xml()
diff --git a/docx/api.py b/docx/api.py
@@ -49,6 +49,13 @@ def body(self):
         """
         return self._document.body
 
+    @property
+    def inline_shapes(self):
+        """
+        Return a reference to the |InlineShapes| instance for this document.
+        """
+        return self._document.inline_shapes
+
     def save(self, file_):
         """
         Save this document to *file_*, where *file_* can be either a path to
diff --git a/docx/parts.py b/docx/parts.py
@@ -7,6 +7,7 @@
 from docx.opc.oxml import serialize_part_xml
 from docx.opc.package import Part
 from docx.oxml.shared import oxml_fromstring
+from docx.shared import lazyproperty
 from docx.table import Table
 from docx.text import Paragraph
 
@@ -32,6 +33,14 @@ def body(self):
         """
         return _Body(self._element.body)
 
+    @lazyproperty
+    def inline_shapes(self):
+        """
+        The |InlineShapes| instance containing the inline shapes in the
+        document.
+        """
+        return InlineShapes(self._element.body)
+
     @staticmethod
     def load(partname, content_type, blob, package):
         document_elm = oxml_fromstring(blob)
@@ -102,3 +111,6 @@ class InlineShapes(object):
     Sequence of |InlineShape| instances, supporting len(), iteration, and
     indexed access.
     """
+    def __init__(self, body_elm):
+        super(InlineShapes, self).__init__()
+        self._body = body_elm
diff --git a/tests/test_parts.py b/tests/test_parts.py
@@ -10,6 +10,7 @@
 
 from mock import Mock
 
+from docx.oxml.parts import CT_Document
 from docx.parts import _Body, _Document
 from docx.table import Table
 from docx.text import Paragraph
@@ -20,7 +21,7 @@
 )
 from .oxml.unitdata.text import a_p, a_sectPr
 from .unitutil import (
-    function_mock, class_mock, initializer_mock
+    function_mock, class_mock, initializer_mock, instance_mock
 )
 
 
@@ -50,17 +51,27 @@ def it_has_a_body(self, document_body_fixture):
         _Body_.assert_called_once_with(body_elm)
         assert _body is _Body_.return_value
 
-    def it_can_serialize_to_xml(self, serialize_part_xml_):
-        # mockery ----------------------
-        doc = _Document(None, None, None, None)
-        doc._element = Mock(name='_element')
-        # exercise ---------------------
-        doc.blob
-        # verify -----------------------
-        serialize_part_xml_.assert_called_once_with(doc._element)
+    def it_can_serialize_to_xml(self, document_blob_fixture):
+        document, document_elm, serialize_part_xml_ = document_blob_fixture
+        blob = document.blob
+        serialize_part_xml_.assert_called_once_with(document_elm)
+        assert blob is serialize_part_xml_.return_value
+
+    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)
+        assert inline_shapes is InlineShapes_.return_value
 
     # fixtures -------------------------------------------------------
 
+    @pytest.fixture
+    def document_blob_fixture(self, request, serialize_part_xml_):
+        document_elm = instance_mock(request, CT_Document)
+        document = _Document(None, None, document_elm, None)
+        return document, document_elm, serialize_part_xml_
+
     @pytest.fixture
     def document_body_fixture(self, request, _Body_):
         document_elm = (
@@ -79,6 +90,20 @@ def _Body_(self, request):
     def init(self, request):
         return initializer_mock(request, _Document)
 
+    @pytest.fixture
+    def InlineShapes_(self, request):
+        return class_mock(request, 'docx.parts.InlineShapes')
+
+    @pytest.fixture
+    def inline_shapes_fixture(self, request, InlineShapes_):
+        document_elm = (
+            a_document().with_nsdecls().with_child(
+                a_body())
+        ).element
+        body_elm = document_elm[0]
+        document = _Document(None, None, document_elm, None)
+        return document, InlineShapes_, body_elm
+
     @pytest.fixture
     def oxml_fromstring_(self, request):
         return function_mock(request, 'docx.parts.oxml_fromstring')
