blob: 0dd8fc4dd0088e564db28d2e27f3ace4f1a3bdc7 [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 +000011warnings.filterwarnings("ignore",
12 category=RuntimeWarning,
13 message="mktemp", module=__name__)
14
Guido van Rossum0e548712002-08-09 16:14:33 +000015if hasattr(os, 'stat'):
16 import stat
17 has_stat = 1
18else:
19 has_stat = 0
20
21has_textmode = (tempfile._text_openflags != tempfile._bin_openflags)
Guido van Rossum78741062002-08-17 11:41:01 +000022has_spawnl = hasattr(os, 'spawnl')
Guido van Rossum0e548712002-08-09 16:14:33 +000023
Neal Norwitz68ee0122002-08-16 19:28:59 +000024# TEST_FILES may need to be tweaked for systems depending on the maximum
25# number of files that can be opened at one time (see ulimit -n)
Jack Jansence921472003-01-08 16:30:34 +000026if sys.platform == 'mac':
27 TEST_FILES = 32
Thomas Wouters89f507f2006-12-13 04:49:30 +000028elif sys.platform in ('openbsd3', 'openbsd4'):
Martin v. Löwis99968282004-09-15 06:02:54 +000029 TEST_FILES = 48
Jack Jansence921472003-01-08 16:30:34 +000030else:
31 TEST_FILES = 100
Neal Norwitz68ee0122002-08-16 19:28:59 +000032
Guido van Rossum0e548712002-08-09 16:14:33 +000033# This is organized as one test for each chunk of code in tempfile.py,
34# in order of their appearance in the file. Testing which requires
35# threads is not done here.
36
37# Common functionality.
38class TC(unittest.TestCase):
39
40 str_check = re.compile(r"[a-zA-Z0-9_-]{6}$")
41
42 def failOnException(self, what, ei=None):
43 if ei is None:
44 ei = sys.exc_info()
45 self.fail("%s raised %s: %s" % (what, ei[0], ei[1]))
46
47 def nameCheck(self, name, dir, pre, suf):
48 (ndir, nbase) = os.path.split(name)
49 npre = nbase[:len(pre)]
50 nsuf = nbase[len(nbase)-len(suf):]
51
Martin v. Löwisd6625482003-10-12 17:37:01 +000052 # check for equality of the absolute paths!
53 self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +000054 "file '%s' not in directory '%s'" % (name, dir))
55 self.assertEqual(npre, pre,
56 "file '%s' does not begin with '%s'" % (nbase, pre))
57 self.assertEqual(nsuf, suf,
58 "file '%s' does not end with '%s'" % (nbase, suf))
59
60 nbase = nbase[len(pre):len(nbase)-len(suf)]
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000061 self.assertTrue(self.str_check.match(nbase),
Guido van Rossum0e548712002-08-09 16:14:33 +000062 "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/"
63 % nbase)
64
65test_classes = []
66
67class test_exports(TC):
68 def test_exports(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +000069 # There are no surprising symbols in the tempfile module
Guido van Rossum0e548712002-08-09 16:14:33 +000070 dict = tempfile.__dict__
71
72 expected = {
73 "NamedTemporaryFile" : 1,
74 "TemporaryFile" : 1,
75 "mkstemp" : 1,
76 "mkdtemp" : 1,
77 "mktemp" : 1,
78 "TMP_MAX" : 1,
79 "gettempprefix" : 1,
80 "gettempdir" : 1,
81 "tempdir" : 1,
Guido van Rossumd8faa362007-04-27 19:54:29 +000082 "template" : 1,
83 "SpooledTemporaryFile" : 1
Guido van Rossum0e548712002-08-09 16:14:33 +000084 }
85
86 unexp = []
87 for key in dict:
88 if key[0] != '_' and key not in expected:
89 unexp.append(key)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000090 self.assertTrue(len(unexp) == 0,
Guido van Rossum0e548712002-08-09 16:14:33 +000091 "unexpected keys: %s" % unexp)
92
93test_classes.append(test_exports)
94
95
Guido van Rossum0e548712002-08-09 16:14:33 +000096class test__RandomNameSequence(TC):
97 """Test the internal iterator object _RandomNameSequence."""
98
99 def setUp(self):
100 self.r = tempfile._RandomNameSequence()
101
102 def test_get_six_char_str(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000103 # _RandomNameSequence returns a six-character string
Georg Brandla18af4e2007-04-21 15:47:16 +0000104 s = next(self.r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000105 self.nameCheck(s, '', '', '')
106
107 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000108 # _RandomNameSequence returns no duplicate strings (stochastic)
Guido van Rossum0e548712002-08-09 16:14:33 +0000109
110 dict = {}
111 r = self.r
Guido van Rossum805365e2007-05-07 22:24:25 +0000112 for i in range(TEST_FILES):
Georg Brandla18af4e2007-04-21 15:47:16 +0000113 s = next(r)
Guido van Rossum0e548712002-08-09 16:14:33 +0000114 self.nameCheck(s, '', '', '')
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000115 self.assertNotIn(s, dict)
Guido van Rossum0e548712002-08-09 16:14:33 +0000116 dict[s] = 1
117
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000118 def supports_iter(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000119 # _RandomNameSequence supports the iterator protocol
Guido van Rossum0e548712002-08-09 16:14:33 +0000120
121 i = 0
122 r = self.r
123 try:
124 for s in r:
125 i += 1
126 if i == 20:
127 break
128 except:
Georg Brandl89fad142010-03-14 10:23:39 +0000129 self.failOnException("iteration")
Guido van Rossum0e548712002-08-09 16:14:33 +0000130
131test_classes.append(test__RandomNameSequence)
132
133
134class test__candidate_tempdir_list(TC):
135 """Test the internal function _candidate_tempdir_list."""
136
137 def test_nonempty_list(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000138 # _candidate_tempdir_list returns a nonempty list of strings
Guido van Rossum0e548712002-08-09 16:14:33 +0000139
140 cand = tempfile._candidate_tempdir_list()
141
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000142 self.assertFalse(len(cand) == 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000143 for c in cand:
Ezio Melottie9615932010-01-24 19:26:24 +0000144 self.assertIsInstance(c, str)
Guido van Rossum0e548712002-08-09 16:14:33 +0000145
146 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000147 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000148
149 # Make sure the interesting environment variables are all set.
Hirokazu Yamamoto71959632009-04-27 01:44:28 +0000150 with support.EnvironmentVarGuard() as env:
Guido van Rossum0e548712002-08-09 16:14:33 +0000151 for envname in 'TMPDIR', 'TEMP', 'TMP':
152 dirname = os.getenv(envname)
153 if not dirname:
Walter Dörwald155374d2009-05-01 19:58:58 +0000154 env[envname] = os.path.abspath(envname)
Guido van Rossum0e548712002-08-09 16:14:33 +0000155
156 cand = tempfile._candidate_tempdir_list()
157
158 for envname in 'TMPDIR', 'TEMP', 'TMP':
159 dirname = os.getenv(envname)
160 if not dirname: raise ValueError
Benjamin Peterson577473f2010-01-19 00:09:57 +0000161 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000162
163 try:
164 dirname = os.getcwd()
165 except (AttributeError, os.error):
166 dirname = os.curdir
167
Benjamin Peterson577473f2010-01-19 00:09:57 +0000168 self.assertIn(dirname, cand)
Guido van Rossum0e548712002-08-09 16:14:33 +0000169
170 # Not practical to try to verify the presence of OS-specific
171 # paths in this list.
Guido van Rossum0e548712002-08-09 16:14:33 +0000172
173test_classes.append(test__candidate_tempdir_list)
174
175
176# We test _get_default_tempdir by testing gettempdir.
177
178
179class test__get_candidate_names(TC):
180 """Test the internal function _get_candidate_names."""
181
182 def test_retval(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000183 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000184 obj = tempfile._get_candidate_names()
Ezio Melottie9615932010-01-24 19:26:24 +0000185 self.assertIsInstance(obj, tempfile._RandomNameSequence)
Guido van Rossum0e548712002-08-09 16:14:33 +0000186
187 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000188 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000189 a = tempfile._get_candidate_names()
190 b = tempfile._get_candidate_names()
191
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000192 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000193
194test_classes.append(test__get_candidate_names)
195
196
197class test__mkstemp_inner(TC):
198 """Test the internal function _mkstemp_inner."""
199
200 class mkstemped:
201 _bflags = tempfile._bin_openflags
202 _tflags = tempfile._text_openflags
203 _close = os.close
204 _unlink = os.unlink
205
206 def __init__(self, dir, pre, suf, bin):
207 if bin: flags = self._bflags
208 else: flags = self._tflags
209
210 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags)
211
212 def write(self, str):
213 os.write(self.fd, str)
214
215 def __del__(self):
216 self._close(self.fd)
217 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000218
Guido van Rossum0e548712002-08-09 16:14:33 +0000219 def do_create(self, dir=None, pre="", suf="", bin=1):
220 if dir is None:
221 dir = tempfile.gettempdir()
222 try:
223 file = self.mkstemped(dir, pre, suf, bin)
224 except:
225 self.failOnException("_mkstemp_inner")
226
227 self.nameCheck(file.name, dir, pre, suf)
228 return file
229
230 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000231 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000232 self.do_create().write(b"blat")
233 self.do_create(pre="a").write(b"blat")
234 self.do_create(suf="b").write(b"blat")
235 self.do_create(pre="a", suf="b").write(b"blat")
236 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000237
238 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000239 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000240 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000241 for i in extant:
242 extant[i] = self.do_create(pre="aa")
243
244 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000245 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000246 dir = tempfile.mkdtemp()
247 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000248 self.do_create(dir=dir).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000249 finally:
250 os.rmdir(dir)
251
252 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000253 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000254 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000255 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000256
257 file = self.do_create()
258 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000259 expected = 0o600
Jack Jansence921472003-01-08 16:30:34 +0000260 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000261 # There's no distinction among 'user', 'group' and 'world';
262 # replicate the 'user' bits.
263 user = expected >> 6
264 expected = user * (1 + 8 + 64)
265 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000266
267 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000268 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum78741062002-08-17 11:41:01 +0000269 if not has_spawnl:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000270 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000271
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000272 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000273 v="v"
274 else:
275 v="q"
276
Guido van Rossum0e548712002-08-09 16:14:33 +0000277 file = self.do_create()
Guido van Rossum78741062002-08-17 11:41:01 +0000278 fd = "%d" % file.fd
279
280 try:
281 me = __file__
282 except NameError:
283 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000284
285 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000286 # effect. The core of this test is therefore in
287 # tf_inherit_check.py, which see.
288 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
289 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000290
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000291 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
292 # but an arg with embedded spaces should be decorated with double
293 # quotes on each end
Christian Heimes895627f2007-12-08 17:28:33 +0000294 if sys.platform in ('win32',):
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000295 decorated = '"%s"' % sys.executable
296 tester = '"%s"' % tester
297 else:
298 decorated = sys.executable
299
300 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000301 self.assertFalse(retval < 0,
Guido van Rossum78741062002-08-17 11:41:01 +0000302 "child process caught fatal signal %d" % -retval)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000303 self.assertFalse(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000304
305 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000306 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000307 if not has_textmode:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000308 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000309
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000310 # A text file is truncated at the first Ctrl+Z byte
311 f = self.do_create(bin=0)
312 f.write(b"blat\x1a")
313 f.write(b"extra\n")
314 os.lseek(f.fd, 0, os.SEEK_SET)
315 self.assertEquals(os.read(f.fd, 20), b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000316
317test_classes.append(test__mkstemp_inner)
318
319
320class test_gettempprefix(TC):
321 """Test gettempprefix()."""
322
323 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000324 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000325 p = tempfile.gettempprefix()
326
Ezio Melottie9615932010-01-24 19:26:24 +0000327 self.assertIsInstance(p, str)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000328 self.assertTrue(len(p) > 0)
Guido van Rossum0e548712002-08-09 16:14:33 +0000329
330 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000331 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000332
333 # Create a temp directory, avoiding use of the prefix.
334 # Then attempt to create a file whose name is
335 # prefix + 'xxxxxx.xxx' in that directory.
336 p = tempfile.gettempprefix() + "xxxxxx.xxx"
337 d = tempfile.mkdtemp(prefix="")
338 try:
339 p = os.path.join(d, p)
340 try:
341 fd = os.open(p, os.O_RDWR | os.O_CREAT)
342 except:
343 self.failOnException("os.open")
344 os.close(fd)
345 os.unlink(p)
346 finally:
347 os.rmdir(d)
348
349test_classes.append(test_gettempprefix)
350
351
352class test_gettempdir(TC):
353 """Test gettempdir()."""
354
355 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000356 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000357
358 dir = tempfile.gettempdir()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000359 self.assertTrue(os.path.isabs(dir) or dir == os.curdir,
Guido van Rossum0e548712002-08-09 16:14:33 +0000360 "%s is not an absolute path" % dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000361 self.assertTrue(os.path.isdir(dir),
Guido van Rossum0e548712002-08-09 16:14:33 +0000362 "%s is not a directory" % dir)
363
364 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000365 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000366
367 # sneaky: just instantiate a NamedTemporaryFile, which
368 # defaults to writing into the directory returned by
369 # gettempdir.
370 try:
371 file = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000372 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000373 file.close()
374 except:
375 self.failOnException("create file in %s" % tempfile.gettempdir())
376
377 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000378 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000379 a = tempfile.gettempdir()
380 b = tempfile.gettempdir()
381
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000382 self.assertTrue(a is b)
Guido van Rossum0e548712002-08-09 16:14:33 +0000383
384test_classes.append(test_gettempdir)
385
386
387class test_mkstemp(TC):
388 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000389
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000390 def do_create(self, dir=None, pre="", suf=""):
Guido van Rossum0e548712002-08-09 16:14:33 +0000391 if dir is None:
392 dir = tempfile.gettempdir()
393 try:
394 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
Martin v. Löwisd6625482003-10-12 17:37:01 +0000395 (ndir, nbase) = os.path.split(name)
396 adir = os.path.abspath(dir)
397 self.assertEqual(adir, ndir,
398 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000399 except:
400 self.failOnException("mkstemp")
401
402 try:
403 self.nameCheck(name, dir, pre, suf)
404 finally:
405 os.close(fd)
406 os.unlink(name)
407
408 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000409 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000410 self.do_create()
411 self.do_create(pre="a")
412 self.do_create(suf="b")
413 self.do_create(pre="a", suf="b")
414 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000415 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000416
417 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000418 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000419 dir = tempfile.mkdtemp()
420 try:
421 self.do_create(dir=dir)
422 finally:
423 os.rmdir(dir)
424
425test_classes.append(test_mkstemp)
426
427
428class test_mkdtemp(TC):
429 """Test mkdtemp()."""
430
431 def do_create(self, dir=None, pre="", suf=""):
432 if dir is None:
433 dir = tempfile.gettempdir()
434 try:
435 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
436 except:
437 self.failOnException("mkdtemp")
438
439 try:
440 self.nameCheck(name, dir, pre, suf)
441 return name
442 except:
443 os.rmdir(name)
444 raise
445
446 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000447 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000448 os.rmdir(self.do_create())
449 os.rmdir(self.do_create(pre="a"))
450 os.rmdir(self.do_create(suf="b"))
451 os.rmdir(self.do_create(pre="a", suf="b"))
452 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000453
Guido van Rossum0e548712002-08-09 16:14:33 +0000454 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000455 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000456 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000457 try:
458 for i in extant:
459 extant[i] = self.do_create(pre="aa")
460 finally:
461 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000462 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000463 os.rmdir(i)
464
465 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000466 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000467 dir = tempfile.mkdtemp()
468 try:
469 os.rmdir(self.do_create(dir=dir))
470 finally:
471 os.rmdir(dir)
472
473 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000474 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000475 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000476 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000477
478 dir = self.do_create()
479 try:
480 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000481 mode &= 0o777 # Mask off sticky bits inherited from /tmp
482 expected = 0o700
Jack Jansence921472003-01-08 16:30:34 +0000483 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000484 # There's no distinction among 'user', 'group' and 'world';
485 # replicate the 'user' bits.
486 user = expected >> 6
487 expected = user * (1 + 8 + 64)
488 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000489 finally:
490 os.rmdir(dir)
491
492test_classes.append(test_mkdtemp)
493
494
495class test_mktemp(TC):
496 """Test mktemp()."""
497
498 # For safety, all use of mktemp must occur in a private directory.
499 # We must also suppress the RuntimeWarning it generates.
500 def setUp(self):
501 self.dir = tempfile.mkdtemp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000502
503 def tearDown(self):
504 if self.dir:
505 os.rmdir(self.dir)
506 self.dir = None
Guido van Rossum0e548712002-08-09 16:14:33 +0000507
508 class mktemped:
509 _unlink = os.unlink
510 _bflags = tempfile._bin_openflags
511
512 def __init__(self, dir, pre, suf):
513 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
514 # Create the file. This will raise an exception if it's
515 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000516 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000517
518 def __del__(self):
519 self._unlink(self.name)
520
521 def do_create(self, pre="", suf=""):
522 try:
523 file = self.mktemped(self.dir, pre, suf)
524 except:
525 self.failOnException("mktemp")
526
527 self.nameCheck(file.name, self.dir, pre, suf)
528 return file
529
530 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000531 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000532 self.do_create()
533 self.do_create(pre="a")
534 self.do_create(suf="b")
535 self.do_create(pre="a", suf="b")
536 self.do_create(pre="aa", suf=".txt")
537
538 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000539 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000540 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000541 for i in extant:
542 extant[i] = self.do_create(pre="aa")
543
Fred Drake8bec4832002-11-22 20:13:43 +0000544## def test_warning(self):
545## # mktemp issues a warning when used
546## warnings.filterwarnings("error",
547## category=RuntimeWarning,
548## message="mktemp")
549## self.assertRaises(RuntimeWarning,
550## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000551
552test_classes.append(test_mktemp)
553
554
555# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
556
557
558class test_NamedTemporaryFile(TC):
559 """Test NamedTemporaryFile()."""
560
Guido van Rossumd8faa362007-04-27 19:54:29 +0000561 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000562 if dir is None:
563 dir = tempfile.gettempdir()
564 try:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000565 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
566 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000567 except:
568 self.failOnException("NamedTemporaryFile")
569
570 self.nameCheck(file.name, dir, pre, suf)
571 return file
572
573
574 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000575 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000576 self.do_create()
577 self.do_create(pre="a")
578 self.do_create(suf="b")
579 self.do_create(pre="a", suf="b")
580 self.do_create(pre="aa", suf=".txt")
581
582 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000583 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000584 f = tempfile.NamedTemporaryFile()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000585 self.assertTrue(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000586 "NamedTemporaryFile %s does not exist" % f.name)
587
588 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000589 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000590 dir = tempfile.mkdtemp()
591 try:
592 f = tempfile.NamedTemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000593 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000594 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000595 self.assertFalse(os.path.exists(f.name),
Guido van Rossum0e548712002-08-09 16:14:33 +0000596 "NamedTemporaryFile %s exists after close" % f.name)
597 finally:
598 os.rmdir(dir)
599
Guido van Rossumd8faa362007-04-27 19:54:29 +0000600 def test_dis_del_on_close(self):
601 # Tests that delete-on-close can be disabled
602 dir = tempfile.mkdtemp()
603 tmp = None
604 try:
605 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
606 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000607 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000608 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000609 self.assertTrue(os.path.exists(f.name),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000610 "NamedTemporaryFile %s missing after close" % f.name)
611 finally:
612 if tmp is not None:
613 os.unlink(tmp)
614 os.rmdir(dir)
615
Guido van Rossum0e548712002-08-09 16:14:33 +0000616 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000617 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000618 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000619 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000620 f.close()
621 try:
622 f.close()
623 f.close()
624 except:
625 self.failOnException("close")
626
Christian Heimes3ecfea712008-02-09 20:51:34 +0000627 def test_context_manager(self):
628 # A NamedTemporaryFile can be used as a context manager
629 with tempfile.NamedTemporaryFile() as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000630 self.assertTrue(os.path.exists(f.name))
631 self.assertFalse(os.path.exists(f.name))
Christian Heimes3ecfea712008-02-09 20:51:34 +0000632 def use_closed():
633 with f:
634 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000635 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000636
Guido van Rossum0e548712002-08-09 16:14:33 +0000637 # How to test the mode and bufsize parameters?
638
639test_classes.append(test_NamedTemporaryFile)
640
Guido van Rossumd8faa362007-04-27 19:54:29 +0000641class test_SpooledTemporaryFile(TC):
642 """Test SpooledTemporaryFile()."""
643
644 def do_create(self, max_size=0, dir=None, pre="", suf=""):
645 if dir is None:
646 dir = tempfile.gettempdir()
647 try:
648 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
649 except:
650 self.failOnException("SpooledTemporaryFile")
651
652 return file
653
654
655 def test_basic(self):
656 # SpooledTemporaryFile can create files
657 f = self.do_create()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000658 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000659 f = self.do_create(max_size=100, pre="a", suf=".txt")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000660 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000661
662 def test_del_on_close(self):
663 # A SpooledTemporaryFile is deleted when closed
664 dir = tempfile.mkdtemp()
665 try:
666 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000667 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000668 f.write(b'blat ' * 5)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000669 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000670 filename = f.name
671 f.close()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000672 self.assertFalse(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000673 "SpooledTemporaryFile %s exists after close" % filename)
674 finally:
675 os.rmdir(dir)
676
677 def test_rewrite_small(self):
678 # A SpooledTemporaryFile can be written to multiple within the max_size
679 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000680 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000681 for i in range(5):
682 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +0000683 f.write(b'x' * 20)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000684 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000685
686 def test_write_sequential(self):
687 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
688 # over afterward
689 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000690 self.assertFalse(f._rolled)
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 Rossum39478e82007-08-27 17:23:59 +0000693 f.write(b'x' * 10)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000694 self.assertFalse(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000695 f.write(b'x')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000696 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000697
698 def test_sparse(self):
699 # A SpooledTemporaryFile that is written late in the file will extend
700 # when that occurs
701 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000702 self.assertFalse(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000703 f.seek(100, 0)
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_fileno(self):
709 # A SpooledTemporaryFile should roll over to a real file on fileno()
710 f = self.do_create(max_size=30)
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000711 self.assertFalse(f._rolled)
712 self.assertTrue(f.fileno() > 0)
713 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000714
Christian Heimes3ecfea712008-02-09 20:51:34 +0000715 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000716 # A SpooledTemporaryFile can be closed many times without error
717 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +0000718 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000719 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000720 f.close()
721 try:
722 f.close()
723 f.close()
724 except:
725 self.failOnException("close")
726
727 def test_multiple_close_after_rollover(self):
728 # A SpooledTemporaryFile can be closed many times without error
729 f = tempfile.SpooledTemporaryFile(max_size=1)
730 f.write(b'abc\n')
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000731 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000732 f.close()
733 try:
734 f.close()
735 f.close()
736 except:
737 self.failOnException("close")
738
739 def test_bound_methods(self):
740 # It should be OK to steal a bound method from a SpooledTemporaryFile
741 # and use it independently; when the file rolls over, those bound
742 # methods should continue to function
743 f = self.do_create(max_size=30)
744 read = f.read
745 write = f.write
746 seek = f.seek
747
Guido van Rossum39478e82007-08-27 17:23:59 +0000748 write(b"a" * 35)
749 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000750 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +0000751 self.assertEqual(read(70), b'a'*35 + b'b'*35)
752
753 def test_text_mode(self):
754 # Creating a SpooledTemporaryFile with a text mode should produce
755 # a file object reading and writing (Unicode) text strings.
756 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10)
757 f.write("abc\n")
758 f.seek(0)
759 self.assertEqual(f.read(), "abc\n")
760 f.write("def\n")
761 f.seek(0)
762 self.assertEqual(f.read(), "abc\ndef\n")
763 f.write("xyzzy\n")
764 f.seek(0)
765 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
Amaury Forgeot d'Arc7d0bddd2009-11-30 00:08:56 +0000766 # Check that Ctrl+Z doesn't truncate the file
767 f.write("foo\x1abar\n")
768 f.seek(0)
769 self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n")
Guido van Rossum9a634702007-07-09 10:24:45 +0000770
Guido van Rossumf0c74162007-08-28 03:29:45 +0000771 def test_text_newline_and_encoding(self):
772 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
773 newline='', encoding='utf-8')
774 f.write("\u039B\r\n")
775 f.seek(0)
776 self.assertEqual(f.read(), "\u039B\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000777 self.assertFalse(f._rolled)
Guido van Rossumf0c74162007-08-28 03:29:45 +0000778
779 f.write("\u039B" * 20 + "\r\n")
780 f.seek(0)
781 self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n")
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000782 self.assertTrue(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000783
Christian Heimes3ecfea712008-02-09 20:51:34 +0000784 def test_context_manager_before_rollover(self):
785 # A SpooledTemporaryFile can be used as a context manager
786 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000787 self.assertFalse(f._rolled)
788 self.assertFalse(f.closed)
789 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000790 def use_closed():
791 with f:
792 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000793 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000794
795 def test_context_manager_during_rollover(self):
796 # A SpooledTemporaryFile can be used as a context manager
797 with tempfile.SpooledTemporaryFile(max_size=1) as f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000798 self.assertFalse(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000799 f.write(b'abc\n')
800 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000801 self.assertTrue(f._rolled)
802 self.assertFalse(f.closed)
803 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000804 def use_closed():
805 with f:
806 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000807 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000808
809 def test_context_manager_after_rollover(self):
810 # A SpooledTemporaryFile can be used as a context manager
811 f = tempfile.SpooledTemporaryFile(max_size=1)
812 f.write(b'abc\n')
813 f.flush()
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000814 self.assertTrue(f._rolled)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000815 with f:
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000816 self.assertFalse(f.closed)
817 self.assertTrue(f.closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000818 def use_closed():
819 with f:
820 pass
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000821 self.assertRaises(ValueError, use_closed)
Christian Heimes3ecfea712008-02-09 20:51:34 +0000822
823
Guido van Rossumd8faa362007-04-27 19:54:29 +0000824test_classes.append(test_SpooledTemporaryFile)
825
Guido van Rossum0e548712002-08-09 16:14:33 +0000826
827class test_TemporaryFile(TC):
828 """Test TemporaryFile()."""
829
830 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000831 # TemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000832 # No point in testing the name params - the file has no name.
833 try:
834 tempfile.TemporaryFile()
835 except:
836 self.failOnException("TemporaryFile")
837
838 def test_has_no_name(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000839 # TemporaryFile creates files with no names (on this system)
Guido van Rossum0e548712002-08-09 16:14:33 +0000840 dir = tempfile.mkdtemp()
841 f = tempfile.TemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000842 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000843
844 # Sneaky: because this file has no name, it should not prevent
845 # us from removing the directory it was created in.
846 try:
847 os.rmdir(dir)
848 except:
849 ei = sys.exc_info()
850 # cleanup
851 f.close()
852 os.rmdir(dir)
853 self.failOnException("rmdir", ei)
854
855 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000856 # A TemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000857 f = tempfile.TemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000858 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000859 f.close()
860 try:
861 f.close()
862 f.close()
863 except:
864 self.failOnException("close")
865
866 # How to test the mode and bufsize parameters?
Guido van Rossumf0c74162007-08-28 03:29:45 +0000867 def test_mode_and_encoding(self):
868
869 def roundtrip(input, *args, **kwargs):
870 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
871 fileobj.write(input)
872 fileobj.seek(0)
873 self.assertEquals(input, fileobj.read())
874
875 roundtrip(b"1234", "w+b")
876 roundtrip("abdc\n", "w+")
877 roundtrip("\u039B", "w+", encoding="utf-16")
878 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +0000879
Guido van Rossum0e548712002-08-09 16:14:33 +0000880
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000881if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Guido van Rossum0e548712002-08-09 16:14:33 +0000882 test_classes.append(test_TemporaryFile)
883
884def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000885 support.run_unittest(*test_classes)
Guido van Rossum0e548712002-08-09 16:14:33 +0000886
887if __name__ == "__main__":
888 test_main()