opc: add reltype to _SerializedPart

Steve Canny · Steve Canny · commit 71e0a41739b4 · 2013-12-28T04:54:31.000-08:00
diff --git a/docx/opc/pkgreader.py b/docx/opc/pkgreader.py
@@ -64,9 +64,11 @@ def _load_serialized_parts(phys_reader, pkg_srels, content_types):
         """
         sparts = []
         part_walker = PackageReader._walk_phys_parts(phys_reader, pkg_srels)
-        for partname, blob, srels in part_walker:
+        for partname, blob, reltype, srels in part_walker:
             content_type = content_types[partname]
-            spart = _SerializedPart(partname, content_type, blob, srels)
+            spart = _SerializedPart(
+                partname, content_type, reltype, blob, srels
+            )
             sparts.append(spart)
         return tuple(sparts)
 
@@ -83,8 +85,9 @@ def _srels_for(phys_reader, source_uri):
     @staticmethod
     def _walk_phys_parts(phys_reader, srels, visited_partnames=None):
         """
-        Generate a 3-tuple `(partname, blob, srels)` for each of the parts in
-        *phys_reader* by walking the relationship graph rooted at srels.
+        Generate a 4-tuple `(partname, blob, reltype, srels)` for each of the
+        parts in *phys_reader* by walking the relationship graph rooted at
+        srels.
         """
         if visited_partnames is None:
             visited_partnames = []
@@ -95,12 +98,15 @@ def _walk_phys_parts(phys_reader, srels, visited_partnames=None):
             if partname in visited_partnames:
                 continue
             visited_partnames.append(partname)
+            reltype = srel.reltype
             part_srels = PackageReader._srels_for(phys_reader, partname)
             blob = phys_reader.blob_for(partname)
-            yield (partname, blob, part_srels)
-            for partname, blob, srels in PackageReader._walk_phys_parts(
-                    phys_reader, part_srels, visited_partnames):
-                yield (partname, blob, srels)
+            yield (partname, blob, reltype, part_srels)
+            next_walker = PackageReader._walk_phys_parts(
+                phys_reader, part_srels, visited_partnames
+            )
+            for partname, blob, reltype, srels in next_walker:
+                yield (partname, blob, reltype, srels)
 
 
 class _ContentTypeMap(object):
@@ -149,10 +155,11 @@ class _SerializedPart(object):
     Value object for an OPC package part. Provides access to the partname,
     content type, blob, and serialized relationships for the part.
     """
-    def __init__(self, partname, content_type, blob, srels):
+    def __init__(self, partname, content_type, reltype, blob, srels):
         super(_SerializedPart, self).__init__()
         self._partname = partname
         self._content_type = content_type
+        self._reltype = reltype
         self._blob = blob
         self._srels = srels
 
@@ -168,6 +175,13 @@ def content_type(self):
     def blob(self):
         return self._blob
 
+    @property
+    def reltype(self):
+        """
+        The referring relationship type of this part.
+        """
+        return self._reltype
+
     @property
     def srels(self):
         return self._srels
diff --git a/tests/opc/test_pkgreader.py b/tests/opc/test_pkgreader.py
@@ -28,44 +28,6 @@ def oxml_fromstring(request):
 
 class DescribePackageReader(object):
 
-    @pytest.fixture
-    def from_xml(self, request):
-        return method_mock(request, _ContentTypeMap, 'from_xml')
-
-    @pytest.fixture
-    def init(self, request):
-        return initializer_mock(request, PackageReader)
-
-    @pytest.fixture
-    def _load_serialized_parts(self, request):
-        return method_mock(request, PackageReader, '_load_serialized_parts')
-
-    @pytest.fixture
-    def PhysPkgReader_(self, request):
-        _patch = patch(
-            'docx.opc.pkgreader.PhysPkgReader', spec_set=_ZipPkgReader
-        )
-        request.addfinalizer(_patch.stop)
-        return _patch.start()
-
-    @pytest.fixture
-    def _SerializedPart_(self, request):
-        return class_mock(request, 'docx.opc.pkgreader._SerializedPart')
-
-    @pytest.fixture
-    def _SerializedRelationshipCollection_(self, request):
-        return class_mock(
-            request, 'docx.opc.pkgreader._SerializedRelationshipCollection'
-        )
-
-    @pytest.fixture
-    def _srels_for(self, request):
-        return method_mock(request, PackageReader, '_srels_for')
-
-    @pytest.fixture
-    def _walk_phys_parts(self, request):
-        return method_mock(request, PackageReader, '_walk_phys_parts')
-
     def it_can_construct_from_pkg_file(self, init, PhysPkgReader_, from_xml,
                                        _srels_for, _load_serialized_parts):
         # mockery ----------------------
@@ -125,10 +87,12 @@ def it_can_iterate_over_all_the_srels(self):
     def it_can_load_serialized_parts(self, _SerializedPart_, _walk_phys_parts):
         # test data --------------------
         test_data = (
-            ('/part/name1.xml', 'app/vnd.type_1', '<Part_1/>', 'srels_1'),
-            ('/part/name2.xml', 'app/vnd.type_2', '<Part_2/>', 'srels_2'),
+            ('/part/name1.xml', 'app/vnd.type_1', 'reltype1', '<Part_1/>',
+             'srels_1'),
+            ('/part/name2.xml', 'app/vnd.type_2', 'reltype2', '<Part_2/>',
+             'srels_2'),
         )
-        iter_vals = [(t[0], t[2], t[3]) for t in test_data]
+        iter_vals = [(t[0], t[2], t[3], t[4]) for t in test_data]
         content_types = dict((t[0], t[1]) for t in test_data)
         # mockery ----------------------
         phys_reader = Mock(name='phys_reader')
@@ -138,12 +102,15 @@ def it_can_load_serialized_parts(self, _SerializedPart_, _walk_phys_parts):
             Mock(name='spart_1'), Mock(name='spart_2')
         )
         # exercise ---------------------
-        retval = PackageReader._load_serialized_parts(phys_reader, pkg_srels,
-                                                      content_types)
+        retval = PackageReader._load_serialized_parts(
+            phys_reader, pkg_srels, content_types
+        )
         # verify -----------------------
         expected_calls = [
-            call('/part/name1.xml', 'app/vnd.type_1', '<Part_1/>', 'srels_1'),
-            call('/part/name2.xml', 'app/vnd.type_2', '<Part_2/>', 'srels_2'),
+            call('/part/name1.xml', 'app/vnd.type_1', '<Part_1/>',
+                 'reltype1', 'srels_1'),
+            call('/part/name2.xml', 'app/vnd.type_2', '<Part_2/>',
+                 'reltype2', 'srels_2'),
         ]
         assert _SerializedPart_.call_args_list == expected_calls
         assert retval == expected_sparts
@@ -164,12 +131,17 @@ def it_can_walk_phys_pkg_parts(self, _srels_for):
         part_1_blob, part_2_blob, part_3_blob = (
             '<Part_1/>', '<Part_2/>', '<Part_3/>'
         )
+        reltype1, reltype2, reltype3 = ('reltype1', 'reltype2', 'reltype3')
         srels = [
             Mock(name='rId1', is_external=True),
-            Mock(name='rId2', is_external=False, target_partname=partname_1),
-            Mock(name='rId3', is_external=False, target_partname=partname_2),
-            Mock(name='rId4', is_external=False, target_partname=partname_1),
-            Mock(name='rId5', is_external=False, target_partname=partname_3),
+            Mock(name='rId2', is_external=False, reltype=reltype1,
+                 target_partname=partname_1),
+            Mock(name='rId3', is_external=False, reltype=reltype2,
+                 target_partname=partname_2),
+            Mock(name='rId4', is_external=False, reltype=reltype1,
+                 target_partname=partname_1),
+            Mock(name='rId5', is_external=False, reltype=reltype3,
+                 target_partname=partname_3),
         ]
         pkg_srels = srels[:2]
         part_1_srels = srels[2:3]
@@ -182,13 +154,14 @@ def it_can_walk_phys_pkg_parts(self, _srels_for):
             part_1_blob, part_2_blob, part_3_blob
         ]
         # exercise ---------------------
-        generated_tuples = [t for t in PackageReader._walk_phys_parts(
-            phys_reader, pkg_srels)]
+        generated_tuples = list(
+            PackageReader._walk_phys_parts(phys_reader, pkg_srels)
+        )
         # verify -----------------------
         expected_tuples = [
-            (partname_1, part_1_blob, part_1_srels),
-            (partname_2, part_2_blob, part_2_srels),
-            (partname_3, part_3_blob, part_3_srels),
+            (partname_1, part_1_blob, reltype1, part_1_srels),
+            (partname_2, part_2_blob, reltype2, part_2_srels),
+            (partname_3, part_3_blob, reltype3, part_3_srels),
         ]
         assert generated_tuples == expected_tuples
 
@@ -207,6 +180,46 @@ def it_can_retrieve_srels_for_a_source_uri(
         load_from_xml.assert_called_once_with(source_uri.baseURI, rels_xml)
         assert retval == srels
 
+    # fixtures -------------------------------------------------------
+
+    @pytest.fixture
+    def from_xml(self, request):
+        return method_mock(request, _ContentTypeMap, 'from_xml')
+
+    @pytest.fixture
+    def init(self, request):
+        return initializer_mock(request, PackageReader)
+
+    @pytest.fixture
+    def _load_serialized_parts(self, request):
+        return method_mock(request, PackageReader, '_load_serialized_parts')
+
+    @pytest.fixture
+    def PhysPkgReader_(self, request):
+        _patch = patch(
+            'docx.opc.pkgreader.PhysPkgReader', spec_set=_ZipPkgReader
+        )
+        request.addfinalizer(_patch.stop)
+        return _patch.start()
+
+    @pytest.fixture
+    def _SerializedPart_(self, request):
+        return class_mock(request, 'docx.opc.pkgreader._SerializedPart')
+
+    @pytest.fixture
+    def _SerializedRelationshipCollection_(self, request):
+        return class_mock(
+            request, 'docx.opc.pkgreader._SerializedRelationshipCollection'
+        )
+
+    @pytest.fixture
+    def _srels_for(self, request):
+        return method_mock(request, PackageReader, '_srels_for')
+
+    @pytest.fixture
+    def _walk_phys_parts(self, request):
+        return method_mock(request, PackageReader, '_walk_phys_parts')
+
 
 class Describe_ContentTypeMap(object):
 
@@ -284,13 +297,15 @@ def it_remembers_construction_values(self):
         # test data --------------------
         partname = '/part/name.xml'
         content_type = 'app/vnd.type'
+        reltype = 'http://rel/type'
         blob = '<Part/>'
         srels = 'srels proxy'
         # exercise ---------------------
-        spart = _SerializedPart(partname, content_type, blob, srels)
+        spart = _SerializedPart(partname, content_type, reltype, blob, srels)
         # verify -----------------------
         assert spart.partname == partname
         assert spart.content_type == content_type
+        assert spart.reltype == reltype
         assert spart.blob == blob
         assert spart.srels == srels
 
