blob: b0976d225aeebcc35111122741bce6819d3dd84f [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)
Ronald Oussoren94f25282010-05-05 19:11:21 +000023if sys.platform in ('openbsd3', 'openbsd4'):
Martin v. Löwis99968282004-09-15 06:02:54 +000024 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000025else:
26 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000027
Guido van Rossum0e548712002-08-09 16:14:33 +000028# This is organized as one test for each chunk of code in tempfile.py,
29# in order of their appearance in the file. Testing which requires
30# threads is not done here.
31
32# Common functionality.
33class TC(unittest.TestCase):
34
35 str_check = re.compile(r"[a-zA-Z0-9_-]{6}$")
36
Brett Cannone1adece2010-03-20 22:19:55 +000037 def setUp(self):
38 self._warnings_manager = support.check_warnings()
39 self._warnings_manager.__enter__()
40 warnings.filterwarnings("ignore", category=RuntimeWarning,
41 message="mktemp", module=__name__)
42
43 def tearDown(self):
44 self._warnings_manager.__exit__(None, None, None)
45
46
Guido van Rossum0e548712002-08-09 16:14:33 +000047 def failOnException(self, what, ei=None):
48 if ei is None:
49 ei = sys.exc_info()
50 self.fail("%s raised %s: %s" % (what, ei[0], ei[1]))
51
52 def nameCheck(self, name, dir, pre, suf):
53 (ndir, nbase) = os.path.split(name)
54 npre = nbase[:len(pre)]
55 nsuf = nbase[len(nbase)-len(suf):]
56
Martin v. Löwisd6625482003-10-12 17:37:01 +000057 # check for equality of the absolute paths!
58 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +000059 "file '%s' not in directory '%s'" % (name, dir))
60 self.assertEqual(npre, pre,
61 "file '%s' does not begin with '%s'" % (nbase, pre))
62 self.assertEqual(nsuf, suf,
63 "file '%s' does not end with '%s'" % (nbase, suf))
64
65 nbase = nbase[len(pre):len(nbase)-len(suf)]
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000066 self.assertTrue(self.str_check.match(nbase),
Guido van Rossum0e548712002-08-09 16:14:33 +000067 "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/"
68 % nbase)
69
70test_classes = []
71
72class test_exports(TC):
73 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +000074 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +000075 dict = tempfile.__dict__
76
77 expected = {
78 "NamedTemporaryFile" : 1,
79 "TemporaryFile" : 1,
80 "mkstemp" : 1,
81 "mkdtemp" : 1,
82 "mktemp" : 1,
83 "TMP_MAX" : 1,
84 "gettempprefix" : 1,
85 "gettempdir" : 1,
86 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +000087 "template" : 1,
88 "SpooledTemporaryFile" : 1
Guido van Rossum0e548712002-08-09 16:14:33 +000089 }
90
91 unexp = []
92 for key in dict:
93 if key[0] != '_' and key not in expected:
94 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000095 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +000096 "unexpected keys: %s" % unexp)
97
98test_classes.append(test_exports)
99
100
Guido van Rossum0e548712002-08-09 16:14:33 +0000101class test__RandomNameSequence(TC):
102 """Test the internal iterator object _RandomNameSequence."""
103
104 def setUp(self):
105 self.r = tempfile._RandomNameSequence()
Brett Cannone1adece2010-03-20 22:19:55 +0000106 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000107
108 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000109 # _RandomNameSequence returns a six-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000110 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000111 self.nameCheck(s, '', '', '')
112
113 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000114 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000115
116 dict = {}
117 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000118 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000119 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000120 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000121 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000122 dict[s] = 1
123
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000124 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000125 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000126
127 i = 0
128 r = self.r
129 try:
130 for s in r:
131 i += 1
132 if i == 20:
133 break
134 except:
Georg Brandl89fad142010-03-14 10:23:39 +0000135 self.failOnException("iteration")
Guido van Rossum0e548712002-08-09 16:14:33 +0000136
137test_classes.append(test__RandomNameSequence)
138
139
140class test__candidate_tempdir_list(TC):
141 """Test the internal function _candidate_tempdir_list."""
142
143 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000144 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000145
146 cand = tempfile._candidate_tempdir_list()
147
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000148 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000149 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000150 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000151
152 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000153 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000154
155 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000156 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000157 for envname in 'TMPDIR', 'TEMP', 'TMP':
158 dirname = os.getenv(envname)
159 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000160 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000161
162 cand = tempfile._candidate_tempdir_list()
163
164 for envname in 'TMPDIR', 'TEMP', 'TMP':
165 dirname = os.getenv(envname)
166 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000167 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000168
169 try:
170 dirname = os.getcwd()
171 except (AttributeError, os.error):
172 dirname = os.curdir
173
Benjamin Peterson577473f2010-01-19 00:09:57 +0000174 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000175
176 # Not practical to try to verify the presence of OS-specific
177 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000178
179test_classes.append(test__candidate_tempdir_list)
180
181
182# We test _get_default_tempdir by testing gettempdir.
183
184
185class test__get_candidate_names(TC):
186 """Test the internal function _get_candidate_names."""
187
188 def test_retval(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000189 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000190 obj = tempfile._get_candidate_names()
Ezio Melottie9615932010-01-24 19:26:24 +0000191 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000192
193 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000194 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000195 a = tempfile._get_candidate_names()
196 b = tempfile._get_candidate_names()
197
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000198 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000199
200test_classes.append(test__get_candidate_names)
201
202
203class test__mkstemp_inner(TC):
204 """Test the internal function _mkstemp_inner."""
205
206 class mkstemped:
207 _bflags = tempfile._bin_openflags
208 _tflags = tempfile._text_openflags
209 _close = os.close
210 _unlink = os.unlink
211
212 def __init__(self, dir, pre, suf, bin):
213 if bin: flags = self._bflags
214 else: flags = self._tflags
215
216 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags)
217
218 def write(self, str):
219 os.write(self.fd, str)
220
221 def __del__(self):
222 self._close(self.fd)
223 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000224
Guido van Rossum0e548712002-08-09 16:14:33 +0000225 def do_create(self, dir=None, pre="", suf="", bin=1):
226 if dir is None:
227 dir = tempfile.gettempdir()
228 try:
229 file = self.mkstemped(dir, pre, suf, bin)
230 except:
231 self.failOnException("_mkstemp_inner")
232
233 self.nameCheck(file.name, dir, pre, suf)
234 return file
235
236 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000237 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000238 self.do_create().write(b"blat")
239 self.do_create(pre="a").write(b"blat")
240 self.do_create(suf="b").write(b"blat")
241 self.do_create(pre="a", suf="b").write(b"blat")
242 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000243
244 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000245 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000246 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000247 for i in extant:
248 extant[i] = self.do_create(pre="aa")
249
250 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000251 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000252 dir = tempfile.mkdtemp()
253 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000254 self.do_create(dir=dir).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000255 finally:
256 os.rmdir(dir)
257
258 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000259 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000260 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000261 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000262
263 file = self.do_create()
264 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000265 expected = 0o600
Ronald Oussoren94f25282010-05-05 19:11:21 +0000266 if sys.platform in ('win32', 'os2emx'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000267 # There's no distinction among 'user', 'group' and 'world';
268 # replicate the 'user' bits.
269 user = expected >> 6
270 expected = user * (1 + 8 + 64)
271 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000272
273 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000274 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum78741062002-08-17 11:41:01 +0000275 if not has_spawnl:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000276 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000277
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000278 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000279 v="v"
280 else:
281 v="q"
282
Guido van Rossum0e548712002-08-09 16:14:33 +0000283 file = self.do_create()
Guido van Rossum78741062002-08-17 11:41:01 +0000284 fd = "%d" % file.fd
285
286 try:
287 me = __file__
288 except NameError:
289 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000290
291 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000292 # effect. The core of this test is therefore in
293 # tf_inherit_check.py, which see.
294 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
295 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000296
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000297 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
298 # but an arg with embedded spaces should be decorated with double
299 # quotes on each end
Christian Heimes895627f2007-12-08 17:28:33 +0000300 if sys.platform in ('win32',):
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000301 decorated = '"%s"' % sys.executable
302 tester = '"%s"' % tester
303 else:
304 decorated = sys.executable
305
306 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000307 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000308 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000309 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000310
311 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000312 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000313 if not has_textmode:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000314 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000315
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000316 # A text file is truncated at the first Ctrl+Z byte
317 f = self.do_create(bin=0)
318 f.write(b"blat\x1a")
319 f.write(b"extra\n")
320 os.lseek(f.fd, 0, os.SEEK_SET)
321 self.assertEquals(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000322
323test_classes.append(test__mkstemp_inner)
324
325
326class test_gettempprefix(TC):
327 """Test gettempprefix()."""
328
329 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000330 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000331 p = tempfile.gettempprefix()
332
Ezio Melottie9615932010-01-24 19:26:24 +0000333 self.assertIsInstance(p, str)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000334 self.assertTrue(len(p) > 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000335
336 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000337 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000338
339 # Create a temp directory, avoiding use of the prefix.
340 # Then attempt to create a file whose name is
341 # prefix + 'xxxxxx.xxx' in that directory.
342 p = tempfile.gettempprefix() + "xxxxxx.xxx"
343 d = tempfile.mkdtemp(prefix="")
344 try:
345 p = os.path.join(d, p)
346 try:
347 fd = os.open(p, os.O_RDWR | os.O_CREAT)
348 except:
349 self.failOnException("os.open")
350 os.close(fd)
351 os.unlink(p)
352 finally:
353 os.rmdir(d)
354
355test_classes.append(test_gettempprefix)
356
357
358class test_gettempdir(TC):
359 """Test gettempdir()."""
360
361 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000362 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000363
364 dir = tempfile.gettempdir()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000365 self.assertTrue(os.path.isabs(dir) or dir == os.curdir,
Guido van Rossum0e548712002-08-09 16:14:33 +0000366 "%s is not an absolute path" % dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000367 self.assertTrue(os.path.isdir(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +0000368 "%s is not a directory" % dir)
369
370 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000371 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000372
373 # sneaky: just instantiate a NamedTemporaryFile, which
374 # defaults to writing into the directory returned by
375 # gettempdir.
376 try:
377 file = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000378 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000379 file.close()
380 except:
381 self.failOnException("create file in %s" % tempfile.gettempdir())
382
383 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000384 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000385 a = tempfile.gettempdir()
386 b = tempfile.gettempdir()
387
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000388 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000389
390test_classes.append(test_gettempdir)
391
392
393class test_mkstemp(TC):
394 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000395
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000396 def do_create(self, dir=None, pre="", suf=""):
Guido van Rossum0e548712002-08-09 16:14:33 +0000397 if dir is None:
398 dir = tempfile.gettempdir()
399 try:
400 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
Martin v. Löwisd6625482003-10-12 17:37:01 +0000401 (ndir, nbase) = os.path.split(name)
402 adir = os.path.abspath(dir)
403 self.assertEqual(adir, ndir,
404 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000405 except:
406 self.failOnException("mkstemp")
407
408 try:
409 self.nameCheck(name, dir, pre, suf)
410 finally:
411 os.close(fd)
412 os.unlink(name)
413
414 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000415 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000416 self.do_create()
417 self.do_create(pre="a")
418 self.do_create(suf="b")
419 self.do_create(pre="a", suf="b")
420 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000421 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000422
423 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000424 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000425 dir = tempfile.mkdtemp()
426 try:
427 self.do_create(dir=dir)
428 finally:
429 os.rmdir(dir)
430
431test_classes.append(test_mkstemp)
432
433
434class test_mkdtemp(TC):
435 """Test mkdtemp()."""
436
437 def do_create(self, dir=None, pre="", suf=""):
438 if dir is None:
439 dir = tempfile.gettempdir()
440 try:
441 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
442 except:
443 self.failOnException("mkdtemp")
444
445 try:
446 self.nameCheck(name, dir, pre, suf)
447 return name
448 except:
449 os.rmdir(name)
450 raise
451
452 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000453 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000454 os.rmdir(self.do_create())
455 os.rmdir(self.do_create(pre="a"))
456 os.rmdir(self.do_create(suf="b"))
457 os.rmdir(self.do_create(pre="a", suf="b"))
458 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000459
Guido van Rossum0e548712002-08-09 16:14:33 +0000460 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000461 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000462 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000463 try:
464 for i in extant:
465 extant[i] = self.do_create(pre="aa")
466 finally:
467 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000468 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000469 os.rmdir(i)
470
471 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000472 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000473 dir = tempfile.mkdtemp()
474 try:
475 os.rmdir(self.do_create(dir=dir))
476 finally:
477 os.rmdir(dir)
478
479 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000480 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000481 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000482 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000483
484 dir = self.do_create()
485 try:
486 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000487 mode &= 0o777 # Mask off sticky bits inherited from /tmp
488 expected = 0o700
Ronald Oussoren94f25282010-05-05 19:11:21 +0000489 if sys.platform in ('win32', 'os2emx'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000490 # There's no distinction among 'user', 'group' and 'world';
491 # replicate the 'user' bits.
492 user = expected >> 6
493 expected = user * (1 + 8 + 64)
494 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000495 finally:
496 os.rmdir(dir)
497
498test_classes.append(test_mkdtemp)
499
500
501class test_mktemp(TC):
502 """Test mktemp()."""
503
504 # For safety, all use of mktemp must occur in a private directory.
505 # We must also suppress the RuntimeWarning it generates.
506 def setUp(self):
507 self.dir = tempfile.mkdtemp()
Brett Cannone1adece2010-03-20 22:19:55 +0000508 super().setUp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000509
510 def tearDown(self):
511 if self.dir:
512 os.rmdir(self.dir)
513 self.dir = None
Brett Cannone1adece2010-03-20 22:19:55 +0000514 super().tearDown()
Guido van Rossum0e548712002-08-09 16:14:33 +0000515
516 class mktemped:
517 _unlink = os.unlink
518 _bflags = tempfile._bin_openflags
519
520 def __init__(self, dir, pre, suf):
521 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
522 # Create the file. This will raise an exception if it's
523 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000524 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000525
526 def __del__(self):
527 self._unlink(self.name)
528
529 def do_create(self, pre="", suf=""):
530 try:
531 file = self.mktemped(self.dir, pre, suf)
532 except:
533 self.failOnException("mktemp")
534
535 self.nameCheck(file.name, self.dir, pre, suf)
536 return file
537
538 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000539 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000540 self.do_create()
541 self.do_create(pre="a")
542 self.do_create(suf="b")
543 self.do_create(pre="a", suf="b")
544 self.do_create(pre="aa", suf=".txt")
545
546 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000547 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000548 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000549 for i in extant:
550 extant[i] = self.do_create(pre="aa")
551
Fred Drake8bec4832002-11-22 20:13:43 +0000552## def test_warning(self):
553## # mktemp issues a warning when used
554## warnings.filterwarnings("error",
555## category=RuntimeWarning,
556## message="mktemp")
557## self.assertRaises(RuntimeWarning,
558## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000559
560test_classes.append(test_mktemp)
561
562
563# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
564
565
566class test_NamedTemporaryFile(TC):
567 """Test NamedTemporaryFile()."""
568
Guido van Rossumd8faa362007-04-27 19:54:29 +0000569 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000570 if dir is None:
571 dir = tempfile.gettempdir()
572 try:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000573 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
574 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000575 except:
576 self.failOnException("NamedTemporaryFile")
577
578 self.nameCheck(file.name, dir, pre, suf)
579 return file
580
581
582 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000583 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000584 self.do_create()
585 self.do_create(pre="a")
586 self.do_create(suf="b")
587 self.do_create(pre="a", suf="b")
588 self.do_create(pre="aa", suf=".txt")
589
590 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000591 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000592 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000593 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000594 "NamedTemporaryFile %s does not exist" % f.name)
595
596 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000597 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000598 dir = tempfile.mkdtemp()
599 try:
600 f = tempfile.NamedTemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000601 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000602 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000603 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000604 "NamedTemporaryFile %s exists after close" % f.name)
605 finally:
606 os.rmdir(dir)
607
Guido van Rossumd8faa362007-04-27 19:54:29 +0000608 def test_dis_del_on_close(self):
609 # Tests that delete-on-close can be disabled
610 dir = tempfile.mkdtemp()
611 tmp = None
612 try:
613 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
614 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000615 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000616 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000617 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000618 "NamedTemporaryFile %s missing after close" % f.name)
619 finally:
620 if tmp is not None:
621 os.unlink(tmp)
622 os.rmdir(dir)
623
Guido van Rossum0e548712002-08-09 16:14:33 +0000624 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000625 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000626 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000627 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000628 f.close()
629 try:
630 f.close()
631 f.close()
632 except:
633 self.failOnException("close")
634
Christian Heimes3ecfea712008-02-09 20:51:34 +0000635 def test_context_manager(self):
636 # A NamedTemporaryFile can be used as a context manager
637 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000638 self.assertTrue(os.path.exists(f.name))
639 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000640 def use_closed():
641 with f:
642 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000643 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000644
Guido van Rossum0e548712002-08-09 16:14:33 +0000645 # How to test the mode and bufsize parameters?
646
647test_classes.append(test_NamedTemporaryFile)
648
Guido van Rossumd8faa362007-04-27 19:54:29 +0000649class test_SpooledTemporaryFile(TC):
650 """Test SpooledTemporaryFile()."""
651
652 def do_create(self, max_size=0, dir=None, pre="", suf=""):
653 if dir is None:
654 dir = tempfile.gettempdir()
655 try:
656 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
657 except:
658 self.failOnException("SpooledTemporaryFile")
659
660 return file
661
662
663 def test_basic(self):
664 # SpooledTemporaryFile can create files
665 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000666 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000667 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000668 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000669
670 def test_del_on_close(self):
671 # A SpooledTemporaryFile is deleted when closed
672 dir = tempfile.mkdtemp()
673 try:
674 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000675 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000676 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000677 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000678 filename = f.name
679 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000680 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000681 "SpooledTemporaryFile %s exists after close" % filename)
682 finally:
683 os.rmdir(dir)
684
685 def test_rewrite_small(self):
686 # A SpooledTemporaryFile can be written to multiple within the max_size
687 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000688 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000689 for i in range(5):
690 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +0000691 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000692 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000693
694 def test_write_sequential(self):
695 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
696 # over afterward
697 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000698 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000699 f.write(b'x' * 20)
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' * 10)
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')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000704 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000705
706 def test_sparse(self):
707 # A SpooledTemporaryFile that is written late in the file will extend
708 # when that occurs
709 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000710 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000711 f.seek(100, 0)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000712 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000713 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000714 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000715
716 def test_fileno(self):
717 # A SpooledTemporaryFile should roll over to a real file on fileno()
718 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000719 self.assertFalse(f._rolled)
720 self.assertTrue(f.fileno() > 0)
721 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000722
Christian Heimes3ecfea712008-02-09 20:51:34 +0000723 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000724 # A SpooledTemporaryFile can be closed many times without error
725 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +0000726 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000727 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000728 f.close()
729 try:
730 f.close()
731 f.close()
732 except:
733 self.failOnException("close")
734
735 def test_multiple_close_after_rollover(self):
736 # A SpooledTemporaryFile can be closed many times without error
737 f = tempfile.SpooledTemporaryFile(max_size=1)
738 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000739 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000740 f.close()
741 try:
742 f.close()
743 f.close()
744 except:
745 self.failOnException("close")
746
747 def test_bound_methods(self):
748 # It should be OK to steal a bound method from a SpooledTemporaryFile
749 # and use it independently; when the file rolls over, those bound
750 # methods should continue to function
751 f = self.do_create(max_size=30)
752 read = f.read
753 write = f.write
754 seek = f.seek
755
Guido van Rossum39478e82007-08-27 17:23:59 +0000756 write(b"a" * 35)
757 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000758 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +0000759 self.assertEqual(read(70), b'a'*35 + b'b'*35)
760
761 def test_text_mode(self):
762 # Creating a SpooledTemporaryFile with a text mode should produce
763 # a file object reading and writing (Unicode) text strings.
764 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10)
765 f.write("abc\n")
766 f.seek(0)
767 self.assertEqual(f.read(), "abc\n")
768 f.write("def\n")
769 f.seek(0)
770 self.assertEqual(f.read(), "abc\ndef\n")
771 f.write("xyzzy\n")
772 f.seek(0)
773 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000774 # Check that Ctrl+Z doesn't truncate the file
775 f.write("foo\x1abar\n")
776 f.seek(0)
777 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Guido van Rossum9a634702007-07-09 10:24:45 +0000778
Guido van Rossumf0c74162007-08-28 03:29:45 +0000779 def test_text_newline_and_encoding(self):
780 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
781 newline='', encoding='utf-8')
782 f.write("\u039B\r\n")
783 f.seek(0)
784 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000785 self.assertFalse(f._rolled)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000786
787 f.write("\u039B" * 20 + "\r\n")
788 f.seek(0)
789 self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000790 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000791
Christian Heimes3ecfea712008-02-09 20:51:34 +0000792 def test_context_manager_before_rollover(self):
793 # A SpooledTemporaryFile can be used as a context manager
794 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000795 self.assertFalse(f._rolled)
796 self.assertFalse(f.closed)
797 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000798 def use_closed():
799 with f:
800 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000801 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000802
803 def test_context_manager_during_rollover(self):
804 # A SpooledTemporaryFile can be used as a context manager
805 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000806 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000807 f.write(b'abc\n')
808 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000809 self.assertTrue(f._rolled)
810 self.assertFalse(f.closed)
811 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000812 def use_closed():
813 with f:
814 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000815 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000816
817 def test_context_manager_after_rollover(self):
818 # A SpooledTemporaryFile can be used as a context manager
819 f = tempfile.SpooledTemporaryFile(max_size=1)
820 f.write(b'abc\n')
821 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000822 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000823 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000824 self.assertFalse(f.closed)
825 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000826 def use_closed():
827 with f:
828 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000829 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000830
831
Guido van Rossumd8faa362007-04-27 19:54:29 +0000832test_classes.append(test_SpooledTemporaryFile)
833
Guido van Rossum0e548712002-08-09 16:14:33 +0000834
835class test_TemporaryFile(TC):
836 """Test TemporaryFile()."""
837
838 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000839 # TemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000840 # No point in testing the name params - the file has no name.
841 try:
842 tempfile.TemporaryFile()
843 except:
844 self.failOnException("TemporaryFile")
845
846 def test_has_no_name(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000847 # TemporaryFile creates files with no names (on this system)
Guido van Rossum0e548712002-08-09 16:14:33 +0000848 dir = tempfile.mkdtemp()
849 f = tempfile.TemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000850 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000851
852 # Sneaky: because this file has no name, it should not prevent
853 # us from removing the directory it was created in.
854 try:
855 os.rmdir(dir)
856 except:
857 ei = sys.exc_info()
858 # cleanup
859 f.close()
860 os.rmdir(dir)
861 self.failOnException("rmdir", ei)
862
863 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000864 # A TemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000865 f = tempfile.TemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000866 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000867 f.close()
868 try:
869 f.close()
870 f.close()
871 except:
872 self.failOnException("close")
873
874 # How to test the mode and bufsize parameters?
Guido van Rossumf0c74162007-08-28 03:29:45 +0000875 def test_mode_and_encoding(self):
876
877 def roundtrip(input, *args, **kwargs):
878 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
879 fileobj.write(input)
880 fileobj.seek(0)
881 self.assertEquals(input, fileobj.read())
882
883 roundtrip(b"1234", "w+b")
884 roundtrip("abdc\n", "w+")
885 roundtrip("\u039B", "w+", encoding="utf-16")
886 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +0000887
Guido van Rossum0e548712002-08-09 16:14:33 +0000888
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000889if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Guido van Rossum0e548712002-08-09 16:14:33 +0000890 test_classes.append(test_TemporaryFile)
891
892def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000893 support.run_unittest(*test_classes)
Guido van Rossum0e548712002-08-09 16:14:33 +0000894
895if __name__ == "__main__":
896 test_main()