Merge pull request #153 from kujirahand/add_popup_files_delimiter

Add FILE_DELIMITER for FilesBrowse and popup_get_files

Author: kujirahand

TkEasyGUI/dialogs.py

@@ -712,25 +712,29 @@ def popup_get_file(
     multiple_files: bool = False,  # can select multiple files
     file_types: Optional[FileTypeList] = None,
     default_extension: Optional[str] = None,
-    files_delimiter: Optional[str] = "|",
+    files_delimiter: Optional[
+        str
+    ] = None,  # default is FILES_DELIMITER for multiple files, used when multiple_files=True
     # pylint: disable=unused-argument
     no_window: Optional[bool] = None,  # for compatibility
     **kw,
-) -> Union[str, tuple[str], None]:
+) -> Optional[str]:
     """Popup a file selection dialog. Return the file selected."""
+    from . import widgets as eg
+
     if title is None:
         title = message
     if initial_folder is None:
         initial_folder = os.getcwd()
     if file_types is None:
         file_types = [("All Files", "*.*")]
+    if files_delimiter is None:
+        files_delimiter = eg.FILES_DELIMITER
     # check no_window
     if no_window is None:
         no_window = True
     if no_window is False:
         # --- no_window is False ---
-        from . import widgets as eg
-
         # show base dialog
         layout_no_window: list[list[eg.Element]] = [
             [eg.Text(message)],
@@ -781,8 +785,7 @@ def popup_get_file(
             **kw,
         )
     if multiple_files and isinstance(result, (tuple, list)):
-        if files_delimiter is not None:
-            result = files_delimiter.join(result)
+        result = str(files_delimiter).join(result)
     return result
 
 

TkEasyGUI/widgets.py

@@ -82,6 +82,10 @@
 EG_SWAP_EVENT_NAME: str = "--swap_event_name--"
 
 DEFAULT_PADX = 1 if utils.is_win() else 3
+FILES_DELIMITER = (
+    "|" if utils.is_win() else ":"
+)  # delimiter for multiple files, used in popup_get_file with multiple_files=True
+
 
 # --- window icon ---
 DEFAULT_WINDOW_ICON = icon_default.ICON
@@ -94,7 +98,6 @@
     "y2": 22 + 6,
 }  # for macOS titlebar
 
-
 # ------------------------------------------------------------------------------
 # Widget wrapper
 # ------------------------------------------------------------------------------
@@ -4688,7 +4691,7 @@ def __init__(
         save_as: bool = False,
         enable_events: bool = False,  # enable changing events
         # other
-        files_delimiter: Optional[str] = "|",
+        files_delimiter: Optional[str] = FILES_DELIMITER,
         metadata: Union[dict[str, Any], None] = None,
         **kw,
     ) -> None:
@@ -4752,33 +4755,23 @@ def show_dialog(self, *args) -> Union[Any, None]:
         init_dir = self._get_initial_directory()
 
         # popup
-        result = dialogs.popup_get_file(
+        popup_result = dialogs.popup_get_file(
             title=self.title,
             initial_folder=init_dir,
             save_as=self.save_as,
             file_types=self.file_types,
             multiple_files=self.multiple_files,
             files_delimiter=self.files_delimiter,
         )
-        target_value = result
-        if isinstance(target_value, (list, tuple)):
-            delimiter = self.files_delimiter
-            if delimiter is not None:
-                target_value = delimiter.join(str(item) for item in target_value)
-            else:
-                # Keep popup_get_file return value unchanged (tuple/list) while
-                # updating target widgets/events with a readable string.
-                fallback_delimiter = " "
-                target_value = fallback_delimiter.join(str(item) for item in target_value)
+        target_value = popup_result if popup_result is not None else ""
         if (target is not None) and (target_value is not None) and (target_value != ""):
             target.update(target_value)  # type: ignore [call-arg]
             if self.enable_events:
                 if (self.window is not None) and (self.key is not None):
                     self.window.dispatch_event(
                         self.key, {"event": target_value, "event_type": "change"}
                     )
-
-        return result
+        return popup_result
 
     def set_text(self, text: str) -> None:
         """Set the text of the button."""
@@ -4802,7 +4795,7 @@ def __init__(
         target_key: Union[str, None] = None,
         title: str = "",
         file_types: Optional[FileTypeList] = None,
-        files_delimiter: Optional[str] = "|",
+        files_delimiter: Optional[str] = FILES_DELIMITER,
         enable_events: bool = False,  # enable changing events
         # other
         metadata: Union[dict[str, Any], None] = None,

tests/filebrowse_test.py

@@ -5,16 +5,17 @@
 # import PySimpleGUI as sg
 import TkEasyGUI as eg
 
-FILES_DELIMITER = "|"
-
 # window create
 window = eg.Window(
     "FileBrowser test",
     layout=[
         [eg.Text("File path:")],
         [eg.Input("", key="-filepath1-"), eg.FileBrowse()],
         [eg.Text("Multiple path:")],
-        [eg.Input("", key="-filepath2-"), eg.FilesBrowse(files_delimiter=FILES_DELIMITER)],
+        [
+            eg.Input("", key="-filepath2-"),
+            eg.FilesBrowse(files_delimiter=eg.FILES_DELIMITER),
+        ],
         [eg.Text("Folder path:")],
         [eg.Input("", key="-folderpath-"), eg.FolderBrowse()],
         [eg.Button("OK")],
@@ -26,14 +27,9 @@
     print("#", event, values)
     if event == "OK":
         print(values)
-        selected_multiple = values["-filepath2-"]
-        selected_multiple_list = []
-        if selected_multiple not in ("", None):
-            selected_multiple_list = str(selected_multiple).split(FILES_DELIMITER)
         a = [
             f"path1={values['-filepath1-']}",
-            f"path2={selected_multiple}",
-            f"path2-list={selected_multiple_list}",
+            f"path2={values['-filepath2-']}",
             f"folder={values['-folderpath-']}",
         ]
         eg.popup("Selected:\n" + "\n".join(a))

tests/popup/popup_get_file_sp_file_types.py

@@ -4,20 +4,19 @@
 
 import TkEasyGUI as eg
 
-FILES_DELIMITER = "|"
-
 # file types
-file_types = (
+file_types = [
     ("Image files", "*.jpg;*.jpeg;*.jpe;*.heic;*.png;*.gif"),
     ("All files", "*.*"),
-)
+]
 # popup
-files = eg.popup_get_file(
+files_str = eg.popup_get_file(
     "Please select images.",
     file_types=file_types,
     multiple_files=True,
-    files_delimiter=FILES_DELIMITER,
+    files_delimiter=eg.FILES_DELIMITER,
 )
-print(f"raw={files}")
-if files not in (None, ""):
-    print(files.split(FILES_DELIMITER))
+print(f"Selected: {files_str}")
+if files_str:
+    files = files_str.split(eg.FILES_DELIMITER)
+    eg.popup_listbox(files, "Selected Files")

tests/popup/select_multiple_files.py

@@ -2,19 +2,19 @@
 
 import TkEasyGUI as eg
 
-FILES_DELIMITER = "|"
-
 selected_files = eg.popup_get_file(
     "Please select files.",
     title="Select Multiple Files",
     multiple_files=True,
-    files_delimiter=FILES_DELIMITER,
+    files_delimiter=eg.FILES_DELIMITER,
 )
 
 if selected_files in (None, ""):
     print("No files selected.")
 else:
     print(f"raw={selected_files}")
     print("split:")
-    for index, file_path in enumerate(str(selected_files).split(FILES_DELIMITER), start=1):
+    for index, file_path in enumerate(
+        str(selected_files).split(eg.FILES_DELIMITER), start=1
+    ):
         print(f"  {index}. {file_path}")