Merge pull request #2225 from jerneju/permission-report

[FIX] Report: handle PermissionError when trying to save

Author: janezd

Orange/canvas/report/owreport.py

@@ -1,4 +1,5 @@
 import os
+import logging
 
 import pkg_resources
 import pickle
@@ -21,6 +22,7 @@
 from Orange.canvas.application.canvasmain import CanvasMainWindow
 from Orange.canvas.gui.utils import message_critical
 
+log = logging.getLogger(__name__)
 
 class Column(IntEnum):
     item = 0
@@ -310,8 +312,11 @@ def save_report(self):
             self.save(filename)
         else:
             def save_html(contents):
-                with open(filename, "w", encoding="utf-8") as f:
-                    f.write(contents)
+                try:
+                    with open(filename, "w", encoding="utf-8") as f:
+                        f.write(contents)
+                except PermissionError:
+                    self.permission_error(filename)
 
             save_html(self.report_view.html())
         self.report_changed = False
@@ -337,14 +342,15 @@ def open_report(self):
 
         try:
             report = self.load(filename)
-        except (IOError, AttributeError) as e:
+        except (IOError, AttributeError, pickle.UnpicklingError) as e:
             message_critical(
                  self.tr("Could not load an Orange Report file"),
                  title=self.tr("Error"),
-                 informative_text=self.tr("An unexpected error occurred "
-                                          "while loading '%s'.") % filename,
+                 informative_text=self.tr("Error occurred "
+                                          "while loading '{}'.").format(filename),
                  exc_info=True,
                  parent=self)
+            log.error(str(e), exc_info=True)
             return
         self.set_instance(report)
         self = report
@@ -363,8 +369,11 @@ def save(self, filename):
                       attributes=attributes,
                       items=items)
 
-        with open(filename, 'wb') as f:
-            pickle.dump(report, f)
+        try:
+            with open(filename, 'wb') as f:
+                pickle.dump(report, f)
+        except PermissionError:
+            self.permission_error(filename)
 
     @classmethod
     def load(cls, filename):
@@ -383,6 +392,16 @@ def load(cls, filename):
             )
         return self
 
+    def permission_error(self, filename):
+        message_critical(
+            self.tr("Permission error when trying to write report."),
+            title=self.tr("Error"),
+            informative_text=self.tr("Permission error occurred "
+                                     "while saving '{}'.").format(filename),
+            exc_info=True,
+            parent=self)
+        log.error("PermissionError when trying to write report.", exc_info=True)
+
     def is_empty(self):
         return not self.table_model.rowCount()
 

Orange/canvas/report/tests/test_report.py

@@ -114,6 +114,22 @@ def test_report_table(self):
             'font-weight:normal;text-align:right;vertical-align:middle;">2</td>'
             '</tr></table>')
 
+    def test_save_report(self):
+        """
+        Permission Error may occur when trying to save report.
+        GH-2147
+        """
+        rep = OWReport.get_instance()
+        patch_target_1 = "Orange.canvas.report.owreport.open"
+        patch_target_2 = "AnyQt.QtWidgets.QFileDialog.getSaveFileName"
+        patch_target_3 = "AnyQt.QtWidgets.QMessageBox.exec_"
+        filenames = ["f.report", "f.html"]
+        for filename in filenames:
+            with unittest.patch(patch_target_1, create=True, side_effect=PermissionError),\
+                    unittest.patch(patch_target_2, return_value=(filename, 0)),\
+                    unittest.patch(patch_target_3, return_value=True):
+                rep.save_report()
+
 
 class TestReportWidgets(WidgetTest):
     model_widgets = MODEL_WIDGETS