doc: add Document.save()

Steve Canny · Steve Canny · commit 60e5b53d13f6 · 2015-02-15T02:08:03.000-08:00
diff --git a/docx/document.py b/docx/document.py
@@ -132,6 +132,13 @@ def part(self):
         """
         return self._part
 
+    def save(self, path_or_stream):
+        """
+        Save this document to *path_or_stream*, which can be either a path to
+        a filesystem location (a string) or a file-like object.
+        """
+        self._part.save(path_or_stream)
+
     @property
     def _body(self):
         """
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -113,6 +113,13 @@ def numbering_part(self):
             self.relate_to(numbering_part, RT.NUMBERING)
             return numbering_part
 
+    def save(self, path_or_stream):
+        """
+        Save this document to *path_or_stream*, which can be either a path to
+        a filesystem location (a string) or a file-like object.
+        """
+        raise NotImplementedError
+
     @lazyproperty
     def sections(self):
         """
diff --git a/tests/test_document.py b/tests/test_document.py
@@ -79,6 +79,11 @@ def it_can_add_a_table(self, add_table_fixture):
         assert table == table_
         assert table.style == style
 
+    def it_can_save_the_document_to_a_file(self, save_fixture):
+        document, file_ = save_fixture
+        document.save(file_)
+        document._part.save.assert_called_once_with(file_)
+
     def it_provides_access_to_its_core_properties(self, core_props_fixture):
         document, core_properties_ = core_props_fixture
         core_properties = document.core_properties
@@ -201,6 +206,12 @@ def part_fixture(self, document_part_):
         document = Document(None, document_part_)
         return document, document_part_
 
+    @pytest.fixture
+    def save_fixture(self, document_part_):
+        document = Document(None, document_part_)
+        file_ = 'foobar.docx'
+        return document, file_
+
     # fixture components ---------------------------------------------
 
     @pytest.fixture
