Merge pull request #170 from mwcraig/add-overwrite

Add overwrite argument to save method

Author: mwcraig

astrowidgets/interface_definition.py

@@ -90,7 +90,7 @@ def load_nddata(self, data: NDData) -> None:
 
     # Saving contents of the view and accessing the view
     @abstractmethod
-    def save(self, filename: str | os.PathLike) -> None:
+    def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
         """
         Save the current view to a file.
 
@@ -99,6 +99,10 @@ def save(self, filename: str | os.PathLike) -> None:
         filename : str
             The file to save to. The format is determined by the
             extension.
+
+        overwrite : bool, optional
+            If `True`, overwrite the file if it exists. Default is
+            `False`.
         """
         raise NotImplementedError
 

astrowidgets/tests/widget_api_test.py

@@ -359,3 +359,16 @@ def test_scroll_pan(self):
     def test_save(self, tmp_path):
         filename = tmp_path / 'woot.png'
         self.image.save(filename)
+
+    def test_save_overwrite(self, tmp_path):
+        filename = tmp_path / 'woot.png'
+
+        # First write should be fine
+        self.image.save(filename)
+
+        # Second write should raise an error because file exists
+        with pytest.raises(FileExistsError):
+            self.image.save(filename)
+
+        # Using overwrite should save successfully
+        self.image.save(filename, overwrite=True)