set: add SettingsPart.default()

Steve Canny · Steve Canny · commit 6fbda3524bfd · 2015-03-15T22:49:28.000-07:00
diff --git a/docx/parts/settings.py b/docx/parts/settings.py
@@ -8,7 +8,12 @@
     absolute_import, division, print_function, unicode_literals
 )
 
+import os
+
+from ..opc.constants import CONTENT_TYPE as CT
+from ..opc.packuri import PackURI
 from ..opc.part import XmlPart
+from ..oxml import parse_xml
 from ..settings import Settings
 
 
@@ -22,7 +27,10 @@ def default(cls, package):
         Return a newly created settings part, containing a default
         `w:settings` element tree.
         """
-        raise NotImplementedError
+        partname = PackURI('/word/settings.xml')
+        content_type = CT.WML_SETTINGS
+        element = parse_xml(cls._default_settings_xml())
+        return cls(partname, content_type, element, package)
 
     @property
     def settings(self):
@@ -31,3 +39,16 @@ def settings(self):
         containing the document-level settings for this document.
         """
         return Settings(self.element)
+
+    @classmethod
+    def _default_settings_xml(cls):
+        """
+        Return a bytestream containing XML for a default settings part.
+        """
+        path = os.path.join(
+            os.path.split(__file__)[0], '..', 'templates',
+            'default-settings.xml'
+        )
+        with open(path, 'rb') as f:
+            xml_bytes = f.read()
+        return xml_bytes
diff --git a/docx/templates/default-settings.xml b/docx/templates/default-settings.xml
@@ -0,0 +1,26 @@
+<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
+<w:settings
+    xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:o="urn:schemas-microsoft-com:office:office"
+    xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"
+    xmlns:sl="http://schemas.openxmlformats.org/schemaLibrary/2006/main"
+    xmlns:v="urn:schemas-microsoft-com:vml"
+    xmlns:w10="urn:schemas-microsoft-com:office:word"
+    xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml"
+    xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+    mc:Ignorable="w14"
+    >
+  <w:defaultTabStop w:val="720"/>
+  <w:characterSpacingControl w:val="doNotCompress"/>
+  <w:savePreviewPicture/>
+  <w:compat>
+    <w:useFELayout/>
+    <w:compatSetting w:name="compatibilityMode" w:uri="http://schemas.microsoft.com/office/word" w:val="14"/>
+    <w:compatSetting w:name="overrideTableStyleFontSizeAndJustification" w:uri="http://schemas.microsoft.com/office/word" w:val="1"/>
+    <w:compatSetting w:name="enableOpenTypeFeatures" w:uri="http://schemas.microsoft.com/office/word" w:val="1"/>
+    <w:compatSetting w:name="doNotFlipMirrorIndents" w:uri="http://schemas.microsoft.com/office/word" w:val="1"/>
+  </w:compat>
+  <w:clrSchemeMapping w:bg1="light1" w:t1="dark1" w:bg2="light2" w:t2="dark2" w:accent1="accent1" w:accent2="accent2" w:accent3="accent3" w:accent4="accent4" w:accent5="accent5" w:accent6="accent6" w:hyperlink="hyperlink" w:followedHyperlink="followedHyperlink"/>
+  <w:doNotAutoCompressPictures/>
+</w:settings>
diff --git a/features/doc-settings.feature b/features/doc-settings.feature
@@ -4,7 +4,6 @@ Feature: Access to document settings
   I access to settings stored in the settings part
 
 
-  @wip
   Scenario Outline: Access document settings
     Given a document having <a-or-no> settings part
      Then document.settings is a Settings object
diff --git a/tests/parts/test_settings.py b/tests/parts/test_settings.py
@@ -11,6 +11,7 @@
 import pytest
 
 from docx.opc.constants import CONTENT_TYPE as CT
+from docx.opc.package import OpcPackage
 from docx.opc.part import PartFactory
 from docx.package import Package
 from docx.parts.settings import SettingsPart
@@ -36,6 +37,15 @@ def it_provides_access_to_its_settings(self, settings_fixture):
         Settings_.assert_called_once_with(settings_part.element)
         assert settings is settings_
 
+    def it_constructs_a_default_settings_part_to_help(self):
+        package = OpcPackage()
+        settings_part = SettingsPart.default(package)
+        assert isinstance(settings_part, SettingsPart)
+        assert settings_part.partname == '/word/settings.xml'
+        assert settings_part.content_type == CT.WML_SETTINGS
+        assert settings_part.package is package
+        assert len(settings_part.element) == 6
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
