GH-87646: Make tempfile.NamedTemporaryFile and TemporaryDirectory…

… path-like. Add `__fspath__()` methods to `tempfile.NamedTemporaryFile` and `TemporaryDirectory`.
python · barneygale · Jan 30, 2024 · Jan 30, 2024 · Feb 21, 2024 · Feb 21, 2024
commit 02e26b6c7ac4da67e6abe2777af7c28bfc9e5142
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
@@ -142,6 +142,9 @@ The module defines the following user-callable items:
    .. versionchanged:: 3.12
       Added *delete_on_close* parameter.
 
+   .. versionchanged:: 3.13
+      Returns a :term:`path-like object`.
+
 
 .. class:: SpooledTemporaryFile(max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)
 
@@ -217,6 +220,9 @@ The module defines the following user-callable items:
    .. versionchanged:: 3.12
       Added the *delete* parameter.
 
+   .. versionchanged:: 3.13
+      Returns a :term:`path-like object`.
+
 
 .. function:: mkstemp(suffix=None, prefix=None, dir=None, text=False)
 

diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
@@ -405,6 +405,13 @@ sys
   This function is not guaranteed to exist in all implementations of Python.
   (Contributed by Serhiy Storchaka in :gh:`78573`.)
 
+tempfile
+--------
+
+* :func:`tempfile.NamedTemporaryFile` and :func:`~tempfile.TemporaryDirectory`
+  now return a :term:`path-like object`.
+  (Contributed by Barney Gale in :gh:`87646`.)
+
 tkinter
 -------
 

diff --git a/Lib/tempfile.py b/Lib/tempfile.py
@@ -505,6 +505,12 @@ def func_wrapper(*args, **kwargs):
             setattr(self, name, a)
         return a
 
+    def __fspath__(self):
+        """
+        Return the filesystem path of this temporary file.
+        """
+        return self.name
+
     # The underlying __enter__ method returns the wrong object
     # (self.file) so override it to return the wrapper
     def __enter__(self):
@@ -938,6 +944,12 @@ def _cleanup(cls, name, warn_message, ignore_errors=False, delete=True):
     def __repr__(self):
         return "<{} {!r}>".format(self.__class__.__name__, self.name)
 
+    def __fspath__(self):
+        """
+        Return the filesystem path of this temporary directory.
+        """
+        return self.name
+
     def __enter__(self):
         return self.name
 

diff --git a/Lib/test/test_tempfile.py b/Lib/test/test_tempfile.py
@@ -932,8 +932,14 @@ def do_create(self, dir=None, pre="", suf="", delete=True):
                                            delete=delete)
 
         self.nameCheck(file.name, dir, pre, suf)
+        self.nameCheck(os.fspath(file), dir, pre, suf)
         return file
 
+    def test_pathlike(self):
+        tmp = self.do_create()
+        self.assertTrue(isinstance(tmp, os.PathLike))
+        cls = type(tmp)
+        self.assertTrue(issubclass(cls, os.PathLike))
 
     def test_basic(self):
         # NamedTemporaryFile can create files
@@ -1580,9 +1586,16 @@ def do_create(self, dir=None, pre="", suf="", recurse=1, dirs=1, files=1,
             dir=dir, prefix=pre, suffix=suf,
             ignore_cleanup_errors=ignore_cleanup_errors)
         self.nameCheck(tmp.name, dir, pre, suf)
+        self.nameCheck(os.fspath(tmp), dir, pre, suf)
         self.do_create2(tmp.name, recurse, dirs, files)
         return tmp
 
+    def test_pathlike(self):
+        tmp = self.do_create()
+        self.assertTrue(isinstance(tmp, os.PathLike))
+        cls = type(tmp)
+        self.assertTrue(issubclass(cls, os.PathLike))
+
     def do_create2(self, path, recurse=1, dirs=1, files=1):
         # Create subdirectories and some files
         if recurse:

diff --git a/Misc/NEWS.d/next/Library/2024-01-30-21-07-20.gh-issue-87646.TQUZMn.rst b/Misc/NEWS.d/next/Library/2024-01-30-21-07-20.gh-issue-87646.TQUZMn.rst
@@ -0,0 +1,3 @@
+Return a :term:`path-like object` from :func:`tempfile.NamedTemporaryFile`
+and :func:`~tempfile.TemporaryDirectory`. (Contributed by Barney Gale in
+:gh:`87646`.)