opc: add OpcPackage._core_properties_part

Steve Canny · Steve Canny · commit 07127f26dafa · 2014-12-13T23:28:10.000-08:00
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -9,6 +9,7 @@
 
 from docx.opc.constants import CONTENT_TYPE as CT, RELATIONSHIP_TYPE as RT
 from docx.opc.part import PartFactory
+from docx.opc.parts.coreprops import CorePropertiesPart
 
 from docx.parts.document import DocumentPart
 from docx.parts.image import ImagePart
@@ -23,8 +24,12 @@ def part_class_selector(content_type, reltype):
 
 
 PartFactory.part_class_selector = part_class_selector
+PartFactory.part_type_for[CT.OPC_CORE_PROPERTIES] = CorePropertiesPart
 PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN] = DocumentPart
 PartFactory.part_type_for[CT.WML_NUMBERING] = NumberingPart
 PartFactory.part_type_for[CT.WML_STYLES] = StylesPart
 
-del CT, DocumentPart, PartFactory, part_class_selector
+del (
+    CT, CorePropertiesPart, DocumentPart, NumberingPart, PartFactory,
+    StylesPart, part_class_selector
+)
diff --git a/docx/opc/package.py b/docx/opc/package.py
@@ -10,6 +10,7 @@
 from .constants import RELATIONSHIP_TYPE as RT
 from .packuri import PACKAGE_URI
 from .part import PartFactory
+from .parts.coreprops import CorePropertiesPart
 from .pkgreader import PackageReader
 from .pkgwriter import PackageWriter
 from .rel import Relationships
@@ -164,7 +165,12 @@ def _core_properties_part(self):
         |CorePropertiesPart| object related to this package. Creates
         a default core properties part if one is not present (not common).
         """
-        raise NotImplementedError
+        try:
+            return self.part_related_by(RT.CORE_PROPERTIES)
+        except KeyError:
+            core_properties_part = CorePropertiesPart.default(self)
+            self.relate_to(core_properties_part, RT.CORE_PROPERTIES)
+            return core_properties_part
 
 
 class Unmarshaller(object):
diff --git a/docx/opc/parts/coreprops.py b/docx/opc/parts/coreprops.py
@@ -16,6 +16,14 @@ class CorePropertiesPart(XmlPart):
     Corresponds to part named ``/docProps/core.xml``, containing the core
     document properties for this document package.
     """
+    @classmethod
+    def default(cls, package):
+        """
+        Return a new |CorePropertiesPart| object initialized with default
+        values for its base properties.
+        """
+        raise NotImplementedError
+
     @property
     def core_properties(self):
         """
diff --git a/tests/opc/test_package.py b/tests/opc/test_package.py
@@ -8,6 +8,7 @@
 
 import pytest
 
+from docx.opc.constants import RELATIONSHIP_TYPE as RT
 from docx.opc.coreprops import CoreProperties
 from docx.opc.package import OpcPackage, Unmarshaller
 from docx.opc.packuri import PACKAGE_URI
@@ -116,6 +117,26 @@ def it_provides_access_to_the_core_properties(self, core_props_fixture):
         core_properties = opc_package.core_properties
         assert core_properties is core_properties_
 
+    def it_provides_access_to_the_core_properties_part_to_help(
+            self, core_props_part_fixture):
+        opc_package, core_properties_part_ = core_props_part_fixture
+        core_properties_part = opc_package._core_properties_part
+        assert core_properties_part is core_properties_part_
+
+    def it_creates_a_default_core_props_part_if_none_present(
+            self, default_core_props_fixture):
+        opc_package, CorePropertiesPart_, core_properties_part_ = (
+            default_core_props_fixture
+        )
+
+        core_properties_part = opc_package._core_properties_part
+
+        CorePropertiesPart_.default.assert_called_once_with(opc_package)
+        opc_package.relate_to.assert_called_once_with(
+            core_properties_part_, RT.CORE_PROPERTIES
+        )
+        assert core_properties_part is core_properties_part_
+
     # fixtures ---------------------------------------------
 
     @pytest.fixture
@@ -127,6 +148,22 @@ def core_props_fixture(
         core_properties_part_.core_properties = core_properties_
         return opc_package, core_properties_
 
+    @pytest.fixture
+    def core_props_part_fixture(
+            self, part_related_by_, core_properties_part_):
+        opc_package = OpcPackage()
+        part_related_by_.return_value = core_properties_part_
+        return opc_package, core_properties_part_
+
+    @pytest.fixture
+    def default_core_props_fixture(
+            self, part_related_by_, CorePropertiesPart_, relate_to_,
+            core_properties_part_):
+        opc_package = OpcPackage()
+        part_related_by_.side_effect = KeyError
+        CorePropertiesPart_.default.return_value = core_properties_part_
+        return opc_package, CorePropertiesPart_, core_properties_part_
+
     @pytest.fixture
     def relate_to_part_fixture_(self, request, pkg, rels_, reltype):
         rId = 'rId99'
@@ -146,6 +183,10 @@ def related_part_fixture_(self, request, rels_, reltype):
 
     # fixture components -----------------------------------
 
+    @pytest.fixture
+    def CorePropertiesPart_(self, request):
+        return class_mock(request, 'docx.opc.package.CorePropertiesPart')
+
     @pytest.fixture
     def core_properties_(self, request):
         return instance_mock(request, CoreProperties)
@@ -170,6 +211,10 @@ def PackageWriter_(self, request):
     def PartFactory_(self, request):
         return class_mock(request, 'docx.opc.package.PartFactory')
 
+    @pytest.fixture
+    def part_related_by_(self, request):
+        return method_mock(request, OpcPackage, 'part_related_by')
+
     @pytest.fixture
     def parts(self, request, parts_):
         """
@@ -214,6 +259,10 @@ def rel_attrs_(self, request):
         rId = 'rId99'
         return reltype, target_, rId
 
+    @pytest.fixture
+    def relate_to_(self, request):
+        return method_mock(request, OpcPackage, 'relate_to')
+
     @pytest.fixture
     def rels_(self, request):
         return instance_mock(request, Relationships)
