Add screenshot path handling to ExecEnv and update grab_save_window function

Author: PierreRaybaut

guidata/env.py

@@ -36,11 +36,13 @@ class ExecEnv:
     ACCEPT_DIALOGS_ARG = "accept_dialogs"
     VERBOSE_ARG = "verbose"
     SCREENSHOT_ARG = "screenshot"
+    SCREENSHOT_PATH_ARG = "screenshot_path"
     DELAY_ARG = "delay"
     UNATTENDED_ENV = "GUIDATA_UNATTENDED"
     ACCEPT_DIALOGS_ENV = "GUIDATA_ACCEPT_DIALOGS"
     VERBOSE_ENV = "GUIDATA_VERBOSE"
     SCREENSHOT_ENV = "GUIDATA_SCREENSHOT"
+    SCREENSHOT_PATH_ENV = "GUIDATA_SCREENSHOT_PATH"
     DELAY_ENV = "GUIDATA_DELAY"
 
     def __init__(self):
@@ -131,6 +133,19 @@ def screenshot(self, value):
         """Set screenshot value"""
         self.__set_mode(self.SCREENSHOT_ENV, value)
 
+    @property
+    def screenshot_path(self):
+        """Get screenshot path"""
+        return os.environ.get(self.SCREENSHOT_PATH_ENV, "")
+
+    @screenshot_path.setter
+    def screenshot_path(self, value):
+        """Set screenshot path"""
+        if value:
+            os.environ[self.SCREENSHOT_PATH_ENV] = str(value)
+        elif self.SCREENSHOT_PATH_ENV in os.environ:
+            os.environ.pop(self.SCREENSHOT_PATH_ENV)
+
     @property
     def verbose(self):
         """Get verbosity level"""
@@ -178,6 +193,12 @@ def parse_args(self):
             help="automatic screenshots",
             default=None,
         )
+        parser.add_argument(
+            "--" + self.SCREENSHOT_PATH_ARG,
+            type=str,
+            help="path to save screenshots",
+            default=None,
+        )
         parser.add_argument(
             "--" + self.DELAY_ARG,
             type=int,
@@ -200,6 +221,7 @@ def set_env_from_args(self, args):
             self.UNATTENDED_ARG,
             self.ACCEPT_DIALOGS_ARG,
             self.SCREENSHOT_ARG,
+            self.SCREENSHOT_PATH_ARG,
             self.VERBOSE_ARG,
             self.DELAY_ARG,
         ):
@@ -252,6 +274,7 @@ def context(
         unattended=None,
         accept_dialogs=None,
         screenshot=None,
+        screenshot_path=None,
         delay=None,
         verbose=None,
     ) -> Generator[None, None, None]:
@@ -264,6 +287,7 @@ def context(
             unattended: whether to run in unattended mode
             accept_dialogs: whether to accept dialogs in unattended mode
             screenshot: whether to take screenshots
+            screenshot_path: path to save screenshots
             delay: delay (ms) before quitting application in unattended mode
             verbose: verbosity level
 
@@ -275,6 +299,7 @@ def context(
             "unattended": unattended,
             "accept_dialogs": accept_dialogs,
             "screenshot": screenshot,
+            "screenshot_path": screenshot_path,
             "delay": delay,
             "verbose": verbose,
         }

guidata/qthelpers.py

@@ -745,7 +745,8 @@ def grab_save_window(
     Args:
         widget: Widget to grab
         name: Widget name. If None, uses ``widget.objectName()``
-        save_dir: Directory to save screenshot. If None, uses current working directory
+        save_dir: Directory to save screenshot. If None, uses
+         ``execenv.screenshot_path`` or current working directory
         add_timestamp: Whether to add timestamp suffix to filename
     """
     if name is None:
@@ -761,7 +762,8 @@ def grab_save_window(
         suffix = "_" + datetime.now().strftime("%Y-%m-%d-%H%M%S")
 
     if save_dir is None:
-        save_dir = os.getcwd()
+        save_dir = execenv.screenshot_path or os.getcwd()
+    os.makedirs(save_dir, exist_ok=True)
 
     pixmap.save(osp.join(save_dir, f"{name}{suffix}.png"))