Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 1 | """Temporary files and filenames.""" |
| 2 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 3 | # XXX This tries to be not UNIX specific, but I don't know beans about |
| 4 | # how to choose a temp directory or filename on MS-DOS or other |
| 5 | # systems so it may have to be changed... |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 6 | |
| 7 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 8 | import os |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 9 | |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 11 | # Parameters that the caller may set to override the defaults |
Guido van Rossum | cff3454 | 1992-01-14 18:31:56 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 13 | tempdir = None |
| 14 | template = None |
| 15 | |
| 16 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 17 | def gettempdir(): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 18 | """Function to calculate the directory to use.""" |
Guido van Rossum | f4aaf86 | 1996-05-28 23:31:34 +0000 | [diff] [blame] | 19 | global tempdir |
Guido van Rossum | 4033ad7 | 1996-08-08 18:33:56 +0000 | [diff] [blame] | 20 | if tempdir is not None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 21 | return tempdir |
Guido van Rossum | 29e5f5d | 1998-04-09 14:27:57 +0000 | [diff] [blame] | 22 | try: |
| 23 | pwd = os.getcwd() |
| 24 | except (AttributeError, os.error): |
| 25 | pwd = os.curdir |
| 26 | attempdirs = ['/usr/tmp', '/tmp', pwd] |
Guido van Rossum | 3e065ad | 1996-08-20 20:38:59 +0000 | [diff] [blame] | 27 | if os.name == 'nt': |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 28 | attempdirs.insert(0, 'C:\\TEMP') |
| 29 | attempdirs.insert(0, '\\TEMP') |
Guido van Rossum | f4f756c | 1997-04-11 19:00:53 +0000 | [diff] [blame] | 30 | elif os.name == 'mac': |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 31 | import macfs, MACFS |
| 32 | try: |
| 33 | refnum, dirid = macfs.FindFolder(MACFS.kOnSystemDisk, |
Guido van Rossum | 57a0661 | 1998-04-28 16:03:34 +0000 | [diff] [blame] | 34 | MACFS.kTemporaryFolderType, 1) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 35 | dirname = macfs.FSSpec((refnum, dirid, '')).as_pathname() |
| 36 | attempdirs.insert(0, dirname) |
| 37 | except macfs.error: |
| 38 | pass |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 39 | for envname in 'TMPDIR', 'TEMP', 'TMP': |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 40 | if os.environ.has_key(envname): |
| 41 | attempdirs.insert(0, os.environ[envname]) |
Guido van Rossum | 3e065ad | 1996-08-20 20:38:59 +0000 | [diff] [blame] | 42 | testfile = gettempprefix() + 'test' |
Guido van Rossum | f4aaf86 | 1996-05-28 23:31:34 +0000 | [diff] [blame] | 43 | for dir in attempdirs: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 44 | try: |
Guido van Rossum | 00f09b3 | 2000-04-24 13:28:02 +0000 | [diff] [blame] | 45 | filename = os.path.join(dir, testfile) |
| 46 | if os.name == 'posix': |
| 47 | try: |
| 48 | fd = os.open(filename, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700) |
| 49 | except OSError: |
| 50 | pass |
| 51 | else: |
| 52 | fp = os.fdopen(fd, 'w') |
| 53 | fp.write('blat') |
| 54 | fp.close() |
| 55 | os.unlink(filename) |
| 56 | del fp, fd |
| 57 | tempdir = dir |
| 58 | break |
| 59 | else: |
| 60 | fp = open(filename, 'w') |
| 61 | fp.write('blat') |
| 62 | fp.close() |
| 63 | os.unlink(filename) |
| 64 | tempdir = dir |
| 65 | break |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 66 | except IOError: |
| 67 | pass |
Guido van Rossum | f4aaf86 | 1996-05-28 23:31:34 +0000 | [diff] [blame] | 68 | if tempdir is None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 69 | msg = "Can't find a usable temporary directory amongst " + `attempdirs` |
| 70 | raise IOError, msg |
Guido van Rossum | f4aaf86 | 1996-05-28 23:31:34 +0000 | [diff] [blame] | 71 | return tempdir |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 72 | |
| 73 | |
Guido van Rossum | b0e5718 | 1998-10-14 20:27:05 +0000 | [diff] [blame] | 74 | _pid = None |
| 75 | |
Guido van Rossum | 41f9503 | 1992-03-31 19:02:01 +0000 | [diff] [blame] | 76 | def gettempprefix(): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 77 | """Function to calculate a prefix of the filename to use.""" |
Guido van Rossum | b0e5718 | 1998-10-14 20:27:05 +0000 | [diff] [blame] | 78 | global template, _pid |
| 79 | if os.name == 'posix' and _pid and _pid != os.getpid(): |
| 80 | # Our pid changed; we must have forked -- zap the template |
| 81 | template = None |
| 82 | if template is None: |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 83 | if os.name == 'posix': |
Guido van Rossum | b0e5718 | 1998-10-14 20:27:05 +0000 | [diff] [blame] | 84 | _pid = os.getpid() |
| 85 | template = '@' + `_pid` + '.' |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 86 | elif os.name == 'nt': |
| 87 | template = '~' + `os.getpid()` + '-' |
| 88 | elif os.name == 'mac': |
| 89 | template = 'Python-Tmp-' |
| 90 | else: |
| 91 | template = 'tmp' # XXX might choose a better one |
| 92 | return template |
Guido van Rossum | cff3454 | 1992-01-14 18:31:56 +0000 | [diff] [blame] | 93 | |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 94 | |
Guido van Rossum | 4a3a41f | 1991-12-26 13:10:50 +0000 | [diff] [blame] | 95 | # Counter for generating unique names |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 96 | |
Guido van Rossum | 4a3a41f | 1991-12-26 13:10:50 +0000 | [diff] [blame] | 97 | counter = 0 |
Guido van Rossum | eee9498 | 1991-11-12 15:38:08 +0000 | [diff] [blame] | 98 | |
| 99 | |
Guido van Rossum | b8c42c9 | 1997-12-19 04:29:50 +0000 | [diff] [blame] | 100 | def mktemp(suffix=""): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 101 | """User-callable function to return a unique temporary file name.""" |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 102 | global counter |
| 103 | dir = gettempdir() |
| 104 | pre = gettempprefix() |
| 105 | while 1: |
| 106 | counter = counter + 1 |
| 107 | file = os.path.join(dir, pre + `counter` + suffix) |
| 108 | if not os.path.exists(file): |
| 109 | return file |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 110 | |
| 111 | |
| 112 | class TemporaryFileWrapper: |
| 113 | """Temporary file wrapper |
| 114 | |
| 115 | This class provides a wrapper around files opened for temporary use. |
| 116 | In particular, it seeks to automatically remove the file when it is |
| 117 | no longer needed. |
| 118 | """ |
| 119 | def __init__(self, file, path): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 120 | self.file = file |
| 121 | self.path = path |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 122 | |
| 123 | def close(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 124 | self.file.close() |
| 125 | os.unlink(self.path) |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 126 | |
| 127 | def __del__(self): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 128 | try: self.close() |
| 129 | except: pass |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 130 | |
| 131 | def __getattr__(self, name): |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 132 | file = self.__dict__['file'] |
| 133 | a = getattr(file, name) |
Guido van Rossum | 6b708d5 | 1999-06-01 18:55:36 +0000 | [diff] [blame] | 134 | if type(a) != type(0): |
| 135 | setattr(self, name, a) |
Guido van Rossum | 45e2fbc | 1998-03-26 21:13:24 +0000 | [diff] [blame] | 136 | return a |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 137 | |
| 138 | |
Guido van Rossum | b8c42c9 | 1997-12-19 04:29:50 +0000 | [diff] [blame] | 139 | def TemporaryFile(mode='w+b', bufsize=-1, suffix=""): |
Guido van Rossum | e7b146f | 2000-02-04 15:28:42 +0000 | [diff] [blame] | 140 | """Create and return a temporary file (opened read-write by default).""" |
Guido van Rossum | b8c42c9 | 1997-12-19 04:29:50 +0000 | [diff] [blame] | 141 | name = mktemp(suffix) |
Guido van Rossum | dce3d55 | 1998-10-24 01:34:45 +0000 | [diff] [blame] | 142 | if os.name == 'posix': |
| 143 | # Unix -- be very careful |
| 144 | fd = os.open(name, os.O_RDWR|os.O_CREAT|os.O_EXCL, 0700) |
Guido van Rossum | 2457fc2 | 1998-10-24 15:02:59 +0000 | [diff] [blame] | 145 | try: |
| 146 | os.unlink(name) |
| 147 | return os.fdopen(fd, mode, bufsize) |
| 148 | except: |
| 149 | os.close(fd) |
| 150 | raise |
Guido van Rossum | ca54982 | 1997-08-12 18:00:12 +0000 | [diff] [blame] | 151 | else: |
Guido van Rossum | dce3d55 | 1998-10-24 01:34:45 +0000 | [diff] [blame] | 152 | # Non-unix -- can't unlink file that's still open, use wrapper |
| 153 | file = open(name, mode, bufsize) |
| 154 | return TemporaryFileWrapper(file, name) |