added support for saving an Excel file with a password

Author: gdementen

doc/source/changes/version_0_30.rst.inc

@@ -359,6 +359,8 @@ Miscellaneous improvements
   - light : to output axes labels only when they change instead of repeating them on each line
   - na_repr : to specify how to represent N/A (NaN) values
 
+* added password argument to :py:obj:`Workbook.save()` to allow protecting Excel files with a password.
+
 * substantially improved performance of creating, iterating, and doing a few other operations over larray objects.
   This solves a few pathological cases of slow operations, especially those involving many small-ish arrays but sadly
   the overall performance improvement is negligible over most of the real-world models using larray that we tested these

larray/inout/xw_excel.py

@@ -25,6 +25,7 @@
 if xw is not None:
     from xlwings.conversion.pandas_conv import PandasDataFrameConverter
 
+    from xlwings.constants import FileFormat
     global_app = None
 
 
@@ -257,12 +258,32 @@ def __delitem__(self, key):
         def sheet_names(self):
             return [s.name for s in self]
 
-        def save(self, path=None):
+        def save(self, path=None, password=None):
+            r"""Save Workbook to file.
+
+            Parameters
+            ----------
+            path : str, optional
+                Path to save the file to. Defaults to None (use the path used when opening the workbook).
+            password : str, optional
+                Password to protect the file. Defaults to None (no password).
+            """
             # saved_path = self.xw_wkb.api.Path
             # was_saved = saved_path != ''
             if path is None and self.delayed_filepath is not None:
                 path = self.delayed_filepath
-            self.xw_wkb.save(path=path)
+
+            if password is not None:
+                if path is None:
+                    raise ValueError("saving a Workbook with a password is only supported for workbooks with an "
+                                     "explicit path (given either when opening the workbook or here as the path "
+                                     "argument)")
+                realpath = os.path.realpath(path)
+                # XXX: this is probably Windows only
+                # using Password as keyword argument does not work !
+                self.xw_wkb.api.SaveAs(realpath, FileFormat.xlOpenXMLWorkbook, password)
+            else:
+                self.xw_wkb.save(path=path)
 
         def close(self):
             # Close the workbook in Excel.