blob: 69d5de2e1b95f417f6ca92dd6b14e537835a29ea [file] [log] [blame]
Guido van Rossum0e548712002-08-09 16:14:33 +00001# tempfile.py unit tests.
Tim Petersc57a2852001-10-29 21:46:08 +00002import tempfile
Serhiy Storchaka7451a722013-02-09 22:25:49 +02003import errno
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +02004import io
Guido van Rossum0e548712002-08-09 16:14:33 +00005import os
Anthony Sottile370138b2019-09-09 08:54:34 -07006import pathlib
Antoine Pitrou4558bad2011-11-25 21:28:15 +01007import signal
Guido van Rossum0e548712002-08-09 16:14:33 +00008import sys
9import re
Guido van Rossum0e548712002-08-09 16:14:33 +000010import warnings
Eli Benderskyaa04f9a2013-09-13 05:28:20 -070011import contextlib
Anthony Sottile8377cd42019-02-25 14:32:27 -080012import stat
Guido van Rossum48b069a2020-04-07 09:50:06 -070013import types
Antoine Pitrou17c93262013-12-21 22:14:56 +010014import weakref
Victor Stinner1f99f9d2014-03-25 09:18:04 +010015from unittest import mock
Tim Petersc57a2852001-10-29 21:46:08 +000016
Guido van Rossum0e548712002-08-09 16:14:33 +000017import unittest
Berker Peksagce643912015-05-06 06:33:17 +030018from test import support
19from test.support import script_helper
Guido van Rossum0e548712002-08-09 16:14:33 +000020
Fred Drake7633d232002-10-17 22:09:03 +000021
Guido van Rossum0e548712002-08-09 16:14:33 +000022has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000023has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000024
Neal Norwitz68ee0122002-08-16 19:28:59 +000025# TEST_FILES may need to be tweaked for systems depending on the maximum
26# number of files that can be opened at one time (see ulimit -n)
Victor Stinner9c3de4a2011-08-17 20:49:41 +020027if sys.platform.startswith('openbsd'):
Martin v. Löwis99968282004-09-15 06:02:54 +000028 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000029else:
30 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000031
Guido van Rossum0e548712002-08-09 16:14:33 +000032# This is organized as one test for each chunk of code in tempfile.py,
33# in order of their appearance in the file. Testing which requires
34# threads is not done here.
35
Gregory P. Smithad577b92015-05-22 16:18:14 -070036class TestLowLevelInternals(unittest.TestCase):
37 def test_infer_return_type_singles(self):
38 self.assertIs(str, tempfile._infer_return_type(''))
39 self.assertIs(bytes, tempfile._infer_return_type(b''))
40 self.assertIs(str, tempfile._infer_return_type(None))
41
42 def test_infer_return_type_multiples(self):
43 self.assertIs(str, tempfile._infer_return_type('', ''))
44 self.assertIs(bytes, tempfile._infer_return_type(b'', b''))
45 with self.assertRaises(TypeError):
46 tempfile._infer_return_type('', b'')
47 with self.assertRaises(TypeError):
48 tempfile._infer_return_type(b'', '')
49
50 def test_infer_return_type_multiples_and_none(self):
51 self.assertIs(str, tempfile._infer_return_type(None, ''))
52 self.assertIs(str, tempfile._infer_return_type('', None))
53 self.assertIs(str, tempfile._infer_return_type(None, None))
54 self.assertIs(bytes, tempfile._infer_return_type(b'', None))
55 self.assertIs(bytes, tempfile._infer_return_type(None, b''))
56 with self.assertRaises(TypeError):
57 tempfile._infer_return_type('', None, b'')
58 with self.assertRaises(TypeError):
59 tempfile._infer_return_type(b'', None, '')
60
Anthony Sottile370138b2019-09-09 08:54:34 -070061 def test_infer_return_type_pathlib(self):
62 self.assertIs(str, tempfile._infer_return_type(pathlib.Path('/')))
63
Gregory P. Smithad577b92015-05-22 16:18:14 -070064
Guido van Rossum0e548712002-08-09 16:14:33 +000065# Common functionality.
Gregory P. Smithad577b92015-05-22 16:18:14 -070066
Antoine Pitroueab2a502012-03-10 16:34:40 +010067class BaseTestCase(unittest.TestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +000068
Victor Stinner97869102013-08-14 01:28:28 +020069 str_check = re.compile(r"^[a-z0-9_-]{8}$")
Gregory P. Smithad577b92015-05-22 16:18:14 -070070 b_check = re.compile(br"^[a-z0-9_-]{8}$")
Guido van Rossum0e548712002-08-09 16:14:33 +000071
Brett Cannone1adece2010-03-20 22:19:55 +000072 def setUp(self):
73 self._warnings_manager = support.check_warnings()
74 self._warnings_manager.__enter__()
75 warnings.filterwarnings("ignore", category=RuntimeWarning,
76 message="mktemp", module=__name__)
77
78 def tearDown(self):
79 self._warnings_manager.__exit__(None, None, None)
80
Guido van Rossum0e548712002-08-09 16:14:33 +000081 def nameCheck(self, name, dir, pre, suf):
82 (ndir, nbase) = os.path.split(name)
83 npre = nbase[:len(pre)]
84 nsuf = nbase[len(nbase)-len(suf):]
85
Gregory P. Smithad577b92015-05-22 16:18:14 -070086 if dir is not None:
Anthony Sottile370138b2019-09-09 08:54:34 -070087 self.assertIs(
88 type(name),
89 str
90 if type(dir) is str or isinstance(dir, os.PathLike) else
91 bytes,
92 "unexpected return type",
93 )
Gregory P. Smithad577b92015-05-22 16:18:14 -070094 if pre is not None:
95 self.assertIs(type(name), str if type(pre) is str else bytes,
96 "unexpected return type")
97 if suf is not None:
98 self.assertIs(type(name), str if type(suf) is str else bytes,
99 "unexpected return type")
100 if (dir, pre, suf) == (None, None, None):
101 self.assertIs(type(name), str, "default return type must be str")
102
Martin v. Löwisd6625482003-10-12 17:37:01 +0000103 # check for equality of the absolute paths!
104 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700105 "file %r not in directory %r" % (name, dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000106 self.assertEqual(npre, pre,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700107 "file %r does not begin with %r" % (nbase, pre))
Guido van Rossum0e548712002-08-09 16:14:33 +0000108 self.assertEqual(nsuf, suf,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700109 "file %r does not end with %r" % (nbase, suf))
Guido van Rossum0e548712002-08-09 16:14:33 +0000110
111 nbase = nbase[len(pre):len(nbase)-len(suf)]
Gregory P. Smithad577b92015-05-22 16:18:14 -0700112 check = self.str_check if isinstance(nbase, str) else self.b_check
113 self.assertTrue(check.match(nbase),
114 "random characters %r do not match %r"
115 % (nbase, check.pattern))
Guido van Rossum0e548712002-08-09 16:14:33 +0000116
Guido van Rossum0e548712002-08-09 16:14:33 +0000117
Antoine Pitroueab2a502012-03-10 16:34:40 +0100118class TestExports(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000119 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000120 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +0000121 dict = tempfile.__dict__
122
123 expected = {
124 "NamedTemporaryFile" : 1,
125 "TemporaryFile" : 1,
126 "mkstemp" : 1,
127 "mkdtemp" : 1,
128 "mktemp" : 1,
129 "TMP_MAX" : 1,
130 "gettempprefix" : 1,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700131 "gettempprefixb" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000132 "gettempdir" : 1,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700133 "gettempdirb" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000134 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +0000135 "template" : 1,
Nick Coghlan543af752010-10-24 11:23:25 +0000136 "SpooledTemporaryFile" : 1,
137 "TemporaryDirectory" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000138 }
139
140 unexp = []
141 for key in dict:
142 if key[0] != '_' and key not in expected:
143 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000144 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +0000145 "unexpected keys: %s" % unexp)
146
Guido van Rossum0e548712002-08-09 16:14:33 +0000147
Antoine Pitroueab2a502012-03-10 16:34:40 +0100148class TestRandomNameSequence(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000149 """Test the internal iterator object _RandomNameSequence."""
150
151 def setUp(self):
152 self.r = tempfile._RandomNameSequence()
Brett Cannone1adece2010-03-20 22:19:55 +0000153 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000154
155 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000156 # _RandomNameSequence returns a six-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000157 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000158 self.nameCheck(s, '', '', '')
159
160 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000161 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000162
163 dict = {}
164 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000165 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000166 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000167 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000168 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000169 dict[s] = 1
170
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000171 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000172 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000173
174 i = 0
175 r = self.r
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100176 for s in r:
177 i += 1
178 if i == 20:
179 break
Guido van Rossum0e548712002-08-09 16:14:33 +0000180
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100181 @unittest.skipUnless(hasattr(os, 'fork'),
182 "os.fork is required for this test")
183 def test_process_awareness(self):
184 # ensure that the random source differs between
185 # child and parent.
186 read_fd, write_fd = os.pipe()
187 pid = None
188 try:
189 pid = os.fork()
190 if not pid:
Victor Stinner6c8c2942017-08-10 13:05:06 +0200191 # child process
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100192 os.close(read_fd)
193 os.write(write_fd, next(self.r).encode("ascii"))
194 os.close(write_fd)
195 # bypass the normal exit handlers- leave those to
196 # the parent.
197 os._exit(0)
Victor Stinner6c8c2942017-08-10 13:05:06 +0200198
199 # parent process
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100200 parent_value = next(self.r)
201 child_value = os.read(read_fd, len(parent_value)).decode("ascii")
202 finally:
203 if pid:
Victor Stinner278c1e12020-03-31 20:08:12 +0200204 support.wait_process(pid, exitcode=0)
Victor Stinner6c8c2942017-08-10 13:05:06 +0200205
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100206 os.close(read_fd)
207 os.close(write_fd)
208 self.assertNotEqual(child_value, parent_value)
209
210
Guido van Rossum0e548712002-08-09 16:14:33 +0000211
Antoine Pitroueab2a502012-03-10 16:34:40 +0100212class TestCandidateTempdirList(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000213 """Test the internal function _candidate_tempdir_list."""
214
215 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000216 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000217
218 cand = tempfile._candidate_tempdir_list()
219
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000220 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000221 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000222 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000223
224 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000225 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000226
227 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000228 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000229 for envname in 'TMPDIR', 'TEMP', 'TMP':
230 dirname = os.getenv(envname)
231 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000232 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000233
234 cand = tempfile._candidate_tempdir_list()
235
236 for envname in 'TMPDIR', 'TEMP', 'TMP':
237 dirname = os.getenv(envname)
238 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000239 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000240
241 try:
242 dirname = os.getcwd()
Andrew Svetlovad28c7f2012-12-18 22:02:39 +0200243 except (AttributeError, OSError):
Guido van Rossum0e548712002-08-09 16:14:33 +0000244 dirname = os.curdir
245
Benjamin Peterson577473f2010-01-19 00:09:57 +0000246 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000247
248 # Not practical to try to verify the presence of OS-specific
249 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000250
Guido van Rossum0e548712002-08-09 16:14:33 +0000251
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200252# We test _get_default_tempdir some more by testing gettempdir.
Guido van Rossum0e548712002-08-09 16:14:33 +0000253
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200254class TestGetDefaultTempdir(BaseTestCase):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200255 """Test _get_default_tempdir()."""
256
257 def test_no_files_left_behind(self):
258 # use a private empty directory
259 with tempfile.TemporaryDirectory() as our_temp_directory:
260 # force _get_default_tempdir() to consider our empty directory
261 def our_candidate_list():
262 return [our_temp_directory]
263
264 with support.swap_attr(tempfile, "_candidate_tempdir_list",
265 our_candidate_list):
266 # verify our directory is empty after _get_default_tempdir()
267 tempfile._get_default_tempdir()
268 self.assertEqual(os.listdir(our_temp_directory), [])
269
270 def raise_OSError(*args, **kwargs):
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200271 raise OSError()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200272
273 with support.swap_attr(io, "open", raise_OSError):
274 # test again with failing io.open()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200275 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200276 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200277 self.assertEqual(os.listdir(our_temp_directory), [])
278
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200279 def bad_writer(*args, **kwargs):
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300280 fp = orig_open(*args, **kwargs)
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200281 fp.write = raise_OSError
282 return fp
283
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300284 with support.swap_attr(io, "open", bad_writer) as orig_open:
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200285 # test again with failing write()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200286 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200287 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200288 self.assertEqual(os.listdir(our_temp_directory), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000289
290
Antoine Pitroueab2a502012-03-10 16:34:40 +0100291class TestGetCandidateNames(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000292 """Test the internal function _get_candidate_names."""
293
294 def test_retval(self):
Victor Stinner1e62bf12017-04-19 22:59:51 +0200295 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000296 obj = tempfile._get_candidate_names()
Victor Stinner1e62bf12017-04-19 22:59:51 +0200297 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000298
299 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000300 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000301 a = tempfile._get_candidate_names()
302 b = tempfile._get_candidate_names()
303
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000304 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000305
Guido van Rossum0e548712002-08-09 16:14:33 +0000306
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700307@contextlib.contextmanager
308def _inside_empty_temp_dir():
309 dir = tempfile.mkdtemp()
310 try:
311 with support.swap_attr(tempfile, 'tempdir', dir):
312 yield
313 finally:
314 support.rmtree(dir)
315
316
317def _mock_candidate_names(*names):
318 return support.swap_attr(tempfile,
319 '_get_candidate_names',
320 lambda: iter(names))
321
322
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300323class TestBadTempdir:
324
325 def test_read_only_directory(self):
326 with _inside_empty_temp_dir():
327 oldmode = mode = os.stat(tempfile.tempdir).st_mode
328 mode &= ~(stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH)
329 os.chmod(tempfile.tempdir, mode)
330 try:
331 if os.access(tempfile.tempdir, os.W_OK):
332 self.skipTest("can't set the directory read-only")
333 with self.assertRaises(PermissionError):
334 self.make_temp()
335 self.assertEqual(os.listdir(tempfile.tempdir), [])
336 finally:
337 os.chmod(tempfile.tempdir, oldmode)
338
339 def test_nonexisting_directory(self):
340 with _inside_empty_temp_dir():
341 tempdir = os.path.join(tempfile.tempdir, 'nonexistent')
342 with support.swap_attr(tempfile, 'tempdir', tempdir):
343 with self.assertRaises(FileNotFoundError):
344 self.make_temp()
345
346 def test_non_directory(self):
347 with _inside_empty_temp_dir():
348 tempdir = os.path.join(tempfile.tempdir, 'file')
349 open(tempdir, 'wb').close()
350 with support.swap_attr(tempfile, 'tempdir', tempdir):
351 with self.assertRaises((NotADirectoryError, FileNotFoundError)):
352 self.make_temp()
353
354
355class TestMkstempInner(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000356 """Test the internal function _mkstemp_inner."""
357
358 class mkstemped:
359 _bflags = tempfile._bin_openflags
360 _tflags = tempfile._text_openflags
361 _close = os.close
362 _unlink = os.unlink
363
364 def __init__(self, dir, pre, suf, bin):
365 if bin: flags = self._bflags
366 else: flags = self._tflags
367
Gregory P. Smithad577b92015-05-22 16:18:14 -0700368 output_type = tempfile._infer_return_type(dir, pre, suf)
369 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags, output_type)
Guido van Rossum0e548712002-08-09 16:14:33 +0000370
371 def write(self, str):
372 os.write(self.fd, str)
373
374 def __del__(self):
375 self._close(self.fd)
376 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000377
Gregory P. Smithad577b92015-05-22 16:18:14 -0700378 def do_create(self, dir=None, pre=None, suf=None, bin=1):
379 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000380 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700381 if output_type is str:
382 dir = tempfile.gettempdir()
383 else:
384 dir = tempfile.gettempdirb()
385 if pre is None:
386 pre = output_type()
387 if suf is None:
388 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100389 file = self.mkstemped(dir, pre, suf, bin)
Guido van Rossum0e548712002-08-09 16:14:33 +0000390
391 self.nameCheck(file.name, dir, pre, suf)
392 return file
393
394 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000395 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000396 self.do_create().write(b"blat")
397 self.do_create(pre="a").write(b"blat")
398 self.do_create(suf="b").write(b"blat")
399 self.do_create(pre="a", suf="b").write(b"blat")
400 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000401
Gregory P. Smithad577b92015-05-22 16:18:14 -0700402 def test_basic_with_bytes_names(self):
403 # _mkstemp_inner can create files when given name parts all
404 # specified as bytes.
405 dir_b = tempfile.gettempdirb()
406 self.do_create(dir=dir_b, suf=b"").write(b"blat")
407 self.do_create(dir=dir_b, pre=b"a").write(b"blat")
408 self.do_create(dir=dir_b, suf=b"b").write(b"blat")
409 self.do_create(dir=dir_b, pre=b"a", suf=b"b").write(b"blat")
410 self.do_create(dir=dir_b, pre=b"aa", suf=b".txt").write(b"blat")
411 # Can't mix str & binary types in the args.
412 with self.assertRaises(TypeError):
413 self.do_create(dir="", suf=b"").write(b"blat")
414 with self.assertRaises(TypeError):
415 self.do_create(dir=dir_b, pre="").write(b"blat")
416 with self.assertRaises(TypeError):
417 self.do_create(dir=dir_b, pre=b"", suf="").write(b"blat")
418
Guido van Rossum0e548712002-08-09 16:14:33 +0000419 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000420 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000421 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000422 for i in extant:
423 extant[i] = self.do_create(pre="aa")
424
425 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000426 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000427 dir = tempfile.mkdtemp()
428 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000429 self.do_create(dir=dir).write(b"blat")
Anthony Sottile370138b2019-09-09 08:54:34 -0700430 self.do_create(dir=pathlib.Path(dir)).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000431 finally:
432 os.rmdir(dir)
433
434 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000435 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000436
437 file = self.do_create()
438 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000439 expected = 0o600
Jesus Cea4791a242012-10-05 03:15:39 +0200440 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000441 # There's no distinction among 'user', 'group' and 'world';
442 # replicate the 'user' bits.
443 user = expected >> 6
444 expected = user * (1 + 8 + 64)
445 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000446
Zachary Ware9fe6d862013-12-08 00:20:35 -0600447 @unittest.skipUnless(has_spawnl, 'os.spawnl not available')
Guido van Rossum0e548712002-08-09 16:14:33 +0000448 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000449 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum0e548712002-08-09 16:14:33 +0000450
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000451 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000452 v="v"
453 else:
454 v="q"
455
Guido van Rossum0e548712002-08-09 16:14:33 +0000456 file = self.do_create()
Victor Stinnerdaf45552013-08-28 00:53:59 +0200457 self.assertEqual(os.get_inheritable(file.fd), False)
Guido van Rossum78741062002-08-17 11:41:01 +0000458 fd = "%d" % file.fd
459
460 try:
461 me = __file__
462 except NameError:
463 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000464
465 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000466 # effect. The core of this test is therefore in
467 # tf_inherit_check.py, which see.
468 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
469 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000470
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000471 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
472 # but an arg with embedded spaces should be decorated with double
473 # quotes on each end
Jesus Cea4791a242012-10-05 03:15:39 +0200474 if sys.platform == 'win32':
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000475 decorated = '"%s"' % sys.executable
476 tester = '"%s"' % tester
477 else:
478 decorated = sys.executable
479
480 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000481 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000482 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000483 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000484
Zachary Ware9fe6d862013-12-08 00:20:35 -0600485 @unittest.skipUnless(has_textmode, "text mode not available")
Guido van Rossum0e548712002-08-09 16:14:33 +0000486 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000487 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000488
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000489 # A text file is truncated at the first Ctrl+Z byte
490 f = self.do_create(bin=0)
491 f.write(b"blat\x1a")
492 f.write(b"extra\n")
493 os.lseek(f.fd, 0, os.SEEK_SET)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000494 self.assertEqual(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000495
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300496 def make_temp(self):
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700497 return tempfile._mkstemp_inner(tempfile.gettempdir(),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700498 tempfile.gettempprefix(),
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700499 '',
Gregory P. Smithad577b92015-05-22 16:18:14 -0700500 tempfile._bin_openflags,
501 str)
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700502
503 def test_collision_with_existing_file(self):
504 # _mkstemp_inner tries another name when a file with
505 # the chosen name already exists
506 with _inside_empty_temp_dir(), \
507 _mock_candidate_names('aaa', 'aaa', 'bbb'):
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300508 (fd1, name1) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700509 os.close(fd1)
510 self.assertTrue(name1.endswith('aaa'))
511
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300512 (fd2, name2) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700513 os.close(fd2)
514 self.assertTrue(name2.endswith('bbb'))
515
Eli Benderskyf315df32013-09-06 06:11:19 -0700516 def test_collision_with_existing_directory(self):
517 # _mkstemp_inner tries another name when a directory with
518 # the chosen name already exists
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700519 with _inside_empty_temp_dir(), \
520 _mock_candidate_names('aaa', 'aaa', 'bbb'):
521 dir = tempfile.mkdtemp()
522 self.assertTrue(dir.endswith('aaa'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700523
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300524 (fd, name) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700525 os.close(fd)
526 self.assertTrue(name.endswith('bbb'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700527
Guido van Rossum0e548712002-08-09 16:14:33 +0000528
Antoine Pitroueab2a502012-03-10 16:34:40 +0100529class TestGetTempPrefix(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000530 """Test gettempprefix()."""
531
532 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000533 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000534 p = tempfile.gettempprefix()
535
Ezio Melottie9615932010-01-24 19:26:24 +0000536 self.assertIsInstance(p, str)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700537 self.assertGreater(len(p), 0)
538
539 pb = tempfile.gettempprefixb()
540
541 self.assertIsInstance(pb, bytes)
542 self.assertGreater(len(pb), 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000543
544 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000545 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000546
547 # Create a temp directory, avoiding use of the prefix.
548 # Then attempt to create a file whose name is
549 # prefix + 'xxxxxx.xxx' in that directory.
550 p = tempfile.gettempprefix() + "xxxxxx.xxx"
551 d = tempfile.mkdtemp(prefix="")
552 try:
553 p = os.path.join(d, p)
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100554 fd = os.open(p, os.O_RDWR | os.O_CREAT)
Guido van Rossum0e548712002-08-09 16:14:33 +0000555 os.close(fd)
556 os.unlink(p)
557 finally:
558 os.rmdir(d)
559
Guido van Rossum0e548712002-08-09 16:14:33 +0000560
Antoine Pitroueab2a502012-03-10 16:34:40 +0100561class TestGetTempDir(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000562 """Test gettempdir()."""
563
564 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000565 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000566
Gregory P. Smithad577b92015-05-22 16:18:14 -0700567 for d in (tempfile.gettempdir(), tempfile.gettempdirb()):
568 self.assertTrue(os.path.isabs(d) or d == os.curdir,
569 "%r is not an absolute path" % d)
570 self.assertTrue(os.path.isdir(d),
571 "%r is not a directory" % d)
Guido van Rossum0e548712002-08-09 16:14:33 +0000572
573 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000574 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000575
576 # sneaky: just instantiate a NamedTemporaryFile, which
577 # defaults to writing into the directory returned by
578 # gettempdir.
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200579 with tempfile.NamedTemporaryFile() as file:
580 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000581
582 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000583 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000584 a = tempfile.gettempdir()
585 b = tempfile.gettempdir()
Gregory P. Smithad577b92015-05-22 16:18:14 -0700586 c = tempfile.gettempdirb()
Guido van Rossum0e548712002-08-09 16:14:33 +0000587
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000588 self.assertTrue(a is b)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700589 self.assertNotEqual(type(a), type(c))
590 self.assertEqual(a, os.fsdecode(c))
Guido van Rossum0e548712002-08-09 16:14:33 +0000591
Tim Golden6d09f092013-10-25 18:38:16 +0100592 def test_case_sensitive(self):
593 # gettempdir should not flatten its case
594 # even on a case-insensitive file system
595 case_sensitive_tempdir = tempfile.mkdtemp("-Temp")
596 _tempdir, tempfile.tempdir = tempfile.tempdir, None
597 try:
598 with support.EnvironmentVarGuard() as env:
599 # Fake the first env var which is checked as a candidate
600 env["TMPDIR"] = case_sensitive_tempdir
601 self.assertEqual(tempfile.gettempdir(), case_sensitive_tempdir)
602 finally:
603 tempfile.tempdir = _tempdir
604 support.rmdir(case_sensitive_tempdir)
605
Guido van Rossum0e548712002-08-09 16:14:33 +0000606
Antoine Pitroueab2a502012-03-10 16:34:40 +0100607class TestMkstemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000608 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000609
Gregory P. Smithad577b92015-05-22 16:18:14 -0700610 def do_create(self, dir=None, pre=None, suf=None):
611 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000612 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700613 if output_type is str:
614 dir = tempfile.gettempdir()
615 else:
616 dir = tempfile.gettempdirb()
617 if pre is None:
618 pre = output_type()
619 if suf is None:
620 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100621 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
622 (ndir, nbase) = os.path.split(name)
623 adir = os.path.abspath(dir)
624 self.assertEqual(adir, ndir,
625 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000626
627 try:
628 self.nameCheck(name, dir, pre, suf)
629 finally:
630 os.close(fd)
631 os.unlink(name)
632
633 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000634 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000635 self.do_create()
636 self.do_create(pre="a")
637 self.do_create(suf="b")
638 self.do_create(pre="a", suf="b")
639 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000640 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000641
Gregory P. Smithad577b92015-05-22 16:18:14 -0700642 def test_basic_with_bytes_names(self):
643 # mkstemp can create files when given name parts all
644 # specified as bytes.
645 d = tempfile.gettempdirb()
646 self.do_create(dir=d, suf=b"")
647 self.do_create(dir=d, pre=b"a")
648 self.do_create(dir=d, suf=b"b")
649 self.do_create(dir=d, pre=b"a", suf=b"b")
650 self.do_create(dir=d, pre=b"aa", suf=b".txt")
651 self.do_create(dir=b".")
652 with self.assertRaises(TypeError):
653 self.do_create(dir=".", pre=b"aa", suf=b".txt")
654 with self.assertRaises(TypeError):
655 self.do_create(dir=b".", pre="aa", suf=b".txt")
656 with self.assertRaises(TypeError):
657 self.do_create(dir=b".", pre=b"aa", suf=".txt")
658
659
Guido van Rossum0e548712002-08-09 16:14:33 +0000660 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000661 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000662 dir = tempfile.mkdtemp()
663 try:
664 self.do_create(dir=dir)
Anthony Sottile370138b2019-09-09 08:54:34 -0700665 self.do_create(dir=pathlib.Path(dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000666 finally:
667 os.rmdir(dir)
668
Guido van Rossum0e548712002-08-09 16:14:33 +0000669
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300670class TestMkdtemp(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000671 """Test mkdtemp()."""
672
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300673 def make_temp(self):
674 return tempfile.mkdtemp()
675
Gregory P. Smithad577b92015-05-22 16:18:14 -0700676 def do_create(self, dir=None, pre=None, suf=None):
677 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000678 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700679 if output_type is str:
680 dir = tempfile.gettempdir()
681 else:
682 dir = tempfile.gettempdirb()
683 if pre is None:
684 pre = output_type()
685 if suf is None:
686 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100687 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000688
689 try:
690 self.nameCheck(name, dir, pre, suf)
691 return name
692 except:
693 os.rmdir(name)
694 raise
695
696 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000697 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000698 os.rmdir(self.do_create())
699 os.rmdir(self.do_create(pre="a"))
700 os.rmdir(self.do_create(suf="b"))
701 os.rmdir(self.do_create(pre="a", suf="b"))
702 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000703
Gregory P. Smithad577b92015-05-22 16:18:14 -0700704 def test_basic_with_bytes_names(self):
705 # mkdtemp can create directories when given all binary parts
706 d = tempfile.gettempdirb()
707 os.rmdir(self.do_create(dir=d))
708 os.rmdir(self.do_create(dir=d, pre=b"a"))
709 os.rmdir(self.do_create(dir=d, suf=b"b"))
710 os.rmdir(self.do_create(dir=d, pre=b"a", suf=b"b"))
711 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=b".txt"))
712 with self.assertRaises(TypeError):
713 os.rmdir(self.do_create(dir=d, pre="aa", suf=b".txt"))
714 with self.assertRaises(TypeError):
715 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=".txt"))
716 with self.assertRaises(TypeError):
717 os.rmdir(self.do_create(dir="", pre=b"aa", suf=b".txt"))
718
Guido van Rossum0e548712002-08-09 16:14:33 +0000719 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000720 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000721 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000722 try:
723 for i in extant:
724 extant[i] = self.do_create(pre="aa")
725 finally:
726 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000727 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000728 os.rmdir(i)
729
730 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000731 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000732 dir = tempfile.mkdtemp()
733 try:
734 os.rmdir(self.do_create(dir=dir))
Anthony Sottile370138b2019-09-09 08:54:34 -0700735 os.rmdir(self.do_create(dir=pathlib.Path(dir)))
Guido van Rossum0e548712002-08-09 16:14:33 +0000736 finally:
737 os.rmdir(dir)
738
739 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000740 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000741
742 dir = self.do_create()
743 try:
744 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000745 mode &= 0o777 # Mask off sticky bits inherited from /tmp
746 expected = 0o700
Jesus Cea4791a242012-10-05 03:15:39 +0200747 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000748 # There's no distinction among 'user', 'group' and 'world';
749 # replicate the 'user' bits.
750 user = expected >> 6
751 expected = user * (1 + 8 + 64)
752 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000753 finally:
754 os.rmdir(dir)
755
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700756 def test_collision_with_existing_file(self):
757 # mkdtemp tries another name when a file with
758 # the chosen name already exists
759 with _inside_empty_temp_dir(), \
760 _mock_candidate_names('aaa', 'aaa', 'bbb'):
761 file = tempfile.NamedTemporaryFile(delete=False)
762 file.close()
763 self.assertTrue(file.name.endswith('aaa'))
764 dir = tempfile.mkdtemp()
765 self.assertTrue(dir.endswith('bbb'))
766
767 def test_collision_with_existing_directory(self):
768 # mkdtemp tries another name when a directory with
769 # the chosen name already exists
770 with _inside_empty_temp_dir(), \
771 _mock_candidate_names('aaa', 'aaa', 'bbb'):
772 dir1 = tempfile.mkdtemp()
773 self.assertTrue(dir1.endswith('aaa'))
774 dir2 = tempfile.mkdtemp()
775 self.assertTrue(dir2.endswith('bbb'))
776
Guido van Rossum0e548712002-08-09 16:14:33 +0000777
Antoine Pitroueab2a502012-03-10 16:34:40 +0100778class TestMktemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000779 """Test mktemp()."""
780
781 # For safety, all use of mktemp must occur in a private directory.
782 # We must also suppress the RuntimeWarning it generates.
783 def setUp(self):
784 self.dir = tempfile.mkdtemp()
Brett Cannone1adece2010-03-20 22:19:55 +0000785 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000786
787 def tearDown(self):
788 if self.dir:
789 os.rmdir(self.dir)
790 self.dir = None
Brett Cannone1adece2010-03-20 22:19:55 +0000791 super().tearDown()
Guido van Rossum0e548712002-08-09 16:14:33 +0000792
793 class mktemped:
794 _unlink = os.unlink
795 _bflags = tempfile._bin_openflags
796
797 def __init__(self, dir, pre, suf):
798 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
799 # Create the file. This will raise an exception if it's
800 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000801 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000802
803 def __del__(self):
804 self._unlink(self.name)
805
806 def do_create(self, pre="", suf=""):
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100807 file = self.mktemped(self.dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000808
809 self.nameCheck(file.name, self.dir, pre, suf)
810 return file
811
812 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000813 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000814 self.do_create()
815 self.do_create(pre="a")
816 self.do_create(suf="b")
817 self.do_create(pre="a", suf="b")
818 self.do_create(pre="aa", suf=".txt")
819
820 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000821 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000822 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000823 for i in extant:
824 extant[i] = self.do_create(pre="aa")
825
Fred Drake8bec4832002-11-22 20:13:43 +0000826## def test_warning(self):
827## # mktemp issues a warning when used
828## warnings.filterwarnings("error",
829## category=RuntimeWarning,
830## message="mktemp")
831## self.assertRaises(RuntimeWarning,
832## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000833
Guido van Rossum0e548712002-08-09 16:14:33 +0000834
835# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
836
837
Antoine Pitroueab2a502012-03-10 16:34:40 +0100838class TestNamedTemporaryFile(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000839 """Test NamedTemporaryFile()."""
840
Guido van Rossumd8faa362007-04-27 19:54:29 +0000841 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000842 if dir is None:
843 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100844 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
845 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000846
847 self.nameCheck(file.name, dir, pre, suf)
848 return file
849
850
851 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000852 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000853 self.do_create()
854 self.do_create(pre="a")
855 self.do_create(suf="b")
856 self.do_create(pre="a", suf="b")
857 self.do_create(pre="aa", suf=".txt")
858
Antoine Pitrou17c93262013-12-21 22:14:56 +0100859 def test_method_lookup(self):
860 # Issue #18879: Looking up a temporary file method should keep it
861 # alive long enough.
862 f = self.do_create()
863 wr = weakref.ref(f)
864 write = f.write
865 write2 = f.write
866 del f
867 write(b'foo')
868 del write
869 write2(b'bar')
870 del write2
871 if support.check_impl_detail(cpython=True):
872 # No reference cycle was created.
873 self.assertIsNone(wr())
874
Serhiy Storchaka56cefa62015-03-19 15:23:15 +0200875 def test_iter(self):
876 # Issue #23700: getting iterator from a temporary file should keep
877 # it alive as long as it's being iterated over
878 lines = [b'spam\n', b'eggs\n', b'beans\n']
879 def make_file():
880 f = tempfile.NamedTemporaryFile(mode='w+b')
881 f.write(b''.join(lines))
882 f.seek(0)
883 return f
884 for i, l in enumerate(make_file()):
885 self.assertEqual(l, lines[i])
886 self.assertEqual(i, len(lines) - 1)
887
Guido van Rossum0e548712002-08-09 16:14:33 +0000888 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000889 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000890 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000891 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000892 "NamedTemporaryFile %s does not exist" % f.name)
893
894 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000895 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000896 dir = tempfile.mkdtemp()
897 try:
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200898 with tempfile.NamedTemporaryFile(dir=dir) as f:
899 f.write(b'blat')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000900 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000901 "NamedTemporaryFile %s exists after close" % f.name)
902 finally:
903 os.rmdir(dir)
904
Guido van Rossumd8faa362007-04-27 19:54:29 +0000905 def test_dis_del_on_close(self):
906 # Tests that delete-on-close can be disabled
907 dir = tempfile.mkdtemp()
908 tmp = None
909 try:
910 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
911 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000912 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000913 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000914 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000915 "NamedTemporaryFile %s missing after close" % f.name)
916 finally:
917 if tmp is not None:
918 os.unlink(tmp)
919 os.rmdir(dir)
920
Guido van Rossum0e548712002-08-09 16:14:33 +0000921 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000922 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000923 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000924 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000925 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100926 f.close()
927 f.close()
Guido van Rossum0e548712002-08-09 16:14:33 +0000928
Christian Heimes3ecfea712008-02-09 20:51:34 +0000929 def test_context_manager(self):
930 # A NamedTemporaryFile can be used as a context manager
931 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000932 self.assertTrue(os.path.exists(f.name))
933 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000934 def use_closed():
935 with f:
936 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000937 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000938
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100939 def test_no_leak_fd(self):
Victor Stinner87d13ea2014-03-25 18:19:17 +0100940 # Issue #21058: don't leak file descriptor when io.open() fails
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100941 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +0200942 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100943 def close(fd):
944 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +0200945 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100946
947 with mock.patch('os.close', side_effect=close):
948 with mock.patch('io.open', side_effect=ValueError):
949 self.assertRaises(ValueError, tempfile.NamedTemporaryFile)
950 self.assertEqual(len(closed), 1)
951
Martin Panter7869a222016-02-28 05:22:20 +0000952 def test_bad_mode(self):
953 dir = tempfile.mkdtemp()
954 self.addCleanup(support.rmtree, dir)
955 with self.assertRaises(ValueError):
956 tempfile.NamedTemporaryFile(mode='wr', dir=dir)
957 with self.assertRaises(TypeError):
958 tempfile.NamedTemporaryFile(mode=2, dir=dir)
959 self.assertEqual(os.listdir(dir), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000960
Martin Panter7869a222016-02-28 05:22:20 +0000961 # How to test the mode and bufsize parameters?
Guido van Rossum0e548712002-08-09 16:14:33 +0000962
Antoine Pitroueab2a502012-03-10 16:34:40 +0100963class TestSpooledTemporaryFile(BaseTestCase):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000964 """Test SpooledTemporaryFile()."""
965
966 def do_create(self, max_size=0, dir=None, pre="", suf=""):
967 if dir is None:
968 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100969 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000970
971 return file
972
973
974 def test_basic(self):
975 # SpooledTemporaryFile can create files
976 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000977 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000978 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000979 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000980
981 def test_del_on_close(self):
982 # A SpooledTemporaryFile is deleted when closed
983 dir = tempfile.mkdtemp()
984 try:
985 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000986 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000987 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000988 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000989 filename = f.name
990 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000991 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000992 "SpooledTemporaryFile %s exists after close" % filename)
993 finally:
994 os.rmdir(dir)
995
996 def test_rewrite_small(self):
997 # A SpooledTemporaryFile can be written to multiple within the max_size
998 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000999 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001000 for i in range(5):
1001 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +00001002 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001003 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001004
1005 def test_write_sequential(self):
1006 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1007 # over afterward
1008 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001009 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001010 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001011 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001012 f.write(b'x' * 10)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001013 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001014 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001015 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001016
R David Murrayd89ee792011-03-14 09:55:46 -04001017 def test_writelines(self):
1018 # Verify writelines with a SpooledTemporaryFile
1019 f = self.do_create()
1020 f.writelines((b'x', b'y', b'z'))
Inada Naoki485e7152020-04-17 15:56:35 +09001021 pos = f.seek(0)
1022 self.assertEqual(pos, 0)
R David Murrayd89ee792011-03-14 09:55:46 -04001023 buf = f.read()
1024 self.assertEqual(buf, b'xyz')
1025
1026 def test_writelines_sequential(self):
1027 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1028 # over afterward
1029 f = self.do_create(max_size=35)
1030 f.writelines((b'x' * 20, b'x' * 10, b'x' * 5))
1031 self.assertFalse(f._rolled)
1032 f.write(b'x')
1033 self.assertTrue(f._rolled)
1034
Guido van Rossumd8faa362007-04-27 19:54:29 +00001035 def test_sparse(self):
1036 # A SpooledTemporaryFile that is written late in the file will extend
1037 # when that occurs
1038 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001039 self.assertFalse(f._rolled)
Inada Naoki485e7152020-04-17 15:56:35 +09001040 pos = f.seek(100, 0)
1041 self.assertEqual(pos, 100)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001042 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001043 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001044 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001045
1046 def test_fileno(self):
1047 # A SpooledTemporaryFile should roll over to a real file on fileno()
1048 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001049 self.assertFalse(f._rolled)
1050 self.assertTrue(f.fileno() > 0)
1051 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001052
Christian Heimes3ecfea712008-02-09 20:51:34 +00001053 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001054 # A SpooledTemporaryFile can be closed many times without error
1055 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +00001056 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001057 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001058 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001059 f.close()
1060 f.close()
Christian Heimes3ecfea712008-02-09 20:51:34 +00001061
1062 def test_multiple_close_after_rollover(self):
1063 # A SpooledTemporaryFile can be closed many times without error
1064 f = tempfile.SpooledTemporaryFile(max_size=1)
1065 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001066 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001067 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001068 f.close()
1069 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001070
1071 def test_bound_methods(self):
1072 # It should be OK to steal a bound method from a SpooledTemporaryFile
1073 # and use it independently; when the file rolls over, those bound
1074 # methods should continue to function
1075 f = self.do_create(max_size=30)
1076 read = f.read
1077 write = f.write
1078 seek = f.seek
1079
Guido van Rossum39478e82007-08-27 17:23:59 +00001080 write(b"a" * 35)
1081 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001082 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +00001083 self.assertEqual(read(70), b'a'*35 + b'b'*35)
1084
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001085 def test_properties(self):
1086 f = tempfile.SpooledTemporaryFile(max_size=10)
1087 f.write(b'x' * 10)
1088 self.assertFalse(f._rolled)
1089 self.assertEqual(f.mode, 'w+b')
1090 self.assertIsNone(f.name)
1091 with self.assertRaises(AttributeError):
1092 f.newlines
1093 with self.assertRaises(AttributeError):
1094 f.encoding
sth825aab92018-05-23 07:07:01 +02001095 with self.assertRaises(AttributeError):
1096 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001097
1098 f.write(b'x')
1099 self.assertTrue(f._rolled)
1100 self.assertEqual(f.mode, 'rb+')
1101 self.assertIsNotNone(f.name)
1102 with self.assertRaises(AttributeError):
1103 f.newlines
1104 with self.assertRaises(AttributeError):
1105 f.encoding
sth825aab92018-05-23 07:07:01 +02001106 with self.assertRaises(AttributeError):
1107 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001108
Guido van Rossum9a634702007-07-09 10:24:45 +00001109 def test_text_mode(self):
1110 # Creating a SpooledTemporaryFile with a text mode should produce
1111 # a file object reading and writing (Unicode) text strings.
Inada Naokiea9835c2019-11-27 22:22:06 +09001112 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
1113 encoding="utf-8")
Guido van Rossum9a634702007-07-09 10:24:45 +00001114 f.write("abc\n")
1115 f.seek(0)
1116 self.assertEqual(f.read(), "abc\n")
1117 f.write("def\n")
1118 f.seek(0)
1119 self.assertEqual(f.read(), "abc\ndef\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001120 self.assertFalse(f._rolled)
1121 self.assertEqual(f.mode, 'w+')
1122 self.assertIsNone(f.name)
Inada Naokiea9835c2019-11-27 22:22:06 +09001123 self.assertEqual(f.newlines, os.linesep)
1124 self.assertEqual(f.encoding, "utf-8")
1125 self.assertEqual(f.errors, "strict")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001126
Guido van Rossum9a634702007-07-09 10:24:45 +00001127 f.write("xyzzy\n")
1128 f.seek(0)
1129 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +00001130 # Check that Ctrl+Z doesn't truncate the file
1131 f.write("foo\x1abar\n")
1132 f.seek(0)
1133 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001134 self.assertTrue(f._rolled)
1135 self.assertEqual(f.mode, 'w+')
1136 self.assertIsNotNone(f.name)
Serhiy Storchaka497cee42013-02-10 14:43:46 +02001137 self.assertEqual(f.newlines, os.linesep)
Inada Naokiea9835c2019-11-27 22:22:06 +09001138 self.assertEqual(f.encoding, "utf-8")
1139 self.assertEqual(f.errors, "strict")
Guido van Rossum9a634702007-07-09 10:24:45 +00001140
Guido van Rossumf0c74162007-08-28 03:29:45 +00001141 def test_text_newline_and_encoding(self):
1142 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
sth825aab92018-05-23 07:07:01 +02001143 newline='', encoding='utf-8',
1144 errors='ignore')
Guido van Rossumf0c74162007-08-28 03:29:45 +00001145 f.write("\u039B\r\n")
1146 f.seek(0)
1147 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001148 self.assertFalse(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001149 self.assertEqual(f.mode, 'w+')
1150 self.assertIsNone(f.name)
Inada Naokiea9835c2019-11-27 22:22:06 +09001151 self.assertIsNotNone(f.newlines)
1152 self.assertEqual(f.encoding, "utf-8")
1153 self.assertEqual(f.errors, "ignore")
Guido van Rossumf0c74162007-08-28 03:29:45 +00001154
Inada Naokiea9835c2019-11-27 22:22:06 +09001155 f.write("\u039C" * 10 + "\r\n")
1156 f.write("\u039D" * 20)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001157 f.seek(0)
Inada Naokiea9835c2019-11-27 22:22:06 +09001158 self.assertEqual(f.read(),
1159 "\u039B\r\n" + ("\u039C" * 10) + "\r\n" + ("\u039D" * 20))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001160 self.assertTrue(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001161 self.assertEqual(f.mode, 'w+')
1162 self.assertIsNotNone(f.name)
1163 self.assertIsNotNone(f.newlines)
1164 self.assertEqual(f.encoding, 'utf-8')
sth825aab92018-05-23 07:07:01 +02001165 self.assertEqual(f.errors, 'ignore')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001166
Christian Heimes3ecfea712008-02-09 20:51:34 +00001167 def test_context_manager_before_rollover(self):
1168 # A SpooledTemporaryFile can be used as a context manager
1169 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001170 self.assertFalse(f._rolled)
1171 self.assertFalse(f.closed)
1172 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001173 def use_closed():
1174 with f:
1175 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001176 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001177
1178 def test_context_manager_during_rollover(self):
1179 # A SpooledTemporaryFile can be used as a context manager
1180 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001181 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001182 f.write(b'abc\n')
1183 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001184 self.assertTrue(f._rolled)
1185 self.assertFalse(f.closed)
1186 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001187 def use_closed():
1188 with f:
1189 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001190 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001191
1192 def test_context_manager_after_rollover(self):
1193 # A SpooledTemporaryFile can be used as a context manager
1194 f = tempfile.SpooledTemporaryFile(max_size=1)
1195 f.write(b'abc\n')
1196 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001197 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001198 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001199 self.assertFalse(f.closed)
1200 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001201 def use_closed():
1202 with f:
1203 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001204 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001205
Antoine Pitrou0e86a582011-11-25 18:03:09 +01001206 def test_truncate_with_size_parameter(self):
1207 # A SpooledTemporaryFile can be truncated to zero size
1208 f = tempfile.SpooledTemporaryFile(max_size=10)
1209 f.write(b'abcdefg\n')
1210 f.seek(0)
1211 f.truncate()
1212 self.assertFalse(f._rolled)
1213 self.assertEqual(f._file.getvalue(), b'')
1214 # A SpooledTemporaryFile can be truncated to a specific size
1215 f = tempfile.SpooledTemporaryFile(max_size=10)
1216 f.write(b'abcdefg\n')
1217 f.truncate(4)
1218 self.assertFalse(f._rolled)
1219 self.assertEqual(f._file.getvalue(), b'abcd')
1220 # A SpooledTemporaryFile rolls over if truncated to large size
1221 f = tempfile.SpooledTemporaryFile(max_size=10)
1222 f.write(b'abcdefg\n')
1223 f.truncate(20)
1224 self.assertTrue(f._rolled)
Anthony Sottile8377cd42019-02-25 14:32:27 -08001225 self.assertEqual(os.fstat(f.fileno()).st_size, 20)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001226
Batuhan TaĹźkaya09c482f2019-12-30 19:08:08 +03001227 def test_class_getitem(self):
Guido van Rossum48b069a2020-04-07 09:50:06 -07001228 self.assertIsInstance(tempfile.SpooledTemporaryFile[bytes],
1229 types.GenericAlias)
Guido van Rossum0e548712002-08-09 16:14:33 +00001230
Guido van Rossum8ccd9b62002-08-22 20:02:03 +00001231if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Antoine Pitroueab2a502012-03-10 16:34:40 +01001232
1233 class TestTemporaryFile(BaseTestCase):
1234 """Test TemporaryFile()."""
1235
1236 def test_basic(self):
1237 # TemporaryFile can create files
1238 # No point in testing the name params - the file has no name.
1239 tempfile.TemporaryFile()
1240
1241 def test_has_no_name(self):
1242 # TemporaryFile creates files with no names (on this system)
1243 dir = tempfile.mkdtemp()
1244 f = tempfile.TemporaryFile(dir=dir)
1245 f.write(b'blat')
1246
1247 # Sneaky: because this file has no name, it should not prevent
1248 # us from removing the directory it was created in.
1249 try:
1250 os.rmdir(dir)
1251 except:
1252 # cleanup
1253 f.close()
1254 os.rmdir(dir)
1255 raise
1256
1257 def test_multiple_close(self):
1258 # A TemporaryFile can be closed many times without error
1259 f = tempfile.TemporaryFile()
1260 f.write(b'abc\n')
1261 f.close()
1262 f.close()
1263 f.close()
1264
1265 # How to test the mode and bufsize parameters?
1266 def test_mode_and_encoding(self):
1267
1268 def roundtrip(input, *args, **kwargs):
1269 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
1270 fileobj.write(input)
1271 fileobj.seek(0)
1272 self.assertEqual(input, fileobj.read())
1273
1274 roundtrip(b"1234", "w+b")
1275 roundtrip("abdc\n", "w+")
1276 roundtrip("\u039B", "w+", encoding="utf-16")
1277 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +00001278
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001279 def test_no_leak_fd(self):
1280 # Issue #21058: don't leak file descriptor when io.open() fails
1281 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +02001282 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001283 def close(fd):
1284 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +02001285 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001286
1287 with mock.patch('os.close', side_effect=close):
1288 with mock.patch('io.open', side_effect=ValueError):
1289 self.assertRaises(ValueError, tempfile.TemporaryFile)
1290 self.assertEqual(len(closed), 1)
1291
1292
Nick Coghlan543af752010-10-24 11:23:25 +00001293
1294# Helper for test_del_on_shutdown
1295class NulledModules:
1296 def __init__(self, *modules):
1297 self.refs = [mod.__dict__ for mod in modules]
1298 self.contents = [ref.copy() for ref in self.refs]
1299
1300 def __enter__(self):
1301 for d in self.refs:
1302 for key in d:
1303 d[key] = None
1304
1305 def __exit__(self, *exc_info):
1306 for d, c in zip(self.refs, self.contents):
1307 d.clear()
1308 d.update(c)
1309
Antoine Pitroueab2a502012-03-10 16:34:40 +01001310class TestTemporaryDirectory(BaseTestCase):
Nick Coghlan543af752010-10-24 11:23:25 +00001311 """Test TemporaryDirectory()."""
1312
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001313 def do_create(self, dir=None, pre="", suf="", recurse=1, dirs=1, files=1):
Nick Coghlan543af752010-10-24 11:23:25 +00001314 if dir is None:
1315 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001316 tmp = tempfile.TemporaryDirectory(dir=dir, prefix=pre, suffix=suf)
Nick Coghlan543af752010-10-24 11:23:25 +00001317 self.nameCheck(tmp.name, dir, pre, suf)
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001318 self.do_create2(tmp.name, recurse, dirs, files)
Nick Coghlan543af752010-10-24 11:23:25 +00001319 return tmp
1320
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001321 def do_create2(self, path, recurse=1, dirs=1, files=1):
1322 # Create subdirectories and some files
1323 if recurse:
1324 for i in range(dirs):
1325 name = os.path.join(path, "dir%d" % i)
1326 os.mkdir(name)
1327 self.do_create2(name, recurse-1, dirs, files)
1328 for i in range(files):
1329 with open(os.path.join(path, "test%d.txt" % i), "wb") as f:
1330 f.write(b"Hello world!")
1331
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001332 def test_mkdtemp_failure(self):
1333 # Check no additional exception if mkdtemp fails
1334 # Previously would raise AttributeError instead
Nick Coghlan3c54ea62010-12-13 03:02:43 +00001335 # (noted as part of Issue #10188)
1336 with tempfile.TemporaryDirectory() as nonexistent:
1337 pass
Serhiy Storchaka7451a722013-02-09 22:25:49 +02001338 with self.assertRaises(FileNotFoundError) as cm:
Nick Coghlan3c54ea62010-12-13 03:02:43 +00001339 tempfile.TemporaryDirectory(dir=nonexistent)
Serhiy Storchaka7451a722013-02-09 22:25:49 +02001340 self.assertEqual(cm.exception.errno, errno.ENOENT)
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001341
Nick Coghlan543af752010-10-24 11:23:25 +00001342 def test_explicit_cleanup(self):
1343 # A TemporaryDirectory is deleted when cleaned up
1344 dir = tempfile.mkdtemp()
1345 try:
1346 d = self.do_create(dir=dir)
1347 self.assertTrue(os.path.exists(d.name),
1348 "TemporaryDirectory %s does not exist" % d.name)
1349 d.cleanup()
1350 self.assertFalse(os.path.exists(d.name),
1351 "TemporaryDirectory %s exists after cleanup" % d.name)
1352 finally:
1353 os.rmdir(dir)
1354
Charles-François Natalidef35432011-07-29 18:59:24 +02001355 @support.skip_unless_symlink
1356 def test_cleanup_with_symlink_to_a_directory(self):
1357 # cleanup() should not follow symlinks to directories (issue #12464)
1358 d1 = self.do_create()
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001359 d2 = self.do_create(recurse=0)
Charles-François Natalidef35432011-07-29 18:59:24 +02001360
1361 # Symlink d1/foo -> d2
1362 os.symlink(d2.name, os.path.join(d1.name, "foo"))
1363
1364 # This call to cleanup() should not follow the "foo" symlink
1365 d1.cleanup()
1366
1367 self.assertFalse(os.path.exists(d1.name),
1368 "TemporaryDirectory %s exists after cleanup" % d1.name)
1369 self.assertTrue(os.path.exists(d2.name),
1370 "Directory pointed to by a symlink was deleted")
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001371 self.assertEqual(os.listdir(d2.name), ['test0.txt'],
Charles-François Natalidef35432011-07-29 18:59:24 +02001372 "Contents of the directory pointed to by a symlink "
1373 "were deleted")
1374 d2.cleanup()
1375
Nick Coghlan543af752010-10-24 11:23:25 +00001376 @support.cpython_only
1377 def test_del_on_collection(self):
1378 # A TemporaryDirectory is deleted when garbage collected
1379 dir = tempfile.mkdtemp()
1380 try:
1381 d = self.do_create(dir=dir)
1382 name = d.name
1383 del d # Rely on refcounting to invoke __del__
1384 self.assertFalse(os.path.exists(name),
1385 "TemporaryDirectory %s exists after __del__" % name)
1386 finally:
1387 os.rmdir(dir)
1388
Nick Coghlan543af752010-10-24 11:23:25 +00001389 def test_del_on_shutdown(self):
1390 # A TemporaryDirectory may be cleaned up during shutdown
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001391 with self.do_create() as dir:
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001392 for mod in ('builtins', 'os', 'shutil', 'sys', 'tempfile', 'warnings'):
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001393 code = """if True:
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001394 import builtins
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001395 import os
1396 import shutil
1397 import sys
1398 import tempfile
1399 import warnings
1400
1401 tmp = tempfile.TemporaryDirectory(dir={dir!r})
1402 sys.stdout.buffer.write(tmp.name.encode())
1403
1404 tmp2 = os.path.join(tmp.name, 'test_dir')
1405 os.mkdir(tmp2)
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001406 with open(os.path.join(tmp2, "test0.txt"), "w") as f:
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001407 f.write("Hello world!")
1408
1409 {mod}.tmp = tmp
1410
1411 warnings.filterwarnings("always", category=ResourceWarning)
1412 """.format(dir=dir, mod=mod)
1413 rc, out, err = script_helper.assert_python_ok("-c", code)
1414 tmp_name = out.decode().strip()
1415 self.assertFalse(os.path.exists(tmp_name),
1416 "TemporaryDirectory %s exists after cleanup" % tmp_name)
1417 err = err.decode('utf-8', 'backslashreplace')
1418 self.assertNotIn("Exception ", err)
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001419 self.assertIn("ResourceWarning: Implicitly cleaning up", err)
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001420
Serhiy Storchaka5e193ac2014-09-24 13:26:25 +03001421 def test_exit_on_shutdown(self):
1422 # Issue #22427
1423 with self.do_create() as dir:
1424 code = """if True:
1425 import sys
1426 import tempfile
1427 import warnings
1428
1429 def generator():
1430 with tempfile.TemporaryDirectory(dir={dir!r}) as tmp:
1431 yield tmp
1432 g = generator()
1433 sys.stdout.buffer.write(next(g).encode())
1434
1435 warnings.filterwarnings("always", category=ResourceWarning)
1436 """.format(dir=dir)
1437 rc, out, err = script_helper.assert_python_ok("-c", code)
1438 tmp_name = out.decode().strip()
1439 self.assertFalse(os.path.exists(tmp_name),
1440 "TemporaryDirectory %s exists after cleanup" % tmp_name)
1441 err = err.decode('utf-8', 'backslashreplace')
1442 self.assertNotIn("Exception ", err)
1443 self.assertIn("ResourceWarning: Implicitly cleaning up", err)
1444
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001445 def test_warnings_on_cleanup(self):
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001446 # ResourceWarning will be triggered by __del__
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001447 with self.do_create() as dir:
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001448 d = self.do_create(dir=dir, recurse=3)
1449 name = d.name
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001450
1451 # Check for the resource warning
1452 with support.check_warnings(('Implicitly', ResourceWarning), quiet=False):
1453 warnings.filterwarnings("always", category=ResourceWarning)
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001454 del d
1455 support.gc_collect()
1456 self.assertFalse(os.path.exists(name),
1457 "TemporaryDirectory %s exists after __del__" % name)
Nick Coghlan543af752010-10-24 11:23:25 +00001458
1459 def test_multiple_close(self):
1460 # Can be cleaned-up many times without error
1461 d = self.do_create()
1462 d.cleanup()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001463 d.cleanup()
1464 d.cleanup()
Nick Coghlan543af752010-10-24 11:23:25 +00001465
1466 def test_context_manager(self):
1467 # Can be used as a context manager
1468 d = self.do_create()
1469 with d as name:
1470 self.assertTrue(os.path.exists(name))
1471 self.assertEqual(name, d.name)
1472 self.assertFalse(os.path.exists(name))
1473
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001474 def test_modes(self):
1475 for mode in range(8):
1476 mode <<= 6
1477 with self.subTest(mode=format(mode, '03o')):
1478 d = self.do_create(recurse=3, dirs=2, files=2)
1479 with d:
1480 # Change files and directories mode recursively.
1481 for root, dirs, files in os.walk(d.name, topdown=False):
1482 for name in files:
1483 os.chmod(os.path.join(root, name), mode)
1484 os.chmod(root, mode)
1485 d.cleanup()
1486 self.assertFalse(os.path.exists(d.name))
1487
1488 @unittest.skipUnless(hasattr(os, 'chflags'), 'requires os.lchflags')
1489 def test_flags(self):
1490 flags = stat.UF_IMMUTABLE | stat.UF_NOUNLINK
1491 d = self.do_create(recurse=3, dirs=2, files=2)
1492 with d:
1493 # Change files and directories flags recursively.
1494 for root, dirs, files in os.walk(d.name, topdown=False):
1495 for name in files:
1496 os.chflags(os.path.join(root, name), flags)
1497 os.chflags(root, flags)
1498 d.cleanup()
1499 self.assertFalse(os.path.exists(d.name))
1500
Nick Coghlan543af752010-10-24 11:23:25 +00001501
Guido van Rossum0e548712002-08-09 16:14:33 +00001502if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -05001503 unittest.main()