blob: fcc706ede5aaa2861d62c428ef15744f7562ee5b [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
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
Anthony Sottile370138b2019-09-09 08:54:34 -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:
Anthony Sottile370138b2019-09-09 08:54:34 -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:
Victor Stinner278c1e12020-03-31 20:08:12 +0200203 support.wait_process(pid, exitcode=0)
Victor Stinner6c8c2942017-08-10 13:05:06 +0200204
Antoine Pitrou4558bad2011-11-25 21:28:15 +0100205 os.close(read_fd)
206 os.close(write_fd)
207 self.assertNotEqual(child_value, parent_value)
208
209
Guido van Rossum0e548712002-08-09 16:14:33 +0000210
Antoine Pitroueab2a502012-03-10 16:34:40 +0100211class TestCandidateTempdirList(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000212 """Test the internal function _candidate_tempdir_list."""
213
214 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000215 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000216
217 cand = tempfile._candidate_tempdir_list()
218
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000219 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000220 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000221 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000222
223 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000224 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000225
226 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000227 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000228 for envname in 'TMPDIR', 'TEMP', 'TMP':
229 dirname = os.getenv(envname)
230 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000231 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000232
233 cand = tempfile._candidate_tempdir_list()
234
235 for envname in 'TMPDIR', 'TEMP', 'TMP':
236 dirname = os.getenv(envname)
237 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000238 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000239
240 try:
241 dirname = os.getcwd()
Andrew Svetlovad28c7f2012-12-18 22:02:39 +0200242 except (AttributeError, OSError):
Guido van Rossum0e548712002-08-09 16:14:33 +0000243 dirname = os.curdir
244
Benjamin Peterson577473f2010-01-19 00:09:57 +0000245 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000246
247 # Not practical to try to verify the presence of OS-specific
248 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000249
Guido van Rossum0e548712002-08-09 16:14:33 +0000250
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200251# We test _get_default_tempdir some more by testing gettempdir.
Guido van Rossum0e548712002-08-09 16:14:33 +0000252
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200253class TestGetDefaultTempdir(BaseTestCase):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200254 """Test _get_default_tempdir()."""
255
256 def test_no_files_left_behind(self):
257 # use a private empty directory
258 with tempfile.TemporaryDirectory() as our_temp_directory:
259 # force _get_default_tempdir() to consider our empty directory
260 def our_candidate_list():
261 return [our_temp_directory]
262
263 with support.swap_attr(tempfile, "_candidate_tempdir_list",
264 our_candidate_list):
265 # verify our directory is empty after _get_default_tempdir()
266 tempfile._get_default_tempdir()
267 self.assertEqual(os.listdir(our_temp_directory), [])
268
269 def raise_OSError(*args, **kwargs):
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200270 raise OSError()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200271
272 with support.swap_attr(io, "open", raise_OSError):
273 # test again with failing io.open()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200274 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200275 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200276 self.assertEqual(os.listdir(our_temp_directory), [])
277
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200278 def bad_writer(*args, **kwargs):
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300279 fp = orig_open(*args, **kwargs)
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200280 fp.write = raise_OSError
281 return fp
282
Serhiy Storchakad1a1def2017-04-28 19:17:26 +0300283 with support.swap_attr(io, "open", bad_writer) as orig_open:
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200284 # test again with failing write()
Serhiy Storchakaff7fef92013-02-13 00:37:29 +0200285 with self.assertRaises(FileNotFoundError):
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200286 tempfile._get_default_tempdir()
Serhiy Storchakaf6b361e2013-02-13 00:35:30 +0200287 self.assertEqual(os.listdir(our_temp_directory), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000288
289
Antoine Pitroueab2a502012-03-10 16:34:40 +0100290class TestGetCandidateNames(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000291 """Test the internal function _get_candidate_names."""
292
293 def test_retval(self):
Victor Stinner1e62bf12017-04-19 22:59:51 +0200294 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000295 obj = tempfile._get_candidate_names()
Victor Stinner1e62bf12017-04-19 22:59:51 +0200296 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000297
298 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000299 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000300 a = tempfile._get_candidate_names()
301 b = tempfile._get_candidate_names()
302
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000303 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000304
Guido van Rossum0e548712002-08-09 16:14:33 +0000305
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700306@contextlib.contextmanager
307def _inside_empty_temp_dir():
308 dir = tempfile.mkdtemp()
309 try:
310 with support.swap_attr(tempfile, 'tempdir', dir):
311 yield
312 finally:
313 support.rmtree(dir)
314
315
316def _mock_candidate_names(*names):
317 return support.swap_attr(tempfile,
318 '_get_candidate_names',
319 lambda: iter(names))
320
321
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300322class TestBadTempdir:
323
324 def test_read_only_directory(self):
325 with _inside_empty_temp_dir():
326 oldmode = mode = os.stat(tempfile.tempdir).st_mode
327 mode &= ~(stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH)
328 os.chmod(tempfile.tempdir, mode)
329 try:
330 if os.access(tempfile.tempdir, os.W_OK):
331 self.skipTest("can't set the directory read-only")
332 with self.assertRaises(PermissionError):
333 self.make_temp()
334 self.assertEqual(os.listdir(tempfile.tempdir), [])
335 finally:
336 os.chmod(tempfile.tempdir, oldmode)
337
338 def test_nonexisting_directory(self):
339 with _inside_empty_temp_dir():
340 tempdir = os.path.join(tempfile.tempdir, 'nonexistent')
341 with support.swap_attr(tempfile, 'tempdir', tempdir):
342 with self.assertRaises(FileNotFoundError):
343 self.make_temp()
344
345 def test_non_directory(self):
346 with _inside_empty_temp_dir():
347 tempdir = os.path.join(tempfile.tempdir, 'file')
348 open(tempdir, 'wb').close()
349 with support.swap_attr(tempfile, 'tempdir', tempdir):
350 with self.assertRaises((NotADirectoryError, FileNotFoundError)):
351 self.make_temp()
352
353
354class TestMkstempInner(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000355 """Test the internal function _mkstemp_inner."""
356
357 class mkstemped:
358 _bflags = tempfile._bin_openflags
359 _tflags = tempfile._text_openflags
360 _close = os.close
361 _unlink = os.unlink
362
363 def __init__(self, dir, pre, suf, bin):
364 if bin: flags = self._bflags
365 else: flags = self._tflags
366
Gregory P. Smithad577b92015-05-22 16:18:14 -0700367 output_type = tempfile._infer_return_type(dir, pre, suf)
368 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags, output_type)
Guido van Rossum0e548712002-08-09 16:14:33 +0000369
370 def write(self, str):
371 os.write(self.fd, str)
372
373 def __del__(self):
374 self._close(self.fd)
375 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000376
Gregory P. Smithad577b92015-05-22 16:18:14 -0700377 def do_create(self, dir=None, pre=None, suf=None, bin=1):
378 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000379 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700380 if output_type is str:
381 dir = tempfile.gettempdir()
382 else:
383 dir = tempfile.gettempdirb()
384 if pre is None:
385 pre = output_type()
386 if suf is None:
387 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100388 file = self.mkstemped(dir, pre, suf, bin)
Guido van Rossum0e548712002-08-09 16:14:33 +0000389
390 self.nameCheck(file.name, dir, pre, suf)
391 return file
392
393 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000394 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000395 self.do_create().write(b"blat")
396 self.do_create(pre="a").write(b"blat")
397 self.do_create(suf="b").write(b"blat")
398 self.do_create(pre="a", suf="b").write(b"blat")
399 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000400
Gregory P. Smithad577b92015-05-22 16:18:14 -0700401 def test_basic_with_bytes_names(self):
402 # _mkstemp_inner can create files when given name parts all
403 # specified as bytes.
404 dir_b = tempfile.gettempdirb()
405 self.do_create(dir=dir_b, suf=b"").write(b"blat")
406 self.do_create(dir=dir_b, pre=b"a").write(b"blat")
407 self.do_create(dir=dir_b, suf=b"b").write(b"blat")
408 self.do_create(dir=dir_b, pre=b"a", suf=b"b").write(b"blat")
409 self.do_create(dir=dir_b, pre=b"aa", suf=b".txt").write(b"blat")
410 # Can't mix str & binary types in the args.
411 with self.assertRaises(TypeError):
412 self.do_create(dir="", suf=b"").write(b"blat")
413 with self.assertRaises(TypeError):
414 self.do_create(dir=dir_b, pre="").write(b"blat")
415 with self.assertRaises(TypeError):
416 self.do_create(dir=dir_b, pre=b"", suf="").write(b"blat")
417
Guido van Rossum0e548712002-08-09 16:14:33 +0000418 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000419 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000420 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000421 for i in extant:
422 extant[i] = self.do_create(pre="aa")
423
424 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000425 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000426 dir = tempfile.mkdtemp()
427 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000428 self.do_create(dir=dir).write(b"blat")
Anthony Sottile370138b2019-09-09 08:54:34 -0700429 self.do_create(dir=pathlib.Path(dir)).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000430 finally:
431 os.rmdir(dir)
432
433 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000434 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000435
436 file = self.do_create()
437 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000438 expected = 0o600
Jesus Cea4791a242012-10-05 03:15:39 +0200439 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000440 # There's no distinction among 'user', 'group' and 'world';
441 # replicate the 'user' bits.
442 user = expected >> 6
443 expected = user * (1 + 8 + 64)
444 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000445
Zachary Ware9fe6d862013-12-08 00:20:35 -0600446 @unittest.skipUnless(has_spawnl, 'os.spawnl not available')
Guido van Rossum0e548712002-08-09 16:14:33 +0000447 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000448 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum0e548712002-08-09 16:14:33 +0000449
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000450 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000451 v="v"
452 else:
453 v="q"
454
Guido van Rossum0e548712002-08-09 16:14:33 +0000455 file = self.do_create()
Victor Stinnerdaf45552013-08-28 00:53:59 +0200456 self.assertEqual(os.get_inheritable(file.fd), False)
Guido van Rossum78741062002-08-17 11:41:01 +0000457 fd = "%d" % file.fd
458
459 try:
460 me = __file__
461 except NameError:
462 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000463
464 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000465 # effect. The core of this test is therefore in
466 # tf_inherit_check.py, which see.
467 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
468 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000469
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000470 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
471 # but an arg with embedded spaces should be decorated with double
472 # quotes on each end
Jesus Cea4791a242012-10-05 03:15:39 +0200473 if sys.platform == 'win32':
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000474 decorated = '"%s"' % sys.executable
475 tester = '"%s"' % tester
476 else:
477 decorated = sys.executable
478
479 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000480 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000481 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000482 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000483
Zachary Ware9fe6d862013-12-08 00:20:35 -0600484 @unittest.skipUnless(has_textmode, "text mode not available")
Guido van Rossum0e548712002-08-09 16:14:33 +0000485 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000486 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000487
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000488 # A text file is truncated at the first Ctrl+Z byte
489 f = self.do_create(bin=0)
490 f.write(b"blat\x1a")
491 f.write(b"extra\n")
492 os.lseek(f.fd, 0, os.SEEK_SET)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000493 self.assertEqual(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000494
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300495 def make_temp(self):
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700496 return tempfile._mkstemp_inner(tempfile.gettempdir(),
Gregory P. Smithad577b92015-05-22 16:18:14 -0700497 tempfile.gettempprefix(),
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700498 '',
Gregory P. Smithad577b92015-05-22 16:18:14 -0700499 tempfile._bin_openflags,
500 str)
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700501
502 def test_collision_with_existing_file(self):
503 # _mkstemp_inner tries another name when a file with
504 # the chosen name already exists
505 with _inside_empty_temp_dir(), \
506 _mock_candidate_names('aaa', 'aaa', 'bbb'):
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300507 (fd1, name1) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700508 os.close(fd1)
509 self.assertTrue(name1.endswith('aaa'))
510
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300511 (fd2, name2) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700512 os.close(fd2)
513 self.assertTrue(name2.endswith('bbb'))
514
Eli Benderskyf315df32013-09-06 06:11:19 -0700515 def test_collision_with_existing_directory(self):
516 # _mkstemp_inner tries another name when a directory with
517 # the chosen name already exists
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700518 with _inside_empty_temp_dir(), \
519 _mock_candidate_names('aaa', 'aaa', 'bbb'):
520 dir = tempfile.mkdtemp()
521 self.assertTrue(dir.endswith('aaa'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700522
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300523 (fd, name) = self.make_temp()
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700524 os.close(fd)
525 self.assertTrue(name.endswith('bbb'))
Eli Benderskyf315df32013-09-06 06:11:19 -0700526
Guido van Rossum0e548712002-08-09 16:14:33 +0000527
Antoine Pitroueab2a502012-03-10 16:34:40 +0100528class TestGetTempPrefix(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000529 """Test gettempprefix()."""
530
531 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000532 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000533 p = tempfile.gettempprefix()
534
Ezio Melottie9615932010-01-24 19:26:24 +0000535 self.assertIsInstance(p, str)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700536 self.assertGreater(len(p), 0)
537
538 pb = tempfile.gettempprefixb()
539
540 self.assertIsInstance(pb, bytes)
541 self.assertGreater(len(pb), 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000542
543 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000544 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000545
546 # Create a temp directory, avoiding use of the prefix.
547 # Then attempt to create a file whose name is
548 # prefix + 'xxxxxx.xxx' in that directory.
549 p = tempfile.gettempprefix() + "xxxxxx.xxx"
550 d = tempfile.mkdtemp(prefix="")
551 try:
552 p = os.path.join(d, p)
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100553 fd = os.open(p, os.O_RDWR | os.O_CREAT)
Guido van Rossum0e548712002-08-09 16:14:33 +0000554 os.close(fd)
555 os.unlink(p)
556 finally:
557 os.rmdir(d)
558
Guido van Rossum0e548712002-08-09 16:14:33 +0000559
Antoine Pitroueab2a502012-03-10 16:34:40 +0100560class TestGetTempDir(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000561 """Test gettempdir()."""
562
563 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000564 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000565
Gregory P. Smithad577b92015-05-22 16:18:14 -0700566 for d in (tempfile.gettempdir(), tempfile.gettempdirb()):
567 self.assertTrue(os.path.isabs(d) or d == os.curdir,
568 "%r is not an absolute path" % d)
569 self.assertTrue(os.path.isdir(d),
570 "%r is not a directory" % d)
Guido van Rossum0e548712002-08-09 16:14:33 +0000571
572 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000573 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000574
575 # sneaky: just instantiate a NamedTemporaryFile, which
576 # defaults to writing into the directory returned by
577 # gettempdir.
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200578 with tempfile.NamedTemporaryFile() as file:
579 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000580
581 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000582 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000583 a = tempfile.gettempdir()
584 b = tempfile.gettempdir()
Gregory P. Smithad577b92015-05-22 16:18:14 -0700585 c = tempfile.gettempdirb()
Guido van Rossum0e548712002-08-09 16:14:33 +0000586
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000587 self.assertTrue(a is b)
Gregory P. Smithad577b92015-05-22 16:18:14 -0700588 self.assertNotEqual(type(a), type(c))
589 self.assertEqual(a, os.fsdecode(c))
Guido van Rossum0e548712002-08-09 16:14:33 +0000590
Tim Golden6d09f092013-10-25 18:38:16 +0100591 def test_case_sensitive(self):
592 # gettempdir should not flatten its case
593 # even on a case-insensitive file system
594 case_sensitive_tempdir = tempfile.mkdtemp("-Temp")
595 _tempdir, tempfile.tempdir = tempfile.tempdir, None
596 try:
597 with support.EnvironmentVarGuard() as env:
598 # Fake the first env var which is checked as a candidate
599 env["TMPDIR"] = case_sensitive_tempdir
600 self.assertEqual(tempfile.gettempdir(), case_sensitive_tempdir)
601 finally:
602 tempfile.tempdir = _tempdir
603 support.rmdir(case_sensitive_tempdir)
604
Guido van Rossum0e548712002-08-09 16:14:33 +0000605
Antoine Pitroueab2a502012-03-10 16:34:40 +0100606class TestMkstemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000607 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000608
Gregory P. Smithad577b92015-05-22 16:18:14 -0700609 def do_create(self, dir=None, pre=None, suf=None):
610 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000611 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700612 if output_type is str:
613 dir = tempfile.gettempdir()
614 else:
615 dir = tempfile.gettempdirb()
616 if pre is None:
617 pre = output_type()
618 if suf is None:
619 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100620 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
621 (ndir, nbase) = os.path.split(name)
622 adir = os.path.abspath(dir)
623 self.assertEqual(adir, ndir,
624 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000625
626 try:
627 self.nameCheck(name, dir, pre, suf)
628 finally:
629 os.close(fd)
630 os.unlink(name)
631
632 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000633 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000634 self.do_create()
635 self.do_create(pre="a")
636 self.do_create(suf="b")
637 self.do_create(pre="a", suf="b")
638 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000639 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000640
Gregory P. Smithad577b92015-05-22 16:18:14 -0700641 def test_basic_with_bytes_names(self):
642 # mkstemp can create files when given name parts all
643 # specified as bytes.
644 d = tempfile.gettempdirb()
645 self.do_create(dir=d, suf=b"")
646 self.do_create(dir=d, pre=b"a")
647 self.do_create(dir=d, suf=b"b")
648 self.do_create(dir=d, pre=b"a", suf=b"b")
649 self.do_create(dir=d, pre=b"aa", suf=b".txt")
650 self.do_create(dir=b".")
651 with self.assertRaises(TypeError):
652 self.do_create(dir=".", pre=b"aa", suf=b".txt")
653 with self.assertRaises(TypeError):
654 self.do_create(dir=b".", pre="aa", suf=b".txt")
655 with self.assertRaises(TypeError):
656 self.do_create(dir=b".", pre=b"aa", suf=".txt")
657
658
Guido van Rossum0e548712002-08-09 16:14:33 +0000659 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000660 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000661 dir = tempfile.mkdtemp()
662 try:
663 self.do_create(dir=dir)
Anthony Sottile370138b2019-09-09 08:54:34 -0700664 self.do_create(dir=pathlib.Path(dir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000665 finally:
666 os.rmdir(dir)
667
Guido van Rossum0e548712002-08-09 16:14:33 +0000668
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300669class TestMkdtemp(TestBadTempdir, BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000670 """Test mkdtemp()."""
671
Serhiy Storchaka5d6b7b12015-05-20 00:11:48 +0300672 def make_temp(self):
673 return tempfile.mkdtemp()
674
Gregory P. Smithad577b92015-05-22 16:18:14 -0700675 def do_create(self, dir=None, pre=None, suf=None):
676 output_type = tempfile._infer_return_type(dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000677 if dir is None:
Gregory P. Smithad577b92015-05-22 16:18:14 -0700678 if output_type is str:
679 dir = tempfile.gettempdir()
680 else:
681 dir = tempfile.gettempdirb()
682 if pre is None:
683 pre = output_type()
684 if suf is None:
685 suf = output_type()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100686 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000687
688 try:
689 self.nameCheck(name, dir, pre, suf)
690 return name
691 except:
692 os.rmdir(name)
693 raise
694
695 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000696 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000697 os.rmdir(self.do_create())
698 os.rmdir(self.do_create(pre="a"))
699 os.rmdir(self.do_create(suf="b"))
700 os.rmdir(self.do_create(pre="a", suf="b"))
701 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000702
Gregory P. Smithad577b92015-05-22 16:18:14 -0700703 def test_basic_with_bytes_names(self):
704 # mkdtemp can create directories when given all binary parts
705 d = tempfile.gettempdirb()
706 os.rmdir(self.do_create(dir=d))
707 os.rmdir(self.do_create(dir=d, pre=b"a"))
708 os.rmdir(self.do_create(dir=d, suf=b"b"))
709 os.rmdir(self.do_create(dir=d, pre=b"a", suf=b"b"))
710 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=b".txt"))
711 with self.assertRaises(TypeError):
712 os.rmdir(self.do_create(dir=d, pre="aa", suf=b".txt"))
713 with self.assertRaises(TypeError):
714 os.rmdir(self.do_create(dir=d, pre=b"aa", suf=".txt"))
715 with self.assertRaises(TypeError):
716 os.rmdir(self.do_create(dir="", pre=b"aa", suf=b".txt"))
717
Guido van Rossum0e548712002-08-09 16:14:33 +0000718 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000719 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000720 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000721 try:
722 for i in extant:
723 extant[i] = self.do_create(pre="aa")
724 finally:
725 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000726 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000727 os.rmdir(i)
728
729 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000730 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000731 dir = tempfile.mkdtemp()
732 try:
733 os.rmdir(self.do_create(dir=dir))
Anthony Sottile370138b2019-09-09 08:54:34 -0700734 os.rmdir(self.do_create(dir=pathlib.Path(dir)))
Guido van Rossum0e548712002-08-09 16:14:33 +0000735 finally:
736 os.rmdir(dir)
737
738 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000739 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000740
741 dir = self.do_create()
742 try:
743 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000744 mode &= 0o777 # Mask off sticky bits inherited from /tmp
745 expected = 0o700
Jesus Cea4791a242012-10-05 03:15:39 +0200746 if sys.platform == 'win32':
Tim Petersca3ac7f2002-08-09 18:13:51 +0000747 # There's no distinction among 'user', 'group' and 'world';
748 # replicate the 'user' bits.
749 user = expected >> 6
750 expected = user * (1 + 8 + 64)
751 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000752 finally:
753 os.rmdir(dir)
754
Eli Benderskyaa04f9a2013-09-13 05:28:20 -0700755 def test_collision_with_existing_file(self):
756 # mkdtemp tries another name when a file with
757 # the chosen name already exists
758 with _inside_empty_temp_dir(), \
759 _mock_candidate_names('aaa', 'aaa', 'bbb'):
760 file = tempfile.NamedTemporaryFile(delete=False)
761 file.close()
762 self.assertTrue(file.name.endswith('aaa'))
763 dir = tempfile.mkdtemp()
764 self.assertTrue(dir.endswith('bbb'))
765
766 def test_collision_with_existing_directory(self):
767 # mkdtemp tries another name when a directory with
768 # the chosen name already exists
769 with _inside_empty_temp_dir(), \
770 _mock_candidate_names('aaa', 'aaa', 'bbb'):
771 dir1 = tempfile.mkdtemp()
772 self.assertTrue(dir1.endswith('aaa'))
773 dir2 = tempfile.mkdtemp()
774 self.assertTrue(dir2.endswith('bbb'))
775
Guido van Rossum0e548712002-08-09 16:14:33 +0000776
Antoine Pitroueab2a502012-03-10 16:34:40 +0100777class TestMktemp(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000778 """Test mktemp()."""
779
780 # For safety, all use of mktemp must occur in a private directory.
781 # We must also suppress the RuntimeWarning it generates.
782 def setUp(self):
783 self.dir = tempfile.mkdtemp()
Brett Cannone1adece2010-03-20 22:19:55 +0000784 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000785
786 def tearDown(self):
787 if self.dir:
788 os.rmdir(self.dir)
789 self.dir = None
Brett Cannone1adece2010-03-20 22:19:55 +0000790 super().tearDown()
Guido van Rossum0e548712002-08-09 16:14:33 +0000791
792 class mktemped:
793 _unlink = os.unlink
794 _bflags = tempfile._bin_openflags
795
796 def __init__(self, dir, pre, suf):
797 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
798 # Create the file. This will raise an exception if it's
799 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000800 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000801
802 def __del__(self):
803 self._unlink(self.name)
804
805 def do_create(self, pre="", suf=""):
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100806 file = self.mktemped(self.dir, pre, suf)
Guido van Rossum0e548712002-08-09 16:14:33 +0000807
808 self.nameCheck(file.name, self.dir, pre, suf)
809 return file
810
811 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000812 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000813 self.do_create()
814 self.do_create(pre="a")
815 self.do_create(suf="b")
816 self.do_create(pre="a", suf="b")
817 self.do_create(pre="aa", suf=".txt")
818
819 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000820 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000821 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000822 for i in extant:
823 extant[i] = self.do_create(pre="aa")
824
Fred Drake8bec4832002-11-22 20:13:43 +0000825## def test_warning(self):
826## # mktemp issues a warning when used
827## warnings.filterwarnings("error",
828## category=RuntimeWarning,
829## message="mktemp")
830## self.assertRaises(RuntimeWarning,
831## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000832
Guido van Rossum0e548712002-08-09 16:14:33 +0000833
834# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
835
836
Antoine Pitroueab2a502012-03-10 16:34:40 +0100837class TestNamedTemporaryFile(BaseTestCase):
Guido van Rossum0e548712002-08-09 16:14:33 +0000838 """Test NamedTemporaryFile()."""
839
Guido van Rossumd8faa362007-04-27 19:54:29 +0000840 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000841 if dir is None:
842 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100843 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
844 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000845
846 self.nameCheck(file.name, dir, pre, suf)
847 return file
848
849
850 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000851 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000852 self.do_create()
853 self.do_create(pre="a")
854 self.do_create(suf="b")
855 self.do_create(pre="a", suf="b")
856 self.do_create(pre="aa", suf=".txt")
857
Antoine Pitrou17c93262013-12-21 22:14:56 +0100858 def test_method_lookup(self):
859 # Issue #18879: Looking up a temporary file method should keep it
860 # alive long enough.
861 f = self.do_create()
862 wr = weakref.ref(f)
863 write = f.write
864 write2 = f.write
865 del f
866 write(b'foo')
867 del write
868 write2(b'bar')
869 del write2
870 if support.check_impl_detail(cpython=True):
871 # No reference cycle was created.
872 self.assertIsNone(wr())
873
Serhiy Storchaka56cefa62015-03-19 15:23:15 +0200874 def test_iter(self):
875 # Issue #23700: getting iterator from a temporary file should keep
876 # it alive as long as it's being iterated over
877 lines = [b'spam\n', b'eggs\n', b'beans\n']
878 def make_file():
879 f = tempfile.NamedTemporaryFile(mode='w+b')
880 f.write(b''.join(lines))
881 f.seek(0)
882 return f
883 for i, l in enumerate(make_file()):
884 self.assertEqual(l, lines[i])
885 self.assertEqual(i, len(lines) - 1)
886
Guido van Rossum0e548712002-08-09 16:14:33 +0000887 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000888 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000889 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000890 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000891 "NamedTemporaryFile %s does not exist" % f.name)
892
893 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000894 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000895 dir = tempfile.mkdtemp()
896 try:
Serhiy Storchaka5b10b982019-03-05 10:06:26 +0200897 with tempfile.NamedTemporaryFile(dir=dir) as f:
898 f.write(b'blat')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000899 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000900 "NamedTemporaryFile %s exists after close" % f.name)
901 finally:
902 os.rmdir(dir)
903
Guido van Rossumd8faa362007-04-27 19:54:29 +0000904 def test_dis_del_on_close(self):
905 # Tests that delete-on-close can be disabled
906 dir = tempfile.mkdtemp()
907 tmp = None
908 try:
909 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
910 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000911 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000912 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000913 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000914 "NamedTemporaryFile %s missing after close" % f.name)
915 finally:
916 if tmp is not None:
917 os.unlink(tmp)
918 os.rmdir(dir)
919
Guido van Rossum0e548712002-08-09 16:14:33 +0000920 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000921 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000922 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000923 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000924 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100925 f.close()
926 f.close()
Guido van Rossum0e548712002-08-09 16:14:33 +0000927
Christian Heimes3ecfea712008-02-09 20:51:34 +0000928 def test_context_manager(self):
929 # A NamedTemporaryFile can be used as a context manager
930 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000931 self.assertTrue(os.path.exists(f.name))
932 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000933 def use_closed():
934 with f:
935 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000936 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000937
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100938 def test_no_leak_fd(self):
Victor Stinner87d13ea2014-03-25 18:19:17 +0100939 # Issue #21058: don't leak file descriptor when io.open() fails
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100940 closed = []
Victor Stinnerc61c1702014-07-29 01:13:39 +0200941 os_close = os.close
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100942 def close(fd):
943 closed.append(fd)
Victor Stinnerc61c1702014-07-29 01:13:39 +0200944 os_close(fd)
Victor Stinner1f99f9d2014-03-25 09:18:04 +0100945
946 with mock.patch('os.close', side_effect=close):
947 with mock.patch('io.open', side_effect=ValueError):
948 self.assertRaises(ValueError, tempfile.NamedTemporaryFile)
949 self.assertEqual(len(closed), 1)
950
Martin Panter7869a222016-02-28 05:22:20 +0000951 def test_bad_mode(self):
952 dir = tempfile.mkdtemp()
953 self.addCleanup(support.rmtree, dir)
954 with self.assertRaises(ValueError):
955 tempfile.NamedTemporaryFile(mode='wr', dir=dir)
956 with self.assertRaises(TypeError):
957 tempfile.NamedTemporaryFile(mode=2, dir=dir)
958 self.assertEqual(os.listdir(dir), [])
Guido van Rossum0e548712002-08-09 16:14:33 +0000959
Martin Panter7869a222016-02-28 05:22:20 +0000960 # How to test the mode and bufsize parameters?
Guido van Rossum0e548712002-08-09 16:14:33 +0000961
Antoine Pitroueab2a502012-03-10 16:34:40 +0100962class TestSpooledTemporaryFile(BaseTestCase):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000963 """Test SpooledTemporaryFile()."""
964
965 def do_create(self, max_size=0, dir=None, pre="", suf=""):
966 if dir is None:
967 dir = tempfile.gettempdir()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +0100968 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000969
970 return file
971
972
973 def test_basic(self):
974 # SpooledTemporaryFile can create files
975 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000976 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000977 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000978 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000979
980 def test_del_on_close(self):
981 # A SpooledTemporaryFile is deleted when closed
982 dir = tempfile.mkdtemp()
983 try:
984 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000985 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000986 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000987 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000988 filename = f.name
989 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000990 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000991 "SpooledTemporaryFile %s exists after close" % filename)
992 finally:
993 os.rmdir(dir)
994
995 def test_rewrite_small(self):
996 # A SpooledTemporaryFile can be written to multiple within the max_size
997 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000998 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000999 for i in range(5):
1000 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +00001001 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001002 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001003
1004 def test_write_sequential(self):
1005 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1006 # over afterward
1007 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001008 self.assertFalse(f._rolled)
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 Rossum39478e82007-08-27 17:23:59 +00001011 f.write(b'x' * 10)
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')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001014 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001015
R David Murrayd89ee792011-03-14 09:55:46 -04001016 def test_writelines(self):
1017 # Verify writelines with a SpooledTemporaryFile
1018 f = self.do_create()
1019 f.writelines((b'x', b'y', b'z'))
Inada Naoki485e7152020-04-17 15:56:35 +09001020 pos = f.seek(0)
1021 self.assertEqual(pos, 0)
R David Murrayd89ee792011-03-14 09:55:46 -04001022 buf = f.read()
1023 self.assertEqual(buf, b'xyz')
1024
1025 def test_writelines_sequential(self):
1026 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
1027 # over afterward
1028 f = self.do_create(max_size=35)
1029 f.writelines((b'x' * 20, b'x' * 10, b'x' * 5))
1030 self.assertFalse(f._rolled)
1031 f.write(b'x')
1032 self.assertTrue(f._rolled)
1033
Guido van Rossumd8faa362007-04-27 19:54:29 +00001034 def test_sparse(self):
1035 # A SpooledTemporaryFile that is written late in the file will extend
1036 # when that occurs
1037 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001038 self.assertFalse(f._rolled)
Inada Naoki485e7152020-04-17 15:56:35 +09001039 pos = f.seek(100, 0)
1040 self.assertEqual(pos, 100)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001041 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +00001042 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001043 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001044
1045 def test_fileno(self):
1046 # A SpooledTemporaryFile should roll over to a real file on fileno()
1047 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001048 self.assertFalse(f._rolled)
1049 self.assertTrue(f.fileno() > 0)
1050 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001051
Christian Heimes3ecfea712008-02-09 20:51:34 +00001052 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +00001053 # A SpooledTemporaryFile can be closed many times without error
1054 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +00001055 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001056 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001057 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001058 f.close()
1059 f.close()
Christian Heimes3ecfea712008-02-09 20:51:34 +00001060
1061 def test_multiple_close_after_rollover(self):
1062 # A SpooledTemporaryFile can be closed many times without error
1063 f = tempfile.SpooledTemporaryFile(max_size=1)
1064 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001065 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001066 f.close()
Antoine Pitrou8cd8d5e2012-03-10 16:20:24 +01001067 f.close()
1068 f.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +00001069
1070 def test_bound_methods(self):
1071 # It should be OK to steal a bound method from a SpooledTemporaryFile
1072 # and use it independently; when the file rolls over, those bound
1073 # methods should continue to function
1074 f = self.do_create(max_size=30)
1075 read = f.read
1076 write = f.write
1077 seek = f.seek
1078
Guido van Rossum39478e82007-08-27 17:23:59 +00001079 write(b"a" * 35)
1080 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +00001081 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +00001082 self.assertEqual(read(70), b'a'*35 + b'b'*35)
1083
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001084 def test_properties(self):
1085 f = tempfile.SpooledTemporaryFile(max_size=10)
1086 f.write(b'x' * 10)
1087 self.assertFalse(f._rolled)
1088 self.assertEqual(f.mode, 'w+b')
1089 self.assertIsNone(f.name)
1090 with self.assertRaises(AttributeError):
1091 f.newlines
1092 with self.assertRaises(AttributeError):
1093 f.encoding
sth825aab92018-05-23 07:07:01 +02001094 with self.assertRaises(AttributeError):
1095 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001096
1097 f.write(b'x')
1098 self.assertTrue(f._rolled)
1099 self.assertEqual(f.mode, 'rb+')
1100 self.assertIsNotNone(f.name)
1101 with self.assertRaises(AttributeError):
1102 f.newlines
1103 with self.assertRaises(AttributeError):
1104 f.encoding
sth825aab92018-05-23 07:07:01 +02001105 with self.assertRaises(AttributeError):
1106 f.errors
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001107
Guido van Rossum9a634702007-07-09 10:24:45 +00001108 def test_text_mode(self):
1109 # Creating a SpooledTemporaryFile with a text mode should produce
1110 # a file object reading and writing (Unicode) text strings.
Inada Naokiea9835c2019-11-27 22:22:06 +09001111 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
1112 encoding="utf-8")
Guido van Rossum9a634702007-07-09 10:24:45 +00001113 f.write("abc\n")
1114 f.seek(0)
1115 self.assertEqual(f.read(), "abc\n")
1116 f.write("def\n")
1117 f.seek(0)
1118 self.assertEqual(f.read(), "abc\ndef\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001119 self.assertFalse(f._rolled)
1120 self.assertEqual(f.mode, 'w+')
1121 self.assertIsNone(f.name)
Inada Naokiea9835c2019-11-27 22:22:06 +09001122 self.assertEqual(f.newlines, os.linesep)
1123 self.assertEqual(f.encoding, "utf-8")
1124 self.assertEqual(f.errors, "strict")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001125
Guido van Rossum9a634702007-07-09 10:24:45 +00001126 f.write("xyzzy\n")
1127 f.seek(0)
1128 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +00001129 # Check that Ctrl+Z doesn't truncate the file
1130 f.write("foo\x1abar\n")
1131 f.seek(0)
1132 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001133 self.assertTrue(f._rolled)
1134 self.assertEqual(f.mode, 'w+')
1135 self.assertIsNotNone(f.name)
Serhiy Storchaka497cee42013-02-10 14:43:46 +02001136 self.assertEqual(f.newlines, os.linesep)
Inada Naokiea9835c2019-11-27 22:22:06 +09001137 self.assertEqual(f.encoding, "utf-8")
1138 self.assertEqual(f.errors, "strict")
Guido van Rossum9a634702007-07-09 10:24:45 +00001139
Guido van Rossumf0c74162007-08-28 03:29:45 +00001140 def test_text_newline_and_encoding(self):
1141 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
sth825aab92018-05-23 07:07:01 +02001142 newline='', encoding='utf-8',
1143 errors='ignore')
Guido van Rossumf0c74162007-08-28 03:29:45 +00001144 f.write("\u039B\r\n")
1145 f.seek(0)
1146 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001147 self.assertFalse(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001148 self.assertEqual(f.mode, 'w+')
1149 self.assertIsNone(f.name)
Inada Naokiea9835c2019-11-27 22:22:06 +09001150 self.assertIsNotNone(f.newlines)
1151 self.assertEqual(f.encoding, "utf-8")
1152 self.assertEqual(f.errors, "ignore")
Guido van Rossumf0c74162007-08-28 03:29:45 +00001153
Inada Naokiea9835c2019-11-27 22:22:06 +09001154 f.write("\u039C" * 10 + "\r\n")
1155 f.write("\u039D" * 20)
Guido van Rossumf0c74162007-08-28 03:29:45 +00001156 f.seek(0)
Inada Naokiea9835c2019-11-27 22:22:06 +09001157 self.assertEqual(f.read(),
1158 "\u039B\r\n" + ("\u039C" * 10) + "\r\n" + ("\u039D" * 20))
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001159 self.assertTrue(f._rolled)
Serhiy Storchakabbbbe8e2013-02-09 12:21:14 +02001160 self.assertEqual(f.mode, 'w+')
1161 self.assertIsNotNone(f.name)
1162 self.assertIsNotNone(f.newlines)
1163 self.assertEqual(f.encoding, 'utf-8')
sth825aab92018-05-23 07:07:01 +02001164 self.assertEqual(f.errors, 'ignore')
Guido van Rossumd8faa362007-04-27 19:54:29 +00001165
Christian Heimes3ecfea712008-02-09 20:51:34 +00001166 def test_context_manager_before_rollover(self):
1167 # A SpooledTemporaryFile can be used as a context manager
1168 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001169 self.assertFalse(f._rolled)
1170 self.assertFalse(f.closed)
1171 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001172 def use_closed():
1173 with f:
1174 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001175 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001176
1177 def test_context_manager_during_rollover(self):
1178 # A SpooledTemporaryFile can be used as a context manager
1179 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001180 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001181 f.write(b'abc\n')
1182 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001183 self.assertTrue(f._rolled)
1184 self.assertFalse(f.closed)
1185 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001186 def use_closed():
1187 with f:
1188 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001189 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001190
1191 def test_context_manager_after_rollover(self):
1192 # A SpooledTemporaryFile can be used as a context manager
1193 f = tempfile.SpooledTemporaryFile(max_size=1)
1194 f.write(b'abc\n')
1195 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001196 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001197 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001198 self.assertFalse(f.closed)
1199 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001200 def use_closed():
1201 with f:
1202 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +00001203 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001204
Antoine Pitrou0e86a582011-11-25 18:03:09 +01001205 def test_truncate_with_size_parameter(self):
1206 # A SpooledTemporaryFile can be truncated to zero size
1207 f = tempfile.SpooledTemporaryFile(max_size=10)
1208 f.write(b'abcdefg\n')
1209 f.seek(0)
1210 f.truncate()
1211 self.assertFalse(f._rolled)
1212 self.assertEqual(f._file.getvalue(), b'')
1213 # A SpooledTemporaryFile can be truncated to a specific size
1214 f = tempfile.SpooledTemporaryFile(max_size=10)
1215 f.write(b'abcdefg\n')
1216 f.truncate(4)
1217 self.assertFalse(f._rolled)
1218 self.assertEqual(f._file.getvalue(), b'abcd')
1219 # A SpooledTemporaryFile rolls over if truncated to large size
1220 f = tempfile.SpooledTemporaryFile(max_size=10)
1221 f.write(b'abcdefg\n')
1222 f.truncate(20)
1223 self.assertTrue(f._rolled)
Anthony Sottile8377cd42019-02-25 14:32:27 -08001224 self.assertEqual(os.fstat(f.fileno()).st_size, 20)
Christian Heimes3ecfea712008-02-09 20:51:34 +00001225
Batuhan TaĹźkaya09c482f2019-12-30 19:08:08 +03001226 def test_class_getitem(self):
Guido van Rossum48b069a2020-04-07 09:50:06 -07001227 self.assertIsInstance(tempfile.SpooledTemporaryFile[bytes],
1228 types.GenericAlias)
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()