opc: add CorePropertiesPart.core_properties

Steve Canny · Steve Canny · commit 7e92b9afcde0 · 2014-12-13T23:29:04.000-08:00
diff --git a/docx/opc/coreprops.py b/docx/opc/coreprops.py
@@ -15,3 +15,5 @@ class CoreProperties(object):
     Corresponds to part named ``/docProps/core.xml``, containing the core
     document properties for this document package.
     """
+    def __init__(self, element):
+        self._element = element
diff --git a/docx/opc/part.py b/docx/opc/part.py
@@ -219,6 +219,13 @@ def __init__(self, partname, content_type, element, package):
     def blob(self):
         return serialize_part_xml(self._element)
 
+    @property
+    def element(self):
+        """
+        The root XML element of this XML part.
+        """
+        return self._element
+
     @classmethod
     def load(cls, partname, content_type, blob, package):
         element = parse_xml(blob)
diff --git a/docx/opc/parts/coreprops.py b/docx/opc/parts/coreprops.py
@@ -8,6 +8,7 @@
     absolute_import, division, print_function, unicode_literals
 )
 
+from ..coreprops import CoreProperties
 from ..part import XmlPart
 
 
@@ -30,4 +31,4 @@ def core_properties(self):
         A |CoreProperties| object providing read/write access to the core
         properties contained in this core properties part.
         """
-        raise NotImplementedError
+        return CoreProperties(self.element)
diff --git a/docx/oxml/parts/coreprops.py b/docx/oxml/parts/coreprops.py
@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+"""
+lxml custom element classes for core properties-related XML elements.
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from ..xmlchemy import BaseOxmlElement
+
+
+class CT_CoreProperties(BaseOxmlElement):
+    """
+    ``<cp:coreProperties>`` element, the root element of the Core Properties
+    part stored as ``/docProps/core.xml``. Implements many of the Dublin Core
+    document metadata elements. String elements resolve to an empty string
+    ('') if the element is not present in the XML. String elements are
+    limited in length to 255 unicode characters.
+    """
diff --git a/tests/opc/parts/__init__.py b/tests/opc/parts/__init__.py
diff --git a/tests/opc/parts/test_coreprops.py b/tests/opc/parts/test_coreprops.py
@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+"""
+Unit test suite for the docx.opc.parts.coreprops module
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+import pytest
+
+from docx.opc.coreprops import CoreProperties
+from docx.opc.parts.coreprops import CorePropertiesPart
+from docx.oxml.parts.coreprops import CT_CoreProperties
+
+from ...unitutil.mock import class_mock, instance_mock
+
+
+class DescribeCorePropertiesPart(object):
+
+    def it_provides_access_to_its_core_props_object(self, coreprops_fixture):
+        core_properties_part, CoreProperties_ = coreprops_fixture
+        core_properties = core_properties_part.core_properties
+        CoreProperties_.assert_called_once_with(core_properties_part.element)
+        assert isinstance(core_properties, CoreProperties)
+
+    # fixtures ---------------------------------------------
+
+    @pytest.fixture
+    def coreprops_fixture(self, element_, CoreProperties_):
+        core_properties_part = CorePropertiesPart(None, None, element_, None)
+        return core_properties_part, CoreProperties_
+
+    # fixture components -----------------------------------
+
+    @pytest.fixture
+    def CoreProperties_(self, request):
+        return class_mock(request, 'docx.opc.parts.coreprops.CoreProperties')
+
+    @pytest.fixture
+    def element_(self, request):
+        return instance_mock(request, CT_CoreProperties)
