Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 1 | """Temporary files. |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 3 | This module provides generic, low- and high-level interfaces for |
| 4 | creating temporary files and directories. The interfaces listed |
| 5 | as "safe" just below can be used without fear of race conditions. |
| 6 | Those listed as "unsafe" cannot, and are provided for backward |
| 7 | compatibility only. |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 8 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 9 | This module also provides some data items to the user: |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 11 | TMP_MAX - maximum number of names that will be tried before |
| 12 | giving up. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 13 | tempdir - If this is set to a string before the first use of |
| 14 | any routine from this module, it will be considered as |
| 15 | another candidate location to store temporary files. |
| 16 | """ |
Skip Montanaro | 40fc160 | 2001-03-01 04:27:19 +0000 | [diff] [blame] | 17 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 18 | __all__ = [ |
| 19 | "NamedTemporaryFile", "TemporaryFile", # high level safe interfaces |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 20 | "SpooledTemporaryFile", "TemporaryDirectory", |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 21 | "mkstemp", "mkdtemp", # low level safe interfaces |
| 22 | "mktemp", # deprecated unsafe interface |
| 23 | "TMP_MAX", "gettempprefix", # constants |
| 24 | "tempdir", "gettempdir" |
| 25 | ] |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 26 | |
Tim Peters | 4fd5a06 | 2002-01-28 23:11:23 +0000 | [diff] [blame] | 27 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 28 | # Imports. |
Tim Peters | 4fd5a06 | 2002-01-28 23:11:23 +0000 | [diff] [blame] | 29 | |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame] | 30 | import functools as _functools |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 31 | import warnings as _warnings |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 32 | import io as _io |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 33 | import os as _os |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 34 | import shutil as _shutil |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 35 | import errno as _errno |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 36 | from random import Random as _Random |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 37 | import weakref as _weakref |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 38 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 39 | try: |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 40 | import _thread |
Brett Cannon | cd171c8 | 2013-07-04 17:43:24 -0400 | [diff] [blame] | 41 | except ImportError: |
Georg Brandl | 2067bfd | 2008-05-25 13:05:15 +0000 | [diff] [blame] | 42 | import _dummy_thread as _thread |
Guido van Rossum | a093424 | 2002-12-30 22:36:09 +0000 | [diff] [blame] | 43 | _allocate_lock = _thread.allocate_lock |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 44 | |
| 45 | _text_openflags = _os.O_RDWR | _os.O_CREAT | _os.O_EXCL |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 46 | if hasattr(_os, 'O_NOFOLLOW'): |
| 47 | _text_openflags |= _os.O_NOFOLLOW |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 48 | |
| 49 | _bin_openflags = _text_openflags |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 50 | if hasattr(_os, 'O_BINARY'): |
| 51 | _bin_openflags |= _os.O_BINARY |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 52 | |
| 53 | if hasattr(_os, 'TMP_MAX'): |
| 54 | TMP_MAX = _os.TMP_MAX |
| 55 | else: |
| 56 | TMP_MAX = 10000 |
| 57 | |
R David Murray | 3a420c7 | 2011-06-22 21:01:13 -0400 | [diff] [blame] | 58 | # Although it does not have an underscore for historical reasons, this |
| 59 | # variable is an internal implementation detail (see issue 10354). |
Tim Peters | bd7b4c7 | 2002-08-13 23:33:56 +0000 | [diff] [blame] | 60 | template = "tmp" |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 61 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 62 | # Internal routines. |
| 63 | |
| 64 | _once_lock = _allocate_lock() |
| 65 | |
Guido van Rossum | b25615939 | 2003-11-10 02:16:36 +0000 | [diff] [blame] | 66 | if hasattr(_os, "lstat"): |
| 67 | _stat = _os.lstat |
| 68 | elif hasattr(_os, "stat"): |
| 69 | _stat = _os.stat |
| 70 | else: |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 71 | # Fallback. All we need is something that raises OSError if the |
Guido van Rossum | b25615939 | 2003-11-10 02:16:36 +0000 | [diff] [blame] | 72 | # file doesn't exist. |
| 73 | def _stat(fn): |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 74 | fd = _os.open(fn, _os.O_RDONLY) |
Victor Stinner | 69b1e26 | 2014-03-20 08:50:52 +0100 | [diff] [blame] | 75 | _os.close(fd) |
Guido van Rossum | b25615939 | 2003-11-10 02:16:36 +0000 | [diff] [blame] | 76 | |
| 77 | def _exists(fn): |
| 78 | try: |
| 79 | _stat(fn) |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 80 | except OSError: |
Guido van Rossum | b25615939 | 2003-11-10 02:16:36 +0000 | [diff] [blame] | 81 | return False |
| 82 | else: |
| 83 | return True |
| 84 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 85 | class _RandomNameSequence: |
| 86 | """An instance of _RandomNameSequence generates an endless |
| 87 | sequence of unpredictable strings which can safely be incorporated |
| 88 | into file names. Each string is six characters long. Multiple |
| 89 | threads can safely use the same instance at the same time. |
| 90 | |
| 91 | _RandomNameSequence is an iterator.""" |
| 92 | |
Raymond Hettinger | 572895b | 2010-11-09 03:43:58 +0000 | [diff] [blame] | 93 | characters = "abcdefghijklmnopqrstuvwxyz0123456789_" |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 94 | |
Antoine Pitrou | 4558bad | 2011-11-25 21:28:15 +0100 | [diff] [blame] | 95 | @property |
| 96 | def rng(self): |
| 97 | cur_pid = _os.getpid() |
| 98 | if cur_pid != getattr(self, '_rng_pid', None): |
| 99 | self._rng = _Random() |
| 100 | self._rng_pid = cur_pid |
| 101 | return self._rng |
Tim Peters | 97701b5 | 2002-11-21 15:59:59 +0000 | [diff] [blame] | 102 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 103 | def __iter__(self): |
| 104 | return self |
| 105 | |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 106 | def __next__(self): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 107 | c = self.characters |
Tim Peters | 97701b5 | 2002-11-21 15:59:59 +0000 | [diff] [blame] | 108 | choose = self.rng.choice |
Victor Stinner | 9786910 | 2013-08-14 01:28:28 +0200 | [diff] [blame] | 109 | letters = [choose(c) for dummy in range(8)] |
Raymond Hettinger | 572895b | 2010-11-09 03:43:58 +0000 | [diff] [blame] | 110 | return ''.join(letters) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 111 | |
| 112 | def _candidate_tempdir_list(): |
| 113 | """Generate a list of candidate temporary directories which |
| 114 | _get_default_tempdir will try.""" |
| 115 | |
| 116 | dirlist = [] |
| 117 | |
| 118 | # First, try the environment. |
| 119 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
| 120 | dirname = _os.getenv(envname) |
| 121 | if dirname: dirlist.append(dirname) |
| 122 | |
| 123 | # Failing that, try OS-specific locations. |
Alexandre Vassalotti | eca20b6 | 2008-05-16 02:54:33 +0000 | [diff] [blame] | 124 | if _os.name == 'nt': |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 125 | dirlist.extend([ r'c:\temp', r'c:\tmp', r'\temp', r'\tmp' ]) |
| 126 | else: |
| 127 | dirlist.extend([ '/tmp', '/var/tmp', '/usr/tmp' ]) |
| 128 | |
| 129 | # As a last resort, the current directory. |
| 130 | try: |
| 131 | dirlist.append(_os.getcwd()) |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 132 | except (AttributeError, OSError): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 133 | dirlist.append(_os.curdir) |
| 134 | |
| 135 | return dirlist |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 136 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 137 | def _get_default_tempdir(): |
| 138 | """Calculate the default directory to use for temporary files. |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 139 | This routine should be called exactly once. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 140 | |
| 141 | We determine whether or not a candidate temp dir is usable by |
| 142 | trying to create and write to a file in that directory. If this |
| 143 | is successful, the test file is deleted. To prevent denial of |
| 144 | service, the name of the test file must be randomized.""" |
| 145 | |
| 146 | namer = _RandomNameSequence() |
| 147 | dirlist = _candidate_tempdir_list() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 148 | |
| 149 | for dir in dirlist: |
| 150 | if dir != _os.curdir: |
Tim Golden | 6d09f09 | 2013-10-25 18:38:16 +0100 | [diff] [blame] | 151 | dir = _os.path.abspath(dir) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 152 | # Try only a few names per directory. |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 153 | for seq in range(100): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 154 | name = next(namer) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 155 | filename = _os.path.join(dir, name) |
| 156 | try: |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 157 | fd = _os.open(filename, _bin_openflags, 0o600) |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 158 | try: |
| 159 | try: |
Serhiy Storchaka | 76a2ed1 | 2013-02-13 00:59:26 +0200 | [diff] [blame] | 160 | with _io.open(fd, 'wb', closefd=False) as fp: |
| 161 | fp.write(b'blat') |
Serhiy Storchaka | f6b361e | 2013-02-13 00:35:30 +0200 | [diff] [blame] | 162 | finally: |
| 163 | _os.close(fd) |
| 164 | finally: |
| 165 | _os.unlink(filename) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 166 | return dir |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 167 | except FileExistsError: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 168 | pass |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 169 | except OSError: |
| 170 | break # no point trying more names in this directory |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 171 | raise FileNotFoundError(_errno.ENOENT, |
| 172 | "No usable temporary directory found in %s" % |
| 173 | dirlist) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 174 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 175 | _name_sequence = None |
| 176 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 177 | def _get_candidate_names(): |
| 178 | """Common setup sequence for all user-callable interfaces.""" |
| 179 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 180 | global _name_sequence |
| 181 | if _name_sequence is None: |
| 182 | _once_lock.acquire() |
| 183 | try: |
| 184 | if _name_sequence is None: |
| 185 | _name_sequence = _RandomNameSequence() |
| 186 | finally: |
| 187 | _once_lock.release() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 188 | return _name_sequence |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 189 | |
| 190 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 191 | def _mkstemp_inner(dir, pre, suf, flags): |
| 192 | """Code common to mkstemp, TemporaryFile, and NamedTemporaryFile.""" |
Tim Peters | 9fadfb0 | 2001-01-13 03:04:02 +0000 | [diff] [blame] | 193 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 194 | names = _get_candidate_names() |
| 195 | |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 196 | for seq in range(TMP_MAX): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 197 | name = next(names) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 198 | file = _os.path.join(dir, pre + name + suf) |
| 199 | try: |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 200 | fd = _os.open(file, flags, 0o600) |
Martin v. Löwis | d662548 | 2003-10-12 17:37:01 +0000 | [diff] [blame] | 201 | return (fd, _os.path.abspath(file)) |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 202 | except FileExistsError: |
| 203 | continue # try again |
Eli Bendersky | f315df3 | 2013-09-06 06:11:19 -0700 | [diff] [blame] | 204 | except PermissionError: |
| 205 | # This exception is thrown when a directory with the chosen name |
| 206 | # already exists on windows. |
| 207 | if _os.name == 'nt': |
| 208 | continue |
| 209 | else: |
| 210 | raise |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 211 | |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 212 | raise FileExistsError(_errno.EEXIST, |
| 213 | "No usable temporary file name found") |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 214 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 215 | |
| 216 | # User visible interfaces. |
Guido van Rossum | b0e5718 | 1998-10-14 20:27:05 +0000 | [diff] [blame] | 217 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 218 | def gettempprefix(): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 219 | """Accessor for tempdir.template.""" |
| 220 | return template |
Tim Peters | 9fadfb0 | 2001-01-13 03:04:02 +0000 | [diff] [blame] | 221 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 222 | tempdir = None |
| 223 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 224 | def gettempdir(): |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 225 | """Accessor for tempfile.tempdir.""" |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 226 | global tempdir |
| 227 | if tempdir is None: |
| 228 | _once_lock.acquire() |
| 229 | try: |
| 230 | if tempdir is None: |
| 231 | tempdir = _get_default_tempdir() |
| 232 | finally: |
| 233 | _once_lock.release() |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 234 | return tempdir |
| 235 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 236 | def mkstemp(suffix="", prefix=template, dir=None, text=False): |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 237 | """User-callable function to create and return a unique temporary |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 238 | file. The return value is a pair (fd, name) where fd is the |
| 239 | file descriptor returned by os.open, and name is the filename. |
| 240 | |
| 241 | If 'suffix' is specified, the file name will end with that suffix, |
| 242 | otherwise there will be no suffix. |
| 243 | |
| 244 | If 'prefix' is specified, the file name will begin with that prefix, |
| 245 | otherwise a default prefix is used. |
| 246 | |
| 247 | If 'dir' is specified, the file will be created in that directory, |
| 248 | otherwise a default directory is used. |
| 249 | |
Tim Peters | 04490bf | 2002-08-14 15:41:26 +0000 | [diff] [blame] | 250 | If 'text' is specified and true, the file is opened in text |
| 251 | mode. Else (the default) the file is opened in binary mode. On |
| 252 | some operating systems, this makes no difference. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 253 | |
| 254 | The file is readable and writable only by the creating user ID. |
| 255 | If the operating system uses permission bits to indicate whether a |
| 256 | file is executable, the file is executable by no one. The file |
| 257 | descriptor is not inherited by children of this process. |
| 258 | |
| 259 | Caller is responsible for deleting the file when done with it. |
Tim Peters | 9fadfb0 | 2001-01-13 03:04:02 +0000 | [diff] [blame] | 260 | """ |
| 261 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 262 | if dir is None: |
| 263 | dir = gettempdir() |
| 264 | |
Tim Peters | 04490bf | 2002-08-14 15:41:26 +0000 | [diff] [blame] | 265 | if text: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 266 | flags = _text_openflags |
Tim Peters | 04490bf | 2002-08-14 15:41:26 +0000 | [diff] [blame] | 267 | else: |
| 268 | flags = _bin_openflags |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 269 | |
| 270 | return _mkstemp_inner(dir, prefix, suffix, flags) |
Guido van Rossum | cff3454 | 1992-01-14 18:31:56 +0000 | [diff] [blame] | 271 | |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 272 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 273 | def mkdtemp(suffix="", prefix=template, dir=None): |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 274 | """User-callable function to create and return a unique temporary |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 275 | directory. The return value is the pathname of the directory. |
| 276 | |
Tim Peters | 04490bf | 2002-08-14 15:41:26 +0000 | [diff] [blame] | 277 | Arguments are as for mkstemp, except that the 'text' argument is |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 278 | not accepted. |
| 279 | |
| 280 | The directory is readable, writable, and searchable only by the |
| 281 | creating user. |
| 282 | |
| 283 | Caller is responsible for deleting the directory when done with it. |
| 284 | """ |
| 285 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 286 | if dir is None: |
| 287 | dir = gettempdir() |
| 288 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 289 | names = _get_candidate_names() |
Tim Peters | a0d55de | 2002-08-09 18:01:01 +0000 | [diff] [blame] | 290 | |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 291 | for seq in range(TMP_MAX): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 292 | name = next(names) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 293 | file = _os.path.join(dir, prefix + name + suffix) |
| 294 | try: |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 295 | _os.mkdir(file, 0o700) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 296 | return file |
Florent Xicluna | 68f71a3 | 2011-10-28 16:06:23 +0200 | [diff] [blame] | 297 | except FileExistsError: |
| 298 | continue # try again |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 299 | |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 300 | raise FileExistsError(_errno.EEXIST, |
| 301 | "No usable temporary directory name found") |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 302 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 303 | def mktemp(suffix="", prefix=template, dir=None): |
Christian Heimes | 81ee3ef | 2008-05-04 22:42:01 +0000 | [diff] [blame] | 304 | """User-callable function to return a unique temporary file name. The |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 305 | file is not created. |
| 306 | |
Tim Peters | 04490bf | 2002-08-14 15:41:26 +0000 | [diff] [blame] | 307 | Arguments are as for mkstemp, except that the 'text' argument is |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 308 | not accepted. |
| 309 | |
| 310 | This function is unsafe and should not be used. The file name |
| 311 | refers to a file that did not exist at some point, but by the time |
| 312 | you get around to creating it, someone else may have beaten you to |
| 313 | the punch. |
| 314 | """ |
| 315 | |
Guido van Rossum | 44f602d | 2002-11-22 15:56:29 +0000 | [diff] [blame] | 316 | ## from warnings import warn as _warn |
| 317 | ## _warn("mktemp is a potential security risk to your program", |
| 318 | ## RuntimeWarning, stacklevel=2) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 319 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 320 | if dir is None: |
| 321 | dir = gettempdir() |
| 322 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 323 | names = _get_candidate_names() |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 324 | for seq in range(TMP_MAX): |
Georg Brandl | a18af4e | 2007-04-21 15:47:16 +0000 | [diff] [blame] | 325 | name = next(names) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 326 | file = _os.path.join(dir, prefix + name + suffix) |
Guido van Rossum | b25615939 | 2003-11-10 02:16:36 +0000 | [diff] [blame] | 327 | if not _exists(file): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 328 | return file |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 329 | |
Serhiy Storchaka | 7451a72 | 2013-02-09 22:25:49 +0200 | [diff] [blame] | 330 | raise FileExistsError(_errno.EEXIST, |
| 331 | "No usable temporary filename found") |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 332 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 333 | |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame] | 334 | class _TemporaryFileCloser: |
| 335 | """A separate object allowing proper closing of a temporary file's |
| 336 | underlying file object, without adding a __del__ method to the |
| 337 | temporary file.""" |
Tim Peters | a255a72 | 2001-12-18 22:32:40 +0000 | [diff] [blame] | 338 | |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 339 | file = None # Set here since __del__ checks it |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 340 | close_called = False |
| 341 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 342 | def __init__(self, file, name, delete=True): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 343 | self.file = file |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 344 | self.name = name |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 345 | self.delete = delete |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 346 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 347 | # NT provides delete-on-close as a primitive, so we don't need |
| 348 | # the wrapper to do anything special. We still use it so that |
| 349 | # file.name is useful (i.e. not "(fdopen)") with NamedTemporaryFile. |
| 350 | if _os.name != 'nt': |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 351 | # Cache the unlinker so we don't get spurious errors at |
| 352 | # shutdown when the module-level "os" is None'd out. Note |
| 353 | # that this must be referenced as self.unlink, because the |
| 354 | # name TemporaryFileWrapper may also get None'd out before |
| 355 | # __del__ is called. |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 356 | |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 357 | def close(self, unlink=_os.unlink): |
| 358 | if not self.close_called and self.file is not None: |
Tim Peters | 6ef966e | 2002-11-21 15:48:33 +0000 | [diff] [blame] | 359 | self.close_called = True |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 360 | self.file.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 361 | if self.delete: |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 362 | unlink(self.name) |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 363 | |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame] | 364 | # Need to ensure the file is deleted on __del__ |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 365 | def __del__(self): |
| 366 | self.close() |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 367 | |
Benjamin Peterson | 98d23f2 | 2009-06-30 22:27:25 +0000 | [diff] [blame] | 368 | else: |
Antoine Pitrou | 17c9326 | 2013-12-21 22:14:56 +0100 | [diff] [blame] | 369 | def close(self): |
| 370 | if not self.close_called: |
| 371 | self.close_called = True |
| 372 | self.file.close() |
| 373 | |
| 374 | |
| 375 | class _TemporaryFileWrapper: |
| 376 | """Temporary file wrapper |
| 377 | |
| 378 | This class provides a wrapper around files opened for |
| 379 | temporary use. In particular, it seeks to automatically |
| 380 | remove the file when it is no longer needed. |
| 381 | """ |
| 382 | |
| 383 | def __init__(self, file, name, delete=True): |
| 384 | self.file = file |
| 385 | self.name = name |
| 386 | self.delete = delete |
| 387 | self._closer = _TemporaryFileCloser(file, name, delete) |
| 388 | |
| 389 | def __getattr__(self, name): |
| 390 | # Attribute lookups are delegated to the underlying file |
| 391 | # and cached for non-numeric results |
| 392 | # (i.e. methods are cached, closed and friends are not) |
| 393 | file = self.__dict__['file'] |
| 394 | a = getattr(file, name) |
| 395 | if hasattr(a, '__call__'): |
| 396 | func = a |
| 397 | @_functools.wraps(func) |
| 398 | def func_wrapper(*args, **kwargs): |
| 399 | return func(*args, **kwargs) |
| 400 | # Avoid closing the file as long as the wrapper is alive, |
| 401 | # see issue #18879. |
| 402 | func_wrapper._closer = self._closer |
| 403 | a = func_wrapper |
| 404 | if not isinstance(a, int): |
| 405 | setattr(self, name, a) |
| 406 | return a |
| 407 | |
| 408 | # The underlying __enter__ method returns the wrong object |
| 409 | # (self.file) so override it to return the wrapper |
| 410 | def __enter__(self): |
| 411 | self.file.__enter__() |
| 412 | return self |
| 413 | |
| 414 | # Need to trap __exit__ as well to ensure the file gets |
| 415 | # deleted when used in a with statement |
| 416 | def __exit__(self, exc, value, tb): |
| 417 | result = self.file.__exit__(exc, value, tb) |
| 418 | self.close() |
| 419 | return result |
| 420 | |
| 421 | def close(self): |
| 422 | """ |
| 423 | Close the temporary file, possibly deleting it. |
| 424 | """ |
| 425 | self._closer.close() |
| 426 | |
| 427 | # iter() doesn't use __getattr__ to find the __iter__ method |
| 428 | def __iter__(self): |
| 429 | return iter(self.file) |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 430 | |
| 431 | |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 432 | def NamedTemporaryFile(mode='w+b', buffering=-1, encoding=None, |
| 433 | newline=None, suffix="", prefix=template, |
| 434 | dir=None, delete=True): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 435 | """Create and return a temporary file. |
| 436 | Arguments: |
| 437 | 'prefix', 'suffix', 'dir' -- as for mkstemp. |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 438 | 'mode' -- the mode argument to io.open (default "w+b"). |
| 439 | 'buffering' -- the buffer size argument to io.open (default -1). |
| 440 | 'encoding' -- the encoding argument to io.open (default None) |
| 441 | 'newline' -- the newline argument to io.open (default None) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 442 | 'delete' -- whether the file is deleted on close (default True). |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 443 | The file is created as mkstemp() would do it. |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 444 | |
Raymond Hettinger | faa10eb | 2005-01-11 15:33:03 +0000 | [diff] [blame] | 445 | Returns an object with a file-like interface; the name of the file |
| 446 | is accessible as file.name. The file will be automatically deleted |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 447 | when it is closed unless the 'delete' argument is set to False. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 448 | """ |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 449 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 450 | if dir is None: |
| 451 | dir = gettempdir() |
| 452 | |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 453 | flags = _bin_openflags |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 454 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 455 | # Setting O_TEMPORARY in the flags causes the OS to delete |
| 456 | # the file when it is closed. This is only supported by Windows. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 457 | if _os.name == 'nt' and delete: |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 458 | flags |= _os.O_TEMPORARY |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 459 | |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 460 | (fd, name) = _mkstemp_inner(dir, prefix, suffix, flags) |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 461 | try: |
| 462 | file = _io.open(fd, mode, buffering=buffering, |
| 463 | newline=newline, encoding=encoding) |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 464 | |
Victor Stinner | 1f99f9d | 2014-03-25 09:18:04 +0100 | [diff] [blame] | 465 | return _TemporaryFileWrapper(file, name, delete) |
| 466 | except Exception: |
| 467 | _os.close(fd) |
| 468 | raise |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 469 | |
Jason Tishler | 80c02af | 2002-08-14 15:10:09 +0000 | [diff] [blame] | 470 | if _os.name != 'posix' or _os.sys.platform == 'cygwin': |
| 471 | # On non-POSIX and Cygwin systems, assume that we cannot unlink a file |
| 472 | # while it is open. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 473 | TemporaryFile = NamedTemporaryFile |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 474 | |
| 475 | else: |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 476 | def TemporaryFile(mode='w+b', buffering=-1, encoding=None, |
| 477 | newline=None, suffix="", prefix=template, |
| 478 | dir=None): |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 479 | """Create and return a temporary file. |
| 480 | Arguments: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 481 | 'prefix', 'suffix', 'dir' -- as for mkstemp. |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 482 | 'mode' -- the mode argument to io.open (default "w+b"). |
| 483 | 'buffering' -- the buffer size argument to io.open (default -1). |
| 484 | 'encoding' -- the encoding argument to io.open (default None) |
| 485 | 'newline' -- the newline argument to io.open (default None) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 486 | The file is created as mkstemp() would do it. |
Tim Peters | 1baa22a | 2001-01-12 10:02:46 +0000 | [diff] [blame] | 487 | |
Raymond Hettinger | faa10eb | 2005-01-11 15:33:03 +0000 | [diff] [blame] | 488 | Returns an object with a file-like interface. The file has no |
| 489 | name, and will cease to exist when it is closed. |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 490 | """ |
| 491 | |
Guido van Rossum | e888cdc | 2002-08-17 14:50:24 +0000 | [diff] [blame] | 492 | if dir is None: |
| 493 | dir = gettempdir() |
| 494 | |
Amaury Forgeot d'Arc | 7d0bddd | 2009-11-30 00:08:56 +0000 | [diff] [blame] | 495 | flags = _bin_openflags |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 496 | |
| 497 | (fd, name) = _mkstemp_inner(dir, prefix, suffix, flags) |
| 498 | try: |
| 499 | _os.unlink(name) |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 500 | return _io.open(fd, mode, buffering=buffering, |
| 501 | newline=newline, encoding=encoding) |
Guido van Rossum | 0e54871 | 2002-08-09 16:14:33 +0000 | [diff] [blame] | 502 | except: |
| 503 | _os.close(fd) |
| 504 | raise |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 505 | |
| 506 | class SpooledTemporaryFile: |
Serhiy Storchaka | 4f169a7 | 2013-02-09 11:46:42 +0200 | [diff] [blame] | 507 | """Temporary file wrapper, specialized to switch from BytesIO |
| 508 | or StringIO to a real file when it exceeds a certain size or |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 509 | when a fileno is needed. |
| 510 | """ |
| 511 | _rolled = False |
| 512 | |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 513 | def __init__(self, max_size=0, mode='w+b', buffering=-1, |
| 514 | encoding=None, newline=None, |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 515 | suffix="", prefix=template, dir=None): |
Guido van Rossum | 9a63470 | 2007-07-09 10:24:45 +0000 | [diff] [blame] | 516 | if 'b' in mode: |
| 517 | self._file = _io.BytesIO() |
| 518 | else: |
Guido van Rossum | 5d21255 | 2007-10-29 16:42:51 +0000 | [diff] [blame] | 519 | # Setting newline="\n" avoids newline translation; |
| 520 | # this is important because otherwise on Windows we'd |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 521 | # hget double newline translation upon rollover(). |
Alexandre Vassalotti | 3ade6f9 | 2008-06-12 01:13:54 +0000 | [diff] [blame] | 522 | self._file = _io.StringIO(newline="\n") |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 523 | self._max_size = max_size |
| 524 | self._rolled = False |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 525 | self._TemporaryFileArgs = {'mode': mode, 'buffering': buffering, |
| 526 | 'suffix': suffix, 'prefix': prefix, |
| 527 | 'encoding': encoding, 'newline': newline, |
| 528 | 'dir': dir} |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 529 | |
| 530 | def _check(self, file): |
| 531 | if self._rolled: return |
| 532 | max_size = self._max_size |
| 533 | if max_size and file.tell() > max_size: |
| 534 | self.rollover() |
| 535 | |
| 536 | def rollover(self): |
| 537 | if self._rolled: return |
| 538 | file = self._file |
Guido van Rossum | f0c7416 | 2007-08-28 03:29:45 +0000 | [diff] [blame] | 539 | newfile = self._file = TemporaryFile(**self._TemporaryFileArgs) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 540 | del self._TemporaryFileArgs |
| 541 | |
| 542 | newfile.write(file.getvalue()) |
| 543 | newfile.seek(file.tell(), 0) |
| 544 | |
| 545 | self._rolled = True |
| 546 | |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 547 | # The method caching trick from NamedTemporaryFile |
| 548 | # won't work here, because _file may change from a |
Serhiy Storchaka | 50254c5 | 2013-08-29 11:35:43 +0300 | [diff] [blame] | 549 | # BytesIO/StringIO instance to a real file. So we list |
Christian Heimes | 3ecfea71 | 2008-02-09 20:51:34 +0000 | [diff] [blame] | 550 | # all the methods directly. |
| 551 | |
| 552 | # Context management protocol |
| 553 | def __enter__(self): |
| 554 | if self._file.closed: |
| 555 | raise ValueError("Cannot enter context with closed file") |
| 556 | return self |
| 557 | |
| 558 | def __exit__(self, exc, value, tb): |
| 559 | self._file.close() |
| 560 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 561 | # file protocol |
| 562 | def __iter__(self): |
| 563 | return self._file.__iter__() |
| 564 | |
| 565 | def close(self): |
| 566 | self._file.close() |
| 567 | |
| 568 | @property |
| 569 | def closed(self): |
| 570 | return self._file.closed |
| 571 | |
| 572 | @property |
| 573 | def encoding(self): |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 574 | try: |
| 575 | return self._file.encoding |
| 576 | except AttributeError: |
| 577 | if 'b' in self._TemporaryFileArgs['mode']: |
| 578 | raise |
| 579 | return self._TemporaryFileArgs['encoding'] |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 580 | |
| 581 | def fileno(self): |
| 582 | self.rollover() |
| 583 | return self._file.fileno() |
| 584 | |
| 585 | def flush(self): |
| 586 | self._file.flush() |
| 587 | |
| 588 | def isatty(self): |
| 589 | return self._file.isatty() |
| 590 | |
| 591 | @property |
| 592 | def mode(self): |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 593 | try: |
| 594 | return self._file.mode |
| 595 | except AttributeError: |
| 596 | return self._TemporaryFileArgs['mode'] |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 597 | |
| 598 | @property |
| 599 | def name(self): |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 600 | try: |
| 601 | return self._file.name |
| 602 | except AttributeError: |
| 603 | return None |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 604 | |
| 605 | @property |
| 606 | def newlines(self): |
Serhiy Storchaka | bbbbe8e | 2013-02-09 12:21:14 +0200 | [diff] [blame] | 607 | try: |
| 608 | return self._file.newlines |
| 609 | except AttributeError: |
| 610 | if 'b' in self._TemporaryFileArgs['mode']: |
| 611 | raise |
| 612 | return self._TemporaryFileArgs['newline'] |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 613 | |
| 614 | def read(self, *args): |
| 615 | return self._file.read(*args) |
| 616 | |
| 617 | def readline(self, *args): |
| 618 | return self._file.readline(*args) |
| 619 | |
| 620 | def readlines(self, *args): |
| 621 | return self._file.readlines(*args) |
| 622 | |
| 623 | def seek(self, *args): |
| 624 | self._file.seek(*args) |
| 625 | |
| 626 | @property |
| 627 | def softspace(self): |
| 628 | return self._file.softspace |
| 629 | |
| 630 | def tell(self): |
| 631 | return self._file.tell() |
| 632 | |
Antoine Pitrou | 0e86a58 | 2011-11-25 18:03:09 +0100 | [diff] [blame] | 633 | def truncate(self, size=None): |
| 634 | if size is None: |
| 635 | self._file.truncate() |
| 636 | else: |
| 637 | if size > self._max_size: |
| 638 | self.rollover() |
| 639 | self._file.truncate(size) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 640 | |
| 641 | def write(self, s): |
| 642 | file = self._file |
| 643 | rv = file.write(s) |
| 644 | self._check(file) |
| 645 | return rv |
| 646 | |
| 647 | def writelines(self, iterable): |
| 648 | file = self._file |
| 649 | rv = file.writelines(iterable) |
| 650 | self._check(file) |
| 651 | return rv |
| 652 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 653 | |
| 654 | class TemporaryDirectory(object): |
| 655 | """Create and return a temporary directory. This has the same |
| 656 | behavior as mkdtemp but can be used as a context manager. For |
| 657 | example: |
| 658 | |
| 659 | with TemporaryDirectory() as tmpdir: |
| 660 | ... |
| 661 | |
Ezio Melotti | 30b9d5d | 2013-08-17 15:50:46 +0300 | [diff] [blame] | 662 | Upon exiting the context, the directory and everything contained |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 663 | in it are removed. |
| 664 | """ |
| 665 | |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 666 | # Handle mkdtemp raising an exception |
| 667 | name = None |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 668 | _finalizer = None |
Serhiy Storchaka | 99e033b | 2014-01-27 11:18:27 +0200 | [diff] [blame] | 669 | _closed = False |
| 670 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 671 | def __init__(self, suffix="", prefix=template, dir=None): |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 672 | self.name = mkdtemp(suffix, prefix, dir) |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 673 | self._finalizer = _weakref.finalize( |
| 674 | self, self._cleanup, self.name, |
| 675 | warn_message="Implicitly cleaning up {!r}".format(self)) |
| 676 | |
| 677 | @classmethod |
| 678 | def _cleanup(cls, name, warn_message=None): |
| 679 | _shutil.rmtree(name) |
| 680 | if warn_message is not None: |
| 681 | _warnings.warn(warn_message, ResourceWarning) |
| 682 | |
Nick Coghlan | 6b22f3f | 2010-12-12 15:24:21 +0000 | [diff] [blame] | 683 | |
| 684 | def __repr__(self): |
| 685 | return "<{} {!r}>".format(self.__class__.__name__, self.name) |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 686 | |
| 687 | def __enter__(self): |
| 688 | return self.name |
| 689 | |
Nick Coghlan | 543af75 | 2010-10-24 11:23:25 +0000 | [diff] [blame] | 690 | def __exit__(self, exc, value, tb): |
| 691 | self.cleanup() |
| 692 | |
Serhiy Storchaka | a28632b | 2014-01-27 11:21:54 +0200 | [diff] [blame] | 693 | def cleanup(self): |
| 694 | if self._finalizer is not None: |
| 695 | self._finalizer.detach() |
| 696 | if self.name is not None and not self._closed: |
| 697 | _shutil.rmtree(self.name) |
| 698 | self._closed = True |