blob: 823c3d4150656d1c5b6760f23830cb1bdfea4542 [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
Guido van Rossum0e548712002-08-09 16:14:33 +00003import os
4import sys
5import re
Guido van Rossum0e548712002-08-09 16:14:33 +00006import warnings
Tim Petersc57a2852001-10-29 21:46:08 +00007
Guido van Rossum0e548712002-08-09 16:14:33 +00008import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +00009from test import support
Guido van Rossum0e548712002-08-09 16:14:33 +000010
Fred Drake7633d232002-10-17 22:09:03 +000011
Guido van Rossum0e548712002-08-09 16:14:33 +000012if hasattr(os, 'stat'):
13 import stat
14 has_stat = 1
15else:
16 has_stat = 0
17
18has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000019has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000020
Neal Norwitz68ee0122002-08-16 19:28:59 +000021# TEST_FILES may need to be tweaked for systems depending on the maximum
22# number of files that can be opened at one time (see ulimit -n)
Jack Jansence921472003-01-08 16:30:34 +000023if sys.platform == 'mac':
24 TEST_FILES = 32
Thomas Wouters89f507f2006-12-13 04:49:30 +000025elif sys.platform in ('openbsd3', 'openbsd4'):
Martin v. Löwis99968282004-09-15 06:02:54 +000026 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000027else:
28 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000029
Guido van Rossum0e548712002-08-09 16:14:33 +000030# This is organized as one test for each chunk of code in tempfile.py,
31# in order of their appearance in the file. Testing which requires
32# threads is not done here.
33
34# Common functionality.
35class TC(unittest.TestCase):
36
37 str_check = re.compile(r"[a-zA-Z0-9_-]{6}$")
38
Brett Cannone1adece2010-03-20 22:19:55 +000039 def setUp(self):
40 self._warnings_manager = support.check_warnings()
41 self._warnings_manager.__enter__()
42 warnings.filterwarnings("ignore", category=RuntimeWarning,
43 message="mktemp", module=__name__)
44
45 def tearDown(self):
46 self._warnings_manager.__exit__(None, None, None)
47
48
Guido van Rossum0e548712002-08-09 16:14:33 +000049 def failOnException(self, what, ei=None):
50 if ei is None:
51 ei = sys.exc_info()
52 self.fail("%s raised %s: %s" % (what, ei[0], ei[1]))
53
54 def nameCheck(self, name, dir, pre, suf):
55 (ndir, nbase) = os.path.split(name)
56 npre = nbase[:len(pre)]
57 nsuf = nbase[len(nbase)-len(suf):]
58
Martin v. Löwisd6625482003-10-12 17:37:01 +000059 # check for equality of the absolute paths!
60 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +000061 "file '%s' not in directory '%s'" % (name, dir))
62 self.assertEqual(npre, pre,
63 "file '%s' does not begin with '%s'" % (nbase, pre))
64 self.assertEqual(nsuf, suf,
65 "file '%s' does not end with '%s'" % (nbase, suf))
66
67 nbase = nbase[len(pre):len(nbase)-len(suf)]
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000068 self.assertTrue(self.str_check.match(nbase),
Guido van Rossum0e548712002-08-09 16:14:33 +000069 "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/"
70 % nbase)
71
72test_classes = []
73
74class test_exports(TC):
75 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +000076 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +000077 dict = tempfile.__dict__
78
79 expected = {
80 "NamedTemporaryFile" : 1,
81 "TemporaryFile" : 1,
82 "mkstemp" : 1,
83 "mkdtemp" : 1,
84 "mktemp" : 1,
85 "TMP_MAX" : 1,
86 "gettempprefix" : 1,
87 "gettempdir" : 1,
88 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +000089 "template" : 1,
90 "SpooledTemporaryFile" : 1
Guido van Rossum0e548712002-08-09 16:14:33 +000091 }
92
93 unexp = []
94 for key in dict:
95 if key[0] != '_' and key not in expected:
96 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000097 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +000098 "unexpected keys: %s" % unexp)
99
100test_classes.append(test_exports)
101
102
Guido van Rossum0e548712002-08-09 16:14:33 +0000103class test__RandomNameSequence(TC):
104 """Test the internal iterator object _RandomNameSequence."""
105
106 def setUp(self):
107 self.r = tempfile._RandomNameSequence()
Brett Cannone1adece2010-03-20 22:19:55 +0000108 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000109
110 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000111 # _RandomNameSequence returns a six-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000112 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000113 self.nameCheck(s, '', '', '')
114
115 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000116 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000117
118 dict = {}
119 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000120 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000121 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000122 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000123 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000124 dict[s] = 1
125
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000126 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000127 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000128
129 i = 0
130 r = self.r
131 try:
132 for s in r:
133 i += 1
134 if i == 20:
135 break
136 except:
Georg Brandl89fad142010-03-14 10:23:39 +0000137 self.failOnException("iteration")
Guido van Rossum0e548712002-08-09 16:14:33 +0000138
139test_classes.append(test__RandomNameSequence)
140
141
142class test__candidate_tempdir_list(TC):
143 """Test the internal function _candidate_tempdir_list."""
144
145 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000146 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000147
148 cand = tempfile._candidate_tempdir_list()
149
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000150 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000151 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000152 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000153
154 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000155 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000156
157 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000158 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000159 for envname in 'TMPDIR', 'TEMP', 'TMP':
160 dirname = os.getenv(envname)
161 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000162 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000163
164 cand = tempfile._candidate_tempdir_list()
165
166 for envname in 'TMPDIR', 'TEMP', 'TMP':
167 dirname = os.getenv(envname)
168 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000169 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000170
171 try:
172 dirname = os.getcwd()
173 except (AttributeError, os.error):
174 dirname = os.curdir
175
Benjamin Peterson577473f2010-01-19 00:09:57 +0000176 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000177
178 # Not practical to try to verify the presence of OS-specific
179 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000180
181test_classes.append(test__candidate_tempdir_list)
182
183
184# We test _get_default_tempdir by testing gettempdir.
185
186
187class test__get_candidate_names(TC):
188 """Test the internal function _get_candidate_names."""
189
190 def test_retval(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000191 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000192 obj = tempfile._get_candidate_names()
Ezio Melottie9615932010-01-24 19:26:24 +0000193 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000194
195 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000196 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000197 a = tempfile._get_candidate_names()
198 b = tempfile._get_candidate_names()
199
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000200 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000201
202test_classes.append(test__get_candidate_names)
203
204
205class test__mkstemp_inner(TC):
206 """Test the internal function _mkstemp_inner."""
207
208 class mkstemped:
209 _bflags = tempfile._bin_openflags
210 _tflags = tempfile._text_openflags
211 _close = os.close
212 _unlink = os.unlink
213
214 def __init__(self, dir, pre, suf, bin):
215 if bin: flags = self._bflags
216 else: flags = self._tflags
217
218 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags)
219
220 def write(self, str):
221 os.write(self.fd, str)
222
223 def __del__(self):
224 self._close(self.fd)
225 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000226
Guido van Rossum0e548712002-08-09 16:14:33 +0000227 def do_create(self, dir=None, pre="", suf="", bin=1):
228 if dir is None:
229 dir = tempfile.gettempdir()
230 try:
231 file = self.mkstemped(dir, pre, suf, bin)
232 except:
233 self.failOnException("_mkstemp_inner")
234
235 self.nameCheck(file.name, dir, pre, suf)
236 return file
237
238 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000239 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000240 self.do_create().write(b"blat")
241 self.do_create(pre="a").write(b"blat")
242 self.do_create(suf="b").write(b"blat")
243 self.do_create(pre="a", suf="b").write(b"blat")
244 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000245
246 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000247 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000248 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000249 for i in extant:
250 extant[i] = self.do_create(pre="aa")
251
252 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000253 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000254 dir = tempfile.mkdtemp()
255 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000256 self.do_create(dir=dir).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000257 finally:
258 os.rmdir(dir)
259
260 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000261 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000262 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000263 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000264
265 file = self.do_create()
266 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000267 expected = 0o600
Jack Jansence921472003-01-08 16:30:34 +0000268 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000269 # There's no distinction among 'user', 'group' and 'world';
270 # replicate the 'user' bits.
271 user = expected >> 6
272 expected = user * (1 + 8 + 64)
273 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000274
275 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000276 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum78741062002-08-17 11:41:01 +0000277 if not has_spawnl:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000278 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000279
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000280 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000281 v="v"
282 else:
283 v="q"
284
Guido van Rossum0e548712002-08-09 16:14:33 +0000285 file = self.do_create()
Guido van Rossum78741062002-08-17 11:41:01 +0000286 fd = "%d" % file.fd
287
288 try:
289 me = __file__
290 except NameError:
291 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000292
293 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000294 # effect. The core of this test is therefore in
295 # tf_inherit_check.py, which see.
296 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
297 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000298
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000299 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
300 # but an arg with embedded spaces should be decorated with double
301 # quotes on each end
Christian Heimes895627f2007-12-08 17:28:33 +0000302 if sys.platform in ('win32',):
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000303 decorated = '"%s"' % sys.executable
304 tester = '"%s"' % tester
305 else:
306 decorated = sys.executable
307
308 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000309 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000310 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000311 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000312
313 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000314 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000315 if not has_textmode:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000316 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000317
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000318 # A text file is truncated at the first Ctrl+Z byte
319 f = self.do_create(bin=0)
320 f.write(b"blat\x1a")
321 f.write(b"extra\n")
322 os.lseek(f.fd, 0, os.SEEK_SET)
323 self.assertEquals(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000324
325test_classes.append(test__mkstemp_inner)
326
327
328class test_gettempprefix(TC):
329 """Test gettempprefix()."""
330
331 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000332 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000333 p = tempfile.gettempprefix()
334
Ezio Melottie9615932010-01-24 19:26:24 +0000335 self.assertIsInstance(p, str)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000336 self.assertTrue(len(p) > 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000337
338 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000339 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000340
341 # Create a temp directory, avoiding use of the prefix.
342 # Then attempt to create a file whose name is
343 # prefix + 'xxxxxx.xxx' in that directory.
344 p = tempfile.gettempprefix() + "xxxxxx.xxx"
345 d = tempfile.mkdtemp(prefix="")
346 try:
347 p = os.path.join(d, p)
348 try:
349 fd = os.open(p, os.O_RDWR | os.O_CREAT)
350 except:
351 self.failOnException("os.open")
352 os.close(fd)
353 os.unlink(p)
354 finally:
355 os.rmdir(d)
356
357test_classes.append(test_gettempprefix)
358
359
360class test_gettempdir(TC):
361 """Test gettempdir()."""
362
363 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000364 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000365
366 dir = tempfile.gettempdir()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000367 self.assertTrue(os.path.isabs(dir) or dir == os.curdir,
Guido van Rossum0e548712002-08-09 16:14:33 +0000368 "%s is not an absolute path" % dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000369 self.assertTrue(os.path.isdir(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +0000370 "%s is not a directory" % dir)
371
372 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000373 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000374
375 # sneaky: just instantiate a NamedTemporaryFile, which
376 # defaults to writing into the directory returned by
377 # gettempdir.
378 try:
379 file = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000380 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000381 file.close()
382 except:
383 self.failOnException("create file in %s" % tempfile.gettempdir())
384
385 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000386 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000387 a = tempfile.gettempdir()
388 b = tempfile.gettempdir()
389
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000390 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000391
392test_classes.append(test_gettempdir)
393
394
395class test_mkstemp(TC):
396 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000397
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000398 def do_create(self, dir=None, pre="", suf=""):
Guido van Rossum0e548712002-08-09 16:14:33 +0000399 if dir is None:
400 dir = tempfile.gettempdir()
401 try:
402 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
Martin v. Löwisd6625482003-10-12 17:37:01 +0000403 (ndir, nbase) = os.path.split(name)
404 adir = os.path.abspath(dir)
405 self.assertEqual(adir, ndir,
406 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000407 except:
408 self.failOnException("mkstemp")
409
410 try:
411 self.nameCheck(name, dir, pre, suf)
412 finally:
413 os.close(fd)
414 os.unlink(name)
415
416 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000417 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000418 self.do_create()
419 self.do_create(pre="a")
420 self.do_create(suf="b")
421 self.do_create(pre="a", suf="b")
422 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000423 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000424
425 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000426 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000427 dir = tempfile.mkdtemp()
428 try:
429 self.do_create(dir=dir)
430 finally:
431 os.rmdir(dir)
432
433test_classes.append(test_mkstemp)
434
435
436class test_mkdtemp(TC):
437 """Test mkdtemp()."""
438
439 def do_create(self, dir=None, pre="", suf=""):
440 if dir is None:
441 dir = tempfile.gettempdir()
442 try:
443 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
444 except:
445 self.failOnException("mkdtemp")
446
447 try:
448 self.nameCheck(name, dir, pre, suf)
449 return name
450 except:
451 os.rmdir(name)
452 raise
453
454 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000455 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000456 os.rmdir(self.do_create())
457 os.rmdir(self.do_create(pre="a"))
458 os.rmdir(self.do_create(suf="b"))
459 os.rmdir(self.do_create(pre="a", suf="b"))
460 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000461
Guido van Rossum0e548712002-08-09 16:14:33 +0000462 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000463 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000464 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000465 try:
466 for i in extant:
467 extant[i] = self.do_create(pre="aa")
468 finally:
469 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000470 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000471 os.rmdir(i)
472
473 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000474 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000475 dir = tempfile.mkdtemp()
476 try:
477 os.rmdir(self.do_create(dir=dir))
478 finally:
479 os.rmdir(dir)
480
481 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000482 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000483 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000484 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000485
486 dir = self.do_create()
487 try:
488 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000489 mode &= 0o777 # Mask off sticky bits inherited from /tmp
490 expected = 0o700
Jack Jansence921472003-01-08 16:30:34 +0000491 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000492 # There's no distinction among 'user', 'group' and 'world';
493 # replicate the 'user' bits.
494 user = expected >> 6
495 expected = user * (1 + 8 + 64)
496 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000497 finally:
498 os.rmdir(dir)
499
500test_classes.append(test_mkdtemp)
501
502
503class test_mktemp(TC):
504 """Test mktemp()."""
505
506 # For safety, all use of mktemp must occur in a private directory.
507 # We must also suppress the RuntimeWarning it generates.
508 def setUp(self):
509 self.dir = tempfile.mkdtemp()
Brett Cannone1adece2010-03-20 22:19:55 +0000510 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000511
512 def tearDown(self):
513 if self.dir:
514 os.rmdir(self.dir)
515 self.dir = None
Brett Cannone1adece2010-03-20 22:19:55 +0000516 super().tearDown()
Guido van Rossum0e548712002-08-09 16:14:33 +0000517
518 class mktemped:
519 _unlink = os.unlink
520 _bflags = tempfile._bin_openflags
521
522 def __init__(self, dir, pre, suf):
523 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
524 # Create the file. This will raise an exception if it's
525 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000526 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000527
528 def __del__(self):
529 self._unlink(self.name)
530
531 def do_create(self, pre="", suf=""):
532 try:
533 file = self.mktemped(self.dir, pre, suf)
534 except:
535 self.failOnException("mktemp")
536
537 self.nameCheck(file.name, self.dir, pre, suf)
538 return file
539
540 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000541 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000542 self.do_create()
543 self.do_create(pre="a")
544 self.do_create(suf="b")
545 self.do_create(pre="a", suf="b")
546 self.do_create(pre="aa", suf=".txt")
547
548 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000549 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000550 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000551 for i in extant:
552 extant[i] = self.do_create(pre="aa")
553
Fred Drake8bec4832002-11-22 20:13:43 +0000554## def test_warning(self):
555## # mktemp issues a warning when used
556## warnings.filterwarnings("error",
557## category=RuntimeWarning,
558## message="mktemp")
559## self.assertRaises(RuntimeWarning,
560## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000561
562test_classes.append(test_mktemp)
563
564
565# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
566
567
568class test_NamedTemporaryFile(TC):
569 """Test NamedTemporaryFile()."""
570
Guido van Rossumd8faa362007-04-27 19:54:29 +0000571 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000572 if dir is None:
573 dir = tempfile.gettempdir()
574 try:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000575 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
576 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000577 except:
578 self.failOnException("NamedTemporaryFile")
579
580 self.nameCheck(file.name, dir, pre, suf)
581 return file
582
583
584 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000585 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000586 self.do_create()
587 self.do_create(pre="a")
588 self.do_create(suf="b")
589 self.do_create(pre="a", suf="b")
590 self.do_create(pre="aa", suf=".txt")
591
592 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000593 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000594 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000595 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000596 "NamedTemporaryFile %s does not exist" % f.name)
597
598 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000599 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000600 dir = tempfile.mkdtemp()
601 try:
602 f = tempfile.NamedTemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000603 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000604 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000605 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000606 "NamedTemporaryFile %s exists after close" % f.name)
607 finally:
608 os.rmdir(dir)
609
Guido van Rossumd8faa362007-04-27 19:54:29 +0000610 def test_dis_del_on_close(self):
611 # Tests that delete-on-close can be disabled
612 dir = tempfile.mkdtemp()
613 tmp = None
614 try:
615 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
616 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000617 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000618 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000619 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000620 "NamedTemporaryFile %s missing after close" % f.name)
621 finally:
622 if tmp is not None:
623 os.unlink(tmp)
624 os.rmdir(dir)
625
Guido van Rossum0e548712002-08-09 16:14:33 +0000626 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000627 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000628 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000629 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000630 f.close()
631 try:
632 f.close()
633 f.close()
634 except:
635 self.failOnException("close")
636
Christian Heimes3ecfea712008-02-09 20:51:34 +0000637 def test_context_manager(self):
638 # A NamedTemporaryFile can be used as a context manager
639 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000640 self.assertTrue(os.path.exists(f.name))
641 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000642 def use_closed():
643 with f:
644 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000645 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000646
Guido van Rossum0e548712002-08-09 16:14:33 +0000647 # How to test the mode and bufsize parameters?
648
649test_classes.append(test_NamedTemporaryFile)
650
Guido van Rossumd8faa362007-04-27 19:54:29 +0000651class test_SpooledTemporaryFile(TC):
652 """Test SpooledTemporaryFile()."""
653
654 def do_create(self, max_size=0, dir=None, pre="", suf=""):
655 if dir is None:
656 dir = tempfile.gettempdir()
657 try:
658 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
659 except:
660 self.failOnException("SpooledTemporaryFile")
661
662 return file
663
664
665 def test_basic(self):
666 # SpooledTemporaryFile can create files
667 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000668 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000669 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000670 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000671
672 def test_del_on_close(self):
673 # A SpooledTemporaryFile is deleted when closed
674 dir = tempfile.mkdtemp()
675 try:
676 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000677 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000678 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000679 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000680 filename = f.name
681 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000682 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000683 "SpooledTemporaryFile %s exists after close" % filename)
684 finally:
685 os.rmdir(dir)
686
687 def test_rewrite_small(self):
688 # A SpooledTemporaryFile can be written to multiple within the max_size
689 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000690 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000691 for i in range(5):
692 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +0000693 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000694 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000695
696 def test_write_sequential(self):
697 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
698 # over afterward
699 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000700 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000701 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000702 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000703 f.write(b'x' * 10)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000704 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000705 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000706 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000707
708 def test_sparse(self):
709 # A SpooledTemporaryFile that is written late in the file will extend
710 # when that occurs
711 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000712 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000713 f.seek(100, 0)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000714 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000715 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000716 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000717
718 def test_fileno(self):
719 # A SpooledTemporaryFile should roll over to a real file on fileno()
720 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000721 self.assertFalse(f._rolled)
722 self.assertTrue(f.fileno() > 0)
723 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000724
Christian Heimes3ecfea712008-02-09 20:51:34 +0000725 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000726 # A SpooledTemporaryFile can be closed many times without error
727 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +0000728 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000729 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000730 f.close()
731 try:
732 f.close()
733 f.close()
734 except:
735 self.failOnException("close")
736
737 def test_multiple_close_after_rollover(self):
738 # A SpooledTemporaryFile can be closed many times without error
739 f = tempfile.SpooledTemporaryFile(max_size=1)
740 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000741 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000742 f.close()
743 try:
744 f.close()
745 f.close()
746 except:
747 self.failOnException("close")
748
749 def test_bound_methods(self):
750 # It should be OK to steal a bound method from a SpooledTemporaryFile
751 # and use it independently; when the file rolls over, those bound
752 # methods should continue to function
753 f = self.do_create(max_size=30)
754 read = f.read
755 write = f.write
756 seek = f.seek
757
Guido van Rossum39478e82007-08-27 17:23:59 +0000758 write(b"a" * 35)
759 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000760 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +0000761 self.assertEqual(read(70), b'a'*35 + b'b'*35)
762
763 def test_text_mode(self):
764 # Creating a SpooledTemporaryFile with a text mode should produce
765 # a file object reading and writing (Unicode) text strings.
766 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10)
767 f.write("abc\n")
768 f.seek(0)
769 self.assertEqual(f.read(), "abc\n")
770 f.write("def\n")
771 f.seek(0)
772 self.assertEqual(f.read(), "abc\ndef\n")
773 f.write("xyzzy\n")
774 f.seek(0)
775 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000776 # Check that Ctrl+Z doesn't truncate the file
777 f.write("foo\x1abar\n")
778 f.seek(0)
779 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Guido van Rossum9a634702007-07-09 10:24:45 +0000780
Guido van Rossumf0c74162007-08-28 03:29:45 +0000781 def test_text_newline_and_encoding(self):
782 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
783 newline='', encoding='utf-8')
784 f.write("\u039B\r\n")
785 f.seek(0)
786 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000787 self.assertFalse(f._rolled)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000788
789 f.write("\u039B" * 20 + "\r\n")
790 f.seek(0)
791 self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000792 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000793
Christian Heimes3ecfea712008-02-09 20:51:34 +0000794 def test_context_manager_before_rollover(self):
795 # A SpooledTemporaryFile can be used as a context manager
796 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000797 self.assertFalse(f._rolled)
798 self.assertFalse(f.closed)
799 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000800 def use_closed():
801 with f:
802 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000803 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000804
805 def test_context_manager_during_rollover(self):
806 # A SpooledTemporaryFile can be used as a context manager
807 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000808 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000809 f.write(b'abc\n')
810 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000811 self.assertTrue(f._rolled)
812 self.assertFalse(f.closed)
813 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000814 def use_closed():
815 with f:
816 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000817 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000818
819 def test_context_manager_after_rollover(self):
820 # A SpooledTemporaryFile can be used as a context manager
821 f = tempfile.SpooledTemporaryFile(max_size=1)
822 f.write(b'abc\n')
823 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000824 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000825 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000826 self.assertFalse(f.closed)
827 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000828 def use_closed():
829 with f:
830 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000831 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000832
833
Guido van Rossumd8faa362007-04-27 19:54:29 +0000834test_classes.append(test_SpooledTemporaryFile)
835
Guido van Rossum0e548712002-08-09 16:14:33 +0000836
837class test_TemporaryFile(TC):
838 """Test TemporaryFile()."""
839
840 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000841 # TemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000842 # No point in testing the name params - the file has no name.
843 try:
844 tempfile.TemporaryFile()
845 except:
846 self.failOnException("TemporaryFile")
847
848 def test_has_no_name(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000849 # TemporaryFile creates files with no names (on this system)
Guido van Rossum0e548712002-08-09 16:14:33 +0000850 dir = tempfile.mkdtemp()
851 f = tempfile.TemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000852 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000853
854 # Sneaky: because this file has no name, it should not prevent
855 # us from removing the directory it was created in.
856 try:
857 os.rmdir(dir)
858 except:
859 ei = sys.exc_info()
860 # cleanup
861 f.close()
862 os.rmdir(dir)
863 self.failOnException("rmdir", ei)
864
865 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000866 # A TemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000867 f = tempfile.TemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000868 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000869 f.close()
870 try:
871 f.close()
872 f.close()
873 except:
874 self.failOnException("close")
875
876 # How to test the mode and bufsize parameters?
Guido van Rossumf0c74162007-08-28 03:29:45 +0000877 def test_mode_and_encoding(self):
878
879 def roundtrip(input, *args, **kwargs):
880 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
881 fileobj.write(input)
882 fileobj.seek(0)
883 self.assertEquals(input, fileobj.read())
884
885 roundtrip(b"1234", "w+b")
886 roundtrip("abdc\n", "w+")
887 roundtrip("\u039B", "w+", encoding="utf-16")
888 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +0000889
Guido van Rossum0e548712002-08-09 16:14:33 +0000890
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000891if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Guido van Rossum0e548712002-08-09 16:14:33 +0000892 test_classes.append(test_TemporaryFile)
893
894def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000895 support.run_unittest(*test_classes)
Guido van Rossum0e548712002-08-09 16:14:33 +0000896
897if __name__ == "__main__":
898 test_main()