gh-87646: Added .path to tempfile

Added `.path` property to generate pathlib's `Path` objects for
NamedTemporaryFile and TemporaryDirectory

Author: ganesh-k13

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
+      Added *path* property.
+
 
 .. class:: SpooledTemporaryFile(max_size=0, mode='w+b', buffering=-1, encoding=None, newline=None, suffix=None, prefix=None, dir=None, *, errors=None)
 
@@ -211,6 +214,9 @@ The module defines the following user-callable items:
    .. versionchanged:: 3.12
       Added the *delete* parameter.
 
+   .. versionchanged:: 3.13
+      Added *path* property.
+
 
 .. function:: mkstemp(suffix=None, prefix=None, dir=None, text=False)
 
@@ -421,6 +427,15 @@ Here are some examples of typical usage of the :mod:`tempfile` module::
     >>>
     # directory and contents have been removed
 
+    # create a named temporary file, similar to TemporaryFile
+    # but location and name is accessible
+    >>> with tempfile.NamedTemporaryFile as fp:
+    ...    print('file name: ', fp.name)
+    ...    print('file path: ', fp.path)
+    file name: '/tmp/tmpfiehg5my'
+    file path: PosixPath('/tmp/tmpfiehg5my')
+
+
 .. _tempfile-mktemp-deprecated:
 
 Deprecated functions and variables

Lib/tempfile.py

@@ -40,6 +40,7 @@
 import warnings as _warnings
 import io as _io
 import os as _os
+from pathlib import Path as _Path
 import shutil as _shutil
 import errno as _errno
 from random import Random as _Random
@@ -518,6 +519,10 @@ def __iter__(self):
         for line in self.file:
             yield line
 
+    @_functools.cached_property
+    def path(self):
+        return _Path(self.name)
+
 def NamedTemporaryFile(mode='w+b', buffering=-1, encoding=None,
                        newline=None, suffix=None, prefix=None,
                        dir=None, delete=True, *, errors=None,
@@ -918,6 +923,10 @@ def __exit__(self, exc, value, tb):
         if self._delete:
             self.cleanup()
 
+    @_functools.cached_property
+    def path(self):
+        return _Path(self.name)
+
     def cleanup(self):
         if self._finalizer.detach() or _os.path.exists(self.name):
             self._rmtree(self.name, ignore_errors=self._ignore_cleanup_errors)

Lib/test/test_tempfile.py

@@ -1147,6 +1147,12 @@ def test_unexpected_error(self):
         mock_open().close.assert_called()
         self.assertEqual(os.listdir(dir), [])
 
+    def test_path_method(self):
+        d = self.do_create()
+        path = d.path
+        self.assertTrue(issubclass(type(path), pathlib.Path), "unexpected return type")
+        self.assertEqual(str(path), d.name, ".path .name mismatch")
+
     # How to test the mode and bufsize parameters?
 
 class TestSpooledTemporaryFile(BaseTestCase):
@@ -1853,5 +1859,12 @@ def test_delete_false(self):
         self.assertTrue(os.path.exists(working_dir))
         shutil.rmtree(working_dir)
 
+    def test_path_method(self):
+        d = self.do_create()
+        path = d.path
+        self.assertTrue(issubclass(type(path), pathlib.Path), "unexpected return type")
+        self.assertEqual(str(path), d.name, ".path .name mismatch")
+
+
 if __name__ == "__main__":
     unittest.main()

Misc/NEWS.d/next/Library/2023-05-14-11-46-21.gh-issue-87646.DNJjDX.rst

@@ -0,0 +1,3 @@
+:class:`tempfile.NamedTemporaryFile` and  :class:`tempfile.TemporaryDirectory`
+includes a new ``.path`` property. This provides the temporary file name as a
+:class:`pathlib.Path` object