doc: add DocumentPart.settings

Steve Canny · Steve Canny · commit c729d2b96eef · 2015-03-15T22:49:28.000-07:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -133,7 +133,7 @@ def settings(self):
         A |Settings| object providing access to the settings in the settings
         part of this document.
         """
-        raise NotImplementedError
+        return self._settings_part.settings
 
     @property
     def styles(self):
@@ -143,6 +143,15 @@ def styles(self):
         """
         return self._styles_part.styles
 
+    @property
+    def _settings_part(self):
+        """
+        A |SettingsPart| object providing access to the document-level
+        settings for this document. Creates a default settings part if one is
+        not present.
+        """
+        raise NotImplementedError
+
     @property
     def _styles_part(self):
         """
diff --git a/docx/parts/settings.py b/docx/parts/settings.py
@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+"""
+|SettingsPart| and closely related objects
+"""
+
+from __future__ import (
+    absolute_import, division, print_function, unicode_literals
+)
+
+from ..opc.part import XmlPart
+
+
+class SettingsPart(XmlPart):
+    """
+    Document-level settings part of a WordprocessingML (WML) package.
+    """
+    @property
+    def settings(self):
+        """
+        A |Settings| proxy object for the `w:settings` element in this part,
+        containing the document-level settings for this document.
+        """
+        raise NotImplementedError
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -15,7 +15,9 @@
 from docx.parts.document import DocumentPart
 from docx.parts.image import ImagePart
 from docx.parts.numbering import NumberingPart
+from docx.parts.settings import SettingsPart
 from docx.parts.styles import StylesPart
+from docx.settings import Settings
 from docx.styles.style import BaseStyle
 from docx.styles.styles import Styles
 from docx.text.paragraph import Paragraph
@@ -45,6 +47,11 @@ def it_can_get_or_add_an_image(self, get_image_fixture):
         document_part.relate_to.assert_called_once_with(image_part_, RT.IMAGE)
         assert (rId, image) == (rId_, image_)
 
+    def it_provides_access_to_the_document_settings(self, settings_fixture):
+        document_part, settings_ = settings_fixture
+        settings = document_part.settings
+        assert settings is settings_
+
     def it_provides_access_to_the_document_styles(self, styles_fixture):
         document_part, styles_ = styles_fixture
         styles = document_part.styles
@@ -217,6 +224,14 @@ def save_fixture(self, package_):
         file_ = 'foobar.docx'
         return document_part, file_
 
+    @pytest.fixture
+    def settings_fixture(self, _settings_part_prop_, settings_part_,
+                         settings_):
+        document_part = DocumentPart(None, None, None, None)
+        _settings_part_prop_.return_value = settings_part_
+        settings_part_.settings = settings_
+        return document_part, settings_
+
     @pytest.fixture
     def styles_fixture(self, _styles_part_prop_, styles_part_, styles_):
         document_part = DocumentPart(None, None, None, None)
@@ -289,6 +304,18 @@ def part_related_by_(self, request):
     def relate_to_(self, request):
         return method_mock(request, DocumentPart, 'relate_to')
 
+    @pytest.fixture
+    def settings_(self, request):
+        return instance_mock(request, Settings)
+
+    @pytest.fixture
+    def settings_part_(self, request):
+        return instance_mock(request, SettingsPart)
+
+    @pytest.fixture
+    def _settings_part_prop_(self, request):
+        return property_mock(request, DocumentPart, '_settings_part')
+
     @pytest.fixture
     def style_(self, request):
         return instance_mock(request, BaseStyle)
