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