temp_folder property

SaveOptions.temp_folder property

Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is None and no temporary files are used.

@property
def temp_folder(self) -> str:
    ...

@temp_folder.setter
def temp_folder(self, value: str):
    ...

Exceptions

exception	condition
RuntimeError (Proxy error(OutOfMemoryException))	Throw if you are saving a very large document (thousands of pages) and/or processing many documents at the same time. The memory spike during saving can be significant enough to cause the exception.

Remarks

When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

Specifying a temporary folder using SaveOptions.temp_folder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

The folder must exist and be writable, otherwise an exception will be thrown.

Aspose.Words automatically deletes all temporary files when saving is complete.

Examples

Shows how to use the hard drive instead of memory when saving a document.

doc = aw.Document(MY_DIR + "Rendering.docx")

# When we save a document, various elements are temporarily stored in memory as the save operation is taking place.
# We can use this option to use a temporary folder in the local file system instead,
# which will reduce our application's memory overhead.
options = aw.saving.DocSaveOptions()
options.temp_folder = ARTIFACTS_DIR + "TempFiles"

# The specified temporary folder must exist in the local file system before the save operation.
os.makedirs(options.temp_folder, exist_ok=True)

doc.save(ARTIFACTS_DIR + "DocSaveOptions.temp_folder.doc", options)

# The folder will persist with no residual contents from the load operation.
self.assertEqual(0, len(os.listdir(options.temp_folder)))

See Also

• module aspose.words.saving
• class SaveOptions