blob: f995f6c9bfaf0062a5b8187a603a20277cf0dd5f [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
Miss Islington (bot)eadf6b82019-09-09 10:31:31 -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
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
18from test.support import script_helper
Guido van Rossum0e548712002-08-09 16:14:33 +000019
Fred Drake7633d232002-10-17 22:09:03 +000020
Guido van Rossum0e548712002-08-09 16:14:33 +000021has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000022has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000023
Neal Norwitz68ee0122002-08-16 19:28:59 +000024# TEST_FILES may need to be tweaked for systems depending on the maximum
25# number of files that can be opened at one time (see ulimit -n)
Victor Stinner9c3de4a2011-08-17 20:49:41 +020026if sys.platform.startswith('openbsd'):
Martin v. Löwis99968282004-09-15 06:02:54 +000027 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000028else:
29 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000030
Guido van Rossum0e548712002-08-09 16:14:33 +000031# This is organized as one test for each chunk of code in tempfile.py,
32# in order of their appearance in the file. Testing which requires
33# threads is not done here.
34
Gregory P. Smithad577b92015-05-22 16:18:14 -070035class TestLowLevelInternals(unittest.TestCase):
36 def test_infer_return_type_singles(self):
37 self.assertIs(str, tempfile._infer_return_type(''))
38 self.assertIs(bytes, tempfile._infer_return_type(b''))
39 self.assertIs(str, tempfile._infer_return_type(None))
40
41 def test_infer_return_type_multiples(self):
42 self.assertIs(str, tempfile._infer_return_type('', ''))
43 self.assertIs(bytes, tempfile._infer_return_type(b'', b''))
44 with self.assertRaises(TypeError):
45 tempfile._infer_return_type('', b'')
46 with self.assertRaises(TypeError):
47 tempfile._infer_return_type(b'', '')
48
49 def test_infer_return_type_multiples_and_none(self):
50 self.assertIs(str, tempfile._infer_return_type(None, ''))
51 self.assertIs(str, tempfile._infer_return_type('', None))
52 self.assertIs(str, tempfile._infer_return_type(None, None))
53 self.assertIs(bytes, tempfile._infer_return_type(b'', None))
54 self.assertIs(bytes, tempfile._infer_return_type(None, b''))
55 with self.assertRaises(TypeError):
56 tempfile._infer_return_type('', None, b'')
57 with self.assertRaises(TypeError):
58 tempfile._infer_return_type(b'', None, '')
59
Miss Islington (bot)eadf6b82019-09-09 10:31:31 -070060 def test_infer_return_type_pathlib(self):
61 self.assertIs(str, tempfile._infer_return_type(pathlib.Path('/')))
62
Gregory P. Smithad577b92015-05-22 16:18:14 -070063
Guido van Rossum0e548712002-08-09 16:14:33 +000064# Common functionality.
Gregory P. Smithad577b92015-05-22 16:18:14 -070065
Antoine Pitroueab2a502012-03-10 16:34:40 +010066class BaseTestCase(unittest.TestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +000067
Victor Stinner97869102013-08-14 01:28:28 +020068 str_check = re.compile(r"^[a-z0-9_-]{8}$")
Gregory P. Smithad577b92015-05-22 16:18:14 -070069 b_check = re.compile(br"^[a-z0-9_-]{8}$")
Guido van Rossum0e548712002-08-09 16:14:33 +000070
Brett Cannone1adece2010-03-20 22:19:55 +000071 def setUp(self):
72 self._warnings_manager = support.check_warnings()
73 self._warnings_manager.__enter__()
74 warnings.filterwarnings("ignore", category=RuntimeWarning,
75 message="mktemp", module=__name__)
76
77 def tearDown(self):
78 self._warnings_manager.__exit__(None, None, None)
79
Guido van Rossum0e548712002-08-09 16:14:33 +000080 def nameCheck(self, name, dir, pre, suf):
81 (ndir, nbase) = os.path.split(name)
82 npre = nbase[:len(pre)]
83 nsuf = nbase[len(nbase)-len(suf):]
84
Gregory P. Smithad577b92015-05-22 16:18:14 -070085 if dir is not None:
Miss Islington (bot)eadf6b82019-09-09 10:31:31 -070086 self.assertIs(
87 type(name),
88 str
89 if type(dir) is str or isinstance(dir, os.PathLike) else
90 bytes,
91 "unexpected return type",
92 )
Gregory P. Smithad577b92015-05-22 16:18:14 -070093 if pre is not None:
94 self.assertIs(type(name), str if type(pre) is str else bytes,
95 "unexpected return type")
96 if suf is not None:
97 self.assertIs(type(name), str if type(suf) is str else bytes,
98 "unexpected return type")
99 if (dir, pre, suf) == (None, None, None):
100 self.assertIs(type(name), str, "default return type must be str")
101
Martin v. Löwisd6625482003-10-12 17:37:01 +0000102 # check for equality of the absolute paths!
103 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700104 "file %r not in directory %r" % (name, dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000105 self.assertEqual(npre, pre,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700106 "file %r does not begin with %r" % (nbase, pre))
Guido van Rossum0e548712002-08-09 16:14:33 +0000107 self.assertEqual(nsuf, suf,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700108 "file %r does not end with %r" % (nbase, suf))
Guido van Rossum0e548712002-08-09 16:14:33 +0000109
110 nbase = nbase[len(pre):len(nbase)-len(suf)]
Gregory P. Smithad577b92015-05-22 16:18:14 -0700111 check = self.str_check if isinstance(nbase, str) else self.b_check
112 self.assertTrue(check.match(nbase),
113 "random characters %r do not match %r"
114 % (nbase, check.pattern))
Guido van Rossum0e548712002-08-09 16:14:33 +0000115
Guido van Rossum0e548712002-08-09 16:14:33 +0000116
Antoine Pitroueab2a502012-03-10 16:34:40 +0100117class TestExports(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000118 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000119 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +0000120 dict = tempfile.__dict__
121
122 expected = {
123 "NamedTemporaryFile" : 1,
124 "TemporaryFile" : 1,
125 "mkstemp" : 1,
126 "mkdtemp" : 1,
127 "mktemp" : 1,
128 "TMP_MAX" : 1,
129 "gettempprefix" : 1,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700130 "gettempprefixb" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000131 "gettempdir" : 1,
Gregory P. Smithad577b92015-05-22 16:18:14 -0700132 "gettempdirb" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000133 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +0000134 "template" : 1,
Nick Coghlan543af752010-10-24 11:23:25 +0000135 "SpooledTemporaryFile" : 1,
136 "TemporaryDirectory" : 1,
Guido van Rossum0e548712002-08-09 16:14:33 +0000137 }
138
139 unexp = []
140 for key in dict:
141 if key[0] != '_' and key not in expected:
142 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000143 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +0000144 "unexpected keys: %s" % unexp)
145
Guido van Rossum0e548712002-08-09 16:14:33 +0000146
Antoine Pitroueab2a502012-03-10 16:34:40 +0100147class TestRandomNameSequence(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000148 """Test the internal iterator object _RandomNameSequence."""
149
150 def setUp(self):
151 self.r = tempfile._RandomNameSequence()
Brett Cannone1adece2010-03-20 22:19:55 +0000152 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000153
154 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000155 # _RandomNameSequence returns a six-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000156 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000157 self.nameCheck(s, '', '', '')
158
159 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000160 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000161
162 dict = {}
163 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000164 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000165 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000166 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000167 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000168 dict[s] = 1
169
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000170 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000171 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000172
173 i = 0
174 r = self.r
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100175 for s in r:
176 i += 1
177 if i == 20:
178 break
Guido van Rossum0e548712002-08-09 16:14:33 +0000179
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100180 @unittest.skipUnless(hasattr(os, 'fork'),
181 "os.fork is required for this test")
182 def test_process_awareness(self):
183 # ensure that the random source differs between
184 # child and parent.
185 read_fd, write_fd = os.pipe()
186 pid = None
187 try:
188 pid = os.fork()
189 if not pid:
Victor Stinner6c8c2942017-08-10 13:05:06 +0200190 # child process
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100191 os.close(read_fd)
192 os.write(write_fd, next(self.r).encode("ascii"))
193 os.close(write_fd)
194 # bypass the normal exit handlers- leave those to
195 # the parent.
196 os._exit(0)
Victor Stinner6c8c2942017-08-10 13:05:06 +0200197
198 # parent process
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100199 parent_value = next(self.r)
200 child_value = os.read(read_fd, len(parent_value)).decode("ascii")
201 finally:
202 if pid:
203 # best effort to ensure the process can't bleed out
204 # via any bugs above
205 try:
206 os.kill(pid, signal.SIGKILL)
Andrew Svetlov3438fa42012-12-17 23:35:18 +0200207 except OSError:
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100208 pass
Victor Stinner6c8c2942017-08-10 13:05:06 +0200209
210 # Read the process exit status to avoid zombie process
211 os.waitpid(pid, 0)
212
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100213 os.close(read_fd)
214 os.close(write_fd)
215 self.assertNotEqual(child_value, parent_value)
216
217
Guido van Rossum0e548712002-08-09 16:14:33 +0000218
Antoine Pitroueab2a502012-03-10 16:34:40 +0100219class TestCandidateTempdirList(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000220 """Test the internal function _candidate_tempdir_list."""
221
222 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000223 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000224
225 cand = tempfile._candidate_tempdir_list()
226
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000227 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000228 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000229 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000230
231 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000232 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000233
234 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000235 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000236 for envname in 'TMPDIR', 'TEMP', 'TMP':
237 dirname = os.getenv(envname)
238 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000239 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000240
241 cand = tempfile._candidate_tempdir_list()
242
243 for envname in 'TMPDIR', 'TEMP', 'TMP':
244 dirname = os.getenv(envname)
245 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000246 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000247
248 try:
249 dirname = os.getcwd()
Andrew Svetlovad28c7f2012-12-18 22:02:39 +0200250 except (AttributeError, OSError):
Guido van Rossum0e548712002-08-09 16:14:33 +0000251 dirname = os.curdir
252
Benjamin Peterson577473f2010-01-19 00:09:57 +0000253 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000254
255 # Not practical to try to verify the presence of OS-specific
256 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000257
Guido van Rossum0e548712002-08-09 16:14:33 +0000258
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200259# We test _get_default_tempdir some more by testing gettempdir.
Guido van Rossum0e548712002-08-09 16:14:33 +0000260
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200261class TestGetDefaultTempdir(BaseTestCase):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200262 """Test _get_default_tempdir()."""
263
264 def test_no_files_left_behind(self):
265 # use a private empty directory
266 with tempfile.TemporaryDirectory() as our_temp_directory:
267 # force _get_default_tempdir() to consider our empty directory
268 def our_candidate_list():
269 return [our_temp_directory]
270
271 with support.swap_attr(tempfile, "_candidate_tempdir_list",
272 our_candidate_list):
273 # verify our directory is empty after _get_default_tempdir()
274 tempfile._get_default_tempdir()
275 self.assertEqual(os.listdir(our_temp_directory), [])
276
277 def raise_OSError(*args, **kwargs):
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200278 raise OSError()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200279
280 with support.swap_attr(io, "open", raise_OSError):
281 # test again with failing io.open()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200282 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200283 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200284 self.assertEqual(os.listdir(our_temp_directory), [])
285
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200286 def bad_writer(*args, **kwargs):
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300287 fp = orig_open(*args, **kwargs)
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200288 fp.write = raise_OSError
289 return fp
290
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300291 with support.swap_attr(io, "open", bad_writer) as orig_open:
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200292 # test again with failing write()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200293 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200294 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200295 self.assertEqual(os.listdir(our_temp_directory), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000296
297
Antoine Pitroueab2a502012-03-10 16:34:40 +0100298class TestGetCandidateNames(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000299 """Test the internal function _get_candidate_names."""
300
301 def test_retval(self):
Victor Stinner1e62bf12017-04-19 22:59:51 +0200302 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000303 obj = tempfile._get_candidate_names()
Victor Stinner1e62bf12017-04-19 22:59:51 +0200304 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000305
306 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000307 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000308 a = tempfile._get_candidate_names()
309 b = tempfile._get_candidate_names()
310
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000311 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000312
Guido van Rossum0e548712002-08-09 16:14:33 +0000313
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700314@contextlib.contextmanager
315def _inside_empty_temp_dir():
316 dir = tempfile.mkdtemp()
317 try:
318 with support.swap_attr(tempfile, 'tempdir', dir):
319 yield
320 finally:
321 support.rmtree(dir)
322
323
324def _mock_candidate_names(*names):
325 return support.swap_attr(tempfile,
326 '_get_candidate_names',
327 lambda: iter(names))
328
329
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300330class TestBadTempdir:
331
332 def test_read_only_directory(self):
333 with _inside_empty_temp_dir():
334 oldmode = mode = os.stat(tempfile.tempdir).st_mode
335 mode &= ~(stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH)
336 os.chmod(tempfile.tempdir, mode)
337 try:
338 if os.access(tempfile.tempdir, os.W_OK):
339 self.skipTest("can't set the directory read-only")
340 with self.assertRaises(PermissionError):
341 self.make_temp()
342 self.assertEqual(os.listdir(tempfile.tempdir), [])
343 finally:
344 os.chmod(tempfile.tempdir, oldmode)
345
346 def test_nonexisting_directory(self):
347 with _inside_empty_temp_dir():
348 tempdir = os.path.join(tempfile.tempdir, 'nonexistent')
349 with support.swap_attr(tempfile, 'tempdir', tempdir):
350 with self.assertRaises(FileNotFoundError):
351 self.make_temp()
352
353 def test_non_directory(self):
354 with _inside_empty_temp_dir():
355 tempdir = os.path.join(tempfile.tempdir, 'file')
356 open(tempdir, 'wb').close()
357 with support.swap_attr(tempfile, 'tempdir', tempdir):
358 with self.assertRaises((NotADirectoryError, FileNotFoundError)):
359 self.make_temp()
360
361
362class TestMkstempInner(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000363 """Test the internal function _mkstemp_inner."""
364
365 class mkstemped:
366 _bflags = tempfile._bin_openflags
367 _tflags = tempfile._text_openflags
368 _close = os.close
369 _unlink = os.unlink
370
371 def __init__(self, dir, pre, suf, bin):
372 if bin: flags = self._bflags
373 else: flags = self._tflags
374
Gregory P. Smithad577b92015-05-22 16:18:14 -0700375 output_type = tempfile._infer_return_type(dir, pre, suf)
376 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags, output_type)
Guido van Rossum0e548712002-08-09 16:14:33 +0000377
378 def write(self, str):
379 os.write(self.fd, str)
380
381 def __del__(self):
382 self._close(self.fd)
383 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000384
Gregory P. Smithad577b92015-05-22 16:18:14 -0700385 def do_create(self, dir=None, pre=None, suf=None, bin=1):
386 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000387 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700388 if output_type is str:
389 dir = tempfile.gettempdir()
390 else:
391 dir = tempfile.gettempdirb()
392 if pre is None:
393 pre = output_type()
394 if suf is None:
395 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100396 file = self.mkstemped(dir, pre, suf, bin)
Guido van Rossum0e548712002-08-09 16:14:33 +0000397
398 self.nameCheck(file.name, dir, pre, suf)
399 return file
400
401 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000402 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000403 self.do_create().write(b"blat")
404 self.do_create(pre="a").write(b"blat")
405 self.do_create(suf="b").write(b"blat")
406 self.do_create(pre="a", suf="b").write(b"blat")
407 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000408
Gregory P. Smithad577b92015-05-22 16:18:14 -0700409 def test_basic_with_bytes_names(self):
410 # _mkstemp_inner can create files when given name parts all
411 # specified as bytes.
412 dir_b = tempfile.gettempdirb()
413 self.do_create(dir=dir_b, suf=b"").write(b"blat")
414 self.do_create(dir=dir_b, pre=b"a").write(b"blat")
415 self.do_create(dir=dir_b, suf=b"b").write(b"blat")
416 self.do_create(dir=dir_b, pre=b"a", suf=b"b").write(b"blat")
417 self.do_create(dir=dir_b, pre=b"aa", suf=b".txt").write(b"blat")
418 # Can't mix str & binary types in the args.
419 with self.assertRaises(TypeError):
420 self.do_create(dir="", suf=b"").write(b"blat")
421 with self.assertRaises(TypeError):
422 self.do_create(dir=dir_b, pre="").write(b"blat")
423 with self.assertRaises(TypeError):
424 self.do_create(dir=dir_b, pre=b"", suf="").write(b"blat")
425
Guido van Rossum0e548712002-08-09 16:14:33 +0000426 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000427 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000428 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000429 for i in extant:
430 extant[i] = self.do_create(pre="aa")
431
432 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000433 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000434 dir = tempfile.mkdtemp()
435 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000436 self.do_create(dir=dir).write(b"blat")
Miss Islington (bot)eadf6b82019-09-09 10:31:31 -0700437 self.do_create(dir=pathlib.Path(dir)).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000438 finally:
439 os.rmdir(dir)
440
441 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000442 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000443
444 file = self.do_create()
445 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000446 expected = 0o600
Jesus Cea4791a242012-10-05 03:15:39 +0200447 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000448 # There's no distinction among 'user', 'group' and 'world';
449 # replicate the 'user' bits.
450 user = expected >> 6
451 expected = user * (1 + 8 + 64)
452 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000453
Zachary Ware9fe6d862013-12-08 00:20:35 -0600454 @unittest.skipUnless(has_spawnl, 'os.spawnl not available')
Guido van Rossum0e548712002-08-09 16:14:33 +0000455 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000456 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum0e548712002-08-09 16:14:33 +0000457
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000458 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000459 v="v"
460 else:
461 v="q"
462
Guido van Rossum0e548712002-08-09 16:14:33 +0000463 file = self.do_create()
Victor Stinnerdaf45552013-08-28 00:53:59 +0200464 self.assertEqual(os.get_inheritable(file.fd), False)
Guido van Rossum78741062002-08-17 11:41:01 +0000465 fd = "%d" % file.fd
466
467 try:
468 me = __file__
469 except NameError:
470 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000471
472 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000473 # effect. The core of this test is therefore in
474 # tf_inherit_check.py, which see.
475 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
476 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000477
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000478 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
479 # but an arg with embedded spaces should be decorated with double
480 # quotes on each end
Jesus Cea4791a242012-10-05 03:15:39 +0200481 if sys.platform == 'win32':
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000482 decorated = '"%s"' % sys.executable
483 tester = '"%s"' % tester
484 else:
485 decorated = sys.executable
486
487 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000488 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000489 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000490 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000491
Zachary Ware9fe6d862013-12-08 00:20:35 -0600492 @unittest.skipUnless(has_textmode, "text mode not available")
Guido van Rossum0e548712002-08-09 16:14:33 +0000493 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000494 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000495
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000496 # A text file is truncated at the first Ctrl+Z byte
497 f = self.do_create(bin=0)
498 f.write(b"blat\x1a")
499 f.write(b"extra\n")
500 os.lseek(f.fd, 0, os.SEEK_SET)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000501 self.assertEqual(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000502
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300503 def make_temp(self):
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700504 return tempfile._mkstemp_inner(tempfile.gettempdir(),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700505 tempfile.gettempprefix(),
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700506 '',
Gregory P. Smithad577b92015-05-22 16:18:14 -0700507 tempfile._bin_openflags,
508 str)
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700509
510 def test_collision_with_existing_file(self):
511 # _mkstemp_inner tries another name when a file with
512 # the chosen name already exists
513 with _inside_empty_temp_dir(), \
514 _mock_candidate_names('aaa', 'aaa', 'bbb'):
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300515 (fd1, name1) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700516 os.close(fd1)
517 self.assertTrue(name1.endswith('aaa'))
518
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300519 (fd2, name2) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700520 os.close(fd2)
521 self.assertTrue(name2.endswith('bbb'))
522
Eli Benderskyf315df32013-09-06 06:11:19 -0700523 def test_collision_with_existing_directory(self):
524 # _mkstemp_inner tries another name when a directory with
525 # the chosen name already exists
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700526 with _inside_empty_temp_dir(), \
527 _mock_candidate_names('aaa', 'aaa', 'bbb'):
528 dir = tempfile.mkdtemp()
529 self.assertTrue(dir.endswith('aaa'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700530
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300531 (fd, name) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700532 os.close(fd)
533 self.assertTrue(name.endswith('bbb'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700534
Guido van Rossum0e548712002-08-09 16:14:33 +0000535
Antoine Pitroueab2a502012-03-10 16:34:40 +0100536class TestGetTempPrefix(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000537 """Test gettempprefix()."""
538
539 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000540 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000541 p = tempfile.gettempprefix()
542
Ezio Melottie9615932010-01-24 19:26:24 +0000543 self.assertIsInstance(p, str)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700544 self.assertGreater(len(p), 0)
545
546 pb = tempfile.gettempprefixb()
547
548 self.assertIsInstance(pb, bytes)
549 self.assertGreater(len(pb), 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000550
551 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000552 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000553
554 # Create a temp directory, avoiding use of the prefix.
555 # Then attempt to create a file whose name is
556 # prefix + 'xxxxxx.xxx' in that directory.
557 p = tempfile.gettempprefix() + "xxxxxx.xxx"
558 d = tempfile.mkdtemp(prefix="")
559 try:
560 p = os.path.join(d, p)
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100561 fd = os.open(p, os.O_RDWR | os.O_CREAT)
Guido van Rossum0e548712002-08-09 16:14:33 +0000562 os.close(fd)
563 os.unlink(p)
564 finally:
565 os.rmdir(d)
566
Guido van Rossum0e548712002-08-09 16:14:33 +0000567
Antoine Pitroueab2a502012-03-10 16:34:40 +0100568class TestGetTempDir(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000569 """Test gettempdir()."""
570
571 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000572 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000573
Gregory P. Smithad577b92015-05-22 16:18:14 -0700574 for d in (tempfile.gettempdir(), tempfile.gettempdirb()):
575 self.assertTrue(os.path.isabs(d) or d == os.curdir,
576 "%r is not an absolute path" % d)
577 self.assertTrue(os.path.isdir(d),
578 "%r is not a directory" % d)
Guido van Rossum0e548712002-08-09 16:14:33 +0000579
580 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000581 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000582
583 # sneaky: just instantiate a NamedTemporaryFile, which
584 # defaults to writing into the directory returned by
585 # gettempdir.
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200586 with tempfile.NamedTemporaryFile() as file:
587 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000588
589 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000590 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000591 a = tempfile.gettempdir()
592 b = tempfile.gettempdir()
Gregory P. Smithad577b92015-05-22 16:18:14 -0700593 c = tempfile.gettempdirb()
Guido van Rossum0e548712002-08-09 16:14:33 +0000594
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000595 self.assertTrue(a is b)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700596 self.assertNotEqual(type(a), type(c))
597 self.assertEqual(a, os.fsdecode(c))
Guido van Rossum0e548712002-08-09 16:14:33 +0000598
Tim Golden6d09f092013-10-25 18:38:16 +0100599 def test_case_sensitive(self):
600 # gettempdir should not flatten its case
601 # even on a case-insensitive file system
602 case_sensitive_tempdir = tempfile.mkdtemp("-Temp")
603 _tempdir, tempfile.tempdir = tempfile.tempdir, None
604 try:
605 with support.EnvironmentVarGuard() as env:
606 # Fake the first env var which is checked as a candidate
607 env["TMPDIR"] = case_sensitive_tempdir
608 self.assertEqual(tempfile.gettempdir(), case_sensitive_tempdir)
609 finally:
610 tempfile.tempdir = _tempdir
611 support.rmdir(case_sensitive_tempdir)
612
Guido van Rossum0e548712002-08-09 16:14:33 +0000613
Antoine Pitroueab2a502012-03-10 16:34:40 +0100614class TestMkstemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000615 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000616
Gregory P. Smithad577b92015-05-22 16:18:14 -0700617 def do_create(self, dir=None, pre=None, suf=None):
618 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000619 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700620 if output_type is str:
621 dir = tempfile.gettempdir()
622 else:
623 dir = tempfile.gettempdirb()
624 if pre is None:
625 pre = output_type()
626 if suf is None:
627 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100628 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
629 (ndir, nbase) = os.path.split(name)
630 adir = os.path.abspath(dir)
631 self.assertEqual(adir, ndir,
632 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000633
634 try:
635 self.nameCheck(name, dir, pre, suf)
636 finally:
637 os.close(fd)
638 os.unlink(name)
639
640 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000641 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000642 self.do_create()
643 self.do_create(pre="a")
644 self.do_create(suf="b")
645 self.do_create(pre="a", suf="b")
646 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000647 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000648
Gregory P. Smithad577b92015-05-22 16:18:14 -0700649 def test_basic_with_bytes_names(self):
650 # mkstemp can create files when given name parts all
651 # specified as bytes.
652 d = tempfile.gettempdirb()
653 self.do_create(dir=d, suf=b"")
654 self.do_create(dir=d, pre=b"a")
655 self.do_create(dir=d, suf=b"b")
656 self.do_create(dir=d, pre=b"a", suf=b"b")
657 self.do_create(dir=d, pre=b"aa", suf=b".txt")
658 self.do_create(dir=b".")
659 with self.assertRaises(TypeError):
660 self.do_create(dir=".", pre=b"aa", suf=b".txt")
661 with self.assertRaises(TypeError):
662 self.do_create(dir=b".", pre="aa", suf=b".txt")
663 with self.assertRaises(TypeError):
664 self.do_create(dir=b".", pre=b"aa", suf=".txt")
665
666
Guido van Rossum0e548712002-08-09 16:14:33 +0000667 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000668 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000669 dir = tempfile.mkdtemp()
670 try:
671 self.do_create(dir=dir)
Miss Islington (bot)eadf6b82019-09-09 10:31:31 -0700672 self.do_create(dir=pathlib.Path(dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000673 finally:
674 os.rmdir(dir)
675
Guido van Rossum0e548712002-08-09 16:14:33 +0000676
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300677class TestMkdtemp(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000678 """Test mkdtemp()."""
679
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300680 def make_temp(self):
681 return tempfile.mkdtemp()
682
Gregory P. Smithad577b92015-05-22 16:18:14 -0700683 def do_create(self, dir=None, pre=None, suf=None):
684 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000685 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700686 if output_type is str:
687 dir = tempfile.gettempdir()
688 else:
689 dir = tempfile.gettempdirb()
690 if pre is None:
691 pre = output_type()
692 if suf is None:
693 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100694 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000695
696 try:
697 self.nameCheck(name, dir, pre, suf)
698 return name
699 except:
700 os.rmdir(name)
701 raise
702
703 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000704 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000705 os.rmdir(self.do_create())
706 os.rmdir(self.do_create(pre="a"))
707 os.rmdir(self.do_create(suf="b"))
708 os.rmdir(self.do_create(pre="a", suf="b"))
709 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000710
Gregory P. Smithad577b92015-05-22 16:18:14 -0700711 def test_basic_with_bytes_names(self):
712 # mkdtemp can create directories when given all binary parts
713 d = tempfile.gettempdirb()
714 os.rmdir(self.do_create(dir=d))
715 os.rmdir(self.do_create(dir=d, pre=b"a"))
716 os.rmdir(self.do_create(dir=d, suf=b"b"))
717 os.rmdir(self.do_create(dir=d, pre=b"a", suf=b"b"))
718 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=b".txt"))
719 with self.assertRaises(TypeError):
720 os.rmdir(self.do_create(dir=d, pre="aa", suf=b".txt"))
721 with self.assertRaises(TypeError):
722 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=".txt"))
723 with self.assertRaises(TypeError):
724 os.rmdir(self.do_create(dir="", pre=b"aa", suf=b".txt"))
725
Guido van Rossum0e548712002-08-09 16:14:33 +0000726 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000727 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000728 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000729 try:
730 for i in extant:
731 extant[i] = self.do_create(pre="aa")
732 finally:
733 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000734 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000735 os.rmdir(i)
736
737 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000738 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000739 dir = tempfile.mkdtemp()
740 try:
741 os.rmdir(self.do_create(dir=dir))
Miss Islington (bot)eadf6b82019-09-09 10:31:31 -0700742 os.rmdir(self.do_create(dir=pathlib.Path(dir)))
Guido van Rossum0e548712002-08-09 16:14:33 +0000743 finally:
744 os.rmdir(dir)
745
746 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000747 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000748
749 dir = self.do_create()
750 try:
751 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000752 mode &= 0o777 # Mask off sticky bits inherited from /tmp
753 expected = 0o700
Jesus Cea4791a242012-10-05 03:15:39 +0200754 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000755 # There's no distinction among 'user', 'group' and 'world';
756 # replicate the 'user' bits.
757 user = expected >> 6
758 expected = user * (1 + 8 + 64)
759 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000760 finally:
761 os.rmdir(dir)
762
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700763 def test_collision_with_existing_file(self):
764 # mkdtemp tries another name when a file with
765 # the chosen name already exists
766 with _inside_empty_temp_dir(), \
767 _mock_candidate_names('aaa', 'aaa', 'bbb'):
768 file = tempfile.NamedTemporaryFile(delete=False)
769 file.close()
770 self.assertTrue(file.name.endswith('aaa'))
771 dir = tempfile.mkdtemp()
772 self.assertTrue(dir.endswith('bbb'))
773
774 def test_collision_with_existing_directory(self):
775 # mkdtemp tries another name when a directory with
776 # the chosen name already exists
777 with _inside_empty_temp_dir(), \
778 _mock_candidate_names('aaa', 'aaa', 'bbb'):
779 dir1 = tempfile.mkdtemp()
780 self.assertTrue(dir1.endswith('aaa'))
781 dir2 = tempfile.mkdtemp()
782 self.assertTrue(dir2.endswith('bbb'))
783
Guido van Rossum0e548712002-08-09 16:14:33 +0000784
Antoine Pitroueab2a502012-03-10 16:34:40 +0100785class TestMktemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000786 """Test mktemp()."""
787
788 # For safety, all use of mktemp must occur in a private directory.
789 # We must also suppress the RuntimeWarning it generates.
790 def setUp(self):
791 self.dir = tempfile.mkdtemp()
Brett Cannone1adece2010-03-20 22:19:55 +0000792 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000793
794 def tearDown(self):
795 if self.dir:
796 os.rmdir(self.dir)
797 self.dir = None
Brett Cannone1adece2010-03-20 22:19:55 +0000798 super().tearDown()
Guido van Rossum0e548712002-08-09 16:14:33 +0000799
800 class mktemped:
801 _unlink = os.unlink
802 _bflags = tempfile._bin_openflags
803
804 def __init__(self, dir, pre, suf):
805 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
806 # Create the file. This will raise an exception if it's
807 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000808 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000809
810 def __del__(self):
811 self._unlink(self.name)
812
813 def do_create(self, pre="", suf=""):
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100814 file = self.mktemped(self.dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000815
816 self.nameCheck(file.name, self.dir, pre, suf)
817 return file
818
819 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000820 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000821 self.do_create()
822 self.do_create(pre="a")
823 self.do_create(suf="b")
824 self.do_create(pre="a", suf="b")
825 self.do_create(pre="aa", suf=".txt")
826
827 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000828 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000829 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000830 for i in extant:
831 extant[i] = self.do_create(pre="aa")
832
Fred Drake8bec4832002-11-22 20:13:43 +0000833## def test_warning(self):
834## # mktemp issues a warning when used
835## warnings.filterwarnings("error",
836## category=RuntimeWarning,
837## message="mktemp")
838## self.assertRaises(RuntimeWarning,
839## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000840
Guido van Rossum0e548712002-08-09 16:14:33 +0000841
842# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
843
844
Antoine Pitroueab2a502012-03-10 16:34:40 +0100845class TestNamedTemporaryFile(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000846 """Test NamedTemporaryFile()."""
847
Guido van Rossumd8faa362007-04-27 19:54:29 +0000848 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000849 if dir is None:
850 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100851 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
852 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000853
854 self.nameCheck(file.name, dir, pre, suf)
855 return file
856
857
858 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000859 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000860 self.do_create()
861 self.do_create(pre="a")
862 self.do_create(suf="b")
863 self.do_create(pre="a", suf="b")
864 self.do_create(pre="aa", suf=".txt")
865
Antoine Pitrou17c93262013-12-21 22:14:56 +0100866 def test_method_lookup(self):
867 # Issue #18879: Looking up a temporary file method should keep it
868 # alive long enough.
869 f = self.do_create()
870 wr = weakref.ref(f)
871 write = f.write
872 write2 = f.write
873 del f
874 write(b'foo')
875 del write
876 write2(b'bar')
877 del write2
878 if support.check_impl_detail(cpython=True):
879 # No reference cycle was created.
880 self.assertIsNone(wr())
881
Serhiy Storchaka56cefa62015-03-19 15:23:15 +0200882 def test_iter(self):
883 # Issue #23700: getting iterator from a temporary file should keep
884 # it alive as long as it's being iterated over
885 lines = [b'spam\n', b'eggs\n', b'beans\n']
886 def make_file():
887 f = tempfile.NamedTemporaryFile(mode='w+b')
888 f.write(b''.join(lines))
889 f.seek(0)
890 return f
891 for i, l in enumerate(make_file()):
892 self.assertEqual(l, lines[i])
893 self.assertEqual(i, len(lines) - 1)
894
Guido van Rossum0e548712002-08-09 16:14:33 +0000895 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000896 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000897 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000898 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000899 "NamedTemporaryFile %s does not exist" % f.name)
900
901 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000902 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000903 dir = tempfile.mkdtemp()
904 try:
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200905 with tempfile.NamedTemporaryFile(dir=dir) as f:
906 f.write(b'blat')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000907 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000908 "NamedTemporaryFile %s exists after close" % f.name)
909 finally:
910 os.rmdir(dir)
911
Guido van Rossumd8faa362007-04-27 19:54:29 +0000912 def test_dis_del_on_close(self):
913 # Tests that delete-on-close can be disabled
914 dir = tempfile.mkdtemp()
915 tmp = None
916 try:
917 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
918 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000919 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000920 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000921 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000922 "NamedTemporaryFile %s missing after close" % f.name)
923 finally:
924 if tmp is not None:
925 os.unlink(tmp)
926 os.rmdir(dir)
927
Guido van Rossum0e548712002-08-09 16:14:33 +0000928 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000929 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000930 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000931 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000932 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100933 f.close()
934 f.close()
Guido van Rossum0e548712002-08-09 16:14:33 +0000935
Christian Heimes3ecfea712008-02-09 20:51:34 +0000936 def test_context_manager(self):
937 # A NamedTemporaryFile can be used as a context manager
938 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000939 self.assertTrue(os.path.exists(f.name))
940 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000941 def use_closed():
942 with f:
943 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000944 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000945
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100946 def test_no_leak_fd(self):
Victor Stinner87d13ea2014-03-25 18:19:17 +0100947 # Issue #21058: don't leak file descriptor when io.open() fails
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100948 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +0200949 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100950 def close(fd):
951 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +0200952 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100953
954 with mock.patch('os.close', side_effect=close):
955 with mock.patch('io.open', side_effect=ValueError):
956 self.assertRaises(ValueError, tempfile.NamedTemporaryFile)
957 self.assertEqual(len(closed), 1)
958
Martin Panter7869a222016-02-28 05:22:20 +0000959 def test_bad_mode(self):
960 dir = tempfile.mkdtemp()
961 self.addCleanup(support.rmtree, dir)
962 with self.assertRaises(ValueError):
963 tempfile.NamedTemporaryFile(mode='wr', dir=dir)
964 with self.assertRaises(TypeError):
965 tempfile.NamedTemporaryFile(mode=2, dir=dir)
966 self.assertEqual(os.listdir(dir), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000967
Martin Panter7869a222016-02-28 05:22:20 +0000968 # How to test the mode and bufsize parameters?
Guido van Rossum0e548712002-08-09 16:14:33 +0000969
Antoine Pitroueab2a502012-03-10 16:34:40 +0100970class TestSpooledTemporaryFile(BaseTestCase):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000971 """Test SpooledTemporaryFile()."""
972
973 def do_create(self, max_size=0, dir=None, pre="", suf=""):
974 if dir is None:
975 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100976 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000977
978 return file
979
980
981 def test_basic(self):
982 # SpooledTemporaryFile can create files
983 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000984 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000985 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000986 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000987
988 def test_del_on_close(self):
989 # A SpooledTemporaryFile is deleted when closed
990 dir = tempfile.mkdtemp()
991 try:
992 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000993 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000994 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000995 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000996 filename = f.name
997 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000998 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000999 "SpooledTemporaryFile %s exists after close" % filename)
1000 finally:
1001 os.rmdir(dir)
1002
1003 def test_rewrite_small(self):
1004 # A SpooledTemporaryFile can be written to multiple within the max_size
1005 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001006 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001007 for i in range(5):
1008 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +00001009 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001010 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001011
1012 def test_write_sequential(self):
1013 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1014 # over afterward
1015 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001016 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001017 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001018 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001019 f.write(b'x' * 10)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001020 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001021 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001022 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001023
R David Murrayd89ee792011-03-14 09:55:46 -04001024 def test_writelines(self):
1025 # Verify writelines with a SpooledTemporaryFile
1026 f = self.do_create()
1027 f.writelines((b'x', b'y', b'z'))
1028 f.seek(0)
1029 buf = f.read()
1030 self.assertEqual(buf, b'xyz')
1031
1032 def test_writelines_sequential(self):
1033 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1034 # over afterward
1035 f = self.do_create(max_size=35)
1036 f.writelines((b'x' * 20, b'x' * 10, b'x' * 5))
1037 self.assertFalse(f._rolled)
1038 f.write(b'x')
1039 self.assertTrue(f._rolled)
1040
Guido van Rossumd8faa362007-04-27 19:54:29 +00001041 def test_sparse(self):
1042 # A SpooledTemporaryFile that is written late in the file will extend
1043 # when that occurs
1044 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001045 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001046 f.seek(100, 0)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001047 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001048 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001049 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001050
1051 def test_fileno(self):
1052 # A SpooledTemporaryFile should roll over to a real file on fileno()
1053 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001054 self.assertFalse(f._rolled)
1055 self.assertTrue(f.fileno() > 0)
1056 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001057
Christian Heimes3ecfea712008-02-09 20:51:34 +00001058 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001059 # A SpooledTemporaryFile can be closed many times without error
1060 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +00001061 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001062 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001063 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001064 f.close()
1065 f.close()
Christian Heimes3ecfea712008-02-09 20:51:34 +00001066
1067 def test_multiple_close_after_rollover(self):
1068 # A SpooledTemporaryFile can be closed many times without error
1069 f = tempfile.SpooledTemporaryFile(max_size=1)
1070 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001071 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001072 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001073 f.close()
1074 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001075
1076 def test_bound_methods(self):
1077 # It should be OK to steal a bound method from a SpooledTemporaryFile
1078 # and use it independently; when the file rolls over, those bound
1079 # methods should continue to function
1080 f = self.do_create(max_size=30)
1081 read = f.read
1082 write = f.write
1083 seek = f.seek
1084
Guido van Rossum39478e82007-08-27 17:23:59 +00001085 write(b"a" * 35)
1086 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001087 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +00001088 self.assertEqual(read(70), b'a'*35 + b'b'*35)
1089
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001090 def test_properties(self):
1091 f = tempfile.SpooledTemporaryFile(max_size=10)
1092 f.write(b'x' * 10)
1093 self.assertFalse(f._rolled)
1094 self.assertEqual(f.mode, 'w+b')
1095 self.assertIsNone(f.name)
1096 with self.assertRaises(AttributeError):
1097 f.newlines
1098 with self.assertRaises(AttributeError):
1099 f.encoding
sth825aab92018-05-23 07:07:01 +02001100 with self.assertRaises(AttributeError):
1101 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001102
1103 f.write(b'x')
1104 self.assertTrue(f._rolled)
1105 self.assertEqual(f.mode, 'rb+')
1106 self.assertIsNotNone(f.name)
1107 with self.assertRaises(AttributeError):
1108 f.newlines
1109 with self.assertRaises(AttributeError):
1110 f.encoding
sth825aab92018-05-23 07:07:01 +02001111 with self.assertRaises(AttributeError):
1112 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001113
Guido van Rossum9a634702007-07-09 10:24:45 +00001114 def test_text_mode(self):
1115 # Creating a SpooledTemporaryFile with a text mode should produce
1116 # a file object reading and writing (Unicode) text strings.
1117 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10)
1118 f.write("abc\n")
1119 f.seek(0)
1120 self.assertEqual(f.read(), "abc\n")
1121 f.write("def\n")
1122 f.seek(0)
1123 self.assertEqual(f.read(), "abc\ndef\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001124 self.assertFalse(f._rolled)
1125 self.assertEqual(f.mode, 'w+')
1126 self.assertIsNone(f.name)
1127 self.assertIsNone(f.newlines)
1128 self.assertIsNone(f.encoding)
sth825aab92018-05-23 07:07:01 +02001129 self.assertIsNone(f.errors)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001130
Guido van Rossum9a634702007-07-09 10:24:45 +00001131 f.write("xyzzy\n")
1132 f.seek(0)
1133 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +00001134 # Check that Ctrl+Z doesn't truncate the file
1135 f.write("foo\x1abar\n")
1136 f.seek(0)
1137 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001138 self.assertTrue(f._rolled)
1139 self.assertEqual(f.mode, 'w+')
1140 self.assertIsNotNone(f.name)
Serhiy Storchaka497cee42013-02-10 14:43:46 +02001141 self.assertEqual(f.newlines, os.linesep)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001142 self.assertIsNotNone(f.encoding)
sth825aab92018-05-23 07:07:01 +02001143 self.assertIsNotNone(f.errors)
Guido van Rossum9a634702007-07-09 10:24:45 +00001144
Guido van Rossumf0c74162007-08-28 03:29:45 +00001145 def test_text_newline_and_encoding(self):
1146 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
sth825aab92018-05-23 07:07:01 +02001147 newline='', encoding='utf-8',
1148 errors='ignore')
Guido van Rossumf0c74162007-08-28 03:29:45 +00001149 f.write("\u039B\r\n")
1150 f.seek(0)
1151 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001152 self.assertFalse(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001153 self.assertEqual(f.mode, 'w+')
1154 self.assertIsNone(f.name)
1155 self.assertIsNone(f.newlines)
1156 self.assertIsNone(f.encoding)
sth825aab92018-05-23 07:07:01 +02001157 self.assertIsNone(f.errors)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001158
1159 f.write("\u039B" * 20 + "\r\n")
1160 f.seek(0)
1161 self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001162 self.assertTrue(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001163 self.assertEqual(f.mode, 'w+')
1164 self.assertIsNotNone(f.name)
1165 self.assertIsNotNone(f.newlines)
1166 self.assertEqual(f.encoding, 'utf-8')
sth825aab92018-05-23 07:07:01 +02001167 self.assertEqual(f.errors, 'ignore')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001168
Christian Heimes3ecfea712008-02-09 20:51:34 +00001169 def test_context_manager_before_rollover(self):
1170 # A SpooledTemporaryFile can be used as a context manager
1171 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001172 self.assertFalse(f._rolled)
1173 self.assertFalse(f.closed)
1174 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001175 def use_closed():
1176 with f:
1177 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001178 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001179
1180 def test_context_manager_during_rollover(self):
1181 # A SpooledTemporaryFile can be used as a context manager
1182 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001183 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001184 f.write(b'abc\n')
1185 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001186 self.assertTrue(f._rolled)
1187 self.assertFalse(f.closed)
1188 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001189 def use_closed():
1190 with f:
1191 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001192 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001193
1194 def test_context_manager_after_rollover(self):
1195 # A SpooledTemporaryFile can be used as a context manager
1196 f = tempfile.SpooledTemporaryFile(max_size=1)
1197 f.write(b'abc\n')
1198 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001199 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001200 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001201 self.assertFalse(f.closed)
1202 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001203 def use_closed():
1204 with f:
1205 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001206 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001207
Antoine Pitrou0e86a582011-11-25 18:03:09 +01001208 def test_truncate_with_size_parameter(self):
1209 # A SpooledTemporaryFile can be truncated to zero size
1210 f = tempfile.SpooledTemporaryFile(max_size=10)
1211 f.write(b'abcdefg\n')
1212 f.seek(0)
1213 f.truncate()
1214 self.assertFalse(f._rolled)
1215 self.assertEqual(f._file.getvalue(), b'')
1216 # A SpooledTemporaryFile can be truncated to a specific size
1217 f = tempfile.SpooledTemporaryFile(max_size=10)
1218 f.write(b'abcdefg\n')
1219 f.truncate(4)
1220 self.assertFalse(f._rolled)
1221 self.assertEqual(f._file.getvalue(), b'abcd')
1222 # A SpooledTemporaryFile rolls over if truncated to large size
1223 f = tempfile.SpooledTemporaryFile(max_size=10)
1224 f.write(b'abcdefg\n')
1225 f.truncate(20)
1226 self.assertTrue(f._rolled)
Anthony Sottile8377cd42019-02-25 14:32:27 -08001227 self.assertEqual(os.fstat(f.fileno()).st_size, 20)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001228
Guido van Rossum0e548712002-08-09 16:14:33 +00001229
Guido van Rossum8ccd9b62002-08-22 20:02:03 +00001230if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Antoine Pitroueab2a502012-03-10 16:34:40 +01001231
1232 class TestTemporaryFile(BaseTestCase):
1233 """Test TemporaryFile()."""
1234
1235 def test_basic(self):
1236 # TemporaryFile can create files
1237 # No point in testing the name params - the file has no name.
1238 tempfile.TemporaryFile()
1239
1240 def test_has_no_name(self):
1241 # TemporaryFile creates files with no names (on this system)
1242 dir = tempfile.mkdtemp()
1243 f = tempfile.TemporaryFile(dir=dir)
1244 f.write(b'blat')
1245
1246 # Sneaky: because this file has no name, it should not prevent
1247 # us from removing the directory it was created in.
1248 try:
1249 os.rmdir(dir)
1250 except:
1251 # cleanup
1252 f.close()
1253 os.rmdir(dir)
1254 raise
1255
1256 def test_multiple_close(self):
1257 # A TemporaryFile can be closed many times without error
1258 f = tempfile.TemporaryFile()
1259 f.write(b'abc\n')
1260 f.close()
1261 f.close()
1262 f.close()
1263
1264 # How to test the mode and bufsize parameters?
1265 def test_mode_and_encoding(self):
1266
1267 def roundtrip(input, *args, **kwargs):
1268 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
1269 fileobj.write(input)
1270 fileobj.seek(0)
1271 self.assertEqual(input, fileobj.read())
1272
1273 roundtrip(b"1234", "w+b")
1274 roundtrip("abdc\n", "w+")
1275 roundtrip("\u039B", "w+", encoding="utf-16")
1276 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +00001277
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001278 def test_no_leak_fd(self):
1279 # Issue #21058: don't leak file descriptor when io.open() fails
1280 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +02001281 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001282 def close(fd):
1283 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +02001284 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +01001285
1286 with mock.patch('os.close', side_effect=close):
1287 with mock.patch('io.open', side_effect=ValueError):
1288 self.assertRaises(ValueError, tempfile.TemporaryFile)
1289 self.assertEqual(len(closed), 1)
1290
1291
Nick Coghlan543af752010-10-24 11:23:25 +00001292
1293# Helper for test_del_on_shutdown
1294class NulledModules:
1295 def __init__(self, *modules):
1296 self.refs = [mod.__dict__ for mod in modules]
1297 self.contents = [ref.copy() for ref in self.refs]
1298
1299 def __enter__(self):
1300 for d in self.refs:
1301 for key in d:
1302 d[key] = None
1303
1304 def __exit__(self, *exc_info):
1305 for d, c in zip(self.refs, self.contents):
1306 d.clear()
1307 d.update(c)
1308
Antoine Pitroueab2a502012-03-10 16:34:40 +01001309class TestTemporaryDirectory(BaseTestCase):
Nick Coghlan543af752010-10-24 11:23:25 +00001310 """Test TemporaryDirectory()."""
1311
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001312 def do_create(self, dir=None, pre="", suf="", recurse=1, dirs=1, files=1):
Nick Coghlan543af752010-10-24 11:23:25 +00001313 if dir is None:
1314 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001315 tmp = tempfile.TemporaryDirectory(dir=dir, prefix=pre, suffix=suf)
Nick Coghlan543af752010-10-24 11:23:25 +00001316 self.nameCheck(tmp.name, dir, pre, suf)
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001317 self.do_create2(tmp.name, recurse, dirs, files)
Nick Coghlan543af752010-10-24 11:23:25 +00001318 return tmp
1319
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001320 def do_create2(self, path, recurse=1, dirs=1, files=1):
1321 # Create subdirectories and some files
1322 if recurse:
1323 for i in range(dirs):
1324 name = os.path.join(path, "dir%d" % i)
1325 os.mkdir(name)
1326 self.do_create2(name, recurse-1, dirs, files)
1327 for i in range(files):
1328 with open(os.path.join(path, "test%d.txt" % i), "wb") as f:
1329 f.write(b"Hello world!")
1330
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001331 def test_mkdtemp_failure(self):
1332 # Check no additional exception if mkdtemp fails
1333 # Previously would raise AttributeError instead
Nick Coghlan3c54ea62010-12-13 03:02:43 +00001334 # (noted as part of Issue #10188)
1335 with tempfile.TemporaryDirectory() as nonexistent:
1336 pass
Serhiy Storchaka7451a722013-02-09 22:25:49 +02001337 with self.assertRaises(FileNotFoundError) as cm:
Nick Coghlan3c54ea62010-12-13 03:02:43 +00001338 tempfile.TemporaryDirectory(dir=nonexistent)
Serhiy Storchaka7451a722013-02-09 22:25:49 +02001339 self.assertEqual(cm.exception.errno, errno.ENOENT)
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001340
Nick Coghlan543af752010-10-24 11:23:25 +00001341 def test_explicit_cleanup(self):
1342 # A TemporaryDirectory is deleted when cleaned up
1343 dir = tempfile.mkdtemp()
1344 try:
1345 d = self.do_create(dir=dir)
1346 self.assertTrue(os.path.exists(d.name),
1347 "TemporaryDirectory %s does not exist" % d.name)
1348 d.cleanup()
1349 self.assertFalse(os.path.exists(d.name),
1350 "TemporaryDirectory %s exists after cleanup" % d.name)
1351 finally:
1352 os.rmdir(dir)
1353
Charles-François Natalidef35432011-07-29 18:59:24 +02001354 @support.skip_unless_symlink
1355 def test_cleanup_with_symlink_to_a_directory(self):
1356 # cleanup() should not follow symlinks to directories (issue #12464)
1357 d1 = self.do_create()
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001358 d2 = self.do_create(recurse=0)
Charles-François Natalidef35432011-07-29 18:59:24 +02001359
1360 # Symlink d1/foo -> d2
1361 os.symlink(d2.name, os.path.join(d1.name, "foo"))
1362
1363 # This call to cleanup() should not follow the "foo" symlink
1364 d1.cleanup()
1365
1366 self.assertFalse(os.path.exists(d1.name),
1367 "TemporaryDirectory %s exists after cleanup" % d1.name)
1368 self.assertTrue(os.path.exists(d2.name),
1369 "Directory pointed to by a symlink was deleted")
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001370 self.assertEqual(os.listdir(d2.name), ['test0.txt'],
Charles-François Natalidef35432011-07-29 18:59:24 +02001371 "Contents of the directory pointed to by a symlink "
1372 "were deleted")
1373 d2.cleanup()
1374
Nick Coghlan543af752010-10-24 11:23:25 +00001375 @support.cpython_only
1376 def test_del_on_collection(self):
1377 # A TemporaryDirectory is deleted when garbage collected
1378 dir = tempfile.mkdtemp()
1379 try:
1380 d = self.do_create(dir=dir)
1381 name = d.name
1382 del d # Rely on refcounting to invoke __del__
1383 self.assertFalse(os.path.exists(name),
1384 "TemporaryDirectory %s exists after __del__" % name)
1385 finally:
1386 os.rmdir(dir)
1387
Nick Coghlan543af752010-10-24 11:23:25 +00001388 def test_del_on_shutdown(self):
1389 # A TemporaryDirectory may be cleaned up during shutdown
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001390 with self.do_create() as dir:
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001391 for mod in ('builtins', 'os', 'shutil', 'sys', 'tempfile', 'warnings'):
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001392 code = """if True:
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001393 import builtins
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001394 import os
1395 import shutil
1396 import sys
1397 import tempfile
1398 import warnings
1399
1400 tmp = tempfile.TemporaryDirectory(dir={dir!r})
1401 sys.stdout.buffer.write(tmp.name.encode())
1402
1403 tmp2 = os.path.join(tmp.name, 'test_dir')
1404 os.mkdir(tmp2)
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001405 with open(os.path.join(tmp2, "test0.txt"), "w") as f:
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001406 f.write("Hello world!")
1407
1408 {mod}.tmp = tmp
1409
1410 warnings.filterwarnings("always", category=ResourceWarning)
1411 """.format(dir=dir, mod=mod)
1412 rc, out, err = script_helper.assert_python_ok("-c", code)
1413 tmp_name = out.decode().strip()
1414 self.assertFalse(os.path.exists(tmp_name),
1415 "TemporaryDirectory %s exists after cleanup" % tmp_name)
1416 err = err.decode('utf-8', 'backslashreplace')
1417 self.assertNotIn("Exception ", err)
Serhiy Storchakaa28632b2014-01-27 11:21:54 +02001418 self.assertIn("ResourceWarning: Implicitly cleaning up", err)
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001419
Serhiy Storchaka5e193ac2014-09-24 13:26:25 +03001420 def test_exit_on_shutdown(self):
1421 # Issue #22427
1422 with self.do_create() as dir:
1423 code = """if True:
1424 import sys
1425 import tempfile
1426 import warnings
1427
1428 def generator():
1429 with tempfile.TemporaryDirectory(dir={dir!r}) as tmp:
1430 yield tmp
1431 g = generator()
1432 sys.stdout.buffer.write(next(g).encode())
1433
1434 warnings.filterwarnings("always", category=ResourceWarning)
1435 """.format(dir=dir)
1436 rc, out, err = script_helper.assert_python_ok("-c", code)
1437 tmp_name = out.decode().strip()
1438 self.assertFalse(os.path.exists(tmp_name),
1439 "TemporaryDirectory %s exists after cleanup" % tmp_name)
1440 err = err.decode('utf-8', 'backslashreplace')
1441 self.assertNotIn("Exception ", err)
1442 self.assertIn("ResourceWarning: Implicitly cleaning up", err)
1443
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001444 def test_warnings_on_cleanup(self):
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001445 # ResourceWarning will be triggered by __del__
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001446 with self.do_create() as dir:
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001447 d = self.do_create(dir=dir, recurse=3)
1448 name = d.name
Nick Coghlan6b22f3f2010-12-12 15:24:21 +00001449
1450 # Check for the resource warning
1451 with support.check_warnings(('Implicitly', ResourceWarning), quiet=False):
1452 warnings.filterwarnings("always", category=ResourceWarning)
Serhiy Storchaka99e033b2014-01-27 11:18:27 +02001453 del d
1454 support.gc_collect()
1455 self.assertFalse(os.path.exists(name),
1456 "TemporaryDirectory %s exists after __del__" % name)
Nick Coghlan543af752010-10-24 11:23:25 +00001457
1458 def test_multiple_close(self):
1459 # Can be cleaned-up many times without error
1460 d = self.do_create()
1461 d.cleanup()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001462 d.cleanup()
1463 d.cleanup()
Nick Coghlan543af752010-10-24 11:23:25 +00001464
1465 def test_context_manager(self):
1466 # Can be used as a context manager
1467 d = self.do_create()
1468 with d as name:
1469 self.assertTrue(os.path.exists(name))
1470 self.assertEqual(name, d.name)
1471 self.assertFalse(os.path.exists(name))
1472
Serhiy Storchakae9b51c02019-05-31 11:30:37 +03001473 def test_modes(self):
1474 for mode in range(8):
1475 mode <<= 6
1476 with self.subTest(mode=format(mode, '03o')):
1477 d = self.do_create(recurse=3, dirs=2, files=2)
1478 with d:
1479 # Change files and directories mode recursively.
1480 for root, dirs, files in os.walk(d.name, topdown=False):
1481 for name in files:
1482 os.chmod(os.path.join(root, name), mode)
1483 os.chmod(root, mode)
1484 d.cleanup()
1485 self.assertFalse(os.path.exists(d.name))
1486
1487 @unittest.skipUnless(hasattr(os, 'chflags'), 'requires os.lchflags')
1488 def test_flags(self):
1489 flags = stat.UF_IMMUTABLE | stat.UF_NOUNLINK
1490 d = self.do_create(recurse=3, dirs=2, files=2)
1491 with d:
1492 # Change files and directories flags recursively.
1493 for root, dirs, files in os.walk(d.name, topdown=False):
1494 for name in files:
1495 os.chflags(os.path.join(root, name), flags)
1496 os.chflags(root, flags)
1497 d.cleanup()
1498 self.assertFalse(os.path.exists(d.name))
1499
Nick Coghlan543af752010-10-24 11:23:25 +00001500
Guido van Rossum0e548712002-08-09 16:14:33 +00001501if __name__ == "__main__":
Zachary Ware38c707e2015-04-13 15:00:43 -05001502 unittest.main()