blob: 27a2183b4bd8175b81d37b90556847402e51a547 [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)]
62 self.assert_(self.str_check.match(nbase),
63 "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)
91 self.failUnless(len(unexp) == 0,
92 "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, '', '', '')
116 self.failIf(s in dict)
117 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:
130 failOnException("iteration")
131
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
143 self.failIf(len(cand) == 0)
144 for c in cand:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000145 self.assert_(isinstance(c, str),
Guido van Rossum0e548712002-08-09 16:14:33 +0000146 "%s is not a string" % c)
147
148 def test_wanted_dirs(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000149 # _candidate_tempdir_list contains the expected directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000150
151 # Make sure the interesting environment variables are all set.
152 added = []
153 try:
154 for envname in 'TMPDIR', 'TEMP', 'TMP':
155 dirname = os.getenv(envname)
156 if not dirname:
157 os.environ[envname] = os.path.abspath(envname)
158 added.append(envname)
159
160 cand = tempfile._candidate_tempdir_list()
161
162 for envname in 'TMPDIR', 'TEMP', 'TMP':
163 dirname = os.getenv(envname)
164 if not dirname: raise ValueError
165 self.assert_(dirname in cand)
166
167 try:
168 dirname = os.getcwd()
169 except (AttributeError, os.error):
170 dirname = os.curdir
171
172 self.assert_(dirname in cand)
173
174 # Not practical to try to verify the presence of OS-specific
175 # paths in this list.
176 finally:
177 for p in added:
178 del os.environ[p]
179
180test_classes.append(test__candidate_tempdir_list)
181
182
183# We test _get_default_tempdir by testing gettempdir.
184
185
186class test__get_candidate_names(TC):
187 """Test the internal function _get_candidate_names."""
188
189 def test_retval(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000190 # _get_candidate_names returns a _RandomNameSequence object
Guido van Rossum0e548712002-08-09 16:14:33 +0000191 obj = tempfile._get_candidate_names()
192 self.assert_(isinstance(obj, tempfile._RandomNameSequence))
193
194 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000195 # _get_candidate_names always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000196 a = tempfile._get_candidate_names()
197 b = tempfile._get_candidate_names()
198
199 self.assert_(a is b)
200
201test_classes.append(test__get_candidate_names)
202
203
204class test__mkstemp_inner(TC):
205 """Test the internal function _mkstemp_inner."""
206
207 class mkstemped:
208 _bflags = tempfile._bin_openflags
209 _tflags = tempfile._text_openflags
210 _close = os.close
211 _unlink = os.unlink
212
213 def __init__(self, dir, pre, suf, bin):
214 if bin: flags = self._bflags
215 else: flags = self._tflags
216
217 (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags)
218
219 def write(self, str):
220 os.write(self.fd, str)
221
222 def __del__(self):
223 self._close(self.fd)
224 self._unlink(self.name)
Tim Petersa0d55de2002-08-09 18:01:01 +0000225
Guido van Rossum0e548712002-08-09 16:14:33 +0000226 def do_create(self, dir=None, pre="", suf="", bin=1):
227 if dir is None:
228 dir = tempfile.gettempdir()
229 try:
230 file = self.mkstemped(dir, pre, suf, bin)
231 except:
232 self.failOnException("_mkstemp_inner")
233
234 self.nameCheck(file.name, dir, pre, suf)
235 return file
236
237 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000238 # _mkstemp_inner can create files
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000239 self.do_create().write(b"blat")
240 self.do_create(pre="a").write(b"blat")
241 self.do_create(suf="b").write(b"blat")
242 self.do_create(pre="a", suf="b").write(b"blat")
243 self.do_create(pre="aa", suf=".txt").write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000244
245 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000246 # _mkstemp_inner can create many files (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000247 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000248 for i in extant:
249 extant[i] = self.do_create(pre="aa")
250
251 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000252 # _mkstemp_inner can create files in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000253 dir = tempfile.mkdtemp()
254 try:
Antoine Pitrou9cadb1b2008-09-15 23:02:56 +0000255 self.do_create(dir=dir).write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000256 finally:
257 os.rmdir(dir)
258
259 def test_file_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000260 # _mkstemp_inner creates files with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000261 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000262 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000263
264 file = self.do_create()
265 mode = stat.S_IMODE(os.stat(file.name).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000266 expected = 0o600
Jack Jansence921472003-01-08 16:30:34 +0000267 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000268 # There's no distinction among 'user', 'group' and 'world';
269 # replicate the 'user' bits.
270 user = expected >> 6
271 expected = user * (1 + 8 + 64)
272 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000273
274 def test_noinherit(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000275 # _mkstemp_inner file handles are not inherited by child processes
Guido van Rossum78741062002-08-17 11:41:01 +0000276 if not has_spawnl:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000277 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000278
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000279 if support.verbose:
Guido van Rossum78741062002-08-17 11:41:01 +0000280 v="v"
281 else:
282 v="q"
283
Guido van Rossum0e548712002-08-09 16:14:33 +0000284 file = self.do_create()
Guido van Rossum78741062002-08-17 11:41:01 +0000285 fd = "%d" % file.fd
286
287 try:
288 me = __file__
289 except NameError:
290 me = sys.argv[0]
Guido van Rossum0e548712002-08-09 16:14:33 +0000291
292 # We have to exec something, so that FD_CLOEXEC will take
Guido van Rossum78741062002-08-17 11:41:01 +0000293 # effect. The core of this test is therefore in
294 # tf_inherit_check.py, which see.
295 tester = os.path.join(os.path.dirname(os.path.abspath(me)),
296 "tf_inherit_check.py")
Guido van Rossum0e548712002-08-09 16:14:33 +0000297
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000298 # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted,
299 # but an arg with embedded spaces should be decorated with double
300 # quotes on each end
Christian Heimes895627f2007-12-08 17:28:33 +0000301 if sys.platform in ('win32',):
Martin v. Löwisd4210bc2003-10-23 15:55:28 +0000302 decorated = '"%s"' % sys.executable
303 tester = '"%s"' % tester
304 else:
305 decorated = sys.executable
306
307 retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd)
Guido van Rossum78741062002-08-17 11:41:01 +0000308 self.failIf(retval < 0,
309 "child process caught fatal signal %d" % -retval)
Michael W. Hudsona1fb4c82005-02-15 15:22:37 +0000310 self.failIf(retval > 0, "child process reports failure %d"%retval)
Guido van Rossum0e548712002-08-09 16:14:33 +0000311
312 def test_textmode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000313 # _mkstemp_inner can create files in text mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000314 if not has_textmode:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000315 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000316
Antoine Pitroud62269f2008-09-15 23:54:52 +0000317 self.do_create(bin=0).write(b"blat\n")
Guido van Rossum0e548712002-08-09 16:14:33 +0000318 # XXX should test that the file really is a text file
319
320test_classes.append(test__mkstemp_inner)
321
322
323class test_gettempprefix(TC):
324 """Test gettempprefix()."""
325
326 def test_sane_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000327 # gettempprefix returns a nonempty prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000328 p = tempfile.gettempprefix()
329
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000330 self.assert_(isinstance(p, str))
Guido van Rossum0e548712002-08-09 16:14:33 +0000331 self.assert_(len(p) > 0)
332
333 def test_usable_template(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000334 # gettempprefix returns a usable prefix string
Guido van Rossum0e548712002-08-09 16:14:33 +0000335
336 # Create a temp directory, avoiding use of the prefix.
337 # Then attempt to create a file whose name is
338 # prefix + 'xxxxxx.xxx' in that directory.
339 p = tempfile.gettempprefix() + "xxxxxx.xxx"
340 d = tempfile.mkdtemp(prefix="")
341 try:
342 p = os.path.join(d, p)
343 try:
344 fd = os.open(p, os.O_RDWR | os.O_CREAT)
345 except:
346 self.failOnException("os.open")
347 os.close(fd)
348 os.unlink(p)
349 finally:
350 os.rmdir(d)
351
352test_classes.append(test_gettempprefix)
353
354
355class test_gettempdir(TC):
356 """Test gettempdir()."""
357
358 def test_directory_exists(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000359 # gettempdir returns a directory which exists
Guido van Rossum0e548712002-08-09 16:14:33 +0000360
361 dir = tempfile.gettempdir()
362 self.assert_(os.path.isabs(dir) or dir == os.curdir,
363 "%s is not an absolute path" % dir)
364 self.assert_(os.path.isdir(dir),
365 "%s is not a directory" % dir)
366
367 def test_directory_writable(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000368 # gettempdir returns a directory writable by the user
Guido van Rossum0e548712002-08-09 16:14:33 +0000369
370 # sneaky: just instantiate a NamedTemporaryFile, which
371 # defaults to writing into the directory returned by
372 # gettempdir.
373 try:
374 file = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000375 file.write(b"blat")
Guido van Rossum0e548712002-08-09 16:14:33 +0000376 file.close()
377 except:
378 self.failOnException("create file in %s" % tempfile.gettempdir())
379
380 def test_same_thing(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000381 # gettempdir always returns the same object
Guido van Rossum0e548712002-08-09 16:14:33 +0000382 a = tempfile.gettempdir()
383 b = tempfile.gettempdir()
384
385 self.assert_(a is b)
386
387test_classes.append(test_gettempdir)
388
389
390class test_mkstemp(TC):
391 """Test mkstemp()."""
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000392
Thomas Wouters73e5a5b2006-06-08 15:35:45 +0000393 def do_create(self, dir=None, pre="", suf=""):
Guido van Rossum0e548712002-08-09 16:14:33 +0000394 if dir is None:
395 dir = tempfile.gettempdir()
396 try:
397 (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf)
Martin v. Löwisd6625482003-10-12 17:37:01 +0000398 (ndir, nbase) = os.path.split(name)
399 adir = os.path.abspath(dir)
400 self.assertEqual(adir, ndir,
401 "Directory '%s' incorrectly returned as '%s'" % (adir, ndir))
Guido van Rossum0e548712002-08-09 16:14:33 +0000402 except:
403 self.failOnException("mkstemp")
404
405 try:
406 self.nameCheck(name, dir, pre, suf)
407 finally:
408 os.close(fd)
409 os.unlink(name)
410
411 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000412 # mkstemp can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000413 self.do_create()
414 self.do_create(pre="a")
415 self.do_create(suf="b")
416 self.do_create(pre="a", suf="b")
417 self.do_create(pre="aa", suf=".txt")
Martin v. Löwisd6625482003-10-12 17:37:01 +0000418 self.do_create(dir=".")
Guido van Rossum0e548712002-08-09 16:14:33 +0000419
420 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000421 # mkstemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000422 dir = tempfile.mkdtemp()
423 try:
424 self.do_create(dir=dir)
425 finally:
426 os.rmdir(dir)
427
428test_classes.append(test_mkstemp)
429
430
431class test_mkdtemp(TC):
432 """Test mkdtemp()."""
433
434 def do_create(self, dir=None, pre="", suf=""):
435 if dir is None:
436 dir = tempfile.gettempdir()
437 try:
438 name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf)
439 except:
440 self.failOnException("mkdtemp")
441
442 try:
443 self.nameCheck(name, dir, pre, suf)
444 return name
445 except:
446 os.rmdir(name)
447 raise
448
449 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000450 # mkdtemp can create directories
Guido van Rossum0e548712002-08-09 16:14:33 +0000451 os.rmdir(self.do_create())
452 os.rmdir(self.do_create(pre="a"))
453 os.rmdir(self.do_create(suf="b"))
454 os.rmdir(self.do_create(pre="a", suf="b"))
455 os.rmdir(self.do_create(pre="aa", suf=".txt"))
Tim Petersa0d55de2002-08-09 18:01:01 +0000456
Guido van Rossum0e548712002-08-09 16:14:33 +0000457 def test_basic_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000458 # mkdtemp can create many directories (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000459 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000460 try:
461 for i in extant:
462 extant[i] = self.do_create(pre="aa")
463 finally:
464 for i in extant:
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000465 if(isinstance(i, str)):
Guido van Rossum0e548712002-08-09 16:14:33 +0000466 os.rmdir(i)
467
468 def test_choose_directory(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000469 # mkdtemp can create directories in a user-selected directory
Guido van Rossum0e548712002-08-09 16:14:33 +0000470 dir = tempfile.mkdtemp()
471 try:
472 os.rmdir(self.do_create(dir=dir))
473 finally:
474 os.rmdir(dir)
475
476 def test_mode(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000477 # mkdtemp creates directories with the proper mode
Guido van Rossum0e548712002-08-09 16:14:33 +0000478 if not has_stat:
Benjamin Petersone549ead2009-03-28 21:42:05 +0000479 return # ugh, can't use SkipTest.
Guido van Rossum0e548712002-08-09 16:14:33 +0000480
481 dir = self.do_create()
482 try:
483 mode = stat.S_IMODE(os.stat(dir).st_mode)
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000484 mode &= 0o777 # Mask off sticky bits inherited from /tmp
485 expected = 0o700
Jack Jansence921472003-01-08 16:30:34 +0000486 if sys.platform in ('win32', 'os2emx', 'mac'):
Tim Petersca3ac7f2002-08-09 18:13:51 +0000487 # There's no distinction among 'user', 'group' and 'world';
488 # replicate the 'user' bits.
489 user = expected >> 6
490 expected = user * (1 + 8 + 64)
491 self.assertEqual(mode, expected)
Guido van Rossum0e548712002-08-09 16:14:33 +0000492 finally:
493 os.rmdir(dir)
494
495test_classes.append(test_mkdtemp)
496
497
498class test_mktemp(TC):
499 """Test mktemp()."""
500
501 # For safety, all use of mktemp must occur in a private directory.
502 # We must also suppress the RuntimeWarning it generates.
503 def setUp(self):
504 self.dir = tempfile.mkdtemp()
Guido van Rossum0e548712002-08-09 16:14:33 +0000505
506 def tearDown(self):
507 if self.dir:
508 os.rmdir(self.dir)
509 self.dir = None
Guido van Rossum0e548712002-08-09 16:14:33 +0000510
511 class mktemped:
512 _unlink = os.unlink
513 _bflags = tempfile._bin_openflags
514
515 def __init__(self, dir, pre, suf):
516 self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf)
517 # Create the file. This will raise an exception if it's
518 # mysteriously appeared in the meanwhile.
Guido van Rossumcd16bf62007-06-13 18:07:49 +0000519 os.close(os.open(self.name, self._bflags, 0o600))
Guido van Rossum0e548712002-08-09 16:14:33 +0000520
521 def __del__(self):
522 self._unlink(self.name)
523
524 def do_create(self, pre="", suf=""):
525 try:
526 file = self.mktemped(self.dir, pre, suf)
527 except:
528 self.failOnException("mktemp")
529
530 self.nameCheck(file.name, self.dir, pre, suf)
531 return file
532
533 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000534 # mktemp can choose usable file names
Guido van Rossum0e548712002-08-09 16:14:33 +0000535 self.do_create()
536 self.do_create(pre="a")
537 self.do_create(suf="b")
538 self.do_create(pre="a", suf="b")
539 self.do_create(pre="aa", suf=".txt")
540
541 def test_many(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000542 # mktemp can choose many usable file names (stochastic)
Guido van Rossum805365e2007-05-07 22:24:25 +0000543 extant = list(range(TEST_FILES))
Guido van Rossum0e548712002-08-09 16:14:33 +0000544 for i in extant:
545 extant[i] = self.do_create(pre="aa")
546
Fred Drake8bec4832002-11-22 20:13:43 +0000547## def test_warning(self):
548## # mktemp issues a warning when used
549## warnings.filterwarnings("error",
550## category=RuntimeWarning,
551## message="mktemp")
552## self.assertRaises(RuntimeWarning,
553## tempfile.mktemp, dir=self.dir)
Guido van Rossum0e548712002-08-09 16:14:33 +0000554
555test_classes.append(test_mktemp)
556
557
558# We test _TemporaryFileWrapper by testing NamedTemporaryFile.
559
560
561class test_NamedTemporaryFile(TC):
562 """Test NamedTemporaryFile()."""
563
Guido van Rossumd8faa362007-04-27 19:54:29 +0000564 def do_create(self, dir=None, pre="", suf="", delete=True):
Guido van Rossum0e548712002-08-09 16:14:33 +0000565 if dir is None:
566 dir = tempfile.gettempdir()
567 try:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000568 file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf,
569 delete=delete)
Guido van Rossum0e548712002-08-09 16:14:33 +0000570 except:
571 self.failOnException("NamedTemporaryFile")
572
573 self.nameCheck(file.name, dir, pre, suf)
574 return file
575
576
577 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000578 # NamedTemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000579 self.do_create()
580 self.do_create(pre="a")
581 self.do_create(suf="b")
582 self.do_create(pre="a", suf="b")
583 self.do_create(pre="aa", suf=".txt")
584
585 def test_creates_named(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000586 # NamedTemporaryFile creates files with names
Guido van Rossum0e548712002-08-09 16:14:33 +0000587 f = tempfile.NamedTemporaryFile()
588 self.failUnless(os.path.exists(f.name),
589 "NamedTemporaryFile %s does not exist" % f.name)
590
591 def test_del_on_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000592 # A NamedTemporaryFile is deleted when closed
Guido van Rossum0e548712002-08-09 16:14:33 +0000593 dir = tempfile.mkdtemp()
594 try:
595 f = tempfile.NamedTemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000596 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000597 f.close()
598 self.failIf(os.path.exists(f.name),
599 "NamedTemporaryFile %s exists after close" % f.name)
600 finally:
601 os.rmdir(dir)
602
Guido van Rossumd8faa362007-04-27 19:54:29 +0000603 def test_dis_del_on_close(self):
604 # Tests that delete-on-close can be disabled
605 dir = tempfile.mkdtemp()
606 tmp = None
607 try:
608 f = tempfile.NamedTemporaryFile(dir=dir, delete=False)
609 tmp = f.name
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000610 f.write(b'blat')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000611 f.close()
612 self.failUnless(os.path.exists(f.name),
613 "NamedTemporaryFile %s missing after close" % f.name)
614 finally:
615 if tmp is not None:
616 os.unlink(tmp)
617 os.rmdir(dir)
618
Guido van Rossum0e548712002-08-09 16:14:33 +0000619 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000620 # A NamedTemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000621 f = tempfile.NamedTemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000622 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000623 f.close()
624 try:
625 f.close()
626 f.close()
627 except:
628 self.failOnException("close")
629
Christian Heimes3ecfea712008-02-09 20:51:34 +0000630 def test_context_manager(self):
631 # A NamedTemporaryFile can be used as a context manager
632 with tempfile.NamedTemporaryFile() as f:
633 self.failUnless(os.path.exists(f.name))
634 self.failIf(os.path.exists(f.name))
635 def use_closed():
636 with f:
637 pass
638 self.failUnlessRaises(ValueError, use_closed)
639
Guido van Rossum0e548712002-08-09 16:14:33 +0000640 # How to test the mode and bufsize parameters?
641
642test_classes.append(test_NamedTemporaryFile)
643
Guido van Rossumd8faa362007-04-27 19:54:29 +0000644class test_SpooledTemporaryFile(TC):
645 """Test SpooledTemporaryFile()."""
646
647 def do_create(self, max_size=0, dir=None, pre="", suf=""):
648 if dir is None:
649 dir = tempfile.gettempdir()
650 try:
651 file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf)
652 except:
653 self.failOnException("SpooledTemporaryFile")
654
655 return file
656
657
658 def test_basic(self):
659 # SpooledTemporaryFile can create files
660 f = self.do_create()
661 self.failIf(f._rolled)
662 f = self.do_create(max_size=100, pre="a", suf=".txt")
663 self.failIf(f._rolled)
664
665 def test_del_on_close(self):
666 # A SpooledTemporaryFile is deleted when closed
667 dir = tempfile.mkdtemp()
668 try:
669 f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir)
670 self.failIf(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000671 f.write(b'blat ' * 5)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000672 self.failUnless(f._rolled)
673 filename = f.name
674 f.close()
Guido van Rossum9a634702007-07-09 10:24:45 +0000675 self.failIf(isinstance(filename, str) and os.path.exists(filename),
Guido van Rossumd8faa362007-04-27 19:54:29 +0000676 "SpooledTemporaryFile %s exists after close" % filename)
677 finally:
678 os.rmdir(dir)
679
680 def test_rewrite_small(self):
681 # A SpooledTemporaryFile can be written to multiple within the max_size
682 f = self.do_create(max_size=30)
683 self.failIf(f._rolled)
684 for i in range(5):
685 f.seek(0, 0)
Guido van Rossum39478e82007-08-27 17:23:59 +0000686 f.write(b'x' * 20)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000687 self.failIf(f._rolled)
688
689 def test_write_sequential(self):
690 # A SpooledTemporaryFile should hold exactly max_size bytes, and roll
691 # over afterward
692 f = self.do_create(max_size=30)
693 self.failIf(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000694 f.write(b'x' * 20)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000695 self.failIf(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000696 f.write(b'x' * 10)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000697 self.failIf(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000698 f.write(b'x')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000699 self.failUnless(f._rolled)
700
701 def test_sparse(self):
702 # A SpooledTemporaryFile that is written late in the file will extend
703 # when that occurs
704 f = self.do_create(max_size=30)
705 self.failIf(f._rolled)
706 f.seek(100, 0)
707 self.failIf(f._rolled)
Guido van Rossum39478e82007-08-27 17:23:59 +0000708 f.write(b'x')
Guido van Rossumd8faa362007-04-27 19:54:29 +0000709 self.failUnless(f._rolled)
710
711 def test_fileno(self):
712 # A SpooledTemporaryFile should roll over to a real file on fileno()
713 f = self.do_create(max_size=30)
714 self.failIf(f._rolled)
715 self.failUnless(f.fileno() > 0)
716 self.failUnless(f._rolled)
717
Christian Heimes3ecfea712008-02-09 20:51:34 +0000718 def test_multiple_close_before_rollover(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000719 # A SpooledTemporaryFile can be closed many times without error
720 f = tempfile.SpooledTemporaryFile()
Guido van Rossum39478e82007-08-27 17:23:59 +0000721 f.write(b'abc\n')
Christian Heimes3ecfea712008-02-09 20:51:34 +0000722 self.failIf(f._rolled)
723 f.close()
724 try:
725 f.close()
726 f.close()
727 except:
728 self.failOnException("close")
729
730 def test_multiple_close_after_rollover(self):
731 # A SpooledTemporaryFile can be closed many times without error
732 f = tempfile.SpooledTemporaryFile(max_size=1)
733 f.write(b'abc\n')
734 self.failUnless(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000735 f.close()
736 try:
737 f.close()
738 f.close()
739 except:
740 self.failOnException("close")
741
742 def test_bound_methods(self):
743 # It should be OK to steal a bound method from a SpooledTemporaryFile
744 # and use it independently; when the file rolls over, those bound
745 # methods should continue to function
746 f = self.do_create(max_size=30)
747 read = f.read
748 write = f.write
749 seek = f.seek
750
Guido van Rossum39478e82007-08-27 17:23:59 +0000751 write(b"a" * 35)
752 write(b"b" * 35)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000753 seek(0, 0)
Guido van Rossum9a634702007-07-09 10:24:45 +0000754 self.assertEqual(read(70), b'a'*35 + b'b'*35)
755
756 def test_text_mode(self):
757 # Creating a SpooledTemporaryFile with a text mode should produce
758 # a file object reading and writing (Unicode) text strings.
759 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10)
760 f.write("abc\n")
761 f.seek(0)
762 self.assertEqual(f.read(), "abc\n")
763 f.write("def\n")
764 f.seek(0)
765 self.assertEqual(f.read(), "abc\ndef\n")
766 f.write("xyzzy\n")
767 f.seek(0)
768 self.assertEqual(f.read(), "abc\ndef\nxyzzy\n")
769
Guido van Rossumf0c74162007-08-28 03:29:45 +0000770 def test_text_newline_and_encoding(self):
771 f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10,
772 newline='', encoding='utf-8')
773 f.write("\u039B\r\n")
774 f.seek(0)
775 self.assertEqual(f.read(), "\u039B\r\n")
776 self.failIf(f._rolled)
777
778 f.write("\u039B" * 20 + "\r\n")
779 f.seek(0)
780 self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n")
781 self.failUnless(f._rolled)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000782
Christian Heimes3ecfea712008-02-09 20:51:34 +0000783 def test_context_manager_before_rollover(self):
784 # A SpooledTemporaryFile can be used as a context manager
785 with tempfile.SpooledTemporaryFile(max_size=1) as f:
786 self.failIf(f._rolled)
787 self.failIf(f.closed)
788 self.failUnless(f.closed)
789 def use_closed():
790 with f:
791 pass
792 self.failUnlessRaises(ValueError, use_closed)
793
794 def test_context_manager_during_rollover(self):
795 # A SpooledTemporaryFile can be used as a context manager
796 with tempfile.SpooledTemporaryFile(max_size=1) as f:
797 self.failIf(f._rolled)
798 f.write(b'abc\n')
799 f.flush()
800 self.failUnless(f._rolled)
801 self.failIf(f.closed)
802 self.failUnless(f.closed)
803 def use_closed():
804 with f:
805 pass
806 self.failUnlessRaises(ValueError, use_closed)
807
808 def test_context_manager_after_rollover(self):
809 # A SpooledTemporaryFile can be used as a context manager
810 f = tempfile.SpooledTemporaryFile(max_size=1)
811 f.write(b'abc\n')
812 f.flush()
813 self.failUnless(f._rolled)
814 with f:
815 self.failIf(f.closed)
816 self.failUnless(f.closed)
817 def use_closed():
818 with f:
819 pass
820 self.failUnlessRaises(ValueError, use_closed)
821
822
Guido van Rossumd8faa362007-04-27 19:54:29 +0000823test_classes.append(test_SpooledTemporaryFile)
824
Guido van Rossum0e548712002-08-09 16:14:33 +0000825
826class test_TemporaryFile(TC):
827 """Test TemporaryFile()."""
828
829 def test_basic(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000830 # TemporaryFile can create files
Guido van Rossum0e548712002-08-09 16:14:33 +0000831 # No point in testing the name params - the file has no name.
832 try:
833 tempfile.TemporaryFile()
834 except:
835 self.failOnException("TemporaryFile")
836
837 def test_has_no_name(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000838 # TemporaryFile creates files with no names (on this system)
Guido van Rossum0e548712002-08-09 16:14:33 +0000839 dir = tempfile.mkdtemp()
840 f = tempfile.TemporaryFile(dir=dir)
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000841 f.write(b'blat')
Guido van Rossum0e548712002-08-09 16:14:33 +0000842
843 # Sneaky: because this file has no name, it should not prevent
844 # us from removing the directory it was created in.
845 try:
846 os.rmdir(dir)
847 except:
848 ei = sys.exc_info()
849 # cleanup
850 f.close()
851 os.rmdir(dir)
852 self.failOnException("rmdir", ei)
853
854 def test_multiple_close(self):
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000855 # A TemporaryFile can be closed many times without error
Guido van Rossum0e548712002-08-09 16:14:33 +0000856 f = tempfile.TemporaryFile()
Guido van Rossumec42ffd2007-08-27 23:40:36 +0000857 f.write(b'abc\n')
Guido van Rossum0e548712002-08-09 16:14:33 +0000858 f.close()
859 try:
860 f.close()
861 f.close()
862 except:
863 self.failOnException("close")
864
865 # How to test the mode and bufsize parameters?
Guido van Rossumf0c74162007-08-28 03:29:45 +0000866 def test_mode_and_encoding(self):
867
868 def roundtrip(input, *args, **kwargs):
869 with tempfile.TemporaryFile(*args, **kwargs) as fileobj:
870 fileobj.write(input)
871 fileobj.seek(0)
872 self.assertEquals(input, fileobj.read())
873
874 roundtrip(b"1234", "w+b")
875 roundtrip("abdc\n", "w+")
876 roundtrip("\u039B", "w+", encoding="utf-16")
877 roundtrip("foo\r\n", "w+", newline="")
Guido van Rossum0e548712002-08-09 16:14:33 +0000878
Guido van Rossum0e548712002-08-09 16:14:33 +0000879
Guido van Rossum8ccd9b62002-08-22 20:02:03 +0000880if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile:
Guido van Rossum0e548712002-08-09 16:14:33 +0000881 test_classes.append(test_TemporaryFile)
882
883def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000884 support.run_unittest(*test_classes)
Guido van Rossum0e548712002-08-09 16:14:33 +0000885
886if __name__ == "__main__":
887 test_main()