gh-103878: Return a consistent empty value from cancelled file dialogs

On cancellation Tcl may report the empty result as '', () or b'' depending
on the platform and Tk version. Normalize it so that askopenfilename(),
asksaveasfilename() and askdirectory() always return '' and
askopenfilenames() always returns ().

Open._fixresult() now distinguishes single from multiple results by the
'multiple' option rather than the result type.

Co-authored-by: Christopher Chavez <chrischavez@gmx.us>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Author: 3 people

Lib/test/test_tkinter/test_filedialog.py

@@ -37,6 +37,39 @@ def test_directory(self):
         self.check(filedialog.Directory, 'tk_chooseDirectory')
 
 
+class CancelResultTest(AbstractTkTest, unittest.TestCase):
+    # On cancellation Tcl may report the empty result as '', () or b''
+    # (gh-103878).  _fixresult() normalizes it to the documented empty value:
+    # '' for the filename dialogs and () for the multiple-selection dialog.
+
+    def check(self, dialog, expected):
+        for empty in ('', (), b''):
+            with self.subTest(empty=empty):
+                result = dialog._fixresult(self.root, empty)
+                self.assertEqual(result, expected)
+                self.assertIs(type(result), type(expected))
+
+    def test_open(self):
+        self.check(filedialog.Open(self.root), '')
+
+    def test_saveas(self):
+        self.check(filedialog.SaveAs(self.root), '')
+
+    def test_directory(self):
+        self.check(filedialog.Directory(self.root), '')
+
+    def test_openfilenames(self):
+        self.check(filedialog.Open(self.root, multiple=1), ())
+
+    def test_results_preserved(self):
+        # A real selection is returned unchanged.
+        single = filedialog.Open(self.root)
+        self.assertEqual(single._fixresult(self.root, '/a/spam'), '/a/spam')
+        multiple = filedialog.Open(self.root, multiple=1)
+        self.assertEqual(multiple._fixresult(self.root, ('/a', '/b')),
+                         ('/a', '/b'))
+
+
 class FileDialogTest(AbstractTkTest, unittest.TestCase):
     # The pure-Python FileDialog runs its own modal loop in go(); its logic is
     # exercised here without entering the loop.

Lib/tkinter/filedialog.py

@@ -311,7 +311,9 @@ def _fixoptions(self):
             pass
 
     def _fixresult(self, widget, result):
-        if result:
+        if not result:
+            result = ''  # normalize the cancelled result (gh-103878)
+        else:
             # keep directory and filename until next time
             # convert Tcl path objects to strings
             try:
@@ -335,17 +337,16 @@ class Open(_Dialog):
     command = "tk_getOpenFile"
 
     def _fixresult(self, widget, result):
-        if isinstance(result, tuple):
-            # multiple results:
+        if self.options.get("multiple"):
+            # multiple results: a tuple of filenames
+            if not isinstance(result, tuple):
+                result = widget.tk.splitlist(result)
             result = tuple([getattr(r, "string", r) for r in result])
             if result:
                 path, file = os.path.split(result[0])
                 self.options["initialdir"] = path
                 # don't set initialfile or filename, as we have multiple of these
             return result
-        if not widget.tk.wantobjects() and "multiple" in self.options:
-            # Need to split result explicitly
-            return self._fixresult(widget, widget.tk.splitlist(result))
         return _Dialog._fixresult(self, widget, result)
 
 
@@ -362,7 +363,9 @@ class Directory(commondialog.Dialog):
     command = "tk_chooseDirectory"
 
     def _fixresult(self, widget, result):
-        if result:
+        if not result:
+            result = ''  # normalize the cancelled result (gh-103878)
+        else:
             # convert Tcl path objects to strings
             try:
                 result = result.string

Misc/NEWS.d/next/Library/2026-06-27-19-02-17.gh-issue-103878.216fa7.rst

@@ -0,0 +1,7 @@
+The :mod:`tkinter.filedialog` functions that return a filename
+(:func:`~tkinter.filedialog.askopenfilename`,
+:func:`~tkinter.filedialog.asksaveasfilename` and
+:func:`~tkinter.filedialog.askdirectory`) now consistently return an empty
+string when the dialog is cancelled, instead of an empty tuple or ``b''``
+on some platforms.  :func:`~tkinter.filedialog.askopenfilenames` likewise
+always returns an empty tuple.