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 |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 3 | import errno |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 4 | import io |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 5 | import os |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 6 | import signal |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 7 | import sys |
| 8 | import re |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 9 | import warnings |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 10 | import contextlib |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame^] | 11 | import weakref |
Tim Peters | c57a285 | 2001-10-29 21:46:08 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 13 | import unittest |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 14 | from test import support |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 15 | |
Fred Drake | 7633d23 | 2002-10-17 22:09:03 +0000 | [diff] [blame] | 16 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 17 | if hasattr(os, 'stat'): |
| 18 | import stat |
| 19 | has_stat = 1 |
| 20 | else: |
| 21 | has_stat = 0 |
| 22 | |
| 23 | has_textmode = (tempfile._text_openflags != tempfile._bin_openflags) |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 24 | has_spawnl = hasattr(os, 'spawnl') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 25 | |
Neal Norwitz | 68ee012 | 2002-08-16 19:28:59 +0000 | [diff] [blame] | 26 | # TEST_FILES may need to be tweaked for systems depending on the maximum |
| 27 | # number of files that can be opened at one time (see ulimit -n) |
Victor Stinner | 9c3de4a | 2011-08-17 20:49:41 +0200 | [diff] [blame] | 28 | if sys.platform.startswith('openbsd'): |
Martin v. Löwis | 9996828 | 2004-09-15 06:02:54 +0000 | [diff] [blame] | 29 | TEST_FILES = 48 |
Jack Jansen | ce92147 | 2003-01-08 16:30:34 +0000 | [diff] [blame] | 30 | else: |
| 31 | TEST_FILES = 100 |
Neal Norwitz | 68ee012 | 2002-08-16 19:28:59 +0000 | [diff] [blame] | 32 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 33 | # 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. |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 38 | class BaseTestCase(unittest.TestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 39 | |
| 40 | str_check = re.compile(r"[a-zA-Z0-9_-]{6}$") |
| 41 | |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 42 | def setUp(self): |
| 43 | self._warnings_manager = support.check_warnings() |
| 44 | self._warnings_manager.__enter__() |
| 45 | warnings.filterwarnings("ignore", category=RuntimeWarning, |
| 46 | message="mktemp", module=__name__) |
| 47 | |
| 48 | def tearDown(self): |
| 49 | self._warnings_manager.__exit__(None, None, None) |
| 50 | |
| 51 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 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 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 70 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 71 | class TestExports(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 72 | def test_exports(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 73 | # There are no surprising symbols in the tempfile module |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 74 | dict = tempfile.__dict__ |
| 75 | |
| 76 | expected = { |
| 77 | "NamedTemporaryFile" : 1, |
| 78 | "TemporaryFile" : 1, |
| 79 | "mkstemp" : 1, |
| 80 | "mkdtemp" : 1, |
| 81 | "mktemp" : 1, |
| 82 | "TMP_MAX" : 1, |
| 83 | "gettempprefix" : 1, |
| 84 | "gettempdir" : 1, |
| 85 | "tempdir" : 1, |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 86 | "template" : 1, |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 87 | "SpooledTemporaryFile" : 1, |
| 88 | "TemporaryDirectory" : 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 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 98 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 99 | class TestRandomNameSequence(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 100 | """Test the internal iterator object _RandomNameSequence.""" |
| 101 | |
| 102 | def setUp(self): |
| 103 | self.r = tempfile._RandomNameSequence() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 104 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 105 | |
| 106 | def test_get_six_char_str(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 107 | # _RandomNameSequence returns a six-character string |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 108 | s = next(self.r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 109 | self.nameCheck(s, '', '', '') |
| 110 | |
| 111 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 112 | # _RandomNameSequence returns no duplicate strings (stochastic) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 113 | |
| 114 | dict = {} |
| 115 | r = self.r |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 116 | for i in range(TEST_FILES): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 117 | s = next(r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 118 | self.nameCheck(s, '', '', '') |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 119 | self.assertNotIn(s, dict) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 120 | dict[s] = 1 |
| 121 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 122 | def supports_iter(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 123 | # _RandomNameSequence supports the iterator protocol |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 124 | |
| 125 | i = 0 |
| 126 | r = self.r |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 127 | for s in r: |
| 128 | i += 1 |
| 129 | if i == 20: |
| 130 | break |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 131 | |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 132 | @unittest.skipUnless(hasattr(os, 'fork'), |
| 133 | "os.fork is required for this test") |
| 134 | def test_process_awareness(self): |
| 135 | # ensure that the random source differs between |
| 136 | # child and parent. |
| 137 | read_fd, write_fd = os.pipe() |
| 138 | pid = None |
| 139 | try: |
| 140 | pid = os.fork() |
| 141 | if not pid: |
| 142 | os.close(read_fd) |
| 143 | os.write(write_fd, next(self.r).encode("ascii")) |
| 144 | os.close(write_fd) |
| 145 | # bypass the normal exit handlers- leave those to |
| 146 | # the parent. |
| 147 | os._exit(0) |
| 148 | parent_value = next(self.r) |
| 149 | child_value = os.read(read_fd, len(parent_value)).decode("ascii") |
| 150 | finally: |
| 151 | if pid: |
| 152 | # best effort to ensure the process can't bleed out |
| 153 | # via any bugs above |
| 154 | try: |
| 155 | os.kill(pid, signal.SIGKILL) |
| 156 | except EnvironmentError: |
| 157 | pass |
| 158 | os.close(read_fd) |
| 159 | os.close(write_fd) |
| 160 | self.assertNotEqual(child_value, parent_value) |
| 161 | |
| 162 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 163 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 164 | class TestCandidateTempdirList(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 165 | """Test the internal function _candidate_tempdir_list.""" |
| 166 | |
| 167 | def test_nonempty_list(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 168 | # _candidate_tempdir_list returns a nonempty list of strings |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 169 | |
| 170 | cand = tempfile._candidate_tempdir_list() |
| 171 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 172 | self.assertFalse(len(cand) == 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 173 | for c in cand: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 174 | self.assertIsInstance(c, str) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 175 | |
| 176 | def test_wanted_dirs(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 177 | # _candidate_tempdir_list contains the expected directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 178 | |
| 179 | # Make sure the interesting environment variables are all set. |
Hirokazu Yamamoto | 7195963 | 2009-04-27 01:44:28 +0000 | [diff] [blame] | 180 | with support.EnvironmentVarGuard() as env: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 181 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 182 | dirname = os.getenv(envname) |
| 183 | if not dirname: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 184 | env[envname] = os.path.abspath(envname) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 185 | |
| 186 | cand = tempfile._candidate_tempdir_list() |
| 187 | |
| 188 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 189 | dirname = os.getenv(envname) |
| 190 | if not dirname: raise ValueError |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 191 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 192 | |
| 193 | try: |
| 194 | dirname = os.getcwd() |
| 195 | except (AttributeError, os.error): |
| 196 | dirname = os.curdir |
| 197 | |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 198 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 199 | |
| 200 | # Not practical to try to verify the presence of OS-specific |
| 201 | # paths in this list. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 202 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 203 | |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 204 | # We test _get_default_tempdir some more by testing gettempdir. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 205 | |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 206 | class TestGetDefaultTempdir(BaseTestCase): |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 207 | """Test _get_default_tempdir().""" |
| 208 | |
| 209 | def test_no_files_left_behind(self): |
| 210 | # use a private empty directory |
| 211 | with tempfile.TemporaryDirectory() as our_temp_directory: |
| 212 | # force _get_default_tempdir() to consider our empty directory |
| 213 | def our_candidate_list(): |
| 214 | return [our_temp_directory] |
| 215 | |
| 216 | with support.swap_attr(tempfile, "_candidate_tempdir_list", |
| 217 | our_candidate_list): |
| 218 | # verify our directory is empty after _get_default_tempdir() |
| 219 | tempfile._get_default_tempdir() |
| 220 | self.assertEqual(os.listdir(our_temp_directory), []) |
| 221 | |
| 222 | def raise_OSError(*args, **kwargs): |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 223 | raise OSError() |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 224 | |
| 225 | with support.swap_attr(io, "open", raise_OSError): |
| 226 | # test again with failing io.open() |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 227 | with self.assertRaises(FileNotFoundError): |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 228 | tempfile._get_default_tempdir() |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 229 | self.assertEqual(os.listdir(our_temp_directory), []) |
| 230 | |
| 231 | open = io.open |
| 232 | def bad_writer(*args, **kwargs): |
| 233 | fp = open(*args, **kwargs) |
| 234 | fp.write = raise_OSError |
| 235 | return fp |
| 236 | |
| 237 | with support.swap_attr(io, "open", bad_writer): |
| 238 | # test again with failing write() |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 239 | with self.assertRaises(FileNotFoundError): |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 240 | tempfile._get_default_tempdir() |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 241 | self.assertEqual(os.listdir(our_temp_directory), []) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 242 | |
| 243 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 244 | class TestGetCandidateNames(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 245 | """Test the internal function _get_candidate_names.""" |
| 246 | |
| 247 | def test_retval(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 248 | # _get_candidate_names returns a _RandomNameSequence object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 249 | obj = tempfile._get_candidate_names() |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 250 | self.assertIsInstance(obj, tempfile._RandomNameSequence) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 251 | |
| 252 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 253 | # _get_candidate_names always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 254 | a = tempfile._get_candidate_names() |
| 255 | b = tempfile._get_candidate_names() |
| 256 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 257 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 258 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 259 | |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 260 | @contextlib.contextmanager |
| 261 | def _inside_empty_temp_dir(): |
| 262 | dir = tempfile.mkdtemp() |
| 263 | try: |
| 264 | with support.swap_attr(tempfile, 'tempdir', dir): |
| 265 | yield |
| 266 | finally: |
| 267 | support.rmtree(dir) |
| 268 | |
| 269 | |
| 270 | def _mock_candidate_names(*names): |
| 271 | return support.swap_attr(tempfile, |
| 272 | '_get_candidate_names', |
| 273 | lambda: iter(names)) |
| 274 | |
| 275 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 276 | class TestMkstempInner(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 277 | """Test the internal function _mkstemp_inner.""" |
| 278 | |
| 279 | class mkstemped: |
| 280 | _bflags = tempfile._bin_openflags |
| 281 | _tflags = tempfile._text_openflags |
| 282 | _close = os.close |
| 283 | _unlink = os.unlink |
| 284 | |
| 285 | def __init__(self, dir, pre, suf, bin): |
| 286 | if bin: flags = self._bflags |
| 287 | else: flags = self._tflags |
| 288 | |
| 289 | (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags) |
| 290 | |
| 291 | def write(self, str): |
| 292 | os.write(self.fd, str) |
| 293 | |
| 294 | def __del__(self): |
| 295 | self._close(self.fd) |
| 296 | self._unlink(self.name) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 297 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 298 | def do_create(self, dir=None, pre="", suf="", bin=1): |
| 299 | if dir is None: |
| 300 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 301 | file = self.mkstemped(dir, pre, suf, bin) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 302 | |
| 303 | self.nameCheck(file.name, dir, pre, suf) |
| 304 | return file |
| 305 | |
| 306 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 307 | # _mkstemp_inner can create files |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 308 | self.do_create().write(b"blat") |
| 309 | self.do_create(pre="a").write(b"blat") |
| 310 | self.do_create(suf="b").write(b"blat") |
| 311 | self.do_create(pre="a", suf="b").write(b"blat") |
| 312 | self.do_create(pre="aa", suf=".txt").write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 313 | |
| 314 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 315 | # _mkstemp_inner can create many files (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 316 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 317 | for i in extant: |
| 318 | extant[i] = self.do_create(pre="aa") |
| 319 | |
| 320 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 321 | # _mkstemp_inner can create files in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 322 | dir = tempfile.mkdtemp() |
| 323 | try: |
Antoine Pitrou | 9cadb1b | 2008-09-15 23:02:56 +0000 | [diff] [blame] | 324 | self.do_create(dir=dir).write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 325 | finally: |
| 326 | os.rmdir(dir) |
| 327 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 328 | @unittest.skipUnless(has_stat, 'os.stat not available') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 329 | def test_file_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 330 | # _mkstemp_inner creates files with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 331 | |
| 332 | file = self.do_create() |
| 333 | mode = stat.S_IMODE(os.stat(file.name).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 334 | expected = 0o600 |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 335 | if sys.platform in ('win32', 'os2emx'): |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 336 | # There's no distinction among 'user', 'group' and 'world'; |
| 337 | # replicate the 'user' bits. |
| 338 | user = expected >> 6 |
| 339 | expected = user * (1 + 8 + 64) |
| 340 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 341 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 342 | @unittest.skipUnless(has_spawnl, 'os.spawnl not available') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 343 | def test_noinherit(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 344 | # _mkstemp_inner file handles are not inherited by child processes |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 345 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 346 | if support.verbose: |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 347 | v="v" |
| 348 | else: |
| 349 | v="q" |
| 350 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 351 | file = self.do_create() |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 352 | fd = "%d" % file.fd |
| 353 | |
| 354 | try: |
| 355 | me = __file__ |
| 356 | except NameError: |
| 357 | me = sys.argv[0] |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 358 | |
| 359 | # We have to exec something, so that FD_CLOEXEC will take |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 360 | # effect. The core of this test is therefore in |
| 361 | # tf_inherit_check.py, which see. |
| 362 | tester = os.path.join(os.path.dirname(os.path.abspath(me)), |
| 363 | "tf_inherit_check.py") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 364 | |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 365 | # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted, |
| 366 | # but an arg with embedded spaces should be decorated with double |
| 367 | # quotes on each end |
Christian Heimes | 895627f | 2007-12-08 17:28:33 +0000 | [diff] [blame] | 368 | if sys.platform in ('win32',): |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 369 | decorated = '"%s"' % sys.executable |
| 370 | tester = '"%s"' % tester |
| 371 | else: |
| 372 | decorated = sys.executable |
| 373 | |
| 374 | retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 375 | self.assertFalse(retval < 0, |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 376 | "child process caught fatal signal %d" % -retval) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 377 | self.assertFalse(retval > 0, "child process reports failure %d"%retval) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 378 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 379 | @unittest.skipUnless(has_textmode, "text mode not available") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 380 | def test_textmode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 381 | # _mkstemp_inner can create files in text mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 382 | |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 383 | # A text file is truncated at the first Ctrl+Z byte |
| 384 | f = self.do_create(bin=0) |
| 385 | f.write(b"blat\x1a") |
| 386 | f.write(b"extra\n") |
| 387 | os.lseek(f.fd, 0, os.SEEK_SET) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 388 | self.assertEqual(os.read(f.fd, 20), b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 389 | |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 390 | def default_mkstemp_inner(self): |
| 391 | return tempfile._mkstemp_inner(tempfile.gettempdir(), |
| 392 | tempfile.template, |
| 393 | '', |
| 394 | tempfile._bin_openflags) |
| 395 | |
| 396 | def test_collision_with_existing_file(self): |
| 397 | # _mkstemp_inner tries another name when a file with |
| 398 | # the chosen name already exists |
| 399 | with _inside_empty_temp_dir(), \ |
| 400 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 401 | (fd1, name1) = self.default_mkstemp_inner() |
| 402 | os.close(fd1) |
| 403 | self.assertTrue(name1.endswith('aaa')) |
| 404 | |
| 405 | (fd2, name2) = self.default_mkstemp_inner() |
| 406 | os.close(fd2) |
| 407 | self.assertTrue(name2.endswith('bbb')) |
| 408 | |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 409 | def test_collision_with_existing_directory(self): |
| 410 | # _mkstemp_inner tries another name when a directory with |
| 411 | # the chosen name already exists |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 412 | with _inside_empty_temp_dir(), \ |
| 413 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 414 | dir = tempfile.mkdtemp() |
| 415 | self.assertTrue(dir.endswith('aaa')) |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 416 | |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 417 | (fd, name) = self.default_mkstemp_inner() |
| 418 | os.close(fd) |
| 419 | self.assertTrue(name.endswith('bbb')) |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 420 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 421 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 422 | class TestGetTempPrefix(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 423 | """Test gettempprefix().""" |
| 424 | |
| 425 | def test_sane_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 426 | # gettempprefix returns a nonempty prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 427 | p = tempfile.gettempprefix() |
| 428 | |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 429 | self.assertIsInstance(p, str) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 430 | self.assertTrue(len(p) > 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 431 | |
| 432 | def test_usable_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 433 | # gettempprefix returns a usable prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 434 | |
| 435 | # Create a temp directory, avoiding use of the prefix. |
| 436 | # Then attempt to create a file whose name is |
| 437 | # prefix + 'xxxxxx.xxx' in that directory. |
| 438 | p = tempfile.gettempprefix() + "xxxxxx.xxx" |
| 439 | d = tempfile.mkdtemp(prefix="") |
| 440 | try: |
| 441 | p = os.path.join(d, p) |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 442 | fd = os.open(p, os.O_RDWR | os.O_CREAT) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 443 | os.close(fd) |
| 444 | os.unlink(p) |
| 445 | finally: |
| 446 | os.rmdir(d) |
| 447 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 448 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 449 | class TestGetTempDir(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 450 | """Test gettempdir().""" |
| 451 | |
| 452 | def test_directory_exists(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 453 | # gettempdir returns a directory which exists |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 454 | |
| 455 | dir = tempfile.gettempdir() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 456 | self.assertTrue(os.path.isabs(dir) or dir == os.curdir, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 457 | "%s is not an absolute path" % dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 458 | self.assertTrue(os.path.isdir(dir), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 459 | "%s is not a directory" % dir) |
| 460 | |
| 461 | def test_directory_writable(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 462 | # gettempdir returns a directory writable by the user |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 463 | |
| 464 | # sneaky: just instantiate a NamedTemporaryFile, which |
| 465 | # defaults to writing into the directory returned by |
| 466 | # gettempdir. |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 467 | file = tempfile.NamedTemporaryFile() |
| 468 | file.write(b"blat") |
| 469 | file.close() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 470 | |
| 471 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 472 | # gettempdir always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 473 | a = tempfile.gettempdir() |
| 474 | b = tempfile.gettempdir() |
| 475 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 476 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 477 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 478 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 479 | class TestMkstemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 480 | """Test mkstemp().""" |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 481 | |
Thomas Wouters | 73e5a5b | 2006-06-08 15:35:45 +0000 | [diff] [blame] | 482 | def do_create(self, dir=None, pre="", suf=""): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 483 | if dir is None: |
| 484 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 485 | (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf) |
| 486 | (ndir, nbase) = os.path.split(name) |
| 487 | adir = os.path.abspath(dir) |
| 488 | self.assertEqual(adir, ndir, |
| 489 | "Directory '%s' incorrectly returned as '%s'" % (adir, ndir)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 490 | |
| 491 | try: |
| 492 | self.nameCheck(name, dir, pre, suf) |
| 493 | finally: |
| 494 | os.close(fd) |
| 495 | os.unlink(name) |
| 496 | |
| 497 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 498 | # mkstemp can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 499 | self.do_create() |
| 500 | self.do_create(pre="a") |
| 501 | self.do_create(suf="b") |
| 502 | self.do_create(pre="a", suf="b") |
| 503 | self.do_create(pre="aa", suf=".txt") |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 504 | self.do_create(dir=".") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 505 | |
| 506 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 507 | # mkstemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 508 | dir = tempfile.mkdtemp() |
| 509 | try: |
| 510 | self.do_create(dir=dir) |
| 511 | finally: |
| 512 | os.rmdir(dir) |
| 513 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 514 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 515 | class TestMkdtemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 516 | """Test mkdtemp().""" |
| 517 | |
| 518 | def do_create(self, dir=None, pre="", suf=""): |
| 519 | if dir is None: |
| 520 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 521 | name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 522 | |
| 523 | try: |
| 524 | self.nameCheck(name, dir, pre, suf) |
| 525 | return name |
| 526 | except: |
| 527 | os.rmdir(name) |
| 528 | raise |
| 529 | |
| 530 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 531 | # mkdtemp can create directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 532 | os.rmdir(self.do_create()) |
| 533 | os.rmdir(self.do_create(pre="a")) |
| 534 | os.rmdir(self.do_create(suf="b")) |
| 535 | os.rmdir(self.do_create(pre="a", suf="b")) |
| 536 | os.rmdir(self.do_create(pre="aa", suf=".txt")) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 537 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 538 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 539 | # mkdtemp can create many directories (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 540 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 541 | try: |
| 542 | for i in extant: |
| 543 | extant[i] = self.do_create(pre="aa") |
| 544 | finally: |
| 545 | for i in extant: |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 546 | if(isinstance(i, str)): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 547 | os.rmdir(i) |
| 548 | |
| 549 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 550 | # mkdtemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 551 | dir = tempfile.mkdtemp() |
| 552 | try: |
| 553 | os.rmdir(self.do_create(dir=dir)) |
| 554 | finally: |
| 555 | os.rmdir(dir) |
| 556 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 557 | @unittest.skipUnless(has_stat, 'os.stat not available') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 558 | def test_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 559 | # mkdtemp creates directories with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 560 | |
| 561 | dir = self.do_create() |
| 562 | try: |
| 563 | mode = stat.S_IMODE(os.stat(dir).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 564 | mode &= 0o777 # Mask off sticky bits inherited from /tmp |
| 565 | expected = 0o700 |
Ronald Oussoren | 94f2528 | 2010-05-05 19:11:21 +0000 | [diff] [blame] | 566 | if sys.platform in ('win32', 'os2emx'): |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 567 | # There's no distinction among 'user', 'group' and 'world'; |
| 568 | # replicate the 'user' bits. |
| 569 | user = expected >> 6 |
| 570 | expected = user * (1 + 8 + 64) |
| 571 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 572 | finally: |
| 573 | os.rmdir(dir) |
| 574 | |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 575 | def test_collision_with_existing_file(self): |
| 576 | # mkdtemp tries another name when a file with |
| 577 | # the chosen name already exists |
| 578 | with _inside_empty_temp_dir(), \ |
| 579 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 580 | file = tempfile.NamedTemporaryFile(delete=False) |
| 581 | file.close() |
| 582 | self.assertTrue(file.name.endswith('aaa')) |
| 583 | dir = tempfile.mkdtemp() |
| 584 | self.assertTrue(dir.endswith('bbb')) |
| 585 | |
| 586 | def test_collision_with_existing_directory(self): |
| 587 | # mkdtemp tries another name when a directory with |
| 588 | # the chosen name already exists |
| 589 | with _inside_empty_temp_dir(), \ |
| 590 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 591 | dir1 = tempfile.mkdtemp() |
| 592 | self.assertTrue(dir1.endswith('aaa')) |
| 593 | dir2 = tempfile.mkdtemp() |
| 594 | self.assertTrue(dir2.endswith('bbb')) |
| 595 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 596 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 597 | class TestMktemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 598 | """Test mktemp().""" |
| 599 | |
| 600 | # For safety, all use of mktemp must occur in a private directory. |
| 601 | # We must also suppress the RuntimeWarning it generates. |
| 602 | def setUp(self): |
| 603 | self.dir = tempfile.mkdtemp() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 604 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 605 | |
| 606 | def tearDown(self): |
| 607 | if self.dir: |
| 608 | os.rmdir(self.dir) |
| 609 | self.dir = None |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 610 | super().tearDown() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 611 | |
| 612 | class mktemped: |
| 613 | _unlink = os.unlink |
| 614 | _bflags = tempfile._bin_openflags |
| 615 | |
| 616 | def __init__(self, dir, pre, suf): |
| 617 | self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf) |
| 618 | # Create the file. This will raise an exception if it's |
| 619 | # mysteriously appeared in the meanwhile. |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 620 | os.close(os.open(self.name, self._bflags, 0o600)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 621 | |
| 622 | def __del__(self): |
| 623 | self._unlink(self.name) |
| 624 | |
| 625 | def do_create(self, pre="", suf=""): |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 626 | file = self.mktemped(self.dir, pre, suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 627 | |
| 628 | self.nameCheck(file.name, self.dir, pre, suf) |
| 629 | return file |
| 630 | |
| 631 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 632 | # mktemp can choose usable file names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 633 | self.do_create() |
| 634 | self.do_create(pre="a") |
| 635 | self.do_create(suf="b") |
| 636 | self.do_create(pre="a", suf="b") |
| 637 | self.do_create(pre="aa", suf=".txt") |
| 638 | |
| 639 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 640 | # mktemp can choose many usable file names (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 641 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 642 | for i in extant: |
| 643 | extant[i] = self.do_create(pre="aa") |
| 644 | |
Fred Drake | 8bec483 | 2002-11-22 20:13:43 +0000 | [diff] [blame] | 645 | ## def test_warning(self): |
| 646 | ## # mktemp issues a warning when used |
| 647 | ## warnings.filterwarnings("error", |
| 648 | ## category=RuntimeWarning, |
| 649 | ## message="mktemp") |
| 650 | ## self.assertRaises(RuntimeWarning, |
| 651 | ## tempfile.mktemp, dir=self.dir) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 652 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 653 | |
| 654 | # We test _TemporaryFileWrapper by testing NamedTemporaryFile. |
| 655 | |
| 656 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 657 | class TestNamedTemporaryFile(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 658 | """Test NamedTemporaryFile().""" |
| 659 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 660 | def do_create(self, dir=None, pre="", suf="", delete=True): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 661 | if dir is None: |
| 662 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 663 | file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf, |
| 664 | delete=delete) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 665 | |
| 666 | self.nameCheck(file.name, dir, pre, suf) |
| 667 | return file |
| 668 | |
| 669 | |
| 670 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 671 | # NamedTemporaryFile can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 672 | self.do_create() |
| 673 | self.do_create(pre="a") |
| 674 | self.do_create(suf="b") |
| 675 | self.do_create(pre="a", suf="b") |
| 676 | self.do_create(pre="aa", suf=".txt") |
| 677 | |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame^] | 678 | def test_method_lookup(self): |
| 679 | # Issue #18879: Looking up a temporary file method should keep it |
| 680 | # alive long enough. |
| 681 | f = self.do_create() |
| 682 | wr = weakref.ref(f) |
| 683 | write = f.write |
| 684 | write2 = f.write |
| 685 | del f |
| 686 | write(b'foo') |
| 687 | del write |
| 688 | write2(b'bar') |
| 689 | del write2 |
| 690 | if support.check_impl_detail(cpython=True): |
| 691 | # No reference cycle was created. |
| 692 | self.assertIsNone(wr()) |
| 693 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 694 | def test_creates_named(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 695 | # NamedTemporaryFile creates files with names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 696 | f = tempfile.NamedTemporaryFile() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 697 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 698 | "NamedTemporaryFile %s does not exist" % f.name) |
| 699 | |
| 700 | def test_del_on_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 701 | # A NamedTemporaryFile is deleted when closed |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 702 | dir = tempfile.mkdtemp() |
| 703 | try: |
| 704 | f = tempfile.NamedTemporaryFile(dir=dir) |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 705 | f.write(b'blat') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 706 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 707 | self.assertFalse(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 708 | "NamedTemporaryFile %s exists after close" % f.name) |
| 709 | finally: |
| 710 | os.rmdir(dir) |
| 711 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 712 | def test_dis_del_on_close(self): |
| 713 | # Tests that delete-on-close can be disabled |
| 714 | dir = tempfile.mkdtemp() |
| 715 | tmp = None |
| 716 | try: |
| 717 | f = tempfile.NamedTemporaryFile(dir=dir, delete=False) |
| 718 | tmp = f.name |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 719 | f.write(b'blat') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 720 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 721 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 722 | "NamedTemporaryFile %s missing after close" % f.name) |
| 723 | finally: |
| 724 | if tmp is not None: |
| 725 | os.unlink(tmp) |
| 726 | os.rmdir(dir) |
| 727 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 728 | def test_multiple_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 729 | # A NamedTemporaryFile can be closed many times without error |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 730 | f = tempfile.NamedTemporaryFile() |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 731 | f.write(b'abc\n') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 732 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 733 | f.close() |
| 734 | f.close() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 735 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 736 | def test_context_manager(self): |
| 737 | # A NamedTemporaryFile can be used as a context manager |
| 738 | with tempfile.NamedTemporaryFile() as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 739 | self.assertTrue(os.path.exists(f.name)) |
| 740 | self.assertFalse(os.path.exists(f.name)) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 741 | def use_closed(): |
| 742 | with f: |
| 743 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 744 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 745 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 746 | # How to test the mode and bufsize parameters? |
| 747 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 748 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 749 | class TestSpooledTemporaryFile(BaseTestCase): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 750 | """Test SpooledTemporaryFile().""" |
| 751 | |
| 752 | def do_create(self, max_size=0, dir=None, pre="", suf=""): |
| 753 | if dir is None: |
| 754 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 755 | file = tempfile.SpooledTemporaryFile(max_size=max_size, dir=dir, prefix=pre, suffix=suf) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 756 | |
| 757 | return file |
| 758 | |
| 759 | |
| 760 | def test_basic(self): |
| 761 | # SpooledTemporaryFile can create files |
| 762 | f = self.do_create() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 763 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 764 | f = self.do_create(max_size=100, pre="a", suf=".txt") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 765 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 766 | |
| 767 | def test_del_on_close(self): |
| 768 | # A SpooledTemporaryFile is deleted when closed |
| 769 | dir = tempfile.mkdtemp() |
| 770 | try: |
| 771 | f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 772 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 773 | f.write(b'blat ' * 5) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 774 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 775 | filename = f.name |
| 776 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 777 | self.assertFalse(isinstance(filename, str) and os.path.exists(filename), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 778 | "SpooledTemporaryFile %s exists after close" % filename) |
| 779 | finally: |
| 780 | os.rmdir(dir) |
| 781 | |
| 782 | def test_rewrite_small(self): |
| 783 | # A SpooledTemporaryFile can be written to multiple within the max_size |
| 784 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 785 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 786 | for i in range(5): |
| 787 | f.seek(0, 0) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 788 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 789 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 790 | |
| 791 | def test_write_sequential(self): |
| 792 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 793 | # over afterward |
| 794 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 795 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 796 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 797 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 798 | f.write(b'x' * 10) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 799 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 800 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 801 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 802 | |
R David Murray | d89ee79 | 2011-03-14 09:55:46 -0400 | [diff] [blame] | 803 | def test_writelines(self): |
| 804 | # Verify writelines with a SpooledTemporaryFile |
| 805 | f = self.do_create() |
| 806 | f.writelines((b'x', b'y', b'z')) |
| 807 | f.seek(0) |
| 808 | buf = f.read() |
| 809 | self.assertEqual(buf, b'xyz') |
| 810 | |
| 811 | def test_writelines_sequential(self): |
| 812 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 813 | # over afterward |
| 814 | f = self.do_create(max_size=35) |
| 815 | f.writelines((b'x' * 20, b'x' * 10, b'x' * 5)) |
| 816 | self.assertFalse(f._rolled) |
| 817 | f.write(b'x') |
| 818 | self.assertTrue(f._rolled) |
| 819 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 820 | def test_sparse(self): |
| 821 | # A SpooledTemporaryFile that is written late in the file will extend |
| 822 | # when that occurs |
| 823 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 824 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 825 | f.seek(100, 0) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 826 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 827 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 828 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 829 | |
| 830 | def test_fileno(self): |
| 831 | # A SpooledTemporaryFile should roll over to a real file on fileno() |
| 832 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 833 | self.assertFalse(f._rolled) |
| 834 | self.assertTrue(f.fileno() > 0) |
| 835 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 836 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 837 | def test_multiple_close_before_rollover(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 838 | # A SpooledTemporaryFile can be closed many times without error |
| 839 | f = tempfile.SpooledTemporaryFile() |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 840 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 841 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 842 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 843 | f.close() |
| 844 | f.close() |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 845 | |
| 846 | def test_multiple_close_after_rollover(self): |
| 847 | # A SpooledTemporaryFile can be closed many times without error |
| 848 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 849 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 850 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 851 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 852 | f.close() |
| 853 | f.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 854 | |
| 855 | def test_bound_methods(self): |
| 856 | # It should be OK to steal a bound method from a SpooledTemporaryFile |
| 857 | # and use it independently; when the file rolls over, those bound |
| 858 | # methods should continue to function |
| 859 | f = self.do_create(max_size=30) |
| 860 | read = f.read |
| 861 | write = f.write |
| 862 | seek = f.seek |
| 863 | |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 864 | write(b"a" * 35) |
| 865 | write(b"b" * 35) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 866 | seek(0, 0) |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 867 | self.assertEqual(read(70), b'a'*35 + b'b'*35) |
| 868 | |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 869 | def test_properties(self): |
| 870 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 871 | f.write(b'x' * 10) |
| 872 | self.assertFalse(f._rolled) |
| 873 | self.assertEqual(f.mode, 'w+b') |
| 874 | self.assertIsNone(f.name) |
| 875 | with self.assertRaises(AttributeError): |
| 876 | f.newlines |
| 877 | with self.assertRaises(AttributeError): |
| 878 | f.encoding |
| 879 | |
| 880 | f.write(b'x') |
| 881 | self.assertTrue(f._rolled) |
| 882 | self.assertEqual(f.mode, 'rb+') |
| 883 | self.assertIsNotNone(f.name) |
| 884 | with self.assertRaises(AttributeError): |
| 885 | f.newlines |
| 886 | with self.assertRaises(AttributeError): |
| 887 | f.encoding |
| 888 | |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 889 | def test_text_mode(self): |
| 890 | # Creating a SpooledTemporaryFile with a text mode should produce |
| 891 | # a file object reading and writing (Unicode) text strings. |
| 892 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10) |
| 893 | f.write("abc\n") |
| 894 | f.seek(0) |
| 895 | self.assertEqual(f.read(), "abc\n") |
| 896 | f.write("def\n") |
| 897 | f.seek(0) |
| 898 | self.assertEqual(f.read(), "abc\ndef\n") |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 899 | self.assertFalse(f._rolled) |
| 900 | self.assertEqual(f.mode, 'w+') |
| 901 | self.assertIsNone(f.name) |
| 902 | self.assertIsNone(f.newlines) |
| 903 | self.assertIsNone(f.encoding) |
| 904 | |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 905 | f.write("xyzzy\n") |
| 906 | f.seek(0) |
| 907 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\n") |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 908 | # Check that Ctrl+Z doesn't truncate the file |
| 909 | f.write("foo\x1abar\n") |
| 910 | f.seek(0) |
| 911 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n") |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 912 | self.assertTrue(f._rolled) |
| 913 | self.assertEqual(f.mode, 'w+') |
| 914 | self.assertIsNotNone(f.name) |
Serhiy Storchaka | 497cee4 | 2013-02-10 14:43:46 +0200 | [diff] [blame] | 915 | self.assertEqual(f.newlines, os.linesep) |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 916 | self.assertIsNotNone(f.encoding) |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 917 | |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 918 | def test_text_newline_and_encoding(self): |
| 919 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10, |
| 920 | newline='', encoding='utf-8') |
| 921 | f.write("\u039B\r\n") |
| 922 | f.seek(0) |
| 923 | self.assertEqual(f.read(), "\u039B\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 924 | self.assertFalse(f._rolled) |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 925 | self.assertEqual(f.mode, 'w+') |
| 926 | self.assertIsNone(f.name) |
| 927 | self.assertIsNone(f.newlines) |
| 928 | self.assertIsNone(f.encoding) |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 929 | |
| 930 | f.write("\u039B" * 20 + "\r\n") |
| 931 | f.seek(0) |
| 932 | self.assertEqual(f.read(), "\u039B\r\n" + ("\u039B" * 20) + "\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 933 | self.assertTrue(f._rolled) |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 934 | self.assertEqual(f.mode, 'w+') |
| 935 | self.assertIsNotNone(f.name) |
| 936 | self.assertIsNotNone(f.newlines) |
| 937 | self.assertEqual(f.encoding, 'utf-8') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 938 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 939 | def test_context_manager_before_rollover(self): |
| 940 | # A SpooledTemporaryFile can be used as a context manager |
| 941 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 942 | self.assertFalse(f._rolled) |
| 943 | self.assertFalse(f.closed) |
| 944 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 945 | def use_closed(): |
| 946 | with f: |
| 947 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 948 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 949 | |
| 950 | def test_context_manager_during_rollover(self): |
| 951 | # A SpooledTemporaryFile can be used as a context manager |
| 952 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 953 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 954 | f.write(b'abc\n') |
| 955 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 956 | self.assertTrue(f._rolled) |
| 957 | self.assertFalse(f.closed) |
| 958 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 959 | def use_closed(): |
| 960 | with f: |
| 961 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 962 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 963 | |
| 964 | def test_context_manager_after_rollover(self): |
| 965 | # A SpooledTemporaryFile can be used as a context manager |
| 966 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 967 | f.write(b'abc\n') |
| 968 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 969 | self.assertTrue(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 970 | with f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 971 | self.assertFalse(f.closed) |
| 972 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 973 | def use_closed(): |
| 974 | with f: |
| 975 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 976 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 977 | |
Antoine Pitrou | 0e86a58 | 2011-11-25 18:03:09 +0100 | [diff] [blame] | 978 | def test_truncate_with_size_parameter(self): |
| 979 | # A SpooledTemporaryFile can be truncated to zero size |
| 980 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 981 | f.write(b'abcdefg\n') |
| 982 | f.seek(0) |
| 983 | f.truncate() |
| 984 | self.assertFalse(f._rolled) |
| 985 | self.assertEqual(f._file.getvalue(), b'') |
| 986 | # A SpooledTemporaryFile can be truncated to a specific size |
| 987 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 988 | f.write(b'abcdefg\n') |
| 989 | f.truncate(4) |
| 990 | self.assertFalse(f._rolled) |
| 991 | self.assertEqual(f._file.getvalue(), b'abcd') |
| 992 | # A SpooledTemporaryFile rolls over if truncated to large size |
| 993 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 994 | f.write(b'abcdefg\n') |
| 995 | f.truncate(20) |
| 996 | self.assertTrue(f._rolled) |
| 997 | if has_stat: |
| 998 | self.assertEqual(os.fstat(f.fileno()).st_size, 20) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 999 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1000 | |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 1001 | if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile: |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 1002 | |
| 1003 | class TestTemporaryFile(BaseTestCase): |
| 1004 | """Test TemporaryFile().""" |
| 1005 | |
| 1006 | def test_basic(self): |
| 1007 | # TemporaryFile can create files |
| 1008 | # No point in testing the name params - the file has no name. |
| 1009 | tempfile.TemporaryFile() |
| 1010 | |
| 1011 | def test_has_no_name(self): |
| 1012 | # TemporaryFile creates files with no names (on this system) |
| 1013 | dir = tempfile.mkdtemp() |
| 1014 | f = tempfile.TemporaryFile(dir=dir) |
| 1015 | f.write(b'blat') |
| 1016 | |
| 1017 | # Sneaky: because this file has no name, it should not prevent |
| 1018 | # us from removing the directory it was created in. |
| 1019 | try: |
| 1020 | os.rmdir(dir) |
| 1021 | except: |
| 1022 | # cleanup |
| 1023 | f.close() |
| 1024 | os.rmdir(dir) |
| 1025 | raise |
| 1026 | |
| 1027 | def test_multiple_close(self): |
| 1028 | # A TemporaryFile can be closed many times without error |
| 1029 | f = tempfile.TemporaryFile() |
| 1030 | f.write(b'abc\n') |
| 1031 | f.close() |
| 1032 | f.close() |
| 1033 | f.close() |
| 1034 | |
| 1035 | # How to test the mode and bufsize parameters? |
| 1036 | def test_mode_and_encoding(self): |
| 1037 | |
| 1038 | def roundtrip(input, *args, **kwargs): |
| 1039 | with tempfile.TemporaryFile(*args, **kwargs) as fileobj: |
| 1040 | fileobj.write(input) |
| 1041 | fileobj.seek(0) |
| 1042 | self.assertEqual(input, fileobj.read()) |
| 1043 | |
| 1044 | roundtrip(b"1234", "w+b") |
| 1045 | roundtrip("abdc\n", "w+") |
| 1046 | roundtrip("\u039B", "w+", encoding="utf-16") |
| 1047 | roundtrip("foo\r\n", "w+", newline="") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1048 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1049 | |
| 1050 | # Helper for test_del_on_shutdown |
| 1051 | class NulledModules: |
| 1052 | def __init__(self, *modules): |
| 1053 | self.refs = [mod.__dict__ for mod in modules] |
| 1054 | self.contents = [ref.copy() for ref in self.refs] |
| 1055 | |
| 1056 | def __enter__(self): |
| 1057 | for d in self.refs: |
| 1058 | for key in d: |
| 1059 | d[key] = None |
| 1060 | |
| 1061 | def __exit__(self, *exc_info): |
| 1062 | for d, c in zip(self.refs, self.contents): |
| 1063 | d.clear() |
| 1064 | d.update(c) |
| 1065 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 1066 | class TestTemporaryDirectory(BaseTestCase): |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1067 | """Test TemporaryDirectory().""" |
| 1068 | |
| 1069 | def do_create(self, dir=None, pre="", suf="", recurse=1): |
| 1070 | if dir is None: |
| 1071 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1072 | tmp = tempfile.TemporaryDirectory(dir=dir, prefix=pre, suffix=suf) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1073 | self.nameCheck(tmp.name, dir, pre, suf) |
| 1074 | # Create a subdirectory and some files |
| 1075 | if recurse: |
| 1076 | self.do_create(tmp.name, pre, suf, recurse-1) |
| 1077 | with open(os.path.join(tmp.name, "test.txt"), "wb") as f: |
| 1078 | f.write(b"Hello world!") |
| 1079 | return tmp |
| 1080 | |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1081 | def test_mkdtemp_failure(self): |
| 1082 | # Check no additional exception if mkdtemp fails |
| 1083 | # Previously would raise AttributeError instead |
Nick Coghlan | 3c54ea6 | 2010-12-13 03:02:43 +0000 | [diff] [blame] | 1084 | # (noted as part of Issue #10188) |
| 1085 | with tempfile.TemporaryDirectory() as nonexistent: |
| 1086 | pass |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 1087 | with self.assertRaises(FileNotFoundError) as cm: |
Nick Coghlan | 3c54ea6 | 2010-12-13 03:02:43 +0000 | [diff] [blame] | 1088 | tempfile.TemporaryDirectory(dir=nonexistent) |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 1089 | self.assertEqual(cm.exception.errno, errno.ENOENT) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1090 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1091 | def test_explicit_cleanup(self): |
| 1092 | # A TemporaryDirectory is deleted when cleaned up |
| 1093 | dir = tempfile.mkdtemp() |
| 1094 | try: |
| 1095 | d = self.do_create(dir=dir) |
| 1096 | self.assertTrue(os.path.exists(d.name), |
| 1097 | "TemporaryDirectory %s does not exist" % d.name) |
| 1098 | d.cleanup() |
| 1099 | self.assertFalse(os.path.exists(d.name), |
| 1100 | "TemporaryDirectory %s exists after cleanup" % d.name) |
| 1101 | finally: |
| 1102 | os.rmdir(dir) |
| 1103 | |
Charles-François Natali | def3543 | 2011-07-29 18:59:24 +0200 | [diff] [blame] | 1104 | @support.skip_unless_symlink |
| 1105 | def test_cleanup_with_symlink_to_a_directory(self): |
| 1106 | # cleanup() should not follow symlinks to directories (issue #12464) |
| 1107 | d1 = self.do_create() |
| 1108 | d2 = self.do_create() |
| 1109 | |
| 1110 | # Symlink d1/foo -> d2 |
| 1111 | os.symlink(d2.name, os.path.join(d1.name, "foo")) |
| 1112 | |
| 1113 | # This call to cleanup() should not follow the "foo" symlink |
| 1114 | d1.cleanup() |
| 1115 | |
| 1116 | self.assertFalse(os.path.exists(d1.name), |
| 1117 | "TemporaryDirectory %s exists after cleanup" % d1.name) |
| 1118 | self.assertTrue(os.path.exists(d2.name), |
| 1119 | "Directory pointed to by a symlink was deleted") |
| 1120 | self.assertEqual(os.listdir(d2.name), ['test.txt'], |
| 1121 | "Contents of the directory pointed to by a symlink " |
| 1122 | "were deleted") |
| 1123 | d2.cleanup() |
| 1124 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1125 | @support.cpython_only |
| 1126 | def test_del_on_collection(self): |
| 1127 | # A TemporaryDirectory is deleted when garbage collected |
| 1128 | dir = tempfile.mkdtemp() |
| 1129 | try: |
| 1130 | d = self.do_create(dir=dir) |
| 1131 | name = d.name |
| 1132 | del d # Rely on refcounting to invoke __del__ |
| 1133 | self.assertFalse(os.path.exists(name), |
| 1134 | "TemporaryDirectory %s exists after __del__" % name) |
| 1135 | finally: |
| 1136 | os.rmdir(dir) |
| 1137 | |
| 1138 | @unittest.expectedFailure # See issue #10188 |
| 1139 | def test_del_on_shutdown(self): |
| 1140 | # A TemporaryDirectory may be cleaned up during shutdown |
| 1141 | # Make sure it works with the relevant modules nulled out |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1142 | with self.do_create() as dir: |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1143 | d = self.do_create(dir=dir) |
| 1144 | # Mimic the nulling out of modules that |
| 1145 | # occurs during system shutdown |
| 1146 | modules = [os, os.path] |
| 1147 | if has_stat: |
| 1148 | modules.append(stat) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1149 | # Currently broken, so suppress the warning |
| 1150 | # that is otherwise emitted on stdout |
| 1151 | with support.captured_stderr() as err: |
| 1152 | with NulledModules(*modules): |
| 1153 | d.cleanup() |
| 1154 | # Currently broken, so stop spurious exception by |
| 1155 | # indicating the object has already been closed |
| 1156 | d._closed = True |
| 1157 | # And this assert will fail, as expected by the |
| 1158 | # unittest decorator... |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1159 | self.assertFalse(os.path.exists(d.name), |
| 1160 | "TemporaryDirectory %s exists after cleanup" % d.name) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1161 | |
| 1162 | def test_warnings_on_cleanup(self): |
| 1163 | # Two kinds of warning on shutdown |
| 1164 | # Issue 10888: may write to stderr if modules are nulled out |
| 1165 | # ResourceWarning will be triggered by __del__ |
| 1166 | with self.do_create() as dir: |
Nick Coghlan | e98e8a3 | 2010-12-13 16:32:51 +0000 | [diff] [blame] | 1167 | if os.sep != '\\': |
| 1168 | # Embed a backslash in order to make sure string escaping |
| 1169 | # in the displayed error message is dealt with correctly |
| 1170 | suffix = '\\check_backslash_handling' |
| 1171 | else: |
| 1172 | suffix = '' |
| 1173 | d = self.do_create(dir=dir, suf=suffix) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1174 | |
| 1175 | #Check for the Issue 10888 message |
| 1176 | modules = [os, os.path] |
| 1177 | if has_stat: |
| 1178 | modules.append(stat) |
| 1179 | with support.captured_stderr() as err: |
| 1180 | with NulledModules(*modules): |
| 1181 | d.cleanup() |
Nick Coghlan | e98e8a3 | 2010-12-13 16:32:51 +0000 | [diff] [blame] | 1182 | message = err.getvalue().replace('\\\\', '\\') |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1183 | self.assertIn("while cleaning up", message) |
| 1184 | self.assertIn(d.name, message) |
| 1185 | |
| 1186 | # Check for the resource warning |
| 1187 | with support.check_warnings(('Implicitly', ResourceWarning), quiet=False): |
| 1188 | warnings.filterwarnings("always", category=ResourceWarning) |
| 1189 | d.__del__() |
| 1190 | self.assertFalse(os.path.exists(d.name), |
| 1191 | "TemporaryDirectory %s exists after __del__" % d.name) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1192 | |
| 1193 | def test_multiple_close(self): |
| 1194 | # Can be cleaned-up many times without error |
| 1195 | d = self.do_create() |
| 1196 | d.cleanup() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1197 | d.cleanup() |
| 1198 | d.cleanup() |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1199 | |
| 1200 | def test_context_manager(self): |
| 1201 | # Can be used as a context manager |
| 1202 | d = self.do_create() |
| 1203 | with d as name: |
| 1204 | self.assertTrue(os.path.exists(name)) |
| 1205 | self.assertEqual(name, d.name) |
| 1206 | self.assertFalse(os.path.exists(name)) |
| 1207 | |
| 1208 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1209 | def test_main(): |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 1210 | support.run_unittest(__name__) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1211 | |
| 1212 | if __name__ == "__main__": |
| 1213 | test_main() |