blob: 5b6a42091e914957429687a19e883862dfb46b65 [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
6import errno
7import warnings
Tim Petersc57a2852001-10-29 21:46:08 +00008
Guido van Rossum0e548712002-08-09 16:14:33 +00009import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +000010from test import support
Guido van Rossum0e548712002-08-09 16:14:33 +000011
Fred Drake7633d232002-10-17 22:09:03 +000012warnings.filterwarnings("ignore",
13 category=RuntimeWarning,
14 message="mktemp", module=__name__)
15
Guido van Rossum0e548712002-08-09 16:14:33 +000016if hasattr(os, 'stat'):
17 import stat
18 has_stat = 1
19else:
20 has_stat = 0
21
22has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000023has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000024
Neal Norwitz68ee0122002-08-16 19:28:59 +000025# TEST_FILES may need to be tweaked for systems depending on the maximum
26# number of files that can be opened at one time (see ulimit -n)
Jack Jansence921472003-01-08 16:30:34 +000027if sys.platform == 'mac':
28 TEST_FILES = 32
Thomas Wouters89f507f2006-12-13 04:49:30 +000029elif sys.platform in ('openbsd3', 'openbsd4'):
Martin v. Löwis99968282004-09-15 06:02:54 +000030 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000031else:
32 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000033
Guido van Rossum0e548712002-08-09 16:14:33 +000034# This is organized as one test for each chunk of code in tempfile.py,
35# in order of their appearance in the file. Testing which requires
36# threads is not done here.
37
38# Common functionality.
39class TC(unittest.TestCase):
40
41 str_check = re.compile(r"[a-zA-Z0-9_-]{6}$")
42
43 def failOnException(self, what, ei=None):
44 if ei is None:
45 ei = sys.exc_info()
46 self.fail("%s raised %s: %s" % (what, ei[0], ei[1]))
47
48 def nameCheck(self, name, dir, pre, suf):
49 (ndir, nbase) = os.path.split(name)
50 npre = nbase[:len(pre)]
51 nsuf = nbase[len(nbase)-len(suf):]
52
Martin v. Löwisd6625482003-10-12 17:37:01 +000053 # check for equality of the absolute paths!
54 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +000055 "file '%s' not in directory '%s'" % (name, dir))
56 self.assertEqual(npre, pre,
57 "file '%s' does not begin with '%s'" % (nbase, pre))
58 self.assertEqual(nsuf, suf,
59 "file '%s' does not end with '%s'" % (nbase, suf))
60
61 nbase = nbase[len(pre):len(nbase)-len(suf)]
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000062 self.assertTrue(self.str_check.match(nbase),
Guido van Rossum0e548712002-08-09 16:14:33 +000063 "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/"
64 % nbase)
65
66test_classes = []
67
68class test_exports(TC):
69 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +000070 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +000071 dict = tempfile.__dict__
72
73 expected = {
74 "NamedTemporaryFile" : 1,
75 "TemporaryFile" : 1,
76 "mkstemp" : 1,
77 "mkdtemp" : 1,
78 "mktemp" : 1,
79 "TMP_MAX" : 1,
80 "gettempprefix" : 1,
81 "gettempdir" : 1,
82 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +000083 "template" : 1,
84 "SpooledTemporaryFile" : 1
Guido van Rossum0e548712002-08-09 16:14:33 +000085 }
86
87 unexp = []
88 for key in dict:
89 if key[0] != '_' and key not in expected:
90 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000091 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +000092 "unexpected keys: %s" % unexp)
93
94test_classes.append(test_exports)
95
96
Guido van Rossum0e548712002-08-09 16:14:33 +000097class test__RandomNameSequence(TC):
98 """Test the internal iterator object _RandomNameSequence."""
99
100 def setUp(self):
101 self.r = tempfile._RandomNameSequence()
102
103 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000104 # _RandomNameSequence returns a six-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000105 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000106 self.nameCheck(s, '', '', '')
107
108 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000109 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000110
111 dict = {}
112 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000113 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000114 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000115 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000116 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000117 dict[s] = 1
118
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000119 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000120 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000121
122 i = 0
123 r = self.r
124 try:
125 for s in r:
126 i += 1
127 if i == 20:
128 break
129 except:
Georg Brandl89fad142010-03-14 10:23:39 +0000130 self.failOnException("iteration")
Guido van Rossum0e548712002-08-09 16:14:33 +0000131
132test_classes.append(test__RandomNameSequence)
133
134
135class test__candidate_tempdir_list(TC):
136 """Test the internal function _candidate_tempdir_list."""
137
138 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000139 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000140
141 cand = tempfile._candidate_tempdir_list()
142
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000143 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000144 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000145 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000146
147 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000148 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000149
150 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000151 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000152 for envname in 'TMPDIR', 'TEMP', 'TMP':
153 dirname = os.getenv(envname)
154 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000155 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000156
157 cand = tempfile._candidate_tempdir_list()
158
159 for envname in 'TMPDIR', 'TEMP', 'TMP':
160 dirname = os.getenv(envname)
161 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000162 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000163
164 try:
165 dirname = os.getcwd()
166 except (AttributeError, os.error):
167 dirname = os.curdir
168
Benjamin Peterson577473f2010-01-19 00:09:57 +0000169 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000170
171 # Not practical to try to verify the presence of OS-specific
172 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000173
174test_classes.append(test__candidate_tempdir_list)
175
176
177# We test _get_default_tempdir by testing gettempdir.
178
179
180class test__get_candidate_names(TC):
181 """Test the internal function _get_candidate_names."""
182
183 def test_retval(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000184 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000185 obj = tempfile._get_candidate_names()
Ezio Melottie9615932010-01-24 19:26:24 +0000186 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000187
188 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000189 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000190 a = tempfile._get_candidate_names()
191 b = tempfile._get_candidate_names()
192
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000193 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000194
195test_classes.append(test__get_candidate_names)
196
197
198class test__mkstemp_inner(TC):
199 """Test the internal function _mkstemp_inner."""
200
201 class mkstemped:
202 _bflags = tempfile._bin_openflags
203 _tflags = tempfile._text_openflags
204 _close = os.close
205 _unlink = os.unlink
206
207 def __init__(self, dir, pre, suf, bin):
208 if bin: flags = self._bflags
209 else: flags = self._tflags
210
211 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags)
212
213 def write(self, str):
214 os.write(self.fd, str)
215
216 def __del__(self):
217 self._close(self.fd)
218 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000219
Guido van Rossum0e548712002-08-09 16:14:33 +0000220 def do_create(self, dir=None, pre="", suf="", bin=1):
221 if dir is None:
222 dir = tempfile.gettempdir()
223 try:
224 file = self.mkstemped(dir, pre, suf, bin)
225 except:
226 self.failOnException("_mkstemp_inner")
227
228 self.nameCheck(file.name, dir, pre, suf)
229 return file
230
231 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000232 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000233 self.do_create().write(b"blat")
234 self.do_create(pre="a").write(b"blat")
235 self.do_create(suf="b").write(b"blat")
236 self.do_create(pre="a", suf="b").write(b"blat")
237 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000238
239 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000240 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000241 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000242 for i in extant:
243 extant[i] = self.do_create(pre="aa")
244
245 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000246 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000247 dir = tempfile.mkdtemp()
248 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000249 self.do_create(dir=dir).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000250 finally:
251 os.rmdir(dir)
252
253 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000254 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000255 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000256 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000257
258 file = self.do_create()
259 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000260 expected = 0o600
Jack Jansence921472003-01-08 16:30:34 +0000261 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000262 # There's no distinction among 'user', 'group' and 'world';
263 # replicate the 'user' bits.
264 user = expected >> 6
265 expected = user * (1 + 8 + 64)
266 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000267
268 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000269 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum78741062002-08-17 11:41:01 +0000270 if not has_spawnl:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000271 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000272
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000273 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000274 v="v"
275 else:
276 v="q"
277
Guido van Rossum0e548712002-08-09 16:14:33 +0000278 file = self.do_create()
Guido van Rossum78741062002-08-17 11:41:01 +0000279 fd = "%d" % file.fd
280
281 try:
282 me = __file__
283 except NameError:
284 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000285
286 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000287 # effect. The core of this test is therefore in
288 # tf_inherit_check.py, which see.
289 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
290 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000291
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000292 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
293 # but an arg with embedded spaces should be decorated with double
294 # quotes on each end
Christian Heimes895627f2007-12-08 17:28:33 +0000295 if sys.platform in ('win32',):
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000296 decorated = '"%s"' % sys.executable
297 tester = '"%s"' % tester
298 else:
299 decorated = sys.executable
300
301 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000302 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000303 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000304 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000305
306 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000307 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000308 if not has_textmode:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000309 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000310
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000311 # A text file is truncated at the first Ctrl+Z byte
312 f = self.do_create(bin=0)
313 f.write(b"blat\x1a")
314 f.write(b"extra\n")
315 os.lseek(f.fd, 0, os.SEEK_SET)
316 self.assertEquals(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000317
318test_classes.append(test__mkstemp_inner)
319
320
321class test_gettempprefix(TC):
322 """Test gettempprefix()."""
323
324 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000325 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000326 p = tempfile.gettempprefix()
327
Ezio Melottie9615932010-01-24 19:26:24 +0000328 self.assertIsInstance(p, str)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000329 self.assertTrue(len(p) > 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000330
331 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000332 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000333
334 # Create a temp directory, avoiding use of the prefix.
335 # Then attempt to create a file whose name is
336 # prefix + 'xxxxxx.xxx' in that directory.
337 p = tempfile.gettempprefix() + "xxxxxx.xxx"
338 d = tempfile.mkdtemp(prefix="")
339 try:
340 p = os.path.join(d, p)
341 try:
342 fd = os.open(p, os.O_RDWR | os.O_CREAT)
343 except:
344 self.failOnException("os.open")
345 os.close(fd)
346 os.unlink(p)
347 finally:
348 os.rmdir(d)
349
350test_classes.append(test_gettempprefix)
351
352
353class test_gettempdir(TC):
354 """Test gettempdir()."""
355
356 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000357 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000358
359 dir = tempfile.gettempdir()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000360 self.assertTrue(os.path.isabs(dir) or dir == os.curdir,
Guido van Rossum0e548712002-08-09 16:14:33 +0000361 "%s is not an absolute path" % dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000362 self.assertTrue(os.path.isdir(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +0000363 "%s is not a directory" % dir)
364
365 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000366 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000367
368 # sneaky: just instantiate a NamedTemporaryFile, which
369 # defaults to writing into the directory returned by
370 # gettempdir.
371 try:
372 file = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000373 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000374 file.close()
375 except:
376 self.failOnException("create file in %s" % tempfile.gettempdir())
377
378 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000379 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000380 a = tempfile.gettempdir()
381 b = tempfile.gettempdir()
382
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000383 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000384
385test_classes.append(test_gettempdir)
386
387
388class test_mkstemp(TC):
389 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000390
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000391 def do_create(self, dir=None, pre="", suf=""):
Guido van Rossum0e548712002-08-09 16:14:33 +0000392 if dir is None:
393 dir = tempfile.gettempdir()
394 try:
395 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
Martin v. Löwisd6625482003-10-12 17:37:01 +0000396 (ndir, nbase) = os.path.split(name)
397 adir = os.path.abspath(dir)
398 self.assertEqual(adir, ndir,
399 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000400 except:
401 self.failOnException("mkstemp")
402
403 try:
404 self.nameCheck(name, dir, pre, suf)
405 finally:
406 os.close(fd)
407 os.unlink(name)
408
409 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000410 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000411 self.do_create()
412 self.do_create(pre="a")
413 self.do_create(suf="b")
414 self.do_create(pre="a", suf="b")
415 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000416 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000417
418 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000419 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000420 dir = tempfile.mkdtemp()
421 try:
422 self.do_create(dir=dir)
423 finally:
424 os.rmdir(dir)
425
426test_classes.append(test_mkstemp)
427
428
429class test_mkdtemp(TC):
430 """Test mkdtemp()."""
431
432 def do_create(self, dir=None, pre="", suf=""):
433 if dir is None:
434 dir = tempfile.gettempdir()
435 try:
436 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
437 except:
438 self.failOnException("mkdtemp")
439
440 try:
441 self.nameCheck(name, dir, pre, suf)
442 return name
443 except:
444 os.rmdir(name)
445 raise
446
447 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000448 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000449 os.rmdir(self.do_create())
450 os.rmdir(self.do_create(pre="a"))
451 os.rmdir(self.do_create(suf="b"))
452 os.rmdir(self.do_create(pre="a", suf="b"))
453 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000454
Guido van Rossum0e548712002-08-09 16:14:33 +0000455 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000456 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000457 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000458 try:
459 for i in extant:
460 extant[i] = self.do_create(pre="aa")
461 finally:
462 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000463 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000464 os.rmdir(i)
465
466 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000467 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000468 dir = tempfile.mkdtemp()
469 try:
470 os.rmdir(self.do_create(dir=dir))
471 finally:
472 os.rmdir(dir)
473
474 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000475 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000476 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000477 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000478
479 dir = self.do_create()
480 try:
481 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000482 mode &= 0o777 # Mask off sticky bits inherited from /tmp
483 expected = 0o700
Jack Jansence921472003-01-08 16:30:34 +0000484 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000485 # There's no distinction among 'user', 'group' and 'world';
486 # replicate the 'user' bits.
487 user = expected >> 6
488 expected = user * (1 + 8 + 64)
489 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000490 finally:
491 os.rmdir(dir)
492
493test_classes.append(test_mkdtemp)
494
495
496class test_mktemp(TC):
497 """Test mktemp()."""
498
499 # For safety, all use of mktemp must occur in a private directory.
500 # We must also suppress the RuntimeWarning it generates.
501 def setUp(self):
502 self.dir = tempfile.mkdtemp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000503
504 def tearDown(self):
505 if self.dir:
506 os.rmdir(self.dir)
507 self.dir = None
Guido van Rossum0e548712002-08-09 16:14:33 +0000508
509 class mktemped:
510 _unlink = os.unlink
511 _bflags = tempfile._bin_openflags
512
513 def __init__(self, dir, pre, suf):
514 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
515 # Create the file. This will raise an exception if it's
516 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000517 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000518
519 def __del__(self):
520 self._unlink(self.name)
521
522 def do_create(self, pre="", suf=""):
523 try:
524 file = self.mktemped(self.dir, pre, suf)
525 except:
526 self.failOnException("mktemp")
527
528 self.nameCheck(file.name, self.dir, pre, suf)
529 return file
530
531 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000532 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000533 self.do_create()
534 self.do_create(pre="a")
535 self.do_create(suf="b")
536 self.do_create(pre="a", suf="b")
537 self.do_create(pre="aa", suf=".txt")
538
539 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000540 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000541 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000542 for i in extant:
543 extant[i] = self.do_create(pre="aa")
544
Fred Drake8bec4832002-11-22 20:13:43 +0000545## def test_warning(self):
546## # mktemp issues a warning when used
547## warnings.filterwarnings("error",
548## category=RuntimeWarning,
549## message="mktemp")
550## self.assertRaises(RuntimeWarning,
551## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000552
553test_classes.append(test_mktemp)
554
555
556# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
557
558
559class test_NamedTemporaryFile(TC):
560 """Test NamedTemporaryFile()."""
561
Guido van Rossumd8faa362007-04-27 19:54:29 +0000562 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000563 if dir is None:
564 dir = tempfile.gettempdir()
565 try:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000566 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
567 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000568 except:
569 self.failOnException("NamedTemporaryFile")
570
571 self.nameCheck(file.name, dir, pre, suf)
572 return file
573
574
575 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000576 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000577 self.do_create()
578 self.do_create(pre="a")
579 self.do_create(suf="b")
580 self.do_create(pre="a", suf="b")
581 self.do_create(pre="aa", suf=".txt")
582
583 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000584 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000585 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000586 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000587 "NamedTemporaryFile %s does not exist" % f.name)
588
589 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000590 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000591 dir = tempfile.mkdtemp()
592 try:
593 f = tempfile.NamedTemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000594 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000595 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000596 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000597 "NamedTemporaryFile %s exists after close" % f.name)
598 finally:
599 os.rmdir(dir)
600
Guido van Rossumd8faa362007-04-27 19:54:29 +0000601 def test_dis_del_on_close(self):
602 # Tests that delete-on-close can be disabled
603 dir = tempfile.mkdtemp()
604 tmp = None
605 try:
606 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
607 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000608 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000609 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000610 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000611 "NamedTemporaryFile %s missing after close" % f.name)
612 finally:
613 if tmp is not None:
614 os.unlink(tmp)
615 os.rmdir(dir)
616
Guido van Rossum0e548712002-08-09 16:14:33 +0000617 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000618 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000619 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000620 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000621 f.close()
622 try:
623 f.close()
624 f.close()
625 except:
626 self.failOnException("close")
627
Christian Heimes3ecfea712008-02-09 20:51:34 +0000628 def test_context_manager(self):
629 # A NamedTemporaryFile can be used as a context manager
630 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000631 self.assertTrue(os.path.exists(f.name))
632 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000633 def use_closed():
634 with f:
635 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000636 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000637
Guido van Rossum0e548712002-08-09 16:14:33 +0000638 # How to test the mode and bufsize parameters?
639
640test_classes.append(test_NamedTemporaryFile)
641
Guido van Rossumd8faa362007-04-27 19:54:29 +0000642class test_SpooledTemporaryFile(TC):
643 """Test SpooledTemporaryFile()."""
644
645 def do_create(self, max_size=0, dir=None, pre="", suf=""):
646 if dir is None:
647 dir = tempfile.gettempdir()
648 try:
649 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
650 except:
651 self.failOnException("SpooledTemporaryFile")
652
653 return file
654
655
656 def test_basic(self):
657 # SpooledTemporaryFile can create files
658 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000659 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000660 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000661 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000662
663 def test_del_on_close(self):
664 # A SpooledTemporaryFile is deleted when closed
665 dir = tempfile.mkdtemp()
666 try:
667 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000668 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000669 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000670 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000671 filename = f.name
672 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000673 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000674 "SpooledTemporaryFile %s exists after close" % filename)
675 finally:
676 os.rmdir(dir)
677
678 def test_rewrite_small(self):
679 # A SpooledTemporaryFile can be written to multiple within the max_size
680 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000681 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000682 for i in range(5):
683 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +0000684 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000685 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000686
687 def test_write_sequential(self):
688 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
689 # over afterward
690 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000691 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000692 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000693 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000694 f.write(b'x' * 10)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000695 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000696 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000697 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000698
699 def test_sparse(self):
700 # A SpooledTemporaryFile that is written late in the file will extend
701 # when that occurs
702 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000703 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000704 f.seek(100, 0)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000705 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000706 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000707 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000708
709 def test_fileno(self):
710 # A SpooledTemporaryFile should roll over to a real file on fileno()
711 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000712 self.assertFalse(f._rolled)
713 self.assertTrue(f.fileno() > 0)
714 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000715
Christian Heimes3ecfea712008-02-09 20:51:34 +0000716 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000717 # A SpooledTemporaryFile can be closed many times without error
718 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +0000719 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000720 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000721 f.close()
722 try:
723 f.close()
724 f.close()
725 except:
726 self.failOnException("close")
727
728 def test_multiple_close_after_rollover(self):
729 # A SpooledTemporaryFile can be closed many times without error
730 f = tempfile.SpooledTemporaryFile(max_size=1)
731 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000732 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000733 f.close()
734 try:
735 f.close()
736 f.close()
737 except:
738 self.failOnException("close")
739
740 def test_bound_methods(self):
741 # It should be OK to steal a bound method from a SpooledTemporaryFile
742 # and use it independently; when the file rolls over, those bound
743 # methods should continue to function
744 f = self.do_create(max_size=30)
745 read = f.read
746 write = f.write
747 seek = f.seek
748
Guido van Rossum39478e82007-08-27 17:23:59 +0000749 write(b"a" * 35)
750 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000751 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +0000752 self.assertEqual(read(70), b'a'*35 + b'b'*35)
753
754 def test_text_mode(self):
755 # Creating a SpooledTemporaryFile with a text mode should produce
756 # a file object reading and writing (Unicode) text strings.
757 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10)
758 f.write("abc\n")
759 f.seek(0)
760 self.assertEqual(f.read(), "abc\n")
761 f.write("def\n")
762 f.seek(0)
763 self.assertEqual(f.read(), "abc\ndef\n")
764 f.write("xyzzy\n")
765 f.seek(0)
766 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000767 # Check that Ctrl+Z doesn't truncate the file
768 f.write("foo\x1abar\n")
769 f.seek(0)
770 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Guido van Rossum9a634702007-07-09 10:24:45 +0000771
Guido van Rossumf0c74162007-08-28 03:29:45 +0000772 def test_text_newline_and_encoding(self):
773 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
774 newline='', encoding='utf-8')
775 f.write("\u039B\r\n")
776 f.seek(0)
777 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000778 self.assertFalse(f._rolled)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000779
780 f.write("\u039B" * 20 + "\r\n")
781 f.seek(0)
782 self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000783 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000784
Christian Heimes3ecfea712008-02-09 20:51:34 +0000785 def test_context_manager_before_rollover(self):
786 # A SpooledTemporaryFile can be used as a context manager
787 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000788 self.assertFalse(f._rolled)
789 self.assertFalse(f.closed)
790 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000791 def use_closed():
792 with f:
793 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000794 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000795
796 def test_context_manager_during_rollover(self):
797 # A SpooledTemporaryFile can be used as a context manager
798 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000799 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000800 f.write(b'abc\n')
801 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000802 self.assertTrue(f._rolled)
803 self.assertFalse(f.closed)
804 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000805 def use_closed():
806 with f:
807 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000808 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000809
810 def test_context_manager_after_rollover(self):
811 # A SpooledTemporaryFile can be used as a context manager
812 f = tempfile.SpooledTemporaryFile(max_size=1)
813 f.write(b'abc\n')
814 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000815 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000816 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000817 self.assertFalse(f.closed)
818 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000819 def use_closed():
820 with f:
821 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000822 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000823
824
Guido van Rossumd8faa362007-04-27 19:54:29 +0000825test_classes.append(test_SpooledTemporaryFile)
826
Guido van Rossum0e548712002-08-09 16:14:33 +0000827
828class test_TemporaryFile(TC):
829 """Test TemporaryFile()."""
830
831 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000832 # TemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000833 # No point in testing the name params - the file has no name.
834 try:
835 tempfile.TemporaryFile()
836 except:
837 self.failOnException("TemporaryFile")
838
839 def test_has_no_name(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000840 # TemporaryFile creates files with no names (on this system)
Guido van Rossum0e548712002-08-09 16:14:33 +0000841 dir = tempfile.mkdtemp()
842 f = tempfile.TemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000843 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000844
845 # Sneaky: because this file has no name, it should not prevent
846 # us from removing the directory it was created in.
847 try:
848 os.rmdir(dir)
849 except:
850 ei = sys.exc_info()
851 # cleanup
852 f.close()
853 os.rmdir(dir)
854 self.failOnException("rmdir", ei)
855
856 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000857 # A TemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000858 f = tempfile.TemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000859 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000860 f.close()
861 try:
862 f.close()
863 f.close()
864 except:
865 self.failOnException("close")
866
867 # How to test the mode and bufsize parameters?
Guido van Rossumf0c74162007-08-28 03:29:45 +0000868 def test_mode_and_encoding(self):
869
870 def roundtrip(input, *args, **kwargs):
871 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
872 fileobj.write(input)
873 fileobj.seek(0)
874 self.assertEquals(input, fileobj.read())
875
876 roundtrip(b"1234", "w+b")
877 roundtrip("abdc\n", "w+")
878 roundtrip("\u039B", "w+", encoding="utf-16")
879 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +0000880
Guido van Rossum0e548712002-08-09 16:14:33 +0000881
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000882if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Guido van Rossum0e548712002-08-09 16:14:33 +0000883 test_classes.append(test_TemporaryFile)
884
885def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000886 support.run_unittest(*test_classes)
Guido van Rossum0e548712002-08-09 16:14:33 +0000887
888if __name__ == "__main__":
889 test_main()