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 |
Anthony Sottile | 370138b | 2019-09-09 08:54:34 -0700 | [diff] [blame] | 6 | import pathlib |
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 |
Anthony Sottile | 8377cd4 | 2019-02-25 14:32:27 -0800 | [diff] [blame] | 11 | import stat |
Guido van Rossum | 48b069a | 2020-04-07 09:50:06 -0700 | [diff] [blame] | 12 | import types |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame] | 13 | import weakref |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 14 | from unittest import mock |
Tim Peters | c57a285 | 2001-10-29 21:46:08 +0000 | [diff] [blame] | 15 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 16 | import unittest |
Berker Peksag | ce64391 | 2015-05-06 06:33:17 +0300 | [diff] [blame] | 17 | from test import support |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 18 | from test.support import os_helper |
Berker Peksag | ce64391 | 2015-05-06 06:33:17 +0300 | [diff] [blame] | 19 | from test.support import script_helper |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 20 | from test.support import warnings_helper |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 21 | |
Fred Drake | 7633d23 | 2002-10-17 22:09:03 +0000 | [diff] [blame] | 22 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 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 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 37 | class TestLowLevelInternals(unittest.TestCase): |
| 38 | def test_infer_return_type_singles(self): |
| 39 | self.assertIs(str, tempfile._infer_return_type('')) |
| 40 | self.assertIs(bytes, tempfile._infer_return_type(b'')) |
| 41 | self.assertIs(str, tempfile._infer_return_type(None)) |
| 42 | |
| 43 | def test_infer_return_type_multiples(self): |
| 44 | self.assertIs(str, tempfile._infer_return_type('', '')) |
| 45 | self.assertIs(bytes, tempfile._infer_return_type(b'', b'')) |
| 46 | with self.assertRaises(TypeError): |
| 47 | tempfile._infer_return_type('', b'') |
| 48 | with self.assertRaises(TypeError): |
| 49 | tempfile._infer_return_type(b'', '') |
| 50 | |
| 51 | def test_infer_return_type_multiples_and_none(self): |
| 52 | self.assertIs(str, tempfile._infer_return_type(None, '')) |
| 53 | self.assertIs(str, tempfile._infer_return_type('', None)) |
| 54 | self.assertIs(str, tempfile._infer_return_type(None, None)) |
| 55 | self.assertIs(bytes, tempfile._infer_return_type(b'', None)) |
| 56 | self.assertIs(bytes, tempfile._infer_return_type(None, b'')) |
| 57 | with self.assertRaises(TypeError): |
| 58 | tempfile._infer_return_type('', None, b'') |
| 59 | with self.assertRaises(TypeError): |
| 60 | tempfile._infer_return_type(b'', None, '') |
| 61 | |
Anthony Sottile | 370138b | 2019-09-09 08:54:34 -0700 | [diff] [blame] | 62 | def test_infer_return_type_pathlib(self): |
| 63 | self.assertIs(str, tempfile._infer_return_type(pathlib.Path('/'))) |
| 64 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 65 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 66 | # Common functionality. |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 67 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 68 | class BaseTestCase(unittest.TestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 69 | |
Victor Stinner | 9786910 | 2013-08-14 01:28:28 +0200 | [diff] [blame] | 70 | str_check = re.compile(r"^[a-z0-9_-]{8}$") |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 71 | b_check = re.compile(br"^[a-z0-9_-]{8}$") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 72 | |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 73 | def setUp(self): |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 74 | self._warnings_manager = warnings_helper.check_warnings() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 75 | self._warnings_manager.__enter__() |
| 76 | warnings.filterwarnings("ignore", category=RuntimeWarning, |
| 77 | message="mktemp", module=__name__) |
| 78 | |
| 79 | def tearDown(self): |
| 80 | self._warnings_manager.__exit__(None, None, None) |
| 81 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 82 | def nameCheck(self, name, dir, pre, suf): |
| 83 | (ndir, nbase) = os.path.split(name) |
| 84 | npre = nbase[:len(pre)] |
| 85 | nsuf = nbase[len(nbase)-len(suf):] |
| 86 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 87 | if dir is not None: |
Anthony Sottile | 370138b | 2019-09-09 08:54:34 -0700 | [diff] [blame] | 88 | self.assertIs( |
| 89 | type(name), |
| 90 | str |
| 91 | if type(dir) is str or isinstance(dir, os.PathLike) else |
| 92 | bytes, |
| 93 | "unexpected return type", |
| 94 | ) |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 95 | if pre is not None: |
| 96 | self.assertIs(type(name), str if type(pre) is str else bytes, |
| 97 | "unexpected return type") |
| 98 | if suf is not None: |
| 99 | self.assertIs(type(name), str if type(suf) is str else bytes, |
| 100 | "unexpected return type") |
| 101 | if (dir, pre, suf) == (None, None, None): |
| 102 | self.assertIs(type(name), str, "default return type must be str") |
| 103 | |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 104 | # check for equality of the absolute paths! |
| 105 | self.assertEqual(os.path.abspath(ndir), os.path.abspath(dir), |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 106 | "file %r not in directory %r" % (name, dir)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 107 | self.assertEqual(npre, pre, |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 108 | "file %r does not begin with %r" % (nbase, pre)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 109 | self.assertEqual(nsuf, suf, |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 110 | "file %r does not end with %r" % (nbase, suf)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 111 | |
| 112 | nbase = nbase[len(pre):len(nbase)-len(suf)] |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 113 | check = self.str_check if isinstance(nbase, str) else self.b_check |
| 114 | self.assertTrue(check.match(nbase), |
| 115 | "random characters %r do not match %r" |
| 116 | % (nbase, check.pattern)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 117 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 118 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 119 | class TestExports(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 120 | def test_exports(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 121 | # There are no surprising symbols in the tempfile module |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 122 | dict = tempfile.__dict__ |
| 123 | |
| 124 | expected = { |
| 125 | "NamedTemporaryFile" : 1, |
| 126 | "TemporaryFile" : 1, |
| 127 | "mkstemp" : 1, |
| 128 | "mkdtemp" : 1, |
| 129 | "mktemp" : 1, |
| 130 | "TMP_MAX" : 1, |
| 131 | "gettempprefix" : 1, |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 132 | "gettempprefixb" : 1, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 133 | "gettempdir" : 1, |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 134 | "gettempdirb" : 1, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 135 | "tempdir" : 1, |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 136 | "template" : 1, |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 137 | "SpooledTemporaryFile" : 1, |
| 138 | "TemporaryDirectory" : 1, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | unexp = [] |
| 142 | for key in dict: |
| 143 | if key[0] != '_' and key not in expected: |
| 144 | unexp.append(key) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 145 | self.assertTrue(len(unexp) == 0, |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 146 | "unexpected keys: %s" % unexp) |
| 147 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 148 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 149 | class TestRandomNameSequence(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 150 | """Test the internal iterator object _RandomNameSequence.""" |
| 151 | |
| 152 | def setUp(self): |
| 153 | self.r = tempfile._RandomNameSequence() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 154 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 155 | |
Inada Naoki | 43ca084 | 2020-10-31 11:15:38 +0900 | [diff] [blame] | 156 | def test_get_six_char_str(self): |
| 157 | # _RandomNameSequence returns a six-character string |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 158 | s = next(self.r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 159 | self.nameCheck(s, '', '', '') |
| 160 | |
| 161 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 162 | # _RandomNameSequence returns no duplicate strings (stochastic) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 163 | |
| 164 | dict = {} |
| 165 | r = self.r |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 166 | for i in range(TEST_FILES): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 167 | s = next(r) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 168 | self.nameCheck(s, '', '', '') |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 169 | self.assertNotIn(s, dict) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 170 | dict[s] = 1 |
| 171 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 172 | def supports_iter(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 173 | # _RandomNameSequence supports the iterator protocol |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 174 | |
| 175 | i = 0 |
| 176 | r = self.r |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 177 | for s in r: |
| 178 | i += 1 |
| 179 | if i == 20: |
| 180 | break |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 181 | |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 182 | @unittest.skipUnless(hasattr(os, 'fork'), |
| 183 | "os.fork is required for this test") |
| 184 | def test_process_awareness(self): |
| 185 | # ensure that the random source differs between |
| 186 | # child and parent. |
| 187 | read_fd, write_fd = os.pipe() |
| 188 | pid = None |
| 189 | try: |
| 190 | pid = os.fork() |
| 191 | if not pid: |
Victor Stinner | 6c8c294 | 2017-08-10 13:05:06 +0200 | [diff] [blame] | 192 | # child process |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 193 | os.close(read_fd) |
| 194 | os.write(write_fd, next(self.r).encode("ascii")) |
| 195 | os.close(write_fd) |
| 196 | # bypass the normal exit handlers- leave those to |
| 197 | # the parent. |
| 198 | os._exit(0) |
Victor Stinner | 6c8c294 | 2017-08-10 13:05:06 +0200 | [diff] [blame] | 199 | |
| 200 | # parent process |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 201 | parent_value = next(self.r) |
| 202 | child_value = os.read(read_fd, len(parent_value)).decode("ascii") |
| 203 | finally: |
| 204 | if pid: |
Victor Stinner | 278c1e1 | 2020-03-31 20:08:12 +0200 | [diff] [blame] | 205 | support.wait_process(pid, exitcode=0) |
Victor Stinner | 6c8c294 | 2017-08-10 13:05:06 +0200 | [diff] [blame] | 206 | |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 207 | os.close(read_fd) |
| 208 | os.close(write_fd) |
| 209 | self.assertNotEqual(child_value, parent_value) |
| 210 | |
| 211 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 212 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 213 | class TestCandidateTempdirList(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 214 | """Test the internal function _candidate_tempdir_list.""" |
| 215 | |
| 216 | def test_nonempty_list(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 217 | # _candidate_tempdir_list returns a nonempty list of strings |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 218 | |
| 219 | cand = tempfile._candidate_tempdir_list() |
| 220 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 221 | self.assertFalse(len(cand) == 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 222 | for c in cand: |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 223 | self.assertIsInstance(c, str) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 224 | |
| 225 | def test_wanted_dirs(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 226 | # _candidate_tempdir_list contains the expected directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 227 | |
| 228 | # Make sure the interesting environment variables are all set. |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 229 | with os_helper.EnvironmentVarGuard() as env: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 230 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 231 | dirname = os.getenv(envname) |
| 232 | if not dirname: |
Walter Dörwald | 155374d | 2009-05-01 19:58:58 +0000 | [diff] [blame] | 233 | env[envname] = os.path.abspath(envname) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 234 | |
| 235 | cand = tempfile._candidate_tempdir_list() |
| 236 | |
| 237 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 238 | dirname = os.getenv(envname) |
| 239 | if not dirname: raise ValueError |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 240 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 241 | |
| 242 | try: |
| 243 | dirname = os.getcwd() |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 244 | except (AttributeError, OSError): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 245 | dirname = os.curdir |
| 246 | |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 247 | self.assertIn(dirname, cand) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 248 | |
| 249 | # Not practical to try to verify the presence of OS-specific |
| 250 | # paths in this list. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 251 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 252 | |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 253 | # We test _get_default_tempdir some more by testing gettempdir. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 254 | |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 255 | class TestGetDefaultTempdir(BaseTestCase): |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 256 | """Test _get_default_tempdir().""" |
| 257 | |
| 258 | def test_no_files_left_behind(self): |
| 259 | # use a private empty directory |
| 260 | with tempfile.TemporaryDirectory() as our_temp_directory: |
| 261 | # force _get_default_tempdir() to consider our empty directory |
| 262 | def our_candidate_list(): |
| 263 | return [our_temp_directory] |
| 264 | |
| 265 | with support.swap_attr(tempfile, "_candidate_tempdir_list", |
| 266 | our_candidate_list): |
| 267 | # verify our directory is empty after _get_default_tempdir() |
| 268 | tempfile._get_default_tempdir() |
| 269 | self.assertEqual(os.listdir(our_temp_directory), []) |
| 270 | |
| 271 | def raise_OSError(*args, **kwargs): |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 272 | raise OSError() |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 273 | |
| 274 | with support.swap_attr(io, "open", raise_OSError): |
| 275 | # test again with failing io.open() |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 276 | with self.assertRaises(FileNotFoundError): |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 277 | tempfile._get_default_tempdir() |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 278 | self.assertEqual(os.listdir(our_temp_directory), []) |
| 279 | |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 280 | def bad_writer(*args, **kwargs): |
Serhiy Storchaka | d1a1def | 2017-04-28 19:17:26 +0300 | [diff] [blame] | 281 | fp = orig_open(*args, **kwargs) |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 282 | fp.write = raise_OSError |
| 283 | return fp |
| 284 | |
Serhiy Storchaka | d1a1def | 2017-04-28 19:17:26 +0300 | [diff] [blame] | 285 | with support.swap_attr(io, "open", bad_writer) as orig_open: |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 286 | # test again with failing write() |
Serhiy Storchaka | ff7fef9 | 2013-02-13 00:37:29 +0200 | [diff] [blame] | 287 | with self.assertRaises(FileNotFoundError): |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 288 | tempfile._get_default_tempdir() |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 289 | self.assertEqual(os.listdir(our_temp_directory), []) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 290 | |
| 291 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 292 | class TestGetCandidateNames(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 293 | """Test the internal function _get_candidate_names.""" |
| 294 | |
| 295 | def test_retval(self): |
Victor Stinner | 1e62bf1 | 2017-04-19 22:59:51 +0200 | [diff] [blame] | 296 | # _get_candidate_names returns a _RandomNameSequence object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 297 | obj = tempfile._get_candidate_names() |
Victor Stinner | 1e62bf1 | 2017-04-19 22:59:51 +0200 | [diff] [blame] | 298 | self.assertIsInstance(obj, tempfile._RandomNameSequence) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 299 | |
| 300 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 301 | # _get_candidate_names always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 302 | a = tempfile._get_candidate_names() |
| 303 | b = tempfile._get_candidate_names() |
| 304 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 305 | self.assertTrue(a is b) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 306 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 307 | |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 308 | @contextlib.contextmanager |
| 309 | def _inside_empty_temp_dir(): |
| 310 | dir = tempfile.mkdtemp() |
| 311 | try: |
| 312 | with support.swap_attr(tempfile, 'tempdir', dir): |
| 313 | yield |
| 314 | finally: |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 315 | os_helper.rmtree(dir) |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 316 | |
| 317 | |
| 318 | def _mock_candidate_names(*names): |
| 319 | return support.swap_attr(tempfile, |
| 320 | '_get_candidate_names', |
| 321 | lambda: iter(names)) |
| 322 | |
| 323 | |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 324 | class TestBadTempdir: |
| 325 | |
| 326 | def test_read_only_directory(self): |
| 327 | with _inside_empty_temp_dir(): |
| 328 | oldmode = mode = os.stat(tempfile.tempdir).st_mode |
| 329 | mode &= ~(stat.S_IWUSR | stat.S_IWGRP | stat.S_IWOTH) |
| 330 | os.chmod(tempfile.tempdir, mode) |
| 331 | try: |
| 332 | if os.access(tempfile.tempdir, os.W_OK): |
| 333 | self.skipTest("can't set the directory read-only") |
| 334 | with self.assertRaises(PermissionError): |
| 335 | self.make_temp() |
| 336 | self.assertEqual(os.listdir(tempfile.tempdir), []) |
| 337 | finally: |
| 338 | os.chmod(tempfile.tempdir, oldmode) |
| 339 | |
| 340 | def test_nonexisting_directory(self): |
| 341 | with _inside_empty_temp_dir(): |
| 342 | tempdir = os.path.join(tempfile.tempdir, 'nonexistent') |
| 343 | with support.swap_attr(tempfile, 'tempdir', tempdir): |
| 344 | with self.assertRaises(FileNotFoundError): |
| 345 | self.make_temp() |
| 346 | |
| 347 | def test_non_directory(self): |
| 348 | with _inside_empty_temp_dir(): |
| 349 | tempdir = os.path.join(tempfile.tempdir, 'file') |
| 350 | open(tempdir, 'wb').close() |
| 351 | with support.swap_attr(tempfile, 'tempdir', tempdir): |
| 352 | with self.assertRaises((NotADirectoryError, FileNotFoundError)): |
| 353 | self.make_temp() |
| 354 | |
| 355 | |
| 356 | class TestMkstempInner(TestBadTempdir, BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 357 | """Test the internal function _mkstemp_inner.""" |
| 358 | |
| 359 | class mkstemped: |
| 360 | _bflags = tempfile._bin_openflags |
| 361 | _tflags = tempfile._text_openflags |
| 362 | _close = os.close |
| 363 | _unlink = os.unlink |
| 364 | |
| 365 | def __init__(self, dir, pre, suf, bin): |
| 366 | if bin: flags = self._bflags |
| 367 | else: flags = self._tflags |
| 368 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 369 | output_type = tempfile._infer_return_type(dir, pre, suf) |
| 370 | (self.fd, self.name) = tempfile._mkstemp_inner(dir, pre, suf, flags, output_type) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 371 | |
| 372 | def write(self, str): |
| 373 | os.write(self.fd, str) |
| 374 | |
| 375 | def __del__(self): |
| 376 | self._close(self.fd) |
| 377 | self._unlink(self.name) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 378 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 379 | def do_create(self, dir=None, pre=None, suf=None, bin=1): |
| 380 | output_type = tempfile._infer_return_type(dir, pre, suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 381 | if dir is None: |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 382 | if output_type is str: |
| 383 | dir = tempfile.gettempdir() |
| 384 | else: |
| 385 | dir = tempfile.gettempdirb() |
| 386 | if pre is None: |
| 387 | pre = output_type() |
| 388 | if suf is None: |
| 389 | suf = output_type() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 390 | file = self.mkstemped(dir, pre, suf, bin) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 391 | |
| 392 | self.nameCheck(file.name, dir, pre, suf) |
| 393 | return file |
| 394 | |
| 395 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 396 | # _mkstemp_inner can create files |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 397 | self.do_create().write(b"blat") |
| 398 | self.do_create(pre="a").write(b"blat") |
| 399 | self.do_create(suf="b").write(b"blat") |
| 400 | self.do_create(pre="a", suf="b").write(b"blat") |
| 401 | self.do_create(pre="aa", suf=".txt").write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 402 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 403 | def test_basic_with_bytes_names(self): |
| 404 | # _mkstemp_inner can create files when given name parts all |
| 405 | # specified as bytes. |
| 406 | dir_b = tempfile.gettempdirb() |
| 407 | self.do_create(dir=dir_b, suf=b"").write(b"blat") |
| 408 | self.do_create(dir=dir_b, pre=b"a").write(b"blat") |
| 409 | self.do_create(dir=dir_b, suf=b"b").write(b"blat") |
| 410 | self.do_create(dir=dir_b, pre=b"a", suf=b"b").write(b"blat") |
| 411 | self.do_create(dir=dir_b, pre=b"aa", suf=b".txt").write(b"blat") |
| 412 | # Can't mix str & binary types in the args. |
| 413 | with self.assertRaises(TypeError): |
| 414 | self.do_create(dir="", suf=b"").write(b"blat") |
| 415 | with self.assertRaises(TypeError): |
| 416 | self.do_create(dir=dir_b, pre="").write(b"blat") |
| 417 | with self.assertRaises(TypeError): |
| 418 | self.do_create(dir=dir_b, pre=b"", suf="").write(b"blat") |
| 419 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 420 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 421 | # _mkstemp_inner can create many files (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 422 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 423 | for i in extant: |
| 424 | extant[i] = self.do_create(pre="aa") |
| 425 | |
| 426 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 427 | # _mkstemp_inner can create files in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 428 | dir = tempfile.mkdtemp() |
| 429 | try: |
Antoine Pitrou | 9cadb1b | 2008-09-15 23:02:56 +0000 | [diff] [blame] | 430 | self.do_create(dir=dir).write(b"blat") |
Anthony Sottile | 370138b | 2019-09-09 08:54:34 -0700 | [diff] [blame] | 431 | self.do_create(dir=pathlib.Path(dir)).write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 432 | finally: |
| 433 | os.rmdir(dir) |
| 434 | |
| 435 | def test_file_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 436 | # _mkstemp_inner creates files with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 437 | |
| 438 | file = self.do_create() |
| 439 | mode = stat.S_IMODE(os.stat(file.name).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 440 | expected = 0o600 |
Jesus Cea | 4791a24 | 2012-10-05 03:15:39 +0200 | [diff] [blame] | 441 | if sys.platform == 'win32': |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 442 | # There's no distinction among 'user', 'group' and 'world'; |
| 443 | # replicate the 'user' bits. |
| 444 | user = expected >> 6 |
| 445 | expected = user * (1 + 8 + 64) |
| 446 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 447 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 448 | @unittest.skipUnless(has_spawnl, 'os.spawnl not available') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 449 | def test_noinherit(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 450 | # _mkstemp_inner file handles are not inherited by child processes |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 451 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 452 | if support.verbose: |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 453 | v="v" |
| 454 | else: |
| 455 | v="q" |
| 456 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 457 | file = self.do_create() |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 458 | self.assertEqual(os.get_inheritable(file.fd), False) |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 459 | fd = "%d" % file.fd |
| 460 | |
| 461 | try: |
| 462 | me = __file__ |
| 463 | except NameError: |
| 464 | me = sys.argv[0] |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 465 | |
| 466 | # We have to exec something, so that FD_CLOEXEC will take |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 467 | # effect. The core of this test is therefore in |
| 468 | # tf_inherit_check.py, which see. |
| 469 | tester = os.path.join(os.path.dirname(os.path.abspath(me)), |
| 470 | "tf_inherit_check.py") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 471 | |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 472 | # On Windows a spawn* /path/ with embedded spaces shouldn't be quoted, |
| 473 | # but an arg with embedded spaces should be decorated with double |
| 474 | # quotes on each end |
Jesus Cea | 4791a24 | 2012-10-05 03:15:39 +0200 | [diff] [blame] | 475 | if sys.platform == 'win32': |
Martin v. Löwis | d4210bc | 2003-10-23 15:55:28 +0000 | [diff] [blame] | 476 | decorated = '"%s"' % sys.executable |
| 477 | tester = '"%s"' % tester |
| 478 | else: |
| 479 | decorated = sys.executable |
| 480 | |
| 481 | retval = os.spawnl(os.P_WAIT, sys.executable, decorated, tester, v, fd) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 482 | self.assertFalse(retval < 0, |
Guido van Rossum | 7874106 | 2002-08-17 11:41:01 +0000 | [diff] [blame] | 483 | "child process caught fatal signal %d" % -retval) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 484 | self.assertFalse(retval > 0, "child process reports failure %d"%retval) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 485 | |
Zachary Ware | 9fe6d86 | 2013-12-08 00:20:35 -0600 | [diff] [blame] | 486 | @unittest.skipUnless(has_textmode, "text mode not available") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 487 | def test_textmode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 488 | # _mkstemp_inner can create files in text mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 489 | |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 490 | # A text file is truncated at the first Ctrl+Z byte |
| 491 | f = self.do_create(bin=0) |
| 492 | f.write(b"blat\x1a") |
| 493 | f.write(b"extra\n") |
| 494 | os.lseek(f.fd, 0, os.SEEK_SET) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 495 | self.assertEqual(os.read(f.fd, 20), b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 496 | |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 497 | def make_temp(self): |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 498 | return tempfile._mkstemp_inner(tempfile.gettempdir(), |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 499 | tempfile.gettempprefix(), |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 500 | '', |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 501 | tempfile._bin_openflags, |
| 502 | str) |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 503 | |
| 504 | def test_collision_with_existing_file(self): |
| 505 | # _mkstemp_inner tries another name when a file with |
| 506 | # the chosen name already exists |
| 507 | with _inside_empty_temp_dir(), \ |
| 508 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 509 | (fd1, name1) = self.make_temp() |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 510 | os.close(fd1) |
| 511 | self.assertTrue(name1.endswith('aaa')) |
| 512 | |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 513 | (fd2, name2) = self.make_temp() |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 514 | os.close(fd2) |
| 515 | self.assertTrue(name2.endswith('bbb')) |
| 516 | |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 517 | def test_collision_with_existing_directory(self): |
| 518 | # _mkstemp_inner tries another name when a directory with |
| 519 | # the chosen name already exists |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 520 | with _inside_empty_temp_dir(), \ |
| 521 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 522 | dir = tempfile.mkdtemp() |
| 523 | self.assertTrue(dir.endswith('aaa')) |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 524 | |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 525 | (fd, name) = self.make_temp() |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 526 | os.close(fd) |
| 527 | self.assertTrue(name.endswith('bbb')) |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 528 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 529 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 530 | class TestGetTempPrefix(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 531 | """Test gettempprefix().""" |
| 532 | |
| 533 | def test_sane_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 534 | # gettempprefix returns a nonempty prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 535 | p = tempfile.gettempprefix() |
| 536 | |
Ezio Melotti | e961593 | 2010-01-24 19:26:24 +0000 | [diff] [blame] | 537 | self.assertIsInstance(p, str) |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 538 | self.assertGreater(len(p), 0) |
| 539 | |
| 540 | pb = tempfile.gettempprefixb() |
| 541 | |
| 542 | self.assertIsInstance(pb, bytes) |
| 543 | self.assertGreater(len(pb), 0) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 544 | |
| 545 | def test_usable_template(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 546 | # gettempprefix returns a usable prefix string |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 547 | |
| 548 | # Create a temp directory, avoiding use of the prefix. |
| 549 | # Then attempt to create a file whose name is |
| 550 | # prefix + 'xxxxxx.xxx' in that directory. |
| 551 | p = tempfile.gettempprefix() + "xxxxxx.xxx" |
| 552 | d = tempfile.mkdtemp(prefix="") |
| 553 | try: |
| 554 | p = os.path.join(d, p) |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 555 | fd = os.open(p, os.O_RDWR | os.O_CREAT) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 556 | os.close(fd) |
| 557 | os.unlink(p) |
| 558 | finally: |
| 559 | os.rmdir(d) |
| 560 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 561 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 562 | class TestGetTempDir(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 563 | """Test gettempdir().""" |
| 564 | |
| 565 | def test_directory_exists(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 566 | # gettempdir returns a directory which exists |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 567 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 568 | for d in (tempfile.gettempdir(), tempfile.gettempdirb()): |
| 569 | self.assertTrue(os.path.isabs(d) or d == os.curdir, |
| 570 | "%r is not an absolute path" % d) |
| 571 | self.assertTrue(os.path.isdir(d), |
| 572 | "%r is not a directory" % d) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 573 | |
| 574 | def test_directory_writable(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 575 | # gettempdir returns a directory writable by the user |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 576 | |
| 577 | # sneaky: just instantiate a NamedTemporaryFile, which |
| 578 | # defaults to writing into the directory returned by |
| 579 | # gettempdir. |
Serhiy Storchaka | 5b10b98 | 2019-03-05 10:06:26 +0200 | [diff] [blame] | 580 | with tempfile.NamedTemporaryFile() as file: |
| 581 | file.write(b"blat") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 582 | |
| 583 | def test_same_thing(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 584 | # gettempdir always returns the same object |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 585 | a = tempfile.gettempdir() |
| 586 | b = tempfile.gettempdir() |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 587 | c = tempfile.gettempdirb() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 588 | |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 589 | self.assertTrue(a is b) |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 590 | self.assertNotEqual(type(a), type(c)) |
| 591 | self.assertEqual(a, os.fsdecode(c)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 592 | |
Tim Golden | 6d09f09 | 2013-10-25 18:38:16 +0100 | [diff] [blame] | 593 | def test_case_sensitive(self): |
| 594 | # gettempdir should not flatten its case |
| 595 | # even on a case-insensitive file system |
| 596 | case_sensitive_tempdir = tempfile.mkdtemp("-Temp") |
| 597 | _tempdir, tempfile.tempdir = tempfile.tempdir, None |
| 598 | try: |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 599 | with os_helper.EnvironmentVarGuard() as env: |
Tim Golden | 6d09f09 | 2013-10-25 18:38:16 +0100 | [diff] [blame] | 600 | # Fake the first env var which is checked as a candidate |
| 601 | env["TMPDIR"] = case_sensitive_tempdir |
| 602 | self.assertEqual(tempfile.gettempdir(), case_sensitive_tempdir) |
| 603 | finally: |
| 604 | tempfile.tempdir = _tempdir |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 605 | os_helper.rmdir(case_sensitive_tempdir) |
Tim Golden | 6d09f09 | 2013-10-25 18:38:16 +0100 | [diff] [blame] | 606 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 607 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 608 | class TestMkstemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 609 | """Test mkstemp().""" |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 610 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 611 | def do_create(self, dir=None, pre=None, suf=None): |
| 612 | output_type = tempfile._infer_return_type(dir, pre, suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 613 | if dir is None: |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 614 | if output_type is str: |
| 615 | dir = tempfile.gettempdir() |
| 616 | else: |
| 617 | dir = tempfile.gettempdirb() |
| 618 | if pre is None: |
| 619 | pre = output_type() |
| 620 | if suf is None: |
| 621 | suf = output_type() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 622 | (fd, name) = tempfile.mkstemp(dir=dir, prefix=pre, suffix=suf) |
| 623 | (ndir, nbase) = os.path.split(name) |
| 624 | adir = os.path.abspath(dir) |
| 625 | self.assertEqual(adir, ndir, |
| 626 | "Directory '%s' incorrectly returned as '%s'" % (adir, ndir)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 627 | |
| 628 | try: |
| 629 | self.nameCheck(name, dir, pre, suf) |
| 630 | finally: |
| 631 | os.close(fd) |
| 632 | os.unlink(name) |
| 633 | |
| 634 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 635 | # mkstemp can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 636 | self.do_create() |
| 637 | self.do_create(pre="a") |
| 638 | self.do_create(suf="b") |
| 639 | self.do_create(pre="a", suf="b") |
| 640 | self.do_create(pre="aa", suf=".txt") |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 641 | self.do_create(dir=".") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 642 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 643 | def test_basic_with_bytes_names(self): |
| 644 | # mkstemp can create files when given name parts all |
| 645 | # specified as bytes. |
| 646 | d = tempfile.gettempdirb() |
| 647 | self.do_create(dir=d, suf=b"") |
| 648 | self.do_create(dir=d, pre=b"a") |
| 649 | self.do_create(dir=d, suf=b"b") |
| 650 | self.do_create(dir=d, pre=b"a", suf=b"b") |
| 651 | self.do_create(dir=d, pre=b"aa", suf=b".txt") |
| 652 | self.do_create(dir=b".") |
| 653 | with self.assertRaises(TypeError): |
| 654 | self.do_create(dir=".", pre=b"aa", suf=b".txt") |
| 655 | with self.assertRaises(TypeError): |
| 656 | self.do_create(dir=b".", pre="aa", suf=b".txt") |
| 657 | with self.assertRaises(TypeError): |
| 658 | self.do_create(dir=b".", pre=b"aa", suf=".txt") |
| 659 | |
| 660 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 661 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 662 | # mkstemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 663 | dir = tempfile.mkdtemp() |
| 664 | try: |
| 665 | self.do_create(dir=dir) |
Anthony Sottile | 370138b | 2019-09-09 08:54:34 -0700 | [diff] [blame] | 666 | self.do_create(dir=pathlib.Path(dir)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 667 | finally: |
| 668 | os.rmdir(dir) |
| 669 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 670 | |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 671 | class TestMkdtemp(TestBadTempdir, BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 672 | """Test mkdtemp().""" |
| 673 | |
Serhiy Storchaka | 5d6b7b1 | 2015-05-20 00:11:48 +0300 | [diff] [blame] | 674 | def make_temp(self): |
| 675 | return tempfile.mkdtemp() |
| 676 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 677 | def do_create(self, dir=None, pre=None, suf=None): |
| 678 | output_type = tempfile._infer_return_type(dir, pre, suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 679 | if dir is None: |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 680 | if output_type is str: |
| 681 | dir = tempfile.gettempdir() |
| 682 | else: |
| 683 | dir = tempfile.gettempdirb() |
| 684 | if pre is None: |
| 685 | pre = output_type() |
| 686 | if suf is None: |
| 687 | suf = output_type() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 688 | name = tempfile.mkdtemp(dir=dir, prefix=pre, suffix=suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 689 | |
| 690 | try: |
| 691 | self.nameCheck(name, dir, pre, suf) |
| 692 | return name |
| 693 | except: |
| 694 | os.rmdir(name) |
| 695 | raise |
| 696 | |
| 697 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 698 | # mkdtemp can create directories |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 699 | os.rmdir(self.do_create()) |
| 700 | os.rmdir(self.do_create(pre="a")) |
| 701 | os.rmdir(self.do_create(suf="b")) |
| 702 | os.rmdir(self.do_create(pre="a", suf="b")) |
| 703 | os.rmdir(self.do_create(pre="aa", suf=".txt")) |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 704 | |
Gregory P. Smith | ad577b9 | 2015-05-22 16:18:14 -0700 | [diff] [blame] | 705 | def test_basic_with_bytes_names(self): |
| 706 | # mkdtemp can create directories when given all binary parts |
| 707 | d = tempfile.gettempdirb() |
| 708 | os.rmdir(self.do_create(dir=d)) |
| 709 | os.rmdir(self.do_create(dir=d, pre=b"a")) |
| 710 | os.rmdir(self.do_create(dir=d, suf=b"b")) |
| 711 | os.rmdir(self.do_create(dir=d, pre=b"a", suf=b"b")) |
| 712 | os.rmdir(self.do_create(dir=d, pre=b"aa", suf=b".txt")) |
| 713 | with self.assertRaises(TypeError): |
| 714 | os.rmdir(self.do_create(dir=d, pre="aa", suf=b".txt")) |
| 715 | with self.assertRaises(TypeError): |
| 716 | os.rmdir(self.do_create(dir=d, pre=b"aa", suf=".txt")) |
| 717 | with self.assertRaises(TypeError): |
| 718 | os.rmdir(self.do_create(dir="", pre=b"aa", suf=b".txt")) |
| 719 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 720 | def test_basic_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 721 | # mkdtemp can create many directories (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 722 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 723 | try: |
| 724 | for i in extant: |
| 725 | extant[i] = self.do_create(pre="aa") |
| 726 | finally: |
| 727 | for i in extant: |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 728 | if(isinstance(i, str)): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 729 | os.rmdir(i) |
| 730 | |
| 731 | def test_choose_directory(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 732 | # mkdtemp can create directories in a user-selected directory |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 733 | dir = tempfile.mkdtemp() |
| 734 | try: |
| 735 | os.rmdir(self.do_create(dir=dir)) |
Anthony Sottile | 370138b | 2019-09-09 08:54:34 -0700 | [diff] [blame] | 736 | os.rmdir(self.do_create(dir=pathlib.Path(dir))) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 737 | finally: |
| 738 | os.rmdir(dir) |
| 739 | |
| 740 | def test_mode(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 741 | # mkdtemp creates directories with the proper mode |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 742 | |
| 743 | dir = self.do_create() |
| 744 | try: |
| 745 | mode = stat.S_IMODE(os.stat(dir).st_mode) |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 746 | mode &= 0o777 # Mask off sticky bits inherited from /tmp |
| 747 | expected = 0o700 |
Jesus Cea | 4791a24 | 2012-10-05 03:15:39 +0200 | [diff] [blame] | 748 | if sys.platform == 'win32': |
Tim Peters | ca3ac7f | 2002-08-09 18:13:51 +0000 | [diff] [blame] | 749 | # There's no distinction among 'user', 'group' and 'world'; |
| 750 | # replicate the 'user' bits. |
| 751 | user = expected >> 6 |
| 752 | expected = user * (1 + 8 + 64) |
| 753 | self.assertEqual(mode, expected) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 754 | finally: |
| 755 | os.rmdir(dir) |
| 756 | |
Eli Bendersky | aa04f9a | 2013-09-13 05:28:20 -0700 | [diff] [blame] | 757 | def test_collision_with_existing_file(self): |
| 758 | # mkdtemp tries another name when a file with |
| 759 | # the chosen name already exists |
| 760 | with _inside_empty_temp_dir(), \ |
| 761 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 762 | file = tempfile.NamedTemporaryFile(delete=False) |
| 763 | file.close() |
| 764 | self.assertTrue(file.name.endswith('aaa')) |
| 765 | dir = tempfile.mkdtemp() |
| 766 | self.assertTrue(dir.endswith('bbb')) |
| 767 | |
| 768 | def test_collision_with_existing_directory(self): |
| 769 | # mkdtemp tries another name when a directory with |
| 770 | # the chosen name already exists |
| 771 | with _inside_empty_temp_dir(), \ |
| 772 | _mock_candidate_names('aaa', 'aaa', 'bbb'): |
| 773 | dir1 = tempfile.mkdtemp() |
| 774 | self.assertTrue(dir1.endswith('aaa')) |
| 775 | dir2 = tempfile.mkdtemp() |
| 776 | self.assertTrue(dir2.endswith('bbb')) |
| 777 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 778 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 779 | class TestMktemp(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 780 | """Test mktemp().""" |
| 781 | |
| 782 | # For safety, all use of mktemp must occur in a private directory. |
| 783 | # We must also suppress the RuntimeWarning it generates. |
| 784 | def setUp(self): |
| 785 | self.dir = tempfile.mkdtemp() |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 786 | super().setUp() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 787 | |
| 788 | def tearDown(self): |
| 789 | if self.dir: |
| 790 | os.rmdir(self.dir) |
| 791 | self.dir = None |
Brett Cannon | e1adece | 2010-03-20 22:19:55 +0000 | [diff] [blame] | 792 | super().tearDown() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 793 | |
| 794 | class mktemped: |
| 795 | _unlink = os.unlink |
| 796 | _bflags = tempfile._bin_openflags |
| 797 | |
| 798 | def __init__(self, dir, pre, suf): |
| 799 | self.name = tempfile.mktemp(dir=dir, prefix=pre, suffix=suf) |
| 800 | # Create the file. This will raise an exception if it's |
| 801 | # mysteriously appeared in the meanwhile. |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 802 | os.close(os.open(self.name, self._bflags, 0o600)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 803 | |
| 804 | def __del__(self): |
| 805 | self._unlink(self.name) |
| 806 | |
| 807 | def do_create(self, pre="", suf=""): |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 808 | file = self.mktemped(self.dir, pre, suf) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 809 | |
| 810 | self.nameCheck(file.name, self.dir, pre, suf) |
| 811 | return file |
| 812 | |
| 813 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 814 | # mktemp can choose usable file names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 815 | self.do_create() |
| 816 | self.do_create(pre="a") |
| 817 | self.do_create(suf="b") |
| 818 | self.do_create(pre="a", suf="b") |
| 819 | self.do_create(pre="aa", suf=".txt") |
| 820 | |
| 821 | def test_many(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 822 | # mktemp can choose many usable file names (stochastic) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 823 | extant = list(range(TEST_FILES)) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 824 | for i in extant: |
| 825 | extant[i] = self.do_create(pre="aa") |
| 826 | |
Fred Drake | 8bec483 | 2002-11-22 20:13:43 +0000 | [diff] [blame] | 827 | ## def test_warning(self): |
| 828 | ## # mktemp issues a warning when used |
| 829 | ## warnings.filterwarnings("error", |
| 830 | ## category=RuntimeWarning, |
| 831 | ## message="mktemp") |
| 832 | ## self.assertRaises(RuntimeWarning, |
| 833 | ## tempfile.mktemp, dir=self.dir) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 834 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 835 | |
| 836 | # We test _TemporaryFileWrapper by testing NamedTemporaryFile. |
| 837 | |
| 838 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 839 | class TestNamedTemporaryFile(BaseTestCase): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 840 | """Test NamedTemporaryFile().""" |
| 841 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 842 | def do_create(self, dir=None, pre="", suf="", delete=True): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 843 | if dir is None: |
| 844 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 845 | file = tempfile.NamedTemporaryFile(dir=dir, prefix=pre, suffix=suf, |
| 846 | delete=delete) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 847 | |
| 848 | self.nameCheck(file.name, dir, pre, suf) |
| 849 | return file |
| 850 | |
| 851 | |
| 852 | def test_basic(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 853 | # NamedTemporaryFile can create files |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 854 | self.do_create() |
| 855 | self.do_create(pre="a") |
| 856 | self.do_create(suf="b") |
| 857 | self.do_create(pre="a", suf="b") |
| 858 | self.do_create(pre="aa", suf=".txt") |
| 859 | |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame] | 860 | def test_method_lookup(self): |
| 861 | # Issue #18879: Looking up a temporary file method should keep it |
| 862 | # alive long enough. |
| 863 | f = self.do_create() |
| 864 | wr = weakref.ref(f) |
| 865 | write = f.write |
| 866 | write2 = f.write |
| 867 | del f |
| 868 | write(b'foo') |
| 869 | del write |
| 870 | write2(b'bar') |
| 871 | del write2 |
| 872 | if support.check_impl_detail(cpython=True): |
| 873 | # No reference cycle was created. |
| 874 | self.assertIsNone(wr()) |
| 875 | |
Serhiy Storchaka | 56cefa6 | 2015-03-19 15:23:15 +0200 | [diff] [blame] | 876 | def test_iter(self): |
| 877 | # Issue #23700: getting iterator from a temporary file should keep |
| 878 | # it alive as long as it's being iterated over |
| 879 | lines = [b'spam\n', b'eggs\n', b'beans\n'] |
| 880 | def make_file(): |
| 881 | f = tempfile.NamedTemporaryFile(mode='w+b') |
| 882 | f.write(b''.join(lines)) |
| 883 | f.seek(0) |
| 884 | return f |
| 885 | for i, l in enumerate(make_file()): |
| 886 | self.assertEqual(l, lines[i]) |
| 887 | self.assertEqual(i, len(lines) - 1) |
| 888 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 889 | def test_creates_named(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 890 | # NamedTemporaryFile creates files with names |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 891 | f = tempfile.NamedTemporaryFile() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 892 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 893 | "NamedTemporaryFile %s does not exist" % f.name) |
| 894 | |
| 895 | def test_del_on_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 896 | # A NamedTemporaryFile is deleted when closed |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 897 | dir = tempfile.mkdtemp() |
| 898 | try: |
Serhiy Storchaka | 5b10b98 | 2019-03-05 10:06:26 +0200 | [diff] [blame] | 899 | with tempfile.NamedTemporaryFile(dir=dir) as f: |
| 900 | f.write(b'blat') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 901 | self.assertFalse(os.path.exists(f.name), |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 902 | "NamedTemporaryFile %s exists after close" % f.name) |
| 903 | finally: |
| 904 | os.rmdir(dir) |
| 905 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 906 | def test_dis_del_on_close(self): |
| 907 | # Tests that delete-on-close can be disabled |
| 908 | dir = tempfile.mkdtemp() |
| 909 | tmp = None |
| 910 | try: |
| 911 | f = tempfile.NamedTemporaryFile(dir=dir, delete=False) |
| 912 | tmp = f.name |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 913 | f.write(b'blat') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 914 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 915 | self.assertTrue(os.path.exists(f.name), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 916 | "NamedTemporaryFile %s missing after close" % f.name) |
| 917 | finally: |
| 918 | if tmp is not None: |
| 919 | os.unlink(tmp) |
| 920 | os.rmdir(dir) |
| 921 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 922 | def test_multiple_close(self): |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 923 | # A NamedTemporaryFile can be closed many times without error |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 924 | f = tempfile.NamedTemporaryFile() |
Guido van Rossum | ec42ffd | 2007-08-27 23:40:36 +0000 | [diff] [blame] | 925 | f.write(b'abc\n') |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 926 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 927 | f.close() |
| 928 | f.close() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 929 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 930 | def test_context_manager(self): |
| 931 | # A NamedTemporaryFile can be used as a context manager |
| 932 | with tempfile.NamedTemporaryFile() as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 933 | self.assertTrue(os.path.exists(f.name)) |
| 934 | self.assertFalse(os.path.exists(f.name)) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 935 | def use_closed(): |
| 936 | with f: |
| 937 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 938 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 939 | |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 940 | def test_no_leak_fd(self): |
Victor Stinner | 87d13ea | 2014-03-25 18:19:17 +0100 | [diff] [blame] | 941 | # Issue #21058: don't leak file descriptor when io.open() fails |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 942 | closed = [] |
Victor Stinner | c61c170 | 2014-07-29 01:13:39 +0200 | [diff] [blame] | 943 | os_close = os.close |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 944 | def close(fd): |
| 945 | closed.append(fd) |
Victor Stinner | c61c170 | 2014-07-29 01:13:39 +0200 | [diff] [blame] | 946 | os_close(fd) |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 947 | |
| 948 | with mock.patch('os.close', side_effect=close): |
| 949 | with mock.patch('io.open', side_effect=ValueError): |
| 950 | self.assertRaises(ValueError, tempfile.NamedTemporaryFile) |
| 951 | self.assertEqual(len(closed), 1) |
| 952 | |
Martin Panter | 7869a22 | 2016-02-28 05:22:20 +0000 | [diff] [blame] | 953 | def test_bad_mode(self): |
| 954 | dir = tempfile.mkdtemp() |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 955 | self.addCleanup(os_helper.rmtree, dir) |
Martin Panter | 7869a22 | 2016-02-28 05:22:20 +0000 | [diff] [blame] | 956 | with self.assertRaises(ValueError): |
| 957 | tempfile.NamedTemporaryFile(mode='wr', dir=dir) |
| 958 | with self.assertRaises(TypeError): |
| 959 | tempfile.NamedTemporaryFile(mode=2, dir=dir) |
| 960 | self.assertEqual(os.listdir(dir), []) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 961 | |
Martin Panter | 7869a22 | 2016-02-28 05:22:20 +0000 | [diff] [blame] | 962 | # How to test the mode and bufsize parameters? |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 963 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 964 | class TestSpooledTemporaryFile(BaseTestCase): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 965 | """Test SpooledTemporaryFile().""" |
| 966 | |
| 967 | def do_create(self, max_size=0, dir=None, pre="", suf=""): |
| 968 | if dir is None: |
| 969 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 970 | 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] | 971 | |
| 972 | return file |
| 973 | |
| 974 | |
| 975 | def test_basic(self): |
| 976 | # SpooledTemporaryFile can create files |
| 977 | f = self.do_create() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 978 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 979 | f = self.do_create(max_size=100, pre="a", suf=".txt") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 980 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 981 | |
| 982 | def test_del_on_close(self): |
| 983 | # A SpooledTemporaryFile is deleted when closed |
| 984 | dir = tempfile.mkdtemp() |
| 985 | try: |
| 986 | f = tempfile.SpooledTemporaryFile(max_size=10, dir=dir) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 987 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 988 | f.write(b'blat ' * 5) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 989 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 990 | filename = f.name |
| 991 | f.close() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 992 | self.assertFalse(isinstance(filename, str) and os.path.exists(filename), |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 993 | "SpooledTemporaryFile %s exists after close" % filename) |
| 994 | finally: |
| 995 | os.rmdir(dir) |
| 996 | |
| 997 | def test_rewrite_small(self): |
| 998 | # A SpooledTemporaryFile can be written to multiple within the max_size |
| 999 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1000 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1001 | for i in range(5): |
| 1002 | f.seek(0, 0) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1003 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1004 | self.assertFalse(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1005 | |
| 1006 | def test_write_sequential(self): |
| 1007 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 1008 | # over afterward |
| 1009 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1010 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1011 | f.write(b'x' * 20) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1012 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1013 | f.write(b'x' * 10) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1014 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1015 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1016 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1017 | |
R David Murray | d89ee79 | 2011-03-14 09:55:46 -0400 | [diff] [blame] | 1018 | def test_writelines(self): |
| 1019 | # Verify writelines with a SpooledTemporaryFile |
| 1020 | f = self.do_create() |
| 1021 | f.writelines((b'x', b'y', b'z')) |
Inada Naoki | 485e715 | 2020-04-17 15:56:35 +0900 | [diff] [blame] | 1022 | pos = f.seek(0) |
| 1023 | self.assertEqual(pos, 0) |
R David Murray | d89ee79 | 2011-03-14 09:55:46 -0400 | [diff] [blame] | 1024 | buf = f.read() |
| 1025 | self.assertEqual(buf, b'xyz') |
| 1026 | |
| 1027 | def test_writelines_sequential(self): |
| 1028 | # A SpooledTemporaryFile should hold exactly max_size bytes, and roll |
| 1029 | # over afterward |
| 1030 | f = self.do_create(max_size=35) |
| 1031 | f.writelines((b'x' * 20, b'x' * 10, b'x' * 5)) |
| 1032 | self.assertFalse(f._rolled) |
| 1033 | f.write(b'x') |
| 1034 | self.assertTrue(f._rolled) |
| 1035 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1036 | def test_sparse(self): |
| 1037 | # A SpooledTemporaryFile that is written late in the file will extend |
| 1038 | # when that occurs |
| 1039 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1040 | self.assertFalse(f._rolled) |
Inada Naoki | 485e715 | 2020-04-17 15:56:35 +0900 | [diff] [blame] | 1041 | pos = f.seek(100, 0) |
| 1042 | self.assertEqual(pos, 100) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1043 | self.assertFalse(f._rolled) |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1044 | f.write(b'x') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1045 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1046 | |
| 1047 | def test_fileno(self): |
| 1048 | # A SpooledTemporaryFile should roll over to a real file on fileno() |
| 1049 | f = self.do_create(max_size=30) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1050 | self.assertFalse(f._rolled) |
| 1051 | self.assertTrue(f.fileno() > 0) |
| 1052 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1053 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1054 | def test_multiple_close_before_rollover(self): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1055 | # A SpooledTemporaryFile can be closed many times without error |
| 1056 | f = tempfile.SpooledTemporaryFile() |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1057 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1058 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1059 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1060 | f.close() |
| 1061 | f.close() |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1062 | |
| 1063 | def test_multiple_close_after_rollover(self): |
| 1064 | # A SpooledTemporaryFile can be closed many times without error |
| 1065 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 1066 | f.write(b'abc\n') |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1067 | self.assertTrue(f._rolled) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1068 | f.close() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1069 | f.close() |
| 1070 | f.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1071 | |
| 1072 | def test_bound_methods(self): |
| 1073 | # It should be OK to steal a bound method from a SpooledTemporaryFile |
| 1074 | # and use it independently; when the file rolls over, those bound |
| 1075 | # methods should continue to function |
| 1076 | f = self.do_create(max_size=30) |
| 1077 | read = f.read |
| 1078 | write = f.write |
| 1079 | seek = f.seek |
| 1080 | |
Guido van Rossum | 39478e8 | 2007-08-27 17:23:59 +0000 | [diff] [blame] | 1081 | write(b"a" * 35) |
| 1082 | write(b"b" * 35) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1083 | seek(0, 0) |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 1084 | self.assertEqual(read(70), b'a'*35 + b'b'*35) |
| 1085 | |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1086 | def test_properties(self): |
| 1087 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 1088 | f.write(b'x' * 10) |
| 1089 | self.assertFalse(f._rolled) |
| 1090 | self.assertEqual(f.mode, 'w+b') |
| 1091 | self.assertIsNone(f.name) |
| 1092 | with self.assertRaises(AttributeError): |
| 1093 | f.newlines |
| 1094 | with self.assertRaises(AttributeError): |
| 1095 | f.encoding |
sth | 825aab9 | 2018-05-23 07:07:01 +0200 | [diff] [blame] | 1096 | with self.assertRaises(AttributeError): |
| 1097 | f.errors |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1098 | |
| 1099 | f.write(b'x') |
| 1100 | self.assertTrue(f._rolled) |
| 1101 | self.assertEqual(f.mode, 'rb+') |
| 1102 | self.assertIsNotNone(f.name) |
| 1103 | with self.assertRaises(AttributeError): |
| 1104 | f.newlines |
| 1105 | with self.assertRaises(AttributeError): |
| 1106 | f.encoding |
sth | 825aab9 | 2018-05-23 07:07:01 +0200 | [diff] [blame] | 1107 | with self.assertRaises(AttributeError): |
| 1108 | f.errors |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1109 | |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 1110 | def test_text_mode(self): |
| 1111 | # Creating a SpooledTemporaryFile with a text mode should produce |
| 1112 | # a file object reading and writing (Unicode) text strings. |
Inada Naoki | ea9835c | 2019-11-27 22:22:06 +0900 | [diff] [blame] | 1113 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10, |
| 1114 | encoding="utf-8") |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 1115 | f.write("abc\n") |
| 1116 | f.seek(0) |
| 1117 | self.assertEqual(f.read(), "abc\n") |
| 1118 | f.write("def\n") |
| 1119 | f.seek(0) |
| 1120 | self.assertEqual(f.read(), "abc\ndef\n") |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1121 | self.assertFalse(f._rolled) |
| 1122 | self.assertEqual(f.mode, 'w+') |
| 1123 | self.assertIsNone(f.name) |
Inada Naoki | ea9835c | 2019-11-27 22:22:06 +0900 | [diff] [blame] | 1124 | self.assertEqual(f.newlines, os.linesep) |
| 1125 | self.assertEqual(f.encoding, "utf-8") |
| 1126 | self.assertEqual(f.errors, "strict") |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1127 | |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 1128 | f.write("xyzzy\n") |
| 1129 | f.seek(0) |
| 1130 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\n") |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 1131 | # Check that Ctrl+Z doesn't truncate the file |
| 1132 | f.write("foo\x1abar\n") |
| 1133 | f.seek(0) |
| 1134 | self.assertEqual(f.read(), "abc\ndef\nxyzzy\nfoo\x1abar\n") |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1135 | self.assertTrue(f._rolled) |
| 1136 | self.assertEqual(f.mode, 'w+') |
| 1137 | self.assertIsNotNone(f.name) |
Serhiy Storchaka | 497cee4 | 2013-02-10 14:43:46 +0200 | [diff] [blame] | 1138 | self.assertEqual(f.newlines, os.linesep) |
Inada Naoki | ea9835c | 2019-11-27 22:22:06 +0900 | [diff] [blame] | 1139 | self.assertEqual(f.encoding, "utf-8") |
| 1140 | self.assertEqual(f.errors, "strict") |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 1141 | |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 1142 | def test_text_newline_and_encoding(self): |
| 1143 | f = tempfile.SpooledTemporaryFile(mode='w+', max_size=10, |
sth | 825aab9 | 2018-05-23 07:07:01 +0200 | [diff] [blame] | 1144 | newline='', encoding='utf-8', |
| 1145 | errors='ignore') |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 1146 | f.write("\u039B\r\n") |
| 1147 | f.seek(0) |
| 1148 | self.assertEqual(f.read(), "\u039B\r\n") |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1149 | self.assertFalse(f._rolled) |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1150 | self.assertEqual(f.mode, 'w+') |
| 1151 | self.assertIsNone(f.name) |
Inada Naoki | ea9835c | 2019-11-27 22:22:06 +0900 | [diff] [blame] | 1152 | self.assertIsNotNone(f.newlines) |
| 1153 | self.assertEqual(f.encoding, "utf-8") |
| 1154 | self.assertEqual(f.errors, "ignore") |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 1155 | |
Inada Naoki | ea9835c | 2019-11-27 22:22:06 +0900 | [diff] [blame] | 1156 | f.write("\u039C" * 10 + "\r\n") |
| 1157 | f.write("\u039D" * 20) |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 1158 | f.seek(0) |
Inada Naoki | ea9835c | 2019-11-27 22:22:06 +0900 | [diff] [blame] | 1159 | self.assertEqual(f.read(), |
| 1160 | "\u039B\r\n" + ("\u039C" * 10) + "\r\n" + ("\u039D" * 20)) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1161 | self.assertTrue(f._rolled) |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 1162 | self.assertEqual(f.mode, 'w+') |
| 1163 | self.assertIsNotNone(f.name) |
| 1164 | self.assertIsNotNone(f.newlines) |
| 1165 | self.assertEqual(f.encoding, 'utf-8') |
sth | 825aab9 | 2018-05-23 07:07:01 +0200 | [diff] [blame] | 1166 | self.assertEqual(f.errors, 'ignore') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1167 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1168 | def test_context_manager_before_rollover(self): |
| 1169 | # A SpooledTemporaryFile can be used as a context manager |
| 1170 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1171 | self.assertFalse(f._rolled) |
| 1172 | self.assertFalse(f.closed) |
| 1173 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1174 | def use_closed(): |
| 1175 | with f: |
| 1176 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1177 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1178 | |
| 1179 | def test_context_manager_during_rollover(self): |
| 1180 | # A SpooledTemporaryFile can be used as a context manager |
| 1181 | with tempfile.SpooledTemporaryFile(max_size=1) as f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1182 | self.assertFalse(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1183 | f.write(b'abc\n') |
| 1184 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1185 | self.assertTrue(f._rolled) |
| 1186 | self.assertFalse(f.closed) |
| 1187 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1188 | def use_closed(): |
| 1189 | with f: |
| 1190 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1191 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1192 | |
| 1193 | def test_context_manager_after_rollover(self): |
| 1194 | # A SpooledTemporaryFile can be used as a context manager |
| 1195 | f = tempfile.SpooledTemporaryFile(max_size=1) |
| 1196 | f.write(b'abc\n') |
| 1197 | f.flush() |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1198 | self.assertTrue(f._rolled) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1199 | with f: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1200 | self.assertFalse(f.closed) |
| 1201 | self.assertTrue(f.closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1202 | def use_closed(): |
| 1203 | with f: |
| 1204 | pass |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 1205 | self.assertRaises(ValueError, use_closed) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1206 | |
Antoine Pitrou | 0e86a58 | 2011-11-25 18:03:09 +0100 | [diff] [blame] | 1207 | def test_truncate_with_size_parameter(self): |
| 1208 | # A SpooledTemporaryFile can be truncated to zero size |
| 1209 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 1210 | f.write(b'abcdefg\n') |
| 1211 | f.seek(0) |
| 1212 | f.truncate() |
| 1213 | self.assertFalse(f._rolled) |
| 1214 | self.assertEqual(f._file.getvalue(), b'') |
| 1215 | # A SpooledTemporaryFile can be truncated to a specific size |
| 1216 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 1217 | f.write(b'abcdefg\n') |
| 1218 | f.truncate(4) |
| 1219 | self.assertFalse(f._rolled) |
| 1220 | self.assertEqual(f._file.getvalue(), b'abcd') |
| 1221 | # A SpooledTemporaryFile rolls over if truncated to large size |
| 1222 | f = tempfile.SpooledTemporaryFile(max_size=10) |
| 1223 | f.write(b'abcdefg\n') |
| 1224 | f.truncate(20) |
| 1225 | self.assertTrue(f._rolled) |
Anthony Sottile | 8377cd4 | 2019-02-25 14:32:27 -0800 | [diff] [blame] | 1226 | self.assertEqual(os.fstat(f.fileno()).st_size, 20) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 1227 | |
Batuhan TaĹźkaya | 09c482f | 2019-12-30 19:08:08 +0300 | [diff] [blame] | 1228 | def test_class_getitem(self): |
Guido van Rossum | 48b069a | 2020-04-07 09:50:06 -0700 | [diff] [blame] | 1229 | self.assertIsInstance(tempfile.SpooledTemporaryFile[bytes], |
| 1230 | types.GenericAlias) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1231 | |
Guido van Rossum | 8ccd9b6 | 2002-08-22 20:02:03 +0000 | [diff] [blame] | 1232 | if tempfile.NamedTemporaryFile is not tempfile.TemporaryFile: |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 1233 | |
| 1234 | class TestTemporaryFile(BaseTestCase): |
| 1235 | """Test TemporaryFile().""" |
| 1236 | |
| 1237 | def test_basic(self): |
| 1238 | # TemporaryFile can create files |
| 1239 | # No point in testing the name params - the file has no name. |
| 1240 | tempfile.TemporaryFile() |
| 1241 | |
| 1242 | def test_has_no_name(self): |
| 1243 | # TemporaryFile creates files with no names (on this system) |
| 1244 | dir = tempfile.mkdtemp() |
| 1245 | f = tempfile.TemporaryFile(dir=dir) |
| 1246 | f.write(b'blat') |
| 1247 | |
| 1248 | # Sneaky: because this file has no name, it should not prevent |
| 1249 | # us from removing the directory it was created in. |
| 1250 | try: |
| 1251 | os.rmdir(dir) |
| 1252 | except: |
| 1253 | # cleanup |
| 1254 | f.close() |
| 1255 | os.rmdir(dir) |
| 1256 | raise |
| 1257 | |
| 1258 | def test_multiple_close(self): |
| 1259 | # A TemporaryFile can be closed many times without error |
| 1260 | f = tempfile.TemporaryFile() |
| 1261 | f.write(b'abc\n') |
| 1262 | f.close() |
| 1263 | f.close() |
| 1264 | f.close() |
| 1265 | |
| 1266 | # How to test the mode and bufsize parameters? |
| 1267 | def test_mode_and_encoding(self): |
| 1268 | |
| 1269 | def roundtrip(input, *args, **kwargs): |
| 1270 | with tempfile.TemporaryFile(*args, **kwargs) as fileobj: |
| 1271 | fileobj.write(input) |
| 1272 | fileobj.seek(0) |
| 1273 | self.assertEqual(input, fileobj.read()) |
| 1274 | |
| 1275 | roundtrip(b"1234", "w+b") |
| 1276 | roundtrip("abdc\n", "w+") |
| 1277 | roundtrip("\u039B", "w+", encoding="utf-16") |
| 1278 | roundtrip("foo\r\n", "w+", newline="") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1279 | |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 1280 | def test_no_leak_fd(self): |
| 1281 | # Issue #21058: don't leak file descriptor when io.open() fails |
| 1282 | closed = [] |
Victor Stinner | c61c170 | 2014-07-29 01:13:39 +0200 | [diff] [blame] | 1283 | os_close = os.close |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 1284 | def close(fd): |
| 1285 | closed.append(fd) |
Victor Stinner | c61c170 | 2014-07-29 01:13:39 +0200 | [diff] [blame] | 1286 | os_close(fd) |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 1287 | |
| 1288 | with mock.patch('os.close', side_effect=close): |
| 1289 | with mock.patch('io.open', side_effect=ValueError): |
| 1290 | self.assertRaises(ValueError, tempfile.TemporaryFile) |
| 1291 | self.assertEqual(len(closed), 1) |
| 1292 | |
| 1293 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1294 | |
| 1295 | # Helper for test_del_on_shutdown |
| 1296 | class NulledModules: |
| 1297 | def __init__(self, *modules): |
| 1298 | self.refs = [mod.__dict__ for mod in modules] |
| 1299 | self.contents = [ref.copy() for ref in self.refs] |
| 1300 | |
| 1301 | def __enter__(self): |
| 1302 | for d in self.refs: |
| 1303 | for key in d: |
| 1304 | d[key] = None |
| 1305 | |
| 1306 | def __exit__(self, *exc_info): |
| 1307 | for d, c in zip(self.refs, self.contents): |
| 1308 | d.clear() |
| 1309 | d.update(c) |
| 1310 | |
Antoine Pitrou | eab2a50 | 2012-03-10 16:34:40 +0100 | [diff] [blame] | 1311 | class TestTemporaryDirectory(BaseTestCase): |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1312 | """Test TemporaryDirectory().""" |
| 1313 | |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 1314 | def do_create(self, dir=None, pre="", suf="", recurse=1, dirs=1, files=1): |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1315 | if dir is None: |
| 1316 | dir = tempfile.gettempdir() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1317 | tmp = tempfile.TemporaryDirectory(dir=dir, prefix=pre, suffix=suf) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1318 | self.nameCheck(tmp.name, dir, pre, suf) |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 1319 | self.do_create2(tmp.name, recurse, dirs, files) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1320 | return tmp |
| 1321 | |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 1322 | def do_create2(self, path, recurse=1, dirs=1, files=1): |
| 1323 | # Create subdirectories and some files |
| 1324 | if recurse: |
| 1325 | for i in range(dirs): |
| 1326 | name = os.path.join(path, "dir%d" % i) |
| 1327 | os.mkdir(name) |
| 1328 | self.do_create2(name, recurse-1, dirs, files) |
| 1329 | for i in range(files): |
| 1330 | with open(os.path.join(path, "test%d.txt" % i), "wb") as f: |
| 1331 | f.write(b"Hello world!") |
| 1332 | |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1333 | def test_mkdtemp_failure(self): |
| 1334 | # Check no additional exception if mkdtemp fails |
| 1335 | # Previously would raise AttributeError instead |
Nick Coghlan | 3c54ea6 | 2010-12-13 03:02:43 +0000 | [diff] [blame] | 1336 | # (noted as part of Issue #10188) |
| 1337 | with tempfile.TemporaryDirectory() as nonexistent: |
| 1338 | pass |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 1339 | with self.assertRaises(FileNotFoundError) as cm: |
Nick Coghlan | 3c54ea6 | 2010-12-13 03:02:43 +0000 | [diff] [blame] | 1340 | tempfile.TemporaryDirectory(dir=nonexistent) |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 1341 | self.assertEqual(cm.exception.errno, errno.ENOENT) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1342 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1343 | def test_explicit_cleanup(self): |
| 1344 | # A TemporaryDirectory is deleted when cleaned up |
| 1345 | dir = tempfile.mkdtemp() |
| 1346 | try: |
| 1347 | d = self.do_create(dir=dir) |
| 1348 | self.assertTrue(os.path.exists(d.name), |
| 1349 | "TemporaryDirectory %s does not exist" % d.name) |
| 1350 | d.cleanup() |
| 1351 | self.assertFalse(os.path.exists(d.name), |
| 1352 | "TemporaryDirectory %s exists after cleanup" % d.name) |
| 1353 | finally: |
| 1354 | os.rmdir(dir) |
| 1355 | |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 1356 | @os_helper.skip_unless_symlink |
Charles-François Natali | def3543 | 2011-07-29 18:59:24 +0200 | [diff] [blame] | 1357 | def test_cleanup_with_symlink_to_a_directory(self): |
| 1358 | # cleanup() should not follow symlinks to directories (issue #12464) |
| 1359 | d1 = self.do_create() |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1360 | d2 = self.do_create(recurse=0) |
Charles-François Natali | def3543 | 2011-07-29 18:59:24 +0200 | [diff] [blame] | 1361 | |
| 1362 | # Symlink d1/foo -> d2 |
| 1363 | os.symlink(d2.name, os.path.join(d1.name, "foo")) |
| 1364 | |
| 1365 | # This call to cleanup() should not follow the "foo" symlink |
| 1366 | d1.cleanup() |
| 1367 | |
| 1368 | self.assertFalse(os.path.exists(d1.name), |
| 1369 | "TemporaryDirectory %s exists after cleanup" % d1.name) |
| 1370 | self.assertTrue(os.path.exists(d2.name), |
| 1371 | "Directory pointed to by a symlink was deleted") |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 1372 | self.assertEqual(os.listdir(d2.name), ['test0.txt'], |
Charles-François Natali | def3543 | 2011-07-29 18:59:24 +0200 | [diff] [blame] | 1373 | "Contents of the directory pointed to by a symlink " |
| 1374 | "were deleted") |
| 1375 | d2.cleanup() |
| 1376 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1377 | @support.cpython_only |
| 1378 | def test_del_on_collection(self): |
| 1379 | # A TemporaryDirectory is deleted when garbage collected |
| 1380 | dir = tempfile.mkdtemp() |
| 1381 | try: |
| 1382 | d = self.do_create(dir=dir) |
| 1383 | name = d.name |
| 1384 | del d # Rely on refcounting to invoke __del__ |
| 1385 | self.assertFalse(os.path.exists(name), |
| 1386 | "TemporaryDirectory %s exists after __del__" % name) |
| 1387 | finally: |
| 1388 | os.rmdir(dir) |
| 1389 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1390 | def test_del_on_shutdown(self): |
| 1391 | # A TemporaryDirectory may be cleaned up during shutdown |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1392 | with self.do_create() as dir: |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 1393 | for mod in ('builtins', 'os', 'shutil', 'sys', 'tempfile', 'warnings'): |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1394 | code = """if True: |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 1395 | import builtins |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1396 | import os |
| 1397 | import shutil |
| 1398 | import sys |
| 1399 | import tempfile |
| 1400 | import warnings |
| 1401 | |
| 1402 | tmp = tempfile.TemporaryDirectory(dir={dir!r}) |
| 1403 | sys.stdout.buffer.write(tmp.name.encode()) |
| 1404 | |
| 1405 | tmp2 = os.path.join(tmp.name, 'test_dir') |
| 1406 | os.mkdir(tmp2) |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 1407 | with open(os.path.join(tmp2, "test0.txt"), "w") as f: |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1408 | f.write("Hello world!") |
| 1409 | |
| 1410 | {mod}.tmp = tmp |
| 1411 | |
| 1412 | warnings.filterwarnings("always", category=ResourceWarning) |
| 1413 | """.format(dir=dir, mod=mod) |
| 1414 | rc, out, err = script_helper.assert_python_ok("-c", code) |
| 1415 | tmp_name = out.decode().strip() |
| 1416 | self.assertFalse(os.path.exists(tmp_name), |
| 1417 | "TemporaryDirectory %s exists after cleanup" % tmp_name) |
| 1418 | err = err.decode('utf-8', 'backslashreplace') |
| 1419 | self.assertNotIn("Exception ", err) |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 1420 | self.assertIn("ResourceWarning: Implicitly cleaning up", err) |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1421 | |
Serhiy Storchaka | 5e193ac | 2014-09-24 13:26:25 +0300 | [diff] [blame] | 1422 | def test_exit_on_shutdown(self): |
| 1423 | # Issue #22427 |
| 1424 | with self.do_create() as dir: |
| 1425 | code = """if True: |
| 1426 | import sys |
| 1427 | import tempfile |
| 1428 | import warnings |
| 1429 | |
| 1430 | def generator(): |
| 1431 | with tempfile.TemporaryDirectory(dir={dir!r}) as tmp: |
| 1432 | yield tmp |
| 1433 | g = generator() |
| 1434 | sys.stdout.buffer.write(next(g).encode()) |
| 1435 | |
| 1436 | warnings.filterwarnings("always", category=ResourceWarning) |
| 1437 | """.format(dir=dir) |
| 1438 | rc, out, err = script_helper.assert_python_ok("-c", code) |
| 1439 | tmp_name = out.decode().strip() |
| 1440 | self.assertFalse(os.path.exists(tmp_name), |
| 1441 | "TemporaryDirectory %s exists after cleanup" % tmp_name) |
| 1442 | err = err.decode('utf-8', 'backslashreplace') |
| 1443 | self.assertNotIn("Exception ", err) |
| 1444 | self.assertIn("ResourceWarning: Implicitly cleaning up", err) |
| 1445 | |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1446 | def test_warnings_on_cleanup(self): |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1447 | # ResourceWarning will be triggered by __del__ |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1448 | with self.do_create() as dir: |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1449 | d = self.do_create(dir=dir, recurse=3) |
| 1450 | name = d.name |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1451 | |
| 1452 | # Check for the resource warning |
Hai Shi | 0c4f0f3 | 2020-06-30 21:46:31 +0800 | [diff] [blame] | 1453 | with warnings_helper.check_warnings(('Implicitly', |
| 1454 | ResourceWarning), |
| 1455 | quiet=False): |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 1456 | warnings.filterwarnings("always", category=ResourceWarning) |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 1457 | del d |
| 1458 | support.gc_collect() |
| 1459 | self.assertFalse(os.path.exists(name), |
| 1460 | "TemporaryDirectory %s exists after __del__" % name) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1461 | |
| 1462 | def test_multiple_close(self): |
| 1463 | # Can be cleaned-up many times without error |
| 1464 | d = self.do_create() |
| 1465 | d.cleanup() |
Antoine Pitrou | 8cd8d5e | 2012-03-10 16:20:24 +0100 | [diff] [blame] | 1466 | d.cleanup() |
| 1467 | d.cleanup() |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1468 | |
| 1469 | def test_context_manager(self): |
| 1470 | # Can be used as a context manager |
| 1471 | d = self.do_create() |
| 1472 | with d as name: |
| 1473 | self.assertTrue(os.path.exists(name)) |
| 1474 | self.assertEqual(name, d.name) |
| 1475 | self.assertFalse(os.path.exists(name)) |
| 1476 | |
Serhiy Storchaka | e9b51c0 | 2019-05-31 11:30:37 +0300 | [diff] [blame] | 1477 | def test_modes(self): |
| 1478 | for mode in range(8): |
| 1479 | mode <<= 6 |
| 1480 | with self.subTest(mode=format(mode, '03o')): |
| 1481 | d = self.do_create(recurse=3, dirs=2, files=2) |
| 1482 | with d: |
| 1483 | # Change files and directories mode recursively. |
| 1484 | for root, dirs, files in os.walk(d.name, topdown=False): |
| 1485 | for name in files: |
| 1486 | os.chmod(os.path.join(root, name), mode) |
| 1487 | os.chmod(root, mode) |
| 1488 | d.cleanup() |
| 1489 | self.assertFalse(os.path.exists(d.name)) |
| 1490 | |
| 1491 | @unittest.skipUnless(hasattr(os, 'chflags'), 'requires os.lchflags') |
| 1492 | def test_flags(self): |
| 1493 | flags = stat.UF_IMMUTABLE | stat.UF_NOUNLINK |
| 1494 | d = self.do_create(recurse=3, dirs=2, files=2) |
| 1495 | with d: |
| 1496 | # Change files and directories flags recursively. |
| 1497 | for root, dirs, files in os.walk(d.name, topdown=False): |
| 1498 | for name in files: |
| 1499 | os.chflags(os.path.join(root, name), flags) |
| 1500 | os.chflags(root, flags) |
| 1501 | d.cleanup() |
| 1502 | self.assertFalse(os.path.exists(d.name)) |
| 1503 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 1504 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1505 | if __name__ == "__main__": |
Zachary Ware | 38c707e | 2015-04-13 15:00:43 -0500 | [diff] [blame] | 1506 | unittest.main() |