Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1 | # tempfile.py unit tests. |
Tim Peters | c57a285 | 2001-10-29 21:46:08 +0000 | [diff] [blame] | 2 | import tempfile |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 3 | import os |
| 4 | import sys |
| 5 | import re |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 6 | import warnings |
Tim Peters | c57a285 | 2001-10-29 21:46:08 +0000 | [diff] [blame] | 7 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 8 | import unittest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 9 | from test import support |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 10 | |
Fred Drake | 7633d23 | 2002-10-17 22:09:03 +0000 | [diff] [blame] | 11 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 12 | if hasattr(os, 'stat'): |
| 13 | import stat |
| 14 | has_stat = 1 |
| 15 | else: |
| 16 | has_stat = 0 |
| 17 | |
| 18 | has_textmode = (tempfile._text_openflags != tempfile._bin_openflags) |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 19 | has_spawnl = hasattr(os, 'spawnl') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 20 | |
Neal Norwitz | 68ee012 | 2002-08-16 19:28:59 +0000 | [diff] [blame] | 21 | # TEST_FILES may need to be tweaked for systems depending on the maximum |
| 22 | # number of files that can be opened at one time (see ulimit -n) |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 23 | if sys.platform in ('openbsd3', 'openbsd4'): |
Martin v. Löwis | 9996828 | 2004-09-15 06:02:54 +0000 | [diff] [blame] | 24 | TEST_FILES = 48 |
Jack Jansen | ce92147 | 2003-01-08 16:30:34 +0000 | [diff] [blame] | 25 | else: |
| 26 | TEST_FILES = 100 |
Neal Norwitz | 68ee012 | 2002-08-16 19:28:59 +0000 | [diff] [blame] | 27 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 28 | # This is organized as one test for each chunk of code in tempfile.py, |
| 29 | # in order of their appearance in the file. Testing which requires |
| 30 | # threads is not done here. |
| 31 | |
| 32 | # Common functionality. |
| 33 | class TC(unittest.TestCase): |
| 34 | |
| 35 | str_check = re.compile(r"[a-zA-Z0-9_-]{6}$") |
| 36 | |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 37 | def setUp(self): |
| 38 | self._warnings_manager = support.check_warnings() |
| 39 | self._warnings_manager.__enter__() |
| 40 | warnings.filterwarnings("ignore", category=RuntimeWarning, |
| 41 | message="mktemp", module=__name__) |
| 42 | |
| 43 | def tearDown(self): |
| 44 | self._warnings_manager.__exit__(None, None, None) |
| 45 | |
| 46 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 47 | def failOnException(self, what, ei=None): |
| 48 | if ei is None: |
| 49 | ei = sys.exc_info() |
| 50 | self.fail("%s raised %s: %s" % (what, ei[0], ei[1])) |
| 51 | |
| 52 | def nameCheck(self, name, dir, pre, suf): |
| 53 | (ndir, nbase) = os.path.split(name) |
| 54 | npre = nbase[:len(pre)] |
| 55 | nsuf = nbase[len(nbase)-len(suf):] |
| 56 | |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 57 | # check for equality of the absolute paths! |
| 58 | self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 59 | "file '%s' not in directory '%s'" % (name, dir)) |
| 60 | self.assertEqual(npre, pre, |
| 61 | "file '%s' does not begin with '%s'" % (nbase, pre)) |
| 62 | self.assertEqual(nsuf, suf, |
| 63 | "file '%s' does not end with '%s'" % (nbase, suf)) |
| 64 | |
| 65 | nbase = nbase[len(pre):len(nbase)-len(suf)] |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 66 | self.assertTrue(self.str_check.match(nbase), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 67 | "random string '%s' does not match /^[a-zA-Z0-9_-]{6}$/" |
| 68 | % nbase) |
| 69 | |
| 70 | test_classes = [] |
| 71 | |
| 72 | class test_exports(TC): |
| 73 | def test_exports(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 74 | # There are no surprising symbols in the tempfile module |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 75 | dict = tempfile.__dict__ |
| 76 | |
| 77 | expected = { |
| 78 | "NamedTemporaryFile" : 1, |
| 79 | "TemporaryFile" : 1, |
| 80 | "mkstemp" : 1, |
| 81 | "mkdtemp" : 1, |
| 82 | "mktemp" : 1, |
| 83 | "TMP_MAX" : 1, |
| 84 | "gettempprefix" : 1, |
| 85 | "gettempdir" : 1, |
| 86 | "tempdir" : 1, |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 87 | "template" : 1, |
| 88 | "SpooledTemporaryFile" : 1 |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | unexp = [] |
| 92 | for key in dict: |
| 93 | if key[0] != '_' and key not in expected: |
| 94 | unexp.append(key) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 95 | self.assertTrue(len(unexp) == 0, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 96 | "unexpected keys: %s" % unexp) |
| 97 | |
| 98 | test_classes.append(test_exports) |
| 99 | |
| 100 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 101 | class test__RandomNameSequence(TC): |
| 102 | """Test the internal iterator object _RandomNameSequence.""" |
| 103 | |
| 104 | def setUp(self): |
| 105 | self.r = tempfile._RandomNameSequence() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 106 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 107 | |
| 108 | def test_get_six_char_str(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 109 | # _RandomNameSequence returns a six-character string |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 110 | s = next(self.r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 111 | self.nameCheck(s, '', '', '') |
| 112 | |
| 113 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 114 | # _RandomNameSequence returns no duplicate strings (stochastic) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 115 | |
| 116 | dict = {} |
| 117 | r = self.r |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 118 | for i in range(TEST_FILES): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 119 | s = next(r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 120 | self.nameCheck(s, '', '', '') |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 121 | self.assertNotIn(s, dict) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 122 | dict[s] = 1 |
| 123 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 124 | def supports_iter(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 125 | # _RandomNameSequence supports the iterator protocol |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 126 | |
| 127 | i = 0 |
| 128 | r = self.r |
| 129 | try: |
| 130 | for s in r: |
| 131 | i += 1 |
| 132 | if i == 20: |
| 133 | break |
| 134 | except: |
Georg Brandl | 89fad14 | 2010-03-14 10:23:39 +0000 | [diff] [blame] | 135 | self.failOnException("iteration") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 136 | |
| 137 | test_classes.append(test__RandomNameSequence) |
| 138 | |
| 139 | |
| 140 | class test__candidate_tempdir_list(TC): |
| 141 | """Test the internal function _candidate_tempdir_list.""" |
| 142 | |
| 143 | def test_nonempty_list(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 144 | # _candidate_tempdir_list returns a nonempty list of strings |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 145 | |
| 146 | cand = tempfile._candidate_tempdir_list() |
| 147 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 148 | self.assertFalse(len(cand) == 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 149 | for c in cand: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 150 | self.assertIsInstance(c, str) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 151 | |
| 152 | def test_wanted_dirs(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 153 | # _candidate_tempdir_list contains the expected directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 154 | |
| 155 | # Make sure the interesting environment variables are all set. |
Hirokazu Yamamoto | 7195963 | 2009-04-27 01:44:28 +0000 | [diff] [blame] | 156 | with support.EnvironmentVarGuard() as env: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 157 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 158 | dirname = os.getenv(envname) |
| 159 | if not dirname: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 160 | env[envname] = os.path.abspath(envname) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 161 | |
| 162 | cand = tempfile._candidate_tempdir_list() |
| 163 | |
| 164 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 165 | dirname = os.getenv(envname) |
| 166 | if not dirname: raise ValueError |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 167 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 168 | |
| 169 | try: |
| 170 | dirname = os.getcwd() |
| 171 | except (AttributeError, os.error): |
| 172 | dirname = os.curdir |
| 173 | |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 174 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 175 | |
| 176 | # Not practical to try to verify the presence of OS-specific |
| 177 | # paths in this list. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 178 | |
| 179 | test_classes.append(test__candidate_tempdir_list) |
| 180 | |
| 181 | |
| 182 | # We test _get_default_tempdir by testing gettempdir. |
| 183 | |
| 184 | |
| 185 | class test__get_candidate_names(TC): |
| 186 | """Test the internal function _get_candidate_names.""" |
| 187 | |
| 188 | def test_retval(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 189 | # _get_candidate_names returns a _RandomNameSequence object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 190 | obj = tempfile._get_candidate_names() |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 191 | self.assertIsInstance(obj, tempfile._RandomNameSequence) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 192 | |
| 193 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 194 | # _get_candidate_names always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 195 | a = tempfile._get_candidate_names() |
| 196 | b = tempfile._get_candidate_names() |
| 197 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 198 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 199 | |
| 200 | test_classes.append(test__get_candidate_names) |
| 201 | |
| 202 | |
| 203 | class test__mkstemp_inner(TC): |
| 204 | """Test the internal function _mkstemp_inner.""" |
| 205 | |
| 206 | class mkstemped: |
| 207 | _bflags = tempfile._bin_openflags |
| 208 | _tflags = tempfile._text_openflags |
| 209 | _close = os.close |
| 210 | _unlink = os.unlink |
| 211 | |
| 212 | def __init__(self, dir, pre, suf, bin): |
| 213 | if bin: flags = self._bflags |
| 214 | else: flags = self._tflags |
| 215 | |
| 216 | (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags) |
| 217 | |
| 218 | def write(self, str): |
| 219 | os.write(self.fd, str) |
| 220 | |
| 221 | def __del__(self): |
| 222 | self._close(self.fd) |
| 223 | self._unlink(self.name) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 224 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 225 | def do_create(self, dir=None, pre="", suf="", bin=1): |
| 226 | if dir is None: |
| 227 | dir = tempfile.gettempdir() |
| 228 | try: |
| 229 | file = self.mkstemped(dir, pre, suf, bin) |
| 230 | except: |
| 231 | self.failOnException("_mkstemp_inner") |
| 232 | |
| 233 | self.nameCheck(file.name, dir, pre, suf) |
| 234 | return file |
| 235 | |
| 236 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 237 | # _mkstemp_inner can create files |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 238 | self.do_create().write(b"blat") |
| 239 | self.do_create(pre="a").write(b"blat") |
| 240 | self.do_create(suf="b").write(b"blat") |
| 241 | self.do_create(pre="a", suf="b").write(b"blat") |
| 242 | self.do_create(pre="aa", suf=".txt").write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 243 | |
| 244 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 245 | # _mkstemp_inner can create many files (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 246 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 247 | for i in extant: |
| 248 | extant[i] = self.do_create(pre="aa") |
| 249 | |
| 250 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 251 | # _mkstemp_inner can create files in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 252 | dir = tempfile.mkdtemp() |
| 253 | try: |
Antoine Pitrou | 9cadb1b | 2008-09-15 23:02:56 +0000 | [diff] [blame] | 254 | self.do_create(dir=dir).write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 255 | finally: |
| 256 | os.rmdir(dir) |
| 257 | |
| 258 | def test_file_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 259 | # _mkstemp_inner creates files with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 260 | if not has_stat: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 261 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 262 | |
| 263 | file = self.do_create() |
| 264 | mode = stat.S_IMODE(os.stat(file.name).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 265 | expected = 0o600 |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 266 | if sys.platform in ('win32', 'os2emx'): |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 267 | # There's no distinction among 'user', 'group' and 'world'; |
| 268 | # replicate the 'user' bits. |
| 269 | user = expected >> 6 |
| 270 | expected = user * (1 + 8 + 64) |
| 271 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 272 | |
| 273 | def test_noinherit(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 274 | # _mkstemp_inner file handles are not inherited by child processes |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 275 | if not has_spawnl: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 276 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 277 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 278 | if support.verbose: |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 279 | v="v" |
| 280 | else: |
| 281 | v="q" |
| 282 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 283 | file = self.do_create() |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 284 | fd = "%d" % file.fd |
| 285 | |
| 286 | try: |
| 287 | me = __file__ |
| 288 | except NameError: |
| 289 | me = sys.argv[0] |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 290 | |
| 291 | # We have to exec something, so that FD_CLOEXEC will take |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 292 | # effect. The core of this test is therefore in |
| 293 | # tf_inherit_check.py, which see. |
| 294 | tester = os.path.join(os.path.dirname(os.path.abspath(me)), |
| 295 | "tf_inherit_check.py") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 296 | |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 297 | # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted, |
| 298 | # but an arg with embedded spaces should be decorated with double |
| 299 | # quotes on each end |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 300 | if sys.platform in ('win32',): |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 301 | decorated = '"%s"' % sys.executable |
| 302 | tester = '"%s"' % tester |
| 303 | else: |
| 304 | decorated = sys.executable |
| 305 | |
| 306 | retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 307 | self.assertFalse(retval < 0, |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 308 | "child process caught fatal signal %d" % -retval) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 309 | self.assertFalse(retval > 0, "child process reports failure %d"%retval) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 310 | |
| 311 | def test_textmode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 312 | # _mkstemp_inner can create files in text mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 313 | if not has_textmode: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 314 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 315 | |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 316 | # A text file is truncated at the first Ctrl+Z byte |
| 317 | f = self.do_create(bin=0) |
| 318 | f.write(b"blat\x1a") |
| 319 | f.write(b"extra\n") |
| 320 | os.lseek(f.fd, 0, os.SEEK_SET) |
| 321 | self.assertEquals(os.read(f.fd, 20), b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 322 | |
| 323 | test_classes.append(test__mkstemp_inner) |
| 324 | |
| 325 | |
| 326 | class test_gettempprefix(TC): |
| 327 | """Test gettempprefix().""" |
| 328 | |
| 329 | def test_sane_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 330 | # gettempprefix returns a nonempty prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 331 | p = tempfile.gettempprefix() |
| 332 | |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 333 | self.assertIsInstance(p, str) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 334 | self.assertTrue(len(p) > 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 335 | |
| 336 | def test_usable_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 337 | # gettempprefix returns a usable prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 338 | |
| 339 | # Create a temp directory, avoiding use of the prefix. |
| 340 | # Then attempt to create a file whose name is |
| 341 | # prefix + 'xxxxxx.xxx' in that directory. |
| 342 | p = tempfile.gettempprefix() + "xxxxxx.xxx" |
| 343 | d = tempfile.mkdtemp(prefix="") |
| 344 | try: |
| 345 | p = os.path.join(d, p) |
| 346 | try: |
| 347 | fd = os.open(p, os.O_RDWR | os.O_CREAT) |
| 348 | except: |
| 349 | self.failOnException("os.open") |
| 350 | os.close(fd) |
| 351 | os.unlink(p) |
| 352 | finally: |
| 353 | os.rmdir(d) |
| 354 | |
| 355 | test_classes.append(test_gettempprefix) |
| 356 | |
| 357 | |
| 358 | class test_gettempdir(TC): |
| 359 | """Test gettempdir().""" |
| 360 | |
| 361 | def test_directory_exists(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 362 | # gettempdir returns a directory which exists |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 363 | |
| 364 | dir = tempfile.gettempdir() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 365 | self.assertTrue(os.path.isabs(dir) or dir == os.curdir, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 366 | "%s is not an absolute path" % dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 367 | self.assertTrue(os.path.isdir(dir), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 368 | "%s is not a directory" % dir) |
| 369 | |
| 370 | def test_directory_writable(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 371 | # gettempdir returns a directory writable by the user |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 372 | |
| 373 | # sneaky: just instantiate a NamedTemporaryFile, which |
| 374 | # defaults to writing into the directory returned by |
| 375 | # gettempdir. |
| 376 | try: |
| 377 | file = tempfile.NamedTemporaryFile() |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 378 | file.write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 379 | file.close() |
| 380 | except: |
| 381 | self.failOnException("create file in %s" % tempfile.gettempdir()) |
| 382 | |
| 383 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 384 | # gettempdir always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 385 | a = tempfile.gettempdir() |
| 386 | b = tempfile.gettempdir() |
| 387 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 388 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 389 | |
| 390 | test_classes.append(test_gettempdir) |
| 391 | |
| 392 | |
| 393 | class test_mkstemp(TC): |
| 394 | """Test mkstemp().""" |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 395 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 396 | def do_create(self, dir=None, pre="", suf=""): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 397 | if dir is None: |
| 398 | dir = tempfile.gettempdir() |
| 399 | try: |
| 400 | (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf) |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 401 | (ndir, nbase) = os.path.split(name) |
| 402 | adir = os.path.abspath(dir) |
| 403 | self.assertEqual(adir, ndir, |
| 404 | "Directory '%s' incorrectly returned as '%s'" % (adir, ndir)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 405 | except: |
| 406 | self.failOnException("mkstemp") |
| 407 | |
| 408 | try: |
| 409 | self.nameCheck(name, dir, pre, suf) |
| 410 | finally: |
| 411 | os.close(fd) |
| 412 | os.unlink(name) |
| 413 | |
| 414 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 415 | # mkstemp can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 416 | self.do_create() |
| 417 | self.do_create(pre="a") |
| 418 | self.do_create(suf="b") |
| 419 | self.do_create(pre="a", suf="b") |
| 420 | self.do_create(pre="aa", suf=".txt") |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 421 | self.do_create(dir=".") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 422 | |
| 423 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 424 | # mkstemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 425 | dir = tempfile.mkdtemp() |
| 426 | try: |
| 427 | self.do_create(dir=dir) |
| 428 | finally: |
| 429 | os.rmdir(dir) |
| 430 | |
| 431 | test_classes.append(test_mkstemp) |
| 432 | |
| 433 | |
| 434 | class test_mkdtemp(TC): |
| 435 | """Test mkdtemp().""" |
| 436 | |
| 437 | def do_create(self, dir=None, pre="", suf=""): |
| 438 | if dir is None: |
| 439 | dir = tempfile.gettempdir() |
| 440 | try: |
| 441 | name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf) |
| 442 | except: |
| 443 | self.failOnException("mkdtemp") |
| 444 | |
| 445 | try: |
| 446 | self.nameCheck(name, dir, pre, suf) |
| 447 | return name |
| 448 | except: |
| 449 | os.rmdir(name) |
| 450 | raise |
| 451 | |
| 452 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 453 | # mkdtemp can create directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 454 | os.rmdir(self.do_create()) |
| 455 | os.rmdir(self.do_create(pre="a")) |
| 456 | os.rmdir(self.do_create(suf="b")) |
| 457 | os.rmdir(self.do_create(pre="a", suf="b")) |
| 458 | os.rmdir(self.do_create(pre="aa", suf=".txt")) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 459 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 460 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 461 | # mkdtemp can create many directories (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 462 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 463 | try: |
| 464 | for i in extant: |
| 465 | extant[i] = self.do_create(pre="aa") |
| 466 | finally: |
| 467 | for i in extant: |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 468 | if(isinstance(i, str)): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 469 | os.rmdir(i) |
| 470 | |
| 471 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 472 | # mkdtemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 473 | dir = tempfile.mkdtemp() |
| 474 | try: |
| 475 | os.rmdir(self.do_create(dir=dir)) |
| 476 | finally: |
| 477 | os.rmdir(dir) |
| 478 | |
| 479 | def test_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 480 | # mkdtemp creates directories with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 481 | if not has_stat: |
Benjamin Peterson | e549ead | 2009-03-28 21:42:05 +0000 | [diff] [blame] | 482 | return # ugh, can't use SkipTest. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 483 | |
| 484 | dir = self.do_create() |
| 485 | try: |
| 486 | mode = stat.S_IMODE(os.stat(dir).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 487 | mode &= 0o777 # Mask off sticky bits inherited from /tmp |
| 488 | expected = 0o700 |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 489 | if sys.platform in ('win32', 'os2emx'): |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 490 | # There's no distinction among 'user', 'group' and 'world'; |
| 491 | # replicate the 'user' bits. |
| 492 | user = expected >> 6 |
| 493 | expected = user * (1 + 8 + 64) |
| 494 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 495 | finally: |
| 496 | os.rmdir(dir) |
| 497 | |
| 498 | test_classes.append(test_mkdtemp) |
| 499 | |
| 500 | |
| 501 | class test_mktemp(TC): |
| 502 | """Test mktemp().""" |
| 503 | |
| 504 | # For safety, all use of mktemp must occur in a private directory. |
| 505 | # We must also suppress the RuntimeWarning it generates. |
| 506 | def setUp(self): |
| 507 | self.dir = tempfile.mkdtemp() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 508 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 509 | |
| 510 | def tearDown(self): |
| 511 | if self.dir: |
| 512 | os.rmdir(self.dir) |
| 513 | self.dir = None |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 514 | super().tearDown() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 515 | |
| 516 | class mktemped: |
| 517 | _unlink = os.unlink |
| 518 | _bflags = tempfile._bin_openflags |
| 519 | |
| 520 | def __init__(self, dir, pre, suf): |
| 521 | self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf) |
| 522 | # Create the file. This will raise an exception if it's |
| 523 | # mysteriously appeared in the meanwhile. |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 524 | os.close(os.open(self.name, self._bflags, 0o600)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 525 | |
| 526 | def __del__(self): |
| 527 | self._unlink(self.name) |
| 528 | |
| 529 | def do_create(self, pre="", suf=""): |
| 530 | try: |
| 531 | file = self.mktemped(self.dir, pre, suf) |
| 532 | except: |
| 533 | self.failOnException("mktemp") |
| 534 | |
| 535 | self.nameCheck(file.name, self.dir, pre, suf) |
| 536 | return file |
| 537 | |
| 538 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 539 | # mktemp can choose usable file names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 540 | self.do_create() |
| 541 | self.do_create(pre="a") |
| 542 | self.do_create(suf="b") |
| 543 | self.do_create(pre="a", suf="b") |
| 544 | self.do_create(pre="aa", suf=".txt") |
| 545 | |
| 546 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 547 | # mktemp can choose many usable file names (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 548 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 549 | for i in extant: |
| 550 | extant[i] = self.do_create(pre="aa") |
| 551 | |
Fred Drake | 8bec483 | 2002-11-22 20:13:43 +0000 | [diff] [blame] | 552 | ## def test_warning(self): |
| 553 | ## # mktemp issues a warning when used |
| 554 | ## warnings.filterwarnings("error", |
| 555 | ## category=RuntimeWarning, |
| 556 | ## message="mktemp") |
| 557 | ## self.assertRaises(RuntimeWarning, |
| 558 | ## tempfile.mktemp, dir=self.dir) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 559 | |
| 560 | test_classes.append(test_mktemp) |
| 561 | |
| 562 | |
| 563 | # We test _TemporaryFileWrapper by testing NamedTemporaryFile. |
| 564 | |
| 565 | |
| 566 | class test_NamedTemporaryFile(TC): |
| 567 | """Test NamedTemporaryFile().""" |
| 568 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 569 | def do_create(self, dir=None, pre="", suf="", delete=True): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 570 | if dir is None: |
| 571 | dir = tempfile.gettempdir() |
| 572 | try: |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 573 | file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf, |
| 574 | delete=delete) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 575 | except: |
| 576 | self.failOnException("NamedTemporaryFile") |
| 577 | |
| 578 | self.nameCheck(file.name, dir, pre, suf) |
| 579 | return file |
| 580 | |
| 581 | |
| 582 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 583 | # NamedTemporaryFile can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 584 | self.do_create() |
| 585 | self.do_create(pre="a") |
| 586 | self.do_create(suf="b") |
| 587 | self.do_create(pre="a", suf="b") |
| 588 | self.do_create(pre="aa", suf=".txt") |
| 589 | |
| 590 | def test_creates_named(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 591 | # NamedTemporaryFile creates files with names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 592 | f = tempfile.NamedTemporaryFile() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 593 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 594 | "NamedTemporaryFile %s does not exist" % f.name) |
| 595 | |
| 596 | def test_del_on_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 597 | # A NamedTemporaryFile is deleted when closed |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 598 | dir = tempfile.mkdtemp() |
| 599 | try: |
| 600 | f = tempfile.NamedTemporaryFile(dir=dir) |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 601 | f.write(b'blat') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 602 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 603 | self.assertFalse(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 604 | "NamedTemporaryFile %s exists after close" % f.name) |
| 605 | finally: |
| 606 | os.rmdir(dir) |
| 607 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 608 | def test_dis_del_on_close(self): |
| 609 | # Tests that delete-on-close can be disabled |
| 610 | dir = tempfile.mkdtemp() |
| 611 | tmp = None |
| 612 | try: |
| 613 | f = tempfile.NamedTemporaryFile(dir=dir, delete=False) |
| 614 | tmp = f.name |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 615 | f.write(b'blat') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 616 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 617 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 618 | "NamedTemporaryFile %s missing after close" % f.name) |
| 619 | finally: |
| 620 | if tmp is not None: |
| 621 | os.unlink(tmp) |
| 622 | os.rmdir(dir) |
| 623 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 624 | def test_multiple_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 625 | # A NamedTemporaryFile can be closed many times without error |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 626 | f = tempfile.NamedTemporaryFile() |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 627 | f.write(b'abc\n') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 628 | f.close() |
| 629 | try: |
| 630 | f.close() |
| 631 | f.close() |
| 632 | except: |
| 633 | self.failOnException("close") |
| 634 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 635 | def test_context_manager(self): |
| 636 | # A NamedTemporaryFile can be used as a context manager |
| 637 | with tempfile.NamedTemporaryFile() as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 638 | self.assertTrue(os.path.exists(f.name)) |
| 639 | self.assertFalse(os.path.exists(f.name)) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 640 | def use_closed(): |
| 641 | with f: |
| 642 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 643 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 644 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 645 | # How to test the mode and bufsize parameters? |
| 646 | |
| 647 | test_classes.append(test_NamedTemporaryFile) |
| 648 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 649 | class test_SpooledTemporaryFile(TC): |
| 650 | """Test SpooledTemporaryFile().""" |
| 651 | |
| 652 | def do_create(self, max_size=0, dir=None, pre="", suf=""): |
| 653 | if dir is None: |
| 654 | dir = tempfile.gettempdir() |
| 655 | try: |
| 656 | file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf) |
| 657 | except: |
| 658 | self.failOnException("SpooledTemporaryFile") |
| 659 | |
| 660 | return file |
| 661 | |
| 662 | |
| 663 | def test_basic(self): |
| 664 | # SpooledTemporaryFile can create files |
| 665 | f = self.do_create() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 666 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 667 | f = self.do_create(max_size=100, pre="a", suf=".txt") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 668 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 669 | |
| 670 | def test_del_on_close(self): |
| 671 | # A SpooledTemporaryFile is deleted when closed |
| 672 | dir = tempfile.mkdtemp() |
| 673 | try: |
| 674 | f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 675 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 676 | f.write(b'blat ' * 5) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 677 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 678 | filename = f.name |
| 679 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 680 | self.assertFalse(isinstance(filename, str) and os.path.exists(filename), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 681 | "SpooledTemporaryFile %s exists after close" % filename) |
| 682 | finally: |
| 683 | os.rmdir(dir) |
| 684 | |
| 685 | def test_rewrite_small(self): |
| 686 | # A SpooledTemporaryFile can be written to multiple within the max_size |
| 687 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 688 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 689 | for i in range(5): |
| 690 | f.seek(0, 0) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 691 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 692 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 693 | |
| 694 | def test_write_sequential(self): |
| 695 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 696 | # over afterward |
| 697 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 698 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 699 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 700 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 701 | f.write(b'x' * 10) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 702 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 703 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 704 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 705 | |
| 706 | def test_sparse(self): |
| 707 | # A SpooledTemporaryFile that is written late in the file will extend |
| 708 | # when that occurs |
| 709 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 710 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 711 | f.seek(100, 0) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 712 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 713 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 714 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 715 | |
| 716 | def test_fileno(self): |
| 717 | # A SpooledTemporaryFile should roll over to a real file on fileno() |
| 718 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 719 | self.assertFalse(f._rolled) |
| 720 | self.assertTrue(f.fileno() > 0) |
| 721 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 722 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 723 | def test_multiple_close_before_rollover(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 724 | # A SpooledTemporaryFile can be closed many times without error |
| 725 | f = tempfile.SpooledTemporaryFile() |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 726 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 727 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 728 | f.close() |
| 729 | try: |
| 730 | f.close() |
| 731 | f.close() |
| 732 | except: |
| 733 | self.failOnException("close") |
| 734 | |
| 735 | def test_multiple_close_after_rollover(self): |
| 736 | # A SpooledTemporaryFile can be closed many times without error |
| 737 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 738 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 739 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 740 | f.close() |
| 741 | try: |
| 742 | f.close() |
| 743 | f.close() |
| 744 | except: |
| 745 | self.failOnException("close") |
| 746 | |
| 747 | def test_bound_methods(self): |
| 748 | # It should be OK to steal a bound method from a SpooledTemporaryFile |
| 749 | # and use it independently; when the file rolls over, those bound |
| 750 | # methods should continue to function |
| 751 | f = self.do_create(max_size=30) |
| 752 | read = f.read |
| 753 | write = f.write |
| 754 | seek = f.seek |
| 755 | |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 756 | write(b"a" * 35) |
| 757 | write(b"b" * 35) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 758 | seek(0, 0) |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 759 | self.assertEqual(read(70), b'a'*35 + b'b'*35) |
| 760 | |
| 761 | def test_text_mode(self): |
| 762 | # Creating a SpooledTemporaryFile with a text mode should produce |
| 763 | # a file object reading and writing (Unicode) text strings. |
| 764 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10) |
| 765 | f.write("abc\n") |
| 766 | f.seek(0) |
| 767 | self.assertEqual(f.read(), "abc\n") |
| 768 | f.write("def\n") |
| 769 | f.seek(0) |
| 770 | self.assertEqual(f.read(), "abc\ndef\n") |
| 771 | f.write("xyzzy\n") |
| 772 | f.seek(0) |
| 773 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\n") |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 774 | # Check that Ctrl+Z doesn't truncate the file |
| 775 | f.write("foo\x1abar\n") |
| 776 | f.seek(0) |
| 777 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n") |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 778 | |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 779 | def test_text_newline_and_encoding(self): |
| 780 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10, |
| 781 | newline='', encoding='utf-8') |
| 782 | f.write("\u039B\r\n") |
| 783 | f.seek(0) |
| 784 | self.assertEqual(f.read(), "\u039B\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 785 | self.assertFalse(f._rolled) |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 786 | |
| 787 | f.write("\u039B" * 20 + "\r\n") |
| 788 | f.seek(0) |
| 789 | self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 790 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 791 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 792 | def test_context_manager_before_rollover(self): |
| 793 | # A SpooledTemporaryFile can be used as a context manager |
| 794 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 795 | self.assertFalse(f._rolled) |
| 796 | self.assertFalse(f.closed) |
| 797 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 798 | def use_closed(): |
| 799 | with f: |
| 800 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 801 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 802 | |
| 803 | def test_context_manager_during_rollover(self): |
| 804 | # A SpooledTemporaryFile can be used as a context manager |
| 805 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 806 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 807 | f.write(b'abc\n') |
| 808 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 809 | self.assertTrue(f._rolled) |
| 810 | self.assertFalse(f.closed) |
| 811 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 812 | def use_closed(): |
| 813 | with f: |
| 814 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 815 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 816 | |
| 817 | def test_context_manager_after_rollover(self): |
| 818 | # A SpooledTemporaryFile can be used as a context manager |
| 819 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 820 | f.write(b'abc\n') |
| 821 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 822 | self.assertTrue(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 823 | with f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 824 | self.assertFalse(f.closed) |
| 825 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 826 | def use_closed(): |
| 827 | with f: |
| 828 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 829 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 830 | |
| 831 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 832 | test_classes.append(test_SpooledTemporaryFile) |
| 833 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 834 | |
| 835 | class test_TemporaryFile(TC): |
| 836 | """Test TemporaryFile().""" |
| 837 | |
| 838 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 839 | # TemporaryFile can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 840 | # No point in testing the name params - the file has no name. |
| 841 | try: |
| 842 | tempfile.TemporaryFile() |
| 843 | except: |
| 844 | self.failOnException("TemporaryFile") |
| 845 | |
| 846 | def test_has_no_name(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 847 | # TemporaryFile creates files with no names (on this system) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 848 | dir = tempfile.mkdtemp() |
| 849 | f = tempfile.TemporaryFile(dir=dir) |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 850 | f.write(b'blat') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 851 | |
| 852 | # Sneaky: because this file has no name, it should not prevent |
| 853 | # us from removing the directory it was created in. |
| 854 | try: |
| 855 | os.rmdir(dir) |
| 856 | except: |
| 857 | ei = sys.exc_info() |
| 858 | # cleanup |
| 859 | f.close() |
| 860 | os.rmdir(dir) |
| 861 | self.failOnException("rmdir", ei) |
| 862 | |
| 863 | def test_multiple_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 864 | # A TemporaryFile can be closed many times without error |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 865 | f = tempfile.TemporaryFile() |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 866 | f.write(b'abc\n') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 867 | f.close() |
| 868 | try: |
| 869 | f.close() |
| 870 | f.close() |
| 871 | except: |
| 872 | self.failOnException("close") |
| 873 | |
| 874 | # How to test the mode and bufsize parameters? |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 875 | def test_mode_and_encoding(self): |
| 876 | |
| 877 | def roundtrip(input, *args, **kwargs): |
| 878 | with tempfile.TemporaryFile(*args, **kwargs) as fileobj: |
| 879 | fileobj.write(input) |
| 880 | fileobj.seek(0) |
| 881 | self.assertEquals(input, fileobj.read()) |
| 882 | |
| 883 | roundtrip(b"1234", "w+b") |
| 884 | roundtrip("abdc\n", "w+") |
| 885 | roundtrip("\u039B", "w+", encoding="utf-16") |
| 886 | roundtrip("foo\r\n", "w+", newline="") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 887 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 888 | |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 889 | if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 890 | test_classes.append(test_TemporaryFile) |
| 891 | |
| 892 | def test_main(): |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 893 | support.run_unittest(*test_classes) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 894 | |
| 895 | if __name__ == "__main__": |
| 896 | test_main() |