blob: 77d710efaf107b9c91163dccd30ea7aebd07a854 [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
Guido van Rossum0e548712002-08-09 16:14:33 +00007import sys
8import re
Guido van Rossum0e548712002-08-09 16:14:33 +00009import warnings
Eli Benderskyaa04f9a2013-09-13 05:28:20 -070010import contextlib
Anthony Sottile8377cd42019-02-25 14:32:27 -080011import stat
Guido van Rossum48b069a2020-04-07 09:50:06 -070012import types
Antoine Pitrou17c93262013-12-21 22:14:56 +010013import weakref
Victor Stinner1f99f9d2014-03-25 09:18:04 +010014from unittest import mock
Tim Petersc57a2852001-10-29 21:46:08 +000015
Guido van Rossum0e548712002-08-09 16:14:33 +000016import unittest
Berker Peksagce643912015-05-06 06:33:17 +030017from test import support
Hai Shi0c4f0f32020-06-30 21:46:31 +080018from test.support import os_helper
Berker Peksagce643912015-05-06 06:33:17 +030019from test.support import script_helper
Hai Shi0c4f0f32020-06-30 21:46:31 +080020from test.support import warnings_helper
Guido van Rossum0e548712002-08-09 16:14:33 +000021
Fred Drake7633d232002-10-17 22:09:03 +000022
Guido van Rossum0e548712002-08-09 16:14:33 +000023has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000024has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000025
Neal Norwitz68ee0122002-08-16 19:28:59 +000026# TEST_FILES may need to be tweaked for systems depending on the maximum
27# number of files that can be opened at one time (see ulimit -n)
Victor Stinner9c3de4a2011-08-17 20:49:41 +020028if sys.platform.startswith('openbsd'):
Martin v. Löwis99968282004-09-15 06:02:54 +000029 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000030else:
31 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000032
Guido van Rossum0e548712002-08-09 16:14:33 +000033# This is organized as one test for each chunk of code in tempfile.py,
34# in order of their appearance in the file. Testing which requires
35# threads is not done here.
36
Gregory P. Smithad577b92015-05-22 16:18:14 -070037class TestLowLevelInternals(unittest.TestCase):
38 def test_infer_return_type_singles(self):
39 self.assertIs(str, tempfile._infer_return_type(''))
40 self.assertIs(bytes, tempfile._infer_return_type(b''))
41 self.assertIs(str, tempfile._infer_return_type(None))
42
43 def test_infer_return_type_multiples(self):
44 self.assertIs(str, tempfile._infer_return_type('', ''))
45 self.assertIs(bytes, tempfile._infer_return_type(b'', b''))
46 with self.assertRaises(TypeError):
47 tempfile._infer_return_type('', b'')
48 with self.assertRaises(TypeError):
49 tempfile._infer_return_type(b'', '')
50
51 def test_infer_return_type_multiples_and_none(self):
52 self.assertIs(str, tempfile._infer_return_type(None, ''))
53 self.assertIs(str, tempfile._infer_return_type('', None))
54 self.assertIs(str, tempfile._infer_return_type(None, None))
55 self.assertIs(bytes, tempfile._infer_return_type(b'', None))
56 self.assertIs(bytes, tempfile._infer_return_type(None, b''))
57 with self.assertRaises(TypeError):
58 tempfile._infer_return_type('', None, b'')
59 with self.assertRaises(TypeError):
60 tempfile._infer_return_type(b'', None, '')
61
Anthony Sottile370138b2019-09-09 08:54:34 -070062 def test_infer_return_type_pathlib(self):
63 self.assertIs(str, tempfile._infer_return_type(pathlib.Path('/')))
64
Gregory P. Smithad577b92015-05-22 16:18:14 -070065
Guido van Rossum0e548712002-08-09 16:14:33 +000066# Common functionality.
Gregory P. Smithad577b92015-05-22 16:18:14 -070067
Antoine Pitroueab2a502012-03-10 16:34:40 +010068class BaseTestCase(unittest.TestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +000069
Victor Stinner97869102013-08-14 01:28:28 +020070 str_check = re.compile(r"^[a-z0-9_-]{8}$")
Gregory P. Smithad577b92015-05-22 16:18:14 -070071 b_check = re.compile(br"^[a-z0-9_-]{8}$")
Guido van Rossum0e548712002-08-09 16:14:33 +000072
Brett Cannone1adece2010-03-20 22:19:55 +000073 def setUp(self):
Hai Shi0c4f0f32020-06-30 21:46:31 +080074 self._warnings_manager = warnings_helper.check_warnings()
Brett Cannone1adece2010-03-20 22:19:55 +000075 self._warnings_manager.__enter__()
76 warnings.filterwarnings("ignore", category=RuntimeWarning,
77 message="mktemp", module=__name__)
78
79 def tearDown(self):
80 self._warnings_manager.__exit__(None, None, None)
81
Guido van Rossum0e548712002-08-09 16:14:33 +000082 def nameCheck(self, name, dir, pre, suf):
83 (ndir, nbase) = os.path.split(name)
84 npre = nbase[:len(pre)]
85 nsuf = nbase[len(nbase)-len(suf):]
86
Gregory P. Smithad577b92015-05-22 16:18:14 -070087 if dir is not None:
Anthony Sottile370138b2019-09-09 08:54:34 -070088 self.assertIs(
89 type(name),
90 str
91 if type(dir) is str or isinstance(dir, os.PathLike) else
92 bytes,
93 "unexpected return type",
94 )
Gregory P. Smithad577b92015-05-22 16:18:14 -070095 if pre is not None:
96 self.assertIs(type(name), str if type(pre) is str else bytes,
97 "unexpected return type")
98 if suf is not None:
99 self.assertIs(type(name), str if type(suf) is str else bytes,
100 "unexpected return type")
101 if (dir, pre, suf) == (None, None, None):
102 self.assertIs(type(name), str, "default return type must be str")
103
Martin v. Löwisd6625482003-10-12 17:37:01 +0000104 # check for equality of the absolute paths!
105 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700106 "file %r not in directory %r" % (name, dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000107 self.assertEqual(npre, pre,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700108 "file %r does not begin with %r" % (nbase, pre))
Guido van Rossum0e548712002-08-09 16:14:33 +0000109 self.assertEqual(nsuf, suf,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700110 "file %r does not end with %r" % (nbase, suf))
Guido van Rossum0e548712002-08-09 16:14:33 +0000111
112 nbase = nbase[len(pre):len(nbase)-len(suf)]
Gregory P. Smithad577b92015-05-22 16:18:14 -0700113 check = self.str_check if isinstance(nbase, str) else self.b_check
114 self.assertTrue(check.match(nbase),
115 "random characters %r do not match %r"
116 % (nbase, check.pattern))
Guido van Rossum0e548712002-08-09 16:14:33 +0000117
Guido van Rossum0e548712002-08-09 16:14:33 +0000118
Antoine Pitroueab2a502012-03-10 16:34:40 +0100119class TestExports(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000120 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000121 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +0000122 dict = tempfile.__dict__
123
124 expected = {
125 "NamedTemporaryFile" : 1,
126 "TemporaryFile" : 1,
127 "mkstemp" : 1,
128 "mkdtemp" : 1,
129 "mktemp" : 1,
130 "TMP_MAX" : 1,
131 "gettempprefix" : 1,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700132 "gettempprefixb" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000133 "gettempdir" : 1,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700134 "gettempdirb" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000135 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +0000136 "template" : 1,
Nick Coghlan543af752010-10-24 11:23:25 +0000137 "SpooledTemporaryFile" : 1,
138 "TemporaryDirectory" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000139 }
140
141 unexp = []
142 for key in dict:
143 if key[0] != '_' and key not in expected:
144 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000145 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +0000146 "unexpected keys: %s" % unexp)
147
Guido van Rossum0e548712002-08-09 16:14:33 +0000148
Antoine Pitroueab2a502012-03-10 16:34:40 +0100149class TestRandomNameSequence(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000150 """Test the internal iterator object _RandomNameSequence."""
151
152 def setUp(self):
153 self.r = tempfile._RandomNameSequence()
Brett Cannone1adece2010-03-20 22:19:55 +0000154 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000155
Inada Naokid2810052020-11-01 20:02:03 +0900156 def test_get_eight_char_str(self):
157 # _RandomNameSequence returns a eight-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000158 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000159 self.nameCheck(s, '', '', '')
160
161 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000162 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000163
164 dict = {}
165 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000166 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000167 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000168 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000169 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000170 dict[s] = 1
171
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000172 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000173 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000174
175 i = 0
176 r = self.r
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100177 for s in r:
178 i += 1
179 if i == 20:
180 break
Guido van Rossum0e548712002-08-09 16:14:33 +0000181
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100182 @unittest.skipUnless(hasattr(os, 'fork'),
183 "os.fork is required for this test")
184 def test_process_awareness(self):
185 # ensure that the random source differs between
186 # child and parent.
187 read_fd, write_fd = os.pipe()
188 pid = None
189 try:
190 pid = os.fork()
191 if not pid:
Victor Stinner6c8c2942017-08-10 13:05:06 +0200192 # child process
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100193 os.close(read_fd)
194 os.write(write_fd, next(self.r).encode("ascii"))
195 os.close(write_fd)
196 # bypass the normal exit handlers- leave those to
197 # the parent.
198 os._exit(0)
Victor Stinner6c8c2942017-08-10 13:05:06 +0200199
200 # parent process
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100201 parent_value = next(self.r)
202 child_value = os.read(read_fd, len(parent_value)).decode("ascii")
203 finally:
204 if pid:
Victor Stinner278c1e12020-03-31 20:08:12 +0200205 support.wait_process(pid, exitcode=0)
Victor Stinner6c8c2942017-08-10 13:05:06 +0200206
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100207 os.close(read_fd)
208 os.close(write_fd)
209 self.assertNotEqual(child_value, parent_value)
210
211
Guido van Rossum0e548712002-08-09 16:14:33 +0000212
Antoine Pitroueab2a502012-03-10 16:34:40 +0100213class TestCandidateTempdirList(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000214 """Test the internal function _candidate_tempdir_list."""
215
216 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000217 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000218
219 cand = tempfile._candidate_tempdir_list()
220
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000221 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000222 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000223 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000224
225 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000226 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000227
228 # Make sure the interesting environment variables are all set.
Hai Shi0c4f0f32020-06-30 21:46:31 +0800229 with os_helper.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000230 for envname in 'TMPDIR', 'TEMP', 'TMP':
231 dirname = os.getenv(envname)
232 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000233 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000234
235 cand = tempfile._candidate_tempdir_list()
236
237 for envname in 'TMPDIR', 'TEMP', 'TMP':
238 dirname = os.getenv(envname)
239 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000240 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000241
242 try:
243 dirname = os.getcwd()
Andrew Svetlovad28c7f2012-12-18 22:02:39 +0200244 except (AttributeError, OSError):
Guido van Rossum0e548712002-08-09 16:14:33 +0000245 dirname = os.curdir
246
Benjamin Peterson577473f2010-01-19 00:09:57 +0000247 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000248
249 # Not practical to try to verify the presence of OS-specific
250 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000251
Guido van Rossum0e548712002-08-09 16:14:33 +0000252
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200253# We test _get_default_tempdir some more by testing gettempdir.
Guido van Rossum0e548712002-08-09 16:14:33 +0000254
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200255class TestGetDefaultTempdir(BaseTestCase):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200256 """Test _get_default_tempdir()."""
257
258 def test_no_files_left_behind(self):
259 # use a private empty directory
260 with tempfile.TemporaryDirectory() as our_temp_directory:
261 # force _get_default_tempdir() to consider our empty directory
262 def our_candidate_list():
263 return [our_temp_directory]
264
265 with support.swap_attr(tempfile, "_candidate_tempdir_list",
266 our_candidate_list):
267 # verify our directory is empty after _get_default_tempdir()
268 tempfile._get_default_tempdir()
269 self.assertEqual(os.listdir(our_temp_directory), [])
270
271 def raise_OSError(*args, **kwargs):
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200272 raise OSError()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200273
274 with support.swap_attr(io, "open", raise_OSError):
275 # test again with failing io.open()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200276 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200277 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200278 self.assertEqual(os.listdir(our_temp_directory), [])
279
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200280 def bad_writer(*args, **kwargs):
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300281 fp = orig_open(*args, **kwargs)
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200282 fp.write = raise_OSError
283 return fp
284
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300285 with support.swap_attr(io, "open", bad_writer) as orig_open:
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200286 # test again with failing write()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200287 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200288 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200289 self.assertEqual(os.listdir(our_temp_directory), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000290
291
Antoine Pitroueab2a502012-03-10 16:34:40 +0100292class TestGetCandidateNames(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000293 """Test the internal function _get_candidate_names."""
294
295 def test_retval(self):
Victor Stinner1e62bf12017-04-19 22:59:51 +0200296 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000297 obj = tempfile._get_candidate_names()
Victor Stinner1e62bf12017-04-19 22:59:51 +0200298 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000299
300 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000301 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000302 a = tempfile._get_candidate_names()
303 b = tempfile._get_candidate_names()
304
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000305 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000306
Guido van Rossum0e548712002-08-09 16:14:33 +0000307
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700308@contextlib.contextmanager
309def _inside_empty_temp_dir():
310 dir = tempfile.mkdtemp()
311 try:
312 with support.swap_attr(tempfile, 'tempdir', dir):
313 yield
314 finally:
Hai Shi0c4f0f32020-06-30 21:46:31 +0800315 os_helper.rmtree(dir)
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700316
317
318def _mock_candidate_names(*names):
319 return support.swap_attr(tempfile,
320 '_get_candidate_names',
321 lambda: iter(names))
322
323
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300324class TestBadTempdir:
325
326 def test_read_only_directory(self):
327 with _inside_empty_temp_dir():
328 oldmode = mode = os.stat(tempfile.tempdir).st_mode
329 mode &= ~(stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH)
330 os.chmod(tempfile.tempdir, mode)
331 try:
332 if os.access(tempfile.tempdir, os.W_OK):
333 self.skipTest("can't set the directory read-only")
334 with self.assertRaises(PermissionError):
335 self.make_temp()
336 self.assertEqual(os.listdir(tempfile.tempdir), [])
337 finally:
338 os.chmod(tempfile.tempdir, oldmode)
339
340 def test_nonexisting_directory(self):
341 with _inside_empty_temp_dir():
342 tempdir = os.path.join(tempfile.tempdir, 'nonexistent')
343 with support.swap_attr(tempfile, 'tempdir', tempdir):
344 with self.assertRaises(FileNotFoundError):
345 self.make_temp()
346
347 def test_non_directory(self):
348 with _inside_empty_temp_dir():
349 tempdir = os.path.join(tempfile.tempdir, 'file')
350 open(tempdir, 'wb').close()
351 with support.swap_attr(tempfile, 'tempdir', tempdir):
352 with self.assertRaises((NotADirectoryError, FileNotFoundError)):
353 self.make_temp()
354
355
356class TestMkstempInner(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000357 """Test the internal function _mkstemp_inner."""
358
359 class mkstemped:
360 _bflags = tempfile._bin_openflags
361 _tflags = tempfile._text_openflags
362 _close = os.close
363 _unlink = os.unlink
364
365 def __init__(self, dir, pre, suf, bin):
366 if bin: flags = self._bflags
367 else: flags = self._tflags
368
Gregory P. Smithad577b92015-05-22 16:18:14 -0700369 output_type = tempfile._infer_return_type(dir, pre, suf)
370 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags, output_type)
Guido van Rossum0e548712002-08-09 16:14:33 +0000371
372 def write(self, str):
373 os.write(self.fd, str)
374
375 def __del__(self):
376 self._close(self.fd)
377 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000378
Gregory P. Smithad577b92015-05-22 16:18:14 -0700379 def do_create(self, dir=None, pre=None, suf=None, bin=1):
380 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000381 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700382 if output_type is str:
383 dir = tempfile.gettempdir()
384 else:
385 dir = tempfile.gettempdirb()
386 if pre is None:
387 pre = output_type()
388 if suf is None:
389 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100390 file = self.mkstemped(dir, pre, suf, bin)
Guido van Rossum0e548712002-08-09 16:14:33 +0000391
392 self.nameCheck(file.name, dir, pre, suf)
393 return file
394
395 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000396 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000397 self.do_create().write(b"blat")
398 self.do_create(pre="a").write(b"blat")
399 self.do_create(suf="b").write(b"blat")
400 self.do_create(pre="a", suf="b").write(b"blat")
401 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000402
Gregory P. Smithad577b92015-05-22 16:18:14 -0700403 def test_basic_with_bytes_names(self):
404 # _mkstemp_inner can create files when given name parts all
405 # specified as bytes.
406 dir_b = tempfile.gettempdirb()
407 self.do_create(dir=dir_b, suf=b"").write(b"blat")
408 self.do_create(dir=dir_b, pre=b"a").write(b"blat")
409 self.do_create(dir=dir_b, suf=b"b").write(b"blat")
410 self.do_create(dir=dir_b, pre=b"a", suf=b"b").write(b"blat")
411 self.do_create(dir=dir_b, pre=b"aa", suf=b".txt").write(b"blat")
412 # Can't mix str & binary types in the args.
413 with self.assertRaises(TypeError):
414 self.do_create(dir="", suf=b"").write(b"blat")
415 with self.assertRaises(TypeError):
416 self.do_create(dir=dir_b, pre="").write(b"blat")
417 with self.assertRaises(TypeError):
418 self.do_create(dir=dir_b, pre=b"", suf="").write(b"blat")
419
Guido van Rossum0e548712002-08-09 16:14:33 +0000420 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000421 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000422 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000423 for i in extant:
424 extant[i] = self.do_create(pre="aa")
425
426 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000427 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000428 dir = tempfile.mkdtemp()
429 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000430 self.do_create(dir=dir).write(b"blat")
Anthony Sottile370138b2019-09-09 08:54:34 -0700431 self.do_create(dir=pathlib.Path(dir)).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000432 finally:
433 os.rmdir(dir)
434
435 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000436 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000437
438 file = self.do_create()
439 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000440 expected = 0o600
Jesus Cea4791a242012-10-05 03:15:39 +0200441 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000442 # There's no distinction among 'user', 'group' and 'world';
443 # replicate the 'user' bits.
444 user = expected >> 6
445 expected = user * (1 + 8 + 64)
446 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000447
Zachary Ware9fe6d862013-12-08 00:20:35 -0600448 @unittest.skipUnless(has_spawnl, 'os.spawnl not available')
Guido van Rossum0e548712002-08-09 16:14:33 +0000449 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000450 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum0e548712002-08-09 16:14:33 +0000451
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000452 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000453 v="v"
454 else:
455 v="q"
456
Guido van Rossum0e548712002-08-09 16:14:33 +0000457 file = self.do_create()
Victor Stinnerdaf45552013-08-28 00:53:59 +0200458 self.assertEqual(os.get_inheritable(file.fd), False)
Guido van Rossum78741062002-08-17 11:41:01 +0000459 fd = "%d" % file.fd
460
461 try:
462 me = __file__
463 except NameError:
464 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000465
466 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000467 # effect. The core of this test is therefore in
468 # tf_inherit_check.py, which see.
469 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
470 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000471
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000472 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
473 # but an arg with embedded spaces should be decorated with double
474 # quotes on each end
Jesus Cea4791a242012-10-05 03:15:39 +0200475 if sys.platform == 'win32':
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000476 decorated = '"%s"' % sys.executable
477 tester = '"%s"' % tester
478 else:
479 decorated = sys.executable
480
481 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000482 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000483 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000484 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000485
Zachary Ware9fe6d862013-12-08 00:20:35 -0600486 @unittest.skipUnless(has_textmode, "text mode not available")
Guido van Rossum0e548712002-08-09 16:14:33 +0000487 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000488 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000489
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000490 # A text file is truncated at the first Ctrl+Z byte
491 f = self.do_create(bin=0)
492 f.write(b"blat\x1a")
493 f.write(b"extra\n")
494 os.lseek(f.fd, 0, os.SEEK_SET)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000495 self.assertEqual(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000496
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300497 def make_temp(self):
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700498 return tempfile._mkstemp_inner(tempfile.gettempdir(),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700499 tempfile.gettempprefix(),
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700500 '',
Gregory P. Smithad577b92015-05-22 16:18:14 -0700501 tempfile._bin_openflags,
502 str)
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700503
504 def test_collision_with_existing_file(self):
505 # _mkstemp_inner tries another name when a file with
506 # the chosen name already exists
507 with _inside_empty_temp_dir(), \
508 _mock_candidate_names('aaa', 'aaa', 'bbb'):
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300509 (fd1, name1) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700510 os.close(fd1)
511 self.assertTrue(name1.endswith('aaa'))
512
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300513 (fd2, name2) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700514 os.close(fd2)
515 self.assertTrue(name2.endswith('bbb'))
516
Eli Benderskyf315df32013-09-06 06:11:19 -0700517 def test_collision_with_existing_directory(self):
518 # _mkstemp_inner tries another name when a directory with
519 # the chosen name already exists
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700520 with _inside_empty_temp_dir(), \
521 _mock_candidate_names('aaa', 'aaa', 'bbb'):
522 dir = tempfile.mkdtemp()
523 self.assertTrue(dir.endswith('aaa'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700524
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300525 (fd, name) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700526 os.close(fd)
527 self.assertTrue(name.endswith('bbb'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700528
Guido van Rossum0e548712002-08-09 16:14:33 +0000529
Antoine Pitroueab2a502012-03-10 16:34:40 +0100530class TestGetTempPrefix(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000531 """Test gettempprefix()."""
532
533 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000534 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000535 p = tempfile.gettempprefix()
536
Ezio Melottie9615932010-01-24 19:26:24 +0000537 self.assertIsInstance(p, str)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700538 self.assertGreater(len(p), 0)
539
540 pb = tempfile.gettempprefixb()
541
542 self.assertIsInstance(pb, bytes)
543 self.assertGreater(len(pb), 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000544
545 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000546 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000547
548 # Create a temp directory, avoiding use of the prefix.
549 # Then attempt to create a file whose name is
550 # prefix + 'xxxxxx.xxx' in that directory.
551 p = tempfile.gettempprefix() + "xxxxxx.xxx"
552 d = tempfile.mkdtemp(prefix="")
553 try:
554 p = os.path.join(d, p)
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100555 fd = os.open(p, os.O_RDWR | os.O_CREAT)
Guido van Rossum0e548712002-08-09 16:14:33 +0000556 os.close(fd)
557 os.unlink(p)
558 finally:
559 os.rmdir(d)
560
Guido van Rossum0e548712002-08-09 16:14:33 +0000561
Antoine Pitroueab2a502012-03-10 16:34:40 +0100562class TestGetTempDir(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000563 """Test gettempdir()."""
564
565 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000566 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000567
Gregory P. Smithad577b92015-05-22 16:18:14 -0700568 for d in (tempfile.gettempdir(), tempfile.gettempdirb()):
569 self.assertTrue(os.path.isabs(d) or d == os.curdir,
570 "%r is not an absolute path" % d)
571 self.assertTrue(os.path.isdir(d),
572 "%r is not a directory" % d)
Guido van Rossum0e548712002-08-09 16:14:33 +0000573
574 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000575 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000576
577 # sneaky: just instantiate a NamedTemporaryFile, which
578 # defaults to writing into the directory returned by
579 # gettempdir.
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200580 with tempfile.NamedTemporaryFile() as file:
581 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000582
583 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000584 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000585 a = tempfile.gettempdir()
586 b = tempfile.gettempdir()
Gregory P. Smithad577b92015-05-22 16:18:14 -0700587 c = tempfile.gettempdirb()
Guido van Rossum0e548712002-08-09 16:14:33 +0000588
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000589 self.assertTrue(a is b)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700590 self.assertNotEqual(type(a), type(c))
591 self.assertEqual(a, os.fsdecode(c))
Guido van Rossum0e548712002-08-09 16:14:33 +0000592
Tim Golden6d09f092013-10-25 18:38:16 +0100593 def test_case_sensitive(self):
594 # gettempdir should not flatten its case
595 # even on a case-insensitive file system
596 case_sensitive_tempdir = tempfile.mkdtemp("-Temp")
597 _tempdir, tempfile.tempdir = tempfile.tempdir, None
598 try:
Hai Shi0c4f0f32020-06-30 21:46:31 +0800599 with os_helper.EnvironmentVarGuard() as env:
Tim Golden6d09f092013-10-25 18:38:16 +0100600 # Fake the first env var which is checked as a candidate
601 env["TMPDIR"] = case_sensitive_tempdir
602 self.assertEqual(tempfile.gettempdir(), case_sensitive_tempdir)
603 finally:
604 tempfile.tempdir = _tempdir
Hai Shi0c4f0f32020-06-30 21:46:31 +0800605 os_helper.rmdir(case_sensitive_tempdir)
Tim Golden6d09f092013-10-25 18:38:16 +0100606
Guido van Rossum0e548712002-08-09 16:14:33 +0000607
Antoine Pitroueab2a502012-03-10 16:34:40 +0100608class TestMkstemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000609 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000610
Gregory P. Smithad577b92015-05-22 16:18:14 -0700611 def do_create(self, dir=None, pre=None, suf=None):
612 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000613 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700614 if output_type is str:
615 dir = tempfile.gettempdir()
616 else:
617 dir = tempfile.gettempdirb()
618 if pre is None:
619 pre = output_type()
620 if suf is None:
621 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100622 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
623 (ndir, nbase) = os.path.split(name)
624 adir = os.path.abspath(dir)
625 self.assertEqual(adir, ndir,
626 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000627
628 try:
629 self.nameCheck(name, dir, pre, suf)
630 finally:
631 os.close(fd)
632 os.unlink(name)
633
634 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000635 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000636 self.do_create()
637 self.do_create(pre="a")
638 self.do_create(suf="b")
639 self.do_create(pre="a", suf="b")
640 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000641 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000642
Gregory P. Smithad577b92015-05-22 16:18:14 -0700643 def test_basic_with_bytes_names(self):
644 # mkstemp can create files when given name parts all
645 # specified as bytes.
646 d = tempfile.gettempdirb()
647 self.do_create(dir=d, suf=b"")
648 self.do_create(dir=d, pre=b"a")
649 self.do_create(dir=d, suf=b"b")
650 self.do_create(dir=d, pre=b"a", suf=b"b")
651 self.do_create(dir=d, pre=b"aa", suf=b".txt")
652 self.do_create(dir=b".")
653 with self.assertRaises(TypeError):
654 self.do_create(dir=".", pre=b"aa", suf=b".txt")
655 with self.assertRaises(TypeError):
656 self.do_create(dir=b".", pre="aa", suf=b".txt")
657 with self.assertRaises(TypeError):
658 self.do_create(dir=b".", pre=b"aa", suf=".txt")
659
660
Guido van Rossum0e548712002-08-09 16:14:33 +0000661 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000662 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000663 dir = tempfile.mkdtemp()
664 try:
665 self.do_create(dir=dir)
Anthony Sottile370138b2019-09-09 08:54:34 -0700666 self.do_create(dir=pathlib.Path(dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000667 finally:
668 os.rmdir(dir)
669
Guido van Rossum0e548712002-08-09 16:14:33 +0000670
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300671class TestMkdtemp(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000672 """Test mkdtemp()."""
673
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300674 def make_temp(self):
675 return tempfile.mkdtemp()
676
Gregory P. Smithad577b92015-05-22 16:18:14 -0700677 def do_create(self, dir=None, pre=None, suf=None):
678 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000679 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700680 if output_type is str:
681 dir = tempfile.gettempdir()
682 else:
683 dir = tempfile.gettempdirb()
684 if pre is None:
685 pre = output_type()
686 if suf is None:
687 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100688 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000689
690 try:
691 self.nameCheck(name, dir, pre, suf)
692 return name
693 except:
694 os.rmdir(name)
695 raise
696
697 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000698 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000699 os.rmdir(self.do_create())
700 os.rmdir(self.do_create(pre="a"))
701 os.rmdir(self.do_create(suf="b"))
702 os.rmdir(self.do_create(pre="a", suf="b"))
703 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000704
Gregory P. Smithad577b92015-05-22 16:18:14 -0700705 def test_basic_with_bytes_names(self):
706 # mkdtemp can create directories when given all binary parts
707 d = tempfile.gettempdirb()
708 os.rmdir(self.do_create(dir=d))
709 os.rmdir(self.do_create(dir=d, pre=b"a"))
710 os.rmdir(self.do_create(dir=d, suf=b"b"))
711 os.rmdir(self.do_create(dir=d, pre=b"a", suf=b"b"))
712 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=b".txt"))
713 with self.assertRaises(TypeError):
714 os.rmdir(self.do_create(dir=d, pre="aa", suf=b".txt"))
715 with self.assertRaises(TypeError):
716 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=".txt"))
717 with self.assertRaises(TypeError):
718 os.rmdir(self.do_create(dir="", pre=b"aa", suf=b".txt"))
719
Guido van Rossum0e548712002-08-09 16:14:33 +0000720 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000721 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000722 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000723 try:
724 for i in extant:
725 extant[i] = self.do_create(pre="aa")
726 finally:
727 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000728 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000729 os.rmdir(i)
730
731 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000732 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000733 dir = tempfile.mkdtemp()
734 try:
735 os.rmdir(self.do_create(dir=dir))
Anthony Sottile370138b2019-09-09 08:54:34 -0700736 os.rmdir(self.do_create(dir=pathlib.Path(dir)))
Guido van Rossum0e548712002-08-09 16:14:33 +0000737 finally:
738 os.rmdir(dir)
739
740 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000741 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000742
743 dir = self.do_create()
744 try:
745 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000746 mode &= 0o777 # Mask off sticky bits inherited from /tmp
747 expected = 0o700
Jesus Cea4791a242012-10-05 03:15:39 +0200748 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000749 # There's no distinction among 'user', 'group' and 'world';
750 # replicate the 'user' bits.
751 user = expected >> 6
752 expected = user * (1 + 8 + 64)
753 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000754 finally:
755 os.rmdir(dir)
756
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700757 def test_collision_with_existing_file(self):
758 # mkdtemp tries another name when a file with
759 # the chosen name already exists
760 with _inside_empty_temp_dir(), \
761 _mock_candidate_names('aaa', 'aaa', 'bbb'):
762 file = tempfile.NamedTemporaryFile(delete=False)
763 file.close()
764 self.assertTrue(file.name.endswith('aaa'))
765 dir = tempfile.mkdtemp()
766 self.assertTrue(dir.endswith('bbb'))
767
768 def test_collision_with_existing_directory(self):
769 # mkdtemp tries another name when a directory with
770 # the chosen name already exists
771 with _inside_empty_temp_dir(), \
772 _mock_candidate_names('aaa', 'aaa', 'bbb'):
773 dir1 = tempfile.mkdtemp()
774 self.assertTrue(dir1.endswith('aaa'))
775 dir2 = tempfile.mkdtemp()
776 self.assertTrue(dir2.endswith('bbb'))
777
Guido van Rossum0e548712002-08-09 16:14:33 +0000778
Antoine Pitroueab2a502012-03-10 16:34:40 +0100779class TestMktemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000780 """Test mktemp()."""
781
782 # For safety, all use of mktemp must occur in a private directory.
783 # We must also suppress the RuntimeWarning it generates.
784 def setUp(self):
785 self.dir = tempfile.mkdtemp()
Brett Cannone1adece2010-03-20 22:19:55 +0000786 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000787
788 def tearDown(self):
789 if self.dir:
790 os.rmdir(self.dir)
791 self.dir = None
Brett Cannone1adece2010-03-20 22:19:55 +0000792 super().tearDown()
Guido van Rossum0e548712002-08-09 16:14:33 +0000793
794 class mktemped:
795 _unlink = os.unlink
796 _bflags = tempfile._bin_openflags
797
798 def __init__(self, dir, pre, suf):
799 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
800 # Create the file. This will raise an exception if it's
801 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000802 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000803
804 def __del__(self):
805 self._unlink(self.name)
806
807 def do_create(self, pre="", suf=""):
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100808 file = self.mktemped(self.dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000809
810 self.nameCheck(file.name, self.dir, pre, suf)
811 return file
812
813 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000814 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000815 self.do_create()
816 self.do_create(pre="a")
817 self.do_create(suf="b")
818 self.do_create(pre="a", suf="b")
819 self.do_create(pre="aa", suf=".txt")
820
821 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000822 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000823 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000824 for i in extant:
825 extant[i] = self.do_create(pre="aa")
826
Fred Drake8bec4832002-11-22 20:13:43 +0000827## def test_warning(self):
828## # mktemp issues a warning when used
829## warnings.filterwarnings("error",
830## category=RuntimeWarning,
831## message="mktemp")
832## self.assertRaises(RuntimeWarning,
833## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000834
Guido van Rossum0e548712002-08-09 16:14:33 +0000835
836# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
837
838
Antoine Pitroueab2a502012-03-10 16:34:40 +0100839class TestNamedTemporaryFile(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000840 """Test NamedTemporaryFile()."""
841
Guido van Rossumd8faa362007-04-27 19:54:29 +0000842 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000843 if dir is None:
844 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100845 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
846 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000847
848 self.nameCheck(file.name, dir, pre, suf)
849 return file
850
851
852 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000853 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000854 self.do_create()
855 self.do_create(pre="a")
856 self.do_create(suf="b")
857 self.do_create(pre="a", suf="b")
858 self.do_create(pre="aa", suf=".txt")
859
Antoine Pitrou17c93262013-12-21 22:14:56 +0100860 def test_method_lookup(self):
861 # Issue #18879: Looking up a temporary file method should keep it
862 # alive long enough.
863 f = self.do_create()
864 wr = weakref.ref(f)
865 write = f.write
866 write2 = f.write
867 del f
868 write(b'foo')
869 del write
870 write2(b'bar')
871 del write2
872 if support.check_impl_detail(cpython=True):
873 # No reference cycle was created.
874 self.assertIsNone(wr())
875
Serhiy Storchaka56cefa62015-03-19 15:23:15 +0200876 def test_iter(self):
877 # Issue #23700: getting iterator from a temporary file should keep
878 # it alive as long as it's being iterated over
879 lines = [b'spam\n', b'eggs\n', b'beans\n']
880 def make_file():
881 f = tempfile.NamedTemporaryFile(mode='w+b')
882 f.write(b''.join(lines))
883 f.seek(0)
884 return f
885 for i, l in enumerate(make_file()):
886 self.assertEqual(l, lines[i])
887 self.assertEqual(i, len(lines) - 1)
888
Guido van Rossum0e548712002-08-09 16:14:33 +0000889 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000890 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000891 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000892 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000893 "NamedTemporaryFile %s does not exist" % f.name)
894
895 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000896 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000897 dir = tempfile.mkdtemp()
898 try:
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200899 with tempfile.NamedTemporaryFile(dir=dir) as f:
900 f.write(b'blat')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000901 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000902 "NamedTemporaryFile %s exists after close" % f.name)
903 finally:
904 os.rmdir(dir)
905
Guido van Rossumd8faa362007-04-27 19:54:29 +0000906 def test_dis_del_on_close(self):
907 # Tests that delete-on-close can be disabled
908 dir = tempfile.mkdtemp()
909 tmp = None
910 try:
911 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
912 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000913 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000914 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000915 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000916 "NamedTemporaryFile %s missing after close" % f.name)
917 finally:
918 if tmp is not None:
919 os.unlink(tmp)
920 os.rmdir(dir)
921
Guido van Rossum0e548712002-08-09 16:14:33 +0000922 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000923 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000924 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000925 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000926 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100927 f.close()
928 f.close()
Guido van Rossum0e548712002-08-09 16:14:33 +0000929
Christian Heimes3ecfea712008-02-09 20:51:34 +0000930 def test_context_manager(self):
931 # A NamedTemporaryFile can be used as a context manager
932 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000933 self.assertTrue(os.path.exists(f.name))
934 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000935 def use_closed():
936 with f:
937 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000938 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000939
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100940 def test_no_leak_fd(self):
Victor Stinner87d13ea2014-03-25 18:19:17 +0100941 # Issue #21058: don't leak file descriptor when io.open() fails
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100942 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +0200943 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100944 def close(fd):
945 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +0200946 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100947
948 with mock.patch('os.close', side_effect=close):
949 with mock.patch('io.open', side_effect=ValueError):
950 self.assertRaises(ValueError, tempfile.NamedTemporaryFile)
951 self.assertEqual(len(closed), 1)
952
Martin Panter7869a222016-02-28 05:22:20 +0000953 def test_bad_mode(self):
954 dir = tempfile.mkdtemp()
Hai Shi0c4f0f32020-06-30 21:46:31 +0800955 self.addCleanup(os_helper.rmtree, dir)
Martin Panter7869a222016-02-28 05:22:20 +0000956 with self.assertRaises(ValueError):
957 tempfile.NamedTemporaryFile(mode='wr', dir=dir)
958 with self.assertRaises(TypeError):
959 tempfile.NamedTemporaryFile(mode=2, dir=dir)
960 self.assertEqual(os.listdir(dir), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000961
Martin Panter7869a222016-02-28 05:22:20 +0000962 # How to test the mode and bufsize parameters?
Guido van Rossum0e548712002-08-09 16:14:33 +0000963
Antoine Pitroueab2a502012-03-10 16:34:40 +0100964class TestSpooledTemporaryFile(BaseTestCase):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000965 """Test SpooledTemporaryFile()."""
966
967 def do_create(self, max_size=0, dir=None, pre="", suf=""):
968 if dir is None:
969 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100970 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000971
972 return file
973
974
975 def test_basic(self):
976 # SpooledTemporaryFile can create files
977 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000978 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000979 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000980 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000981
982 def test_del_on_close(self):
983 # A SpooledTemporaryFile is deleted when closed
984 dir = tempfile.mkdtemp()
985 try:
986 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000987 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000988 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000989 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000990 filename = f.name
991 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000992 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000993 "SpooledTemporaryFile %s exists after close" % filename)
994 finally:
995 os.rmdir(dir)
996
997 def test_rewrite_small(self):
998 # A SpooledTemporaryFile can be written to multiple within the max_size
999 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001000 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001001 for i in range(5):
1002 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +00001003 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001004 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001005
1006 def test_write_sequential(self):
1007 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1008 # over afterward
1009 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001010 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001011 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001012 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001013 f.write(b'x' * 10)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001014 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001015 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001016 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001017
R David Murrayd89ee792011-03-14 09:55:46 -04001018 def test_writelines(self):
1019 # Verify writelines with a SpooledTemporaryFile
1020 f = self.do_create()
1021 f.writelines((b'x', b'y', b'z'))
Inada Naoki485e7152020-04-17 15:56:35 +09001022 pos = f.seek(0)
1023 self.assertEqual(pos, 0)
R David Murrayd89ee792011-03-14 09:55:46 -04001024 buf = f.read()
1025 self.assertEqual(buf, b'xyz')
1026
1027 def test_writelines_sequential(self):
1028 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1029 # over afterward
1030 f = self.do_create(max_size=35)
1031 f.writelines((b'x' * 20, b'x' * 10, b'x' * 5))
1032 self.assertFalse(f._rolled)
1033 f.write(b'x')
1034 self.assertTrue(f._rolled)
1035
Guido van Rossumd8faa362007-04-27 19:54:29 +00001036 def test_sparse(self):
1037 # A SpooledTemporaryFile that is written late in the file will extend
1038 # when that occurs
1039 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001040 self.assertFalse(f._rolled)
Inada Naoki485e7152020-04-17 15:56:35 +09001041 pos = f.seek(100, 0)
1042 self.assertEqual(pos, 100)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001043 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001044 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001045 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001046
1047 def test_fileno(self):
1048 # A SpooledTemporaryFile should roll over to a real file on fileno()
1049 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001050 self.assertFalse(f._rolled)
1051 self.assertTrue(f.fileno() > 0)
1052 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001053
Christian Heimes3ecfea712008-02-09 20:51:34 +00001054 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001055 # A SpooledTemporaryFile can be closed many times without error
1056 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +00001057 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001058 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001059 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001060 f.close()
1061 f.close()
Christian Heimes3ecfea712008-02-09 20:51:34 +00001062
1063 def test_multiple_close_after_rollover(self):
1064 # A SpooledTemporaryFile can be closed many times without error
1065 f = tempfile.SpooledTemporaryFile(max_size=1)
1066 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001067 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001068 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001069 f.close()
1070 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001071
1072 def test_bound_methods(self):
1073 # It should be OK to steal a bound method from a SpooledTemporaryFile
1074 # and use it independently; when the file rolls over, those bound
1075 # methods should continue to function
1076 f = self.do_create(max_size=30)
1077 read = f.read
1078 write = f.write
1079 seek = f.seek
1080
Guido van Rossum39478e82007-08-27 17:23:59 +00001081 write(b"a" * 35)
1082 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001083 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +00001084 self.assertEqual(read(70), b'a'*35 + b'b'*35)
1085
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001086 def test_properties(self):
1087 f = tempfile.SpooledTemporaryFile(max_size=10)
1088 f.write(b'x' * 10)
1089 self.assertFalse(f._rolled)
1090 self.assertEqual(f.mode, 'w+b')
1091 self.assertIsNone(f.name)
1092 with self.assertRaises(AttributeError):
1093 f.newlines
1094 with self.assertRaises(AttributeError):
1095 f.encoding
sth825aab92018-05-23 07:07:01 +02001096 with self.assertRaises(AttributeError):
1097 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001098
1099 f.write(b'x')
1100 self.assertTrue(f._rolled)
1101 self.assertEqual(f.mode, 'rb+')
1102 self.assertIsNotNone(f.name)
1103 with self.assertRaises(AttributeError):
1104 f.newlines
1105 with self.assertRaises(AttributeError):
1106 f.encoding
sth825aab92018-05-23 07:07:01 +02001107 with self.assertRaises(AttributeError):
1108 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001109
Guido van Rossum9a634702007-07-09 10:24:45 +00001110 def test_text_mode(self):
1111 # Creating a SpooledTemporaryFile with a text mode should produce
1112 # a file object reading and writing (Unicode) text strings.
Inada Naokiea9835c2019-11-27 22:22:06 +09001113 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
1114 encoding="utf-8")
Guido van Rossum9a634702007-07-09 10:24:45 +00001115 f.write("abc\n")
1116 f.seek(0)
1117 self.assertEqual(f.read(), "abc\n")
1118 f.write("def\n")
1119 f.seek(0)
1120 self.assertEqual(f.read(), "abc\ndef\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001121 self.assertFalse(f._rolled)
1122 self.assertEqual(f.mode, 'w+')
1123 self.assertIsNone(f.name)
Inada Naokiea9835c2019-11-27 22:22:06 +09001124 self.assertEqual(f.newlines, os.linesep)
1125 self.assertEqual(f.encoding, "utf-8")
1126 self.assertEqual(f.errors, "strict")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001127
Guido van Rossum9a634702007-07-09 10:24:45 +00001128 f.write("xyzzy\n")
1129 f.seek(0)
1130 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +00001131 # Check that Ctrl+Z doesn't truncate the file
1132 f.write("foo\x1abar\n")
1133 f.seek(0)
1134 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001135 self.assertTrue(f._rolled)
1136 self.assertEqual(f.mode, 'w+')
1137 self.assertIsNotNone(f.name)
Serhiy Storchaka497cee42013-02-10 14:43:46 +02001138 self.assertEqual(f.newlines, os.linesep)
Inada Naokiea9835c2019-11-27 22:22:06 +09001139 self.assertEqual(f.encoding, "utf-8")
1140 self.assertEqual(f.errors, "strict")
Guido van Rossum9a634702007-07-09 10:24:45 +00001141
Guido van Rossumf0c74162007-08-28 03:29:45 +00001142 def test_text_newline_and_encoding(self):
1143 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
sth825aab92018-05-23 07:07:01 +02001144 newline='', encoding='utf-8',
1145 errors='ignore')
Guido van Rossumf0c74162007-08-28 03:29:45 +00001146 f.write("\u039B\r\n")
1147 f.seek(0)
1148 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001149 self.assertFalse(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001150 self.assertEqual(f.mode, 'w+')
1151 self.assertIsNone(f.name)
Inada Naokiea9835c2019-11-27 22:22:06 +09001152 self.assertIsNotNone(f.newlines)
1153 self.assertEqual(f.encoding, "utf-8")
1154 self.assertEqual(f.errors, "ignore")
Guido van Rossumf0c74162007-08-28 03:29:45 +00001155
Inada Naokiea9835c2019-11-27 22:22:06 +09001156 f.write("\u039C" * 10 + "\r\n")
1157 f.write("\u039D" * 20)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001158 f.seek(0)
Inada Naokiea9835c2019-11-27 22:22:06 +09001159 self.assertEqual(f.read(),
1160 "\u039B\r\n" + ("\u039C" * 10) + "\r\n" + ("\u039D" * 20))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001161 self.assertTrue(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001162 self.assertEqual(f.mode, 'w+')
1163 self.assertIsNotNone(f.name)
1164 self.assertIsNotNone(f.newlines)
1165 self.assertEqual(f.encoding, 'utf-8')
sth825aab92018-05-23 07:07:01 +02001166 self.assertEqual(f.errors, 'ignore')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001167
Christian Heimes3ecfea712008-02-09 20:51:34 +00001168 def test_context_manager_before_rollover(self):
1169 # A SpooledTemporaryFile can be used as a context manager
1170 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001171 self.assertFalse(f._rolled)
1172 self.assertFalse(f.closed)
1173 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001174 def use_closed():
1175 with f:
1176 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001177 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001178
1179 def test_context_manager_during_rollover(self):
1180 # A SpooledTemporaryFile can be used as a context manager
1181 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001182 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001183 f.write(b'abc\n')
1184 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001185 self.assertTrue(f._rolled)
1186 self.assertFalse(f.closed)
1187 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001188 def use_closed():
1189 with f:
1190 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001191 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001192
1193 def test_context_manager_after_rollover(self):
1194 # A SpooledTemporaryFile can be used as a context manager
1195 f = tempfile.SpooledTemporaryFile(max_size=1)
1196 f.write(b'abc\n')
1197 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001198 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001199 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001200 self.assertFalse(f.closed)
1201 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001202 def use_closed():
1203 with f:
1204 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001205 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001206
Antoine Pitrou0e86a582011-11-25 18:03:09 +01001207 def test_truncate_with_size_parameter(self):
1208 # A SpooledTemporaryFile can be truncated to zero size
1209 f = tempfile.SpooledTemporaryFile(max_size=10)
1210 f.write(b'abcdefg\n')
1211 f.seek(0)
1212 f.truncate()
1213 self.assertFalse(f._rolled)
1214 self.assertEqual(f._file.getvalue(), b'')
1215 # A SpooledTemporaryFile can be truncated to a specific size
1216 f = tempfile.SpooledTemporaryFile(max_size=10)
1217 f.write(b'abcdefg\n')
1218 f.truncate(4)
1219 self.assertFalse(f._rolled)
1220 self.assertEqual(f._file.getvalue(), b'abcd')
1221 # A SpooledTemporaryFile rolls over if truncated to large size
1222 f = tempfile.SpooledTemporaryFile(max_size=10)
1223 f.write(b'abcdefg\n')
1224 f.truncate(20)
1225 self.assertTrue(f._rolled)
Anthony Sottile8377cd42019-02-25 14:32:27 -08001226 self.assertEqual(os.fstat(f.fileno()).st_size, 20)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001227
Batuhan TaĹźkaya09c482f2019-12-30 19:08:08 +03001228 def test_class_getitem(self):
Guido van Rossum48b069a2020-04-07 09:50:06 -07001229 self.assertIsInstance(tempfile.SpooledTemporaryFile[bytes],
1230 types.GenericAlias)
Guido van Rossum0e548712002-08-09 16:14:33 +00001231
Guido van Rossum8ccd9b62002-08-22 20:02:03 +00001232if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Antoine Pitroueab2a502012-03-10 16:34:40 +01001233
1234 class TestTemporaryFile(BaseTestCase):
1235 """Test TemporaryFile()."""
1236
1237 def test_basic(self):
1238 # TemporaryFile can create files
1239 # No point in testing the name params - the file has no name.
1240 tempfile.TemporaryFile()
1241
1242 def test_has_no_name(self):
1243 # TemporaryFile creates files with no names (on this system)
1244 dir = tempfile.mkdtemp()
1245 f = tempfile.TemporaryFile(dir=dir)
1246 f.write(b'blat')
1247
1248 # Sneaky: because this file has no name, it should not prevent
1249 # us from removing the directory it was created in.
1250 try:
1251 os.rmdir(dir)
1252 except:
1253 # cleanup
1254 f.close()
1255 os.rmdir(dir)
1256 raise
1257
1258 def test_multiple_close(self):
1259 # A TemporaryFile can be closed many times without error
1260 f = tempfile.TemporaryFile()
1261 f.write(b'abc\n')
1262 f.close()
1263 f.close()
1264 f.close()
1265
1266 # How to test the mode and bufsize parameters?
1267 def test_mode_and_encoding(self):
1268
1269 def roundtrip(input, *args, **kwargs):
1270 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
1271 fileobj.write(input)
1272 fileobj.seek(0)
1273 self.assertEqual(input, fileobj.read())
1274
1275 roundtrip(b"1234", "w+b")
1276 roundtrip("abdc\n", "w+")
1277 roundtrip("\u039B", "w+", encoding="utf-16")
1278 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +00001279
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001280 def test_no_leak_fd(self):
1281 # Issue #21058: don't leak file descriptor when io.open() fails
1282 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +02001283 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001284 def close(fd):
1285 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +02001286 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001287
1288 with mock.patch('os.close', side_effect=close):
1289 with mock.patch('io.open', side_effect=ValueError):
1290 self.assertRaises(ValueError, tempfile.TemporaryFile)
1291 self.assertEqual(len(closed), 1)
1292
1293
Nick Coghlan543af752010-10-24 11:23:25 +00001294
1295# Helper for test_del_on_shutdown
1296class NulledModules:
1297 def __init__(self, *modules):
1298 self.refs = [mod.__dict__ for mod in modules]
1299 self.contents = [ref.copy() for ref in self.refs]
1300
1301 def __enter__(self):
1302 for d in self.refs:
1303 for key in d:
1304 d[key] = None
1305
1306 def __exit__(self, *exc_info):
1307 for d, c in zip(self.refs, self.contents):
1308 d.clear()
1309 d.update(c)
1310
Antoine Pitroueab2a502012-03-10 16:34:40 +01001311class TestTemporaryDirectory(BaseTestCase):
Nick Coghlan543af752010-10-24 11:23:25 +00001312 """Test TemporaryDirectory()."""
1313
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001314 def do_create(self, dir=None, pre="", suf="", recurse=1, dirs=1, files=1):
Nick Coghlan543af752010-10-24 11:23:25 +00001315 if dir is None:
1316 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001317 tmp = tempfile.TemporaryDirectory(dir=dir, prefix=pre, suffix=suf)
Nick Coghlan543af752010-10-24 11:23:25 +00001318 self.nameCheck(tmp.name, dir, pre, suf)
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001319 self.do_create2(tmp.name, recurse, dirs, files)
Nick Coghlan543af752010-10-24 11:23:25 +00001320 return tmp
1321
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001322 def do_create2(self, path, recurse=1, dirs=1, files=1):
1323 # Create subdirectories and some files
1324 if recurse:
1325 for i in range(dirs):
1326 name = os.path.join(path, "dir%d" % i)
1327 os.mkdir(name)
1328 self.do_create2(name, recurse-1, dirs, files)
1329 for i in range(files):
1330 with open(os.path.join(path, "test%d.txt" % i), "wb") as f:
1331 f.write(b"Hello world!")
1332
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001333 def test_mkdtemp_failure(self):
1334 # Check no additional exception if mkdtemp fails
1335 # Previously would raise AttributeError instead
Nick Coghlan3c54ea62010-12-13 03:02:43 +00001336 # (noted as part of Issue #10188)
1337 with tempfile.TemporaryDirectory() as nonexistent:
1338 pass
Serhiy Storchaka7451a722013-02-09 22:25:49 +02001339 with self.assertRaises(FileNotFoundError) as cm:
Nick Coghlan3c54ea62010-12-13 03:02:43 +00001340 tempfile.TemporaryDirectory(dir=nonexistent)
Serhiy Storchaka7451a722013-02-09 22:25:49 +02001341 self.assertEqual(cm.exception.errno, errno.ENOENT)
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001342
Nick Coghlan543af752010-10-24 11:23:25 +00001343 def test_explicit_cleanup(self):
1344 # A TemporaryDirectory is deleted when cleaned up
1345 dir = tempfile.mkdtemp()
1346 try:
1347 d = self.do_create(dir=dir)
1348 self.assertTrue(os.path.exists(d.name),
1349 "TemporaryDirectory %s does not exist" % d.name)
1350 d.cleanup()
1351 self.assertFalse(os.path.exists(d.name),
1352 "TemporaryDirectory %s exists after cleanup" % d.name)
1353 finally:
1354 os.rmdir(dir)
1355
Hai Shi0c4f0f32020-06-30 21:46:31 +08001356 @os_helper.skip_unless_symlink
Charles-François Natalidef35432011-07-29 18:59:24 +02001357 def test_cleanup_with_symlink_to_a_directory(self):
1358 # cleanup() should not follow symlinks to directories (issue #12464)
1359 d1 = self.do_create()
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001360 d2 = self.do_create(recurse=0)
Charles-François Natalidef35432011-07-29 18:59:24 +02001361
1362 # Symlink d1/foo -> d2
1363 os.symlink(d2.name, os.path.join(d1.name, "foo"))
1364
1365 # This call to cleanup() should not follow the "foo" symlink
1366 d1.cleanup()
1367
1368 self.assertFalse(os.path.exists(d1.name),
1369 "TemporaryDirectory %s exists after cleanup" % d1.name)
1370 self.assertTrue(os.path.exists(d2.name),
1371 "Directory pointed to by a symlink was deleted")
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001372 self.assertEqual(os.listdir(d2.name), ['test0.txt'],
Charles-François Natalidef35432011-07-29 18:59:24 +02001373 "Contents of the directory pointed to by a symlink "
1374 "were deleted")
1375 d2.cleanup()
1376
Nick Coghlan543af752010-10-24 11:23:25 +00001377 @support.cpython_only
1378 def test_del_on_collection(self):
1379 # A TemporaryDirectory is deleted when garbage collected
1380 dir = tempfile.mkdtemp()
1381 try:
1382 d = self.do_create(dir=dir)
1383 name = d.name
1384 del d # Rely on refcounting to invoke __del__
1385 self.assertFalse(os.path.exists(name),
1386 "TemporaryDirectory %s exists after __del__" % name)
1387 finally:
1388 os.rmdir(dir)
1389
Nick Coghlan543af752010-10-24 11:23:25 +00001390 def test_del_on_shutdown(self):
1391 # A TemporaryDirectory may be cleaned up during shutdown
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001392 with self.do_create() as dir:
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001393 for mod in ('builtins', 'os', 'shutil', 'sys', 'tempfile', 'warnings'):
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001394 code = """if True:
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001395 import builtins
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001396 import os
1397 import shutil
1398 import sys
1399 import tempfile
1400 import warnings
1401
1402 tmp = tempfile.TemporaryDirectory(dir={dir!r})
1403 sys.stdout.buffer.write(tmp.name.encode())
1404
1405 tmp2 = os.path.join(tmp.name, 'test_dir')
1406 os.mkdir(tmp2)
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001407 with open(os.path.join(tmp2, "test0.txt"), "w") as f:
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001408 f.write("Hello world!")
1409
1410 {mod}.tmp = tmp
1411
1412 warnings.filterwarnings("always", category=ResourceWarning)
1413 """.format(dir=dir, mod=mod)
1414 rc, out, err = script_helper.assert_python_ok("-c", code)
1415 tmp_name = out.decode().strip()
1416 self.assertFalse(os.path.exists(tmp_name),
1417 "TemporaryDirectory %s exists after cleanup" % tmp_name)
1418 err = err.decode('utf-8', 'backslashreplace')
1419 self.assertNotIn("Exception ", err)
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001420 self.assertIn("ResourceWarning: Implicitly cleaning up", err)
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001421
Serhiy Storchaka5e193ac2014-09-24 13:26:25 +03001422 def test_exit_on_shutdown(self):
1423 # Issue #22427
1424 with self.do_create() as dir:
1425 code = """if True:
1426 import sys
1427 import tempfile
1428 import warnings
1429
1430 def generator():
1431 with tempfile.TemporaryDirectory(dir={dir!r}) as tmp:
1432 yield tmp
1433 g = generator()
1434 sys.stdout.buffer.write(next(g).encode())
1435
1436 warnings.filterwarnings("always", category=ResourceWarning)
1437 """.format(dir=dir)
1438 rc, out, err = script_helper.assert_python_ok("-c", code)
1439 tmp_name = out.decode().strip()
1440 self.assertFalse(os.path.exists(tmp_name),
1441 "TemporaryDirectory %s exists after cleanup" % tmp_name)
1442 err = err.decode('utf-8', 'backslashreplace')
1443 self.assertNotIn("Exception ", err)
1444 self.assertIn("ResourceWarning: Implicitly cleaning up", err)
1445
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001446 def test_warnings_on_cleanup(self):
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001447 # ResourceWarning will be triggered by __del__
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001448 with self.do_create() as dir:
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001449 d = self.do_create(dir=dir, recurse=3)
1450 name = d.name
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001451
1452 # Check for the resource warning
Hai Shi0c4f0f32020-06-30 21:46:31 +08001453 with warnings_helper.check_warnings(('Implicitly',
1454 ResourceWarning),
1455 quiet=False):
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001456 warnings.filterwarnings("always", category=ResourceWarning)
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001457 del d
1458 support.gc_collect()
1459 self.assertFalse(os.path.exists(name),
1460 "TemporaryDirectory %s exists after __del__" % name)
Nick Coghlan543af752010-10-24 11:23:25 +00001461
1462 def test_multiple_close(self):
1463 # Can be cleaned-up many times without error
1464 d = self.do_create()
1465 d.cleanup()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001466 d.cleanup()
1467 d.cleanup()
Nick Coghlan543af752010-10-24 11:23:25 +00001468
1469 def test_context_manager(self):
1470 # Can be used as a context manager
1471 d = self.do_create()
1472 with d as name:
1473 self.assertTrue(os.path.exists(name))
1474 self.assertEqual(name, d.name)
1475 self.assertFalse(os.path.exists(name))
1476
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001477 def test_modes(self):
1478 for mode in range(8):
1479 mode <<= 6
1480 with self.subTest(mode=format(mode, '03o')):
1481 d = self.do_create(recurse=3, dirs=2, files=2)
1482 with d:
1483 # Change files and directories mode recursively.
1484 for root, dirs, files in os.walk(d.name, topdown=False):
1485 for name in files:
1486 os.chmod(os.path.join(root, name), mode)
1487 os.chmod(root, mode)
1488 d.cleanup()
1489 self.assertFalse(os.path.exists(d.name))
1490
1491 @unittest.skipUnless(hasattr(os, 'chflags'), 'requires os.lchflags')
1492 def test_flags(self):
1493 flags = stat.UF_IMMUTABLE | stat.UF_NOUNLINK
1494 d = self.do_create(recurse=3, dirs=2, files=2)
1495 with d:
1496 # Change files and directories flags recursively.
1497 for root, dirs, files in os.walk(d.name, topdown=False):
1498 for name in files:
1499 os.chflags(os.path.join(root, name), flags)
1500 os.chflags(root, flags)
1501 d.cleanup()
1502 self.assertFalse(os.path.exists(d.name))
1503
Nick Coghlan543af752010-10-24 11:23:25 +00001504
Guido van Rossum0e548712002-08-09 16:14:33 +00001505if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -05001506 unittest.main()