Ka-Ping Yee | feb6719 | 2001-03-02 23:31:43 +0000 | [diff] [blame] | 1 | r"""OS routines for Mac, DOS, NT, or Posix depending on what system we're on. |
Guido van Rossum | 31104f4 | 1992-01-14 18:28:36 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 3 | This exports: |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 4 | - all functions from posix, nt, dos, os2, mac, or ce, e.g. unlink, stat, etc. |
| 5 | - os.path is one of the modules posixpath, ntpath, macpath, or dospath |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 6 | - os.name is 'posix', 'nt', 'dos', 'os2', 'mac', 'ce' or 'riscos' |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 7 | - os.curdir is a string representing the current directory ('.' or ':') |
| 8 | - os.pardir is a string representing the parent directory ('..' or '::') |
| 9 | - os.sep is the (or a most common) pathname separator ('/' or ':' or '\\') |
Guido van Rossum | e2ae77b | 2001-10-24 20:42:55 +0000 | [diff] [blame] | 10 | - os.extsep is the extension separator ('.' or '/') |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 11 | - os.altsep is the alternate pathname separator (None or '/') |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 12 | - os.pathsep is the component separator used in $PATH etc |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 13 | - os.linesep is the line separator in text files ('\r' or '\n' or '\r\n') |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 14 | - os.defpath is the default search path for executables |
Guido van Rossum | 31104f4 | 1992-01-14 18:28:36 +0000 | [diff] [blame] | 15 | |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 16 | Programs that import and use 'os' stand a better chance of being |
| 17 | portable between different platforms. Of course, they must then |
| 18 | only use functions that are defined by all platforms (e.g., unlink |
| 19 | and opendir), and leave all pathname manipulation to os.path |
| 20 | (e.g., split and join). |
| 21 | """ |
Guido van Rossum | 31104f4 | 1992-01-14 18:28:36 +0000 | [diff] [blame] | 22 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 23 | #' |
| 24 | |
Guido van Rossum | 2979b01 | 1994-08-01 11:18:30 +0000 | [diff] [blame] | 25 | import sys |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 26 | |
| 27 | _names = sys.builtin_module_names |
| 28 | |
| 29 | altsep = None |
| 30 | |
Skip Montanaro | 6c0a0e1 | 2001-02-28 01:00:58 +0000 | [diff] [blame] | 31 | __all__ = ["altsep", "curdir", "pardir", "sep", "pathsep", "linesep", |
| 32 | "defpath", "name"] |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 33 | |
| 34 | def _get_exports_list(module): |
| 35 | try: |
| 36 | return list(module.__all__) |
| 37 | except AttributeError: |
| 38 | return [n for n in dir(module) if n[0] != '_'] |
| 39 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 40 | if 'posix' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 41 | name = 'posix' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 42 | linesep = '\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 43 | curdir = '.'; pardir = '..'; sep = '/'; pathsep = ':' |
| 44 | defpath = ':/bin:/usr/bin' |
| 45 | from posix import * |
| 46 | try: |
| 47 | from posix import _exit |
| 48 | except ImportError: |
| 49 | pass |
| 50 | import posixpath |
| 51 | path = posixpath |
| 52 | del posixpath |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 53 | |
| 54 | import posix |
| 55 | __all__.extend(_get_exports_list(posix)) |
| 56 | del posix |
| 57 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 58 | elif 'nt' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 59 | name = 'nt' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 60 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 61 | curdir = '.'; pardir = '..'; sep = '\\'; pathsep = ';' |
| 62 | defpath = '.;C:\\bin' |
| 63 | from nt import * |
Guido van Rossum | fb801e7 | 1999-02-22 15:40:34 +0000 | [diff] [blame] | 64 | for i in ['_exit']: |
Guido van Rossum | 67c65b2 | 1999-02-01 23:52:29 +0000 | [diff] [blame] | 65 | try: |
| 66 | exec "from nt import " + i |
| 67 | except ImportError: |
| 68 | pass |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 69 | import ntpath |
| 70 | path = ntpath |
| 71 | del ntpath |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 72 | |
| 73 | import nt |
| 74 | __all__.extend(_get_exports_list(nt)) |
| 75 | del nt |
| 76 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 77 | elif 'dos' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 78 | name = 'dos' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 79 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 80 | curdir = '.'; pardir = '..'; sep = '\\'; pathsep = ';' |
| 81 | defpath = '.;C:\\bin' |
| 82 | from dos import * |
| 83 | try: |
| 84 | from dos import _exit |
| 85 | except ImportError: |
| 86 | pass |
| 87 | import dospath |
| 88 | path = dospath |
| 89 | del dospath |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 90 | |
| 91 | import dos |
| 92 | __all__.extend(_get_exports_list(dos)) |
| 93 | del dos |
| 94 | |
Guido van Rossum | 8e9ebfd | 1997-11-22 21:53:48 +0000 | [diff] [blame] | 95 | elif 'os2' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 96 | name = 'os2' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 97 | linesep = '\r\n' |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 98 | curdir = '.'; pardir = '..'; pathsep = ';' |
| 99 | if sys.version.find('EMX GCC') == -1: |
| 100 | # standard OS/2 compiler (VACPP or Watcom?) |
| 101 | sep = '\\'; altsep = '/' |
| 102 | else: |
| 103 | # EMX |
| 104 | sep = '/'; altsep = '\\' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 105 | defpath = '.;C:\\bin' |
| 106 | from os2 import * |
| 107 | try: |
| 108 | from os2 import _exit |
| 109 | except ImportError: |
| 110 | pass |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 111 | if sys.version.find('EMX GCC') == -1: |
| 112 | import ntpath |
| 113 | path = ntpath |
| 114 | del ntpath |
| 115 | else: |
| 116 | import os2emxpath |
| 117 | path = os2emxpath |
| 118 | del os2emxpath |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 119 | |
| 120 | import os2 |
| 121 | __all__.extend(_get_exports_list(os2)) |
| 122 | del os2 |
| 123 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 124 | elif 'mac' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 125 | name = 'mac' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 126 | linesep = '\r' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 127 | curdir = ':'; pardir = '::'; sep = ':'; pathsep = '\n' |
| 128 | defpath = ':' |
| 129 | from mac import * |
| 130 | try: |
| 131 | from mac import _exit |
| 132 | except ImportError: |
| 133 | pass |
| 134 | import macpath |
| 135 | path = macpath |
| 136 | del macpath |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 137 | |
| 138 | import mac |
| 139 | __all__.extend(_get_exports_list(mac)) |
| 140 | del mac |
| 141 | |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 142 | elif 'ce' in _names: |
| 143 | name = 'ce' |
| 144 | linesep = '\r\n' |
| 145 | curdir = '.'; pardir = '..'; sep = '\\'; pathsep = ';' |
| 146 | defpath = '\\Windows' |
| 147 | from ce import * |
| 148 | for i in ['_exit']: |
| 149 | try: |
| 150 | exec "from ce import " + i |
| 151 | except ImportError: |
| 152 | pass |
| 153 | # We can use the standard Windows path. |
| 154 | import ntpath |
| 155 | path = ntpath |
| 156 | del ntpath |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 157 | |
| 158 | import ce |
| 159 | __all__.extend(_get_exports_list(ce)) |
| 160 | del ce |
| 161 | |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 162 | elif 'riscos' in _names: |
| 163 | name = 'riscos' |
| 164 | linesep = '\n' |
| 165 | curdir = '@'; pardir = '^'; sep = '.'; pathsep = ',' |
| 166 | defpath = '<Run$Dir>' |
| 167 | from riscos import * |
| 168 | try: |
| 169 | from riscos import _exit |
| 170 | except ImportError: |
| 171 | pass |
| 172 | import riscospath |
| 173 | path = riscospath |
| 174 | del riscospath |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 175 | |
| 176 | import riscos |
| 177 | __all__.extend(_get_exports_list(riscos)) |
Skip Montanaro | 81e4b1c | 2001-03-06 15:26:07 +0000 | [diff] [blame] | 178 | del riscos |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 179 | |
Guido van Rossum | 2979b01 | 1994-08-01 11:18:30 +0000 | [diff] [blame] | 180 | else: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 181 | raise ImportError, 'no os specific module found' |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 182 | |
Guido van Rossum | e2ae77b | 2001-10-24 20:42:55 +0000 | [diff] [blame] | 183 | |
| 184 | if sep=='.': |
| 185 | extsep = '/' |
| 186 | else: |
| 187 | extsep = '.' |
| 188 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 189 | __all__.append("path") |
| 190 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 191 | del _names |
| 192 | |
Fred Drake | 0237909 | 1999-01-19 16:05:13 +0000 | [diff] [blame] | 193 | sys.modules['os.path'] = path |
| 194 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 195 | #' |
| 196 | |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 197 | # Super directory utilities. |
| 198 | # (Inspired by Eric Raymond; the doc strings are mostly his) |
| 199 | |
| 200 | def makedirs(name, mode=0777): |
| 201 | """makedirs(path [, mode=0777]) -> None |
| 202 | |
| 203 | Super-mkdir; create a leaf directory and all intermediate ones. |
| 204 | Works like mkdir, except that any intermediate path segment (not |
| 205 | just the rightmost) will be created if it does not exist. This is |
| 206 | recursive. |
| 207 | |
| 208 | """ |
| 209 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 210 | if not tail: |
| 211 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 212 | if head and tail and not path.exists(head): |
| 213 | makedirs(head, mode) |
| 214 | mkdir(name, mode) |
| 215 | |
| 216 | def removedirs(name): |
| 217 | """removedirs(path) -> None |
| 218 | |
| 219 | Super-rmdir; remove a leaf directory and empty all intermediate |
| 220 | ones. Works like rmdir except that, if the leaf directory is |
| 221 | successfully removed, directories corresponding to rightmost path |
| 222 | segments will be pruned way until either the whole path is |
| 223 | consumed or an error occurs. Errors during this latter phase are |
| 224 | ignored -- they generally mean that a directory was not empty. |
| 225 | |
| 226 | """ |
| 227 | rmdir(name) |
| 228 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 229 | if not tail: |
| 230 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 231 | while head and tail: |
| 232 | try: |
| 233 | rmdir(head) |
| 234 | except error: |
| 235 | break |
| 236 | head, tail = path.split(head) |
| 237 | |
| 238 | def renames(old, new): |
| 239 | """renames(old, new) -> None |
| 240 | |
| 241 | Super-rename; create directories as necessary and delete any left |
| 242 | empty. Works like rename, except creation of any intermediate |
| 243 | directories needed to make the new pathname good is attempted |
| 244 | first. After the rename, directories corresponding to rightmost |
| 245 | path segments of the old name will be pruned way until either the |
| 246 | whole path is consumed or a nonempty directory is found. |
| 247 | |
| 248 | Note: this function can fail with the new directory structure made |
| 249 | if you lack permissions needed to unlink the leaf directory or |
| 250 | file. |
| 251 | |
| 252 | """ |
| 253 | head, tail = path.split(new) |
| 254 | if head and tail and not path.exists(head): |
| 255 | makedirs(head) |
| 256 | rename(old, new) |
| 257 | head, tail = path.split(old) |
| 258 | if head and tail: |
| 259 | try: |
| 260 | removedirs(head) |
| 261 | except error: |
| 262 | pass |
| 263 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 264 | __all__.extend(["makedirs", "removedirs", "renames"]) |
| 265 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 266 | # Make sure os.environ exists, at least |
| 267 | try: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 268 | environ |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 269 | except NameError: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 270 | environ = {} |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 271 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 272 | def execl(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 273 | """execl(file, *args) |
| 274 | |
| 275 | Execute the executable file with argument list args, replacing the |
| 276 | current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 277 | execv(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 278 | |
| 279 | def execle(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 280 | """execle(file, *args, env) |
| 281 | |
| 282 | Execute the executable file with argument list args and |
| 283 | environment env, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 284 | env = args[-1] |
| 285 | execve(file, args[:-1], env) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 286 | |
| 287 | def execlp(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 288 | """execlp(file, *args) |
| 289 | |
| 290 | Execute the executable file (which is searched for along $PATH) |
| 291 | with argument list args, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 292 | execvp(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 293 | |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 294 | def execlpe(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 295 | """execlpe(file, *args, env) |
| 296 | |
| 297 | Execute the executable file (which is searched for along $PATH) |
| 298 | with argument list args and environment env, replacing the current |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 299 | process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 300 | env = args[-1] |
| 301 | execvpe(file, args[:-1], env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 302 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 303 | def execvp(file, args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 304 | """execp(file, args) |
| 305 | |
| 306 | Execute the executable file (which is searched for along $PATH) |
| 307 | with argument list args, replacing the current process. |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 308 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 309 | _execvpe(file, args) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 310 | |
| 311 | def execvpe(file, args, env): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 312 | """execv(file, args, env) |
| 313 | |
| 314 | Execute the executable file (which is searched for along $PATH) |
| 315 | with argument list args and environment env , replacing the |
| 316 | current process. |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 317 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 318 | _execvpe(file, args, env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 319 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 320 | __all__.extend(["execl","execle","execlp","execlpe","execvp","execvpe"]) |
| 321 | |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 322 | _notfound = None |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 323 | def _execvpe(file, args, env=None): |
| 324 | if env is not None: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 325 | func = execve |
| 326 | argrest = (args, env) |
| 327 | else: |
| 328 | func = execv |
| 329 | argrest = (args,) |
| 330 | env = environ |
| 331 | global _notfound |
| 332 | head, tail = path.split(file) |
| 333 | if head: |
| 334 | apply(func, (file,) + argrest) |
| 335 | return |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 336 | if 'PATH' in env: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 337 | envpath = env['PATH'] |
| 338 | else: |
| 339 | envpath = defpath |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 340 | PATH = envpath.split(pathsep) |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 341 | if not _notfound: |
Guido van Rossum | b7fe432 | 2001-03-02 07:04:51 +0000 | [diff] [blame] | 342 | if sys.platform[:4] == 'beos': |
| 343 | # Process handling (fork, wait) under BeOS (up to 5.0) |
| 344 | # doesn't interoperate reliably with the thread interlocking |
| 345 | # that happens during an import. The actual error we need |
| 346 | # is the same on BeOS for posix.open() et al., ENOENT. |
| 347 | try: unlink('/_#.# ## #.#') |
| 348 | except error, _notfound: pass |
| 349 | else: |
| 350 | import tempfile |
| 351 | t = tempfile.mktemp() |
| 352 | # Exec a file that is guaranteed not to exist |
| 353 | try: execv(t, ('blah',)) |
| 354 | except error, _notfound: pass |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 355 | exc, arg = error, _notfound |
| 356 | for dir in PATH: |
| 357 | fullname = path.join(dir, file) |
| 358 | try: |
| 359 | apply(func, (fullname,) + argrest) |
| 360 | except error, (errno, msg): |
| 361 | if errno != arg[0]: |
| 362 | exc, arg = error, (errno, msg) |
| 363 | raise exc, arg |
Guido van Rossum | 2979b01 | 1994-08-01 11:18:30 +0000 | [diff] [blame] | 364 | |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 365 | |
Martin v. Löwis | a90f438 | 2001-03-07 09:05:45 +0000 | [diff] [blame] | 366 | # Change environ to automatically call putenv() if it exists |
| 367 | try: |
| 368 | # This will fail if there's no putenv |
| 369 | putenv |
| 370 | except NameError: |
| 371 | pass |
| 372 | else: |
| 373 | import UserDict |
Guido van Rossum | 3b8e20d | 1996-07-24 00:55:17 +0000 | [diff] [blame] | 374 | |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 375 | # Fake unsetenv() for Windows |
Tim Peters | 1633a2e | 2001-10-30 05:56:40 +0000 | [diff] [blame] | 376 | # not sure about os2 and dos here but |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 377 | # I'm guessing they are the same. |
| 378 | |
| 379 | if name in ('os2', 'nt', 'dos'): |
| 380 | def unsetenv(key): |
| 381 | putenv(key, "") |
| 382 | |
Martin v. Löwis | a90f438 | 2001-03-07 09:05:45 +0000 | [diff] [blame] | 383 | if name == "riscos": |
| 384 | # On RISC OS, all env access goes through getenv and putenv |
| 385 | from riscosenviron import _Environ |
| 386 | elif name in ('os2', 'nt', 'dos'): # Where Env Var Names Must Be UPPERCASE |
Guido van Rossum | da4d6da | 1998-08-04 16:01:23 +0000 | [diff] [blame] | 387 | # But we store them as upper case |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 388 | class _Environ(UserDict.UserDict): |
| 389 | def __init__(self, environ): |
| 390 | UserDict.UserDict.__init__(self) |
Guido van Rossum | da4d6da | 1998-08-04 16:01:23 +0000 | [diff] [blame] | 391 | data = self.data |
Guido van Rossum | da4d6da | 1998-08-04 16:01:23 +0000 | [diff] [blame] | 392 | for k, v in environ.items(): |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 393 | data[k.upper()] = v |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 394 | def __setitem__(self, key, item): |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 395 | putenv(key, item) |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 396 | self.data[key.upper()] = item |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 397 | def __getitem__(self, key): |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 398 | return self.data[key.upper()] |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 399 | try: |
| 400 | unsetenv |
| 401 | except NameError: |
| 402 | def __delitem__(self, key): |
| 403 | del self.data[key.upper()] |
| 404 | else: |
| 405 | def __delitem__(self, key): |
| 406 | unsetenv(key) |
| 407 | del self.data[key.upper()] |
Guido van Rossum | b46413f | 1999-05-03 15:23:24 +0000 | [diff] [blame] | 408 | def has_key(self, key): |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 409 | return key.upper() in self.data |
| 410 | def __contains__(self, key): |
| 411 | return key.upper() in self.data |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 412 | def get(self, key, failobj=None): |
| 413 | return self.data.get(key.upper(), failobj) |
| 414 | def update(self, dict): |
| 415 | for k, v in dict.items(): |
| 416 | self[k] = v |
Martin v. Löwis | a066f46 | 2002-05-02 17:39:19 +0000 | [diff] [blame] | 417 | def copy(self): |
| 418 | return dict(self) |
Guido van Rossum | 3b8e20d | 1996-07-24 00:55:17 +0000 | [diff] [blame] | 419 | |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 420 | else: # Where Env Var Names Can Be Mixed Case |
| 421 | class _Environ(UserDict.UserDict): |
| 422 | def __init__(self, environ): |
| 423 | UserDict.UserDict.__init__(self) |
| 424 | self.data = environ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 425 | def __setitem__(self, key, item): |
| 426 | putenv(key, item) |
| 427 | self.data[key] = item |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 428 | def update(self, dict): |
| 429 | for k, v in dict.items(): |
| 430 | self[k] = v |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 431 | try: |
| 432 | unsetenv |
| 433 | except NameError: |
| 434 | pass |
| 435 | else: |
| 436 | def __delitem__(self, key): |
| 437 | unsetenv(key) |
| 438 | del self.data[key] |
Martin v. Löwis | a066f46 | 2002-05-02 17:39:19 +0000 | [diff] [blame] | 439 | def copy(self): |
| 440 | return dict(self) |
Tim Peters | 1633a2e | 2001-10-30 05:56:40 +0000 | [diff] [blame] | 441 | |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 442 | |
| 443 | environ = _Environ(environ) |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 444 | |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 445 | def getenv(key, default=None): |
| 446 | """Get an environment variable, return None if it doesn't exist. |
| 447 | The optional second argument can specify an alternate default.""" |
| 448 | return environ.get(key, default) |
| 449 | __all__.append("getenv") |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 450 | |
| 451 | def _exists(name): |
| 452 | try: |
| 453 | eval(name) |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 454 | return True |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 455 | except NameError: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 456 | return False |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 457 | |
| 458 | # Supply spawn*() (probably only for Unix) |
| 459 | if _exists("fork") and not _exists("spawnv") and _exists("execv"): |
| 460 | |
| 461 | P_WAIT = 0 |
| 462 | P_NOWAIT = P_NOWAITO = 1 |
| 463 | |
| 464 | # XXX Should we support P_DETACH? I suppose it could fork()**2 |
| 465 | # and close the std I/O streams. Also, P_OVERLAY is the same |
| 466 | # as execv*()? |
| 467 | |
| 468 | def _spawnvef(mode, file, args, env, func): |
| 469 | # Internal helper; func is the exec*() function to use |
| 470 | pid = fork() |
| 471 | if not pid: |
| 472 | # Child |
| 473 | try: |
| 474 | if env is None: |
| 475 | func(file, args) |
| 476 | else: |
| 477 | func(file, args, env) |
| 478 | except: |
| 479 | _exit(127) |
| 480 | else: |
| 481 | # Parent |
| 482 | if mode == P_NOWAIT: |
| 483 | return pid # Caller is responsible for waiting! |
| 484 | while 1: |
| 485 | wpid, sts = waitpid(pid, 0) |
| 486 | if WIFSTOPPED(sts): |
| 487 | continue |
| 488 | elif WIFSIGNALED(sts): |
| 489 | return -WTERMSIG(sts) |
| 490 | elif WIFEXITED(sts): |
| 491 | return WEXITSTATUS(sts) |
| 492 | else: |
| 493 | raise error, "Not stopped, signaled or exited???" |
| 494 | |
| 495 | def spawnv(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 496 | """spawnv(mode, file, args) -> integer |
| 497 | |
| 498 | Execute file with arguments from args in a subprocess. |
| 499 | If mode == P_NOWAIT return the pid of the process. |
| 500 | If mode == P_WAIT return the process's exit code if it exits normally; |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 501 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 502 | return _spawnvef(mode, file, args, None, execv) |
| 503 | |
| 504 | def spawnve(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 505 | """spawnve(mode, file, args, env) -> integer |
| 506 | |
| 507 | Execute file with arguments from args in a subprocess with the |
| 508 | specified environment. |
| 509 | If mode == P_NOWAIT return the pid of the process. |
| 510 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 511 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 512 | return _spawnvef(mode, file, args, env, execve) |
| 513 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 514 | # Note: spawnvp[e] is't currently supported on Windows |
| 515 | |
| 516 | def spawnvp(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 517 | """spawnvp(mode, file, args) -> integer |
| 518 | |
| 519 | Execute file (which is looked for along $PATH) with arguments from |
| 520 | args in a subprocess. |
| 521 | If mode == P_NOWAIT return the pid of the process. |
| 522 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 523 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 524 | return _spawnvef(mode, file, args, None, execvp) |
| 525 | |
| 526 | def spawnvpe(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 527 | """spawnvpe(mode, file, args, env) -> integer |
| 528 | |
| 529 | Execute file (which is looked for along $PATH) with arguments from |
| 530 | args in a subprocess with the supplied environment. |
| 531 | If mode == P_NOWAIT return the pid of the process. |
| 532 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 533 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 534 | return _spawnvef(mode, file, args, env, execvpe) |
| 535 | |
| 536 | if _exists("spawnv"): |
| 537 | # These aren't supplied by the basic Windows code |
| 538 | # but can be easily implemented in Python |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 539 | |
| 540 | def spawnl(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 541 | """spawnl(mode, file, *args) -> integer |
| 542 | |
| 543 | Execute file with arguments from args in a subprocess. |
| 544 | If mode == P_NOWAIT return the pid of the process. |
| 545 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 546 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 547 | return spawnv(mode, file, args) |
| 548 | |
| 549 | def spawnle(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 550 | """spawnle(mode, file, *args, env) -> integer |
| 551 | |
| 552 | Execute file with arguments from args in a subprocess with the |
| 553 | supplied environment. |
| 554 | If mode == P_NOWAIT return the pid of the process. |
| 555 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 556 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 557 | env = args[-1] |
| 558 | return spawnve(mode, file, args[:-1], env) |
| 559 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 560 | if _exists("spawnvp"): |
| 561 | # At the moment, Windows doesn't implement spawnvp[e], |
| 562 | # so it won't have spawnlp[e] either. |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 563 | def spawnlp(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 564 | """spawnlp(mode, file, *args, env) -> integer |
| 565 | |
| 566 | Execute file (which is looked for along $PATH) with arguments from |
| 567 | args in a subprocess with the supplied environment. |
| 568 | If mode == P_NOWAIT return the pid of the process. |
| 569 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 570 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 571 | return spawnvp(mode, file, args) |
| 572 | |
| 573 | def spawnlpe(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 574 | """spawnlpe(mode, file, *args, env) -> integer |
| 575 | |
| 576 | Execute file (which is looked for along $PATH) with arguments from |
| 577 | args in a subprocess with the supplied environment. |
| 578 | If mode == P_NOWAIT return the pid of the process. |
| 579 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 580 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 581 | env = args[-1] |
| 582 | return spawnvpe(mode, file, args[:-1], env) |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 583 | |
| 584 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 585 | __all__.extend(["spawnlp","spawnlpe","spawnv", "spawnve","spawnvp", |
| 586 | "spawnvpe","spawnl","spawnle",]) |
| 587 | |
| 588 | |
Guido van Rossum | d9a8e96 | 2000-09-19 03:04:52 +0000 | [diff] [blame] | 589 | # Supply popen2 etc. (for Unix) |
| 590 | if _exists("fork"): |
| 591 | if not _exists("popen2"): |
| 592 | def popen2(cmd, mode="t", bufsize=-1): |
Guido van Rossum | d9a8e96 | 2000-09-19 03:04:52 +0000 | [diff] [blame] | 593 | import popen2 |
| 594 | stdout, stdin = popen2.popen2(cmd, bufsize) |
| 595 | return stdin, stdout |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 596 | __all__.append("popen2") |
Fred Drake | 31f182e | 2000-08-28 17:20:05 +0000 | [diff] [blame] | 597 | |
Guido van Rossum | d9a8e96 | 2000-09-19 03:04:52 +0000 | [diff] [blame] | 598 | if not _exists("popen3"): |
| 599 | def popen3(cmd, mode="t", bufsize=-1): |
Guido van Rossum | d9a8e96 | 2000-09-19 03:04:52 +0000 | [diff] [blame] | 600 | import popen2 |
| 601 | stdout, stdin, stderr = popen2.popen3(cmd, bufsize) |
| 602 | return stdin, stdout, stderr |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 603 | __all__.append("popen3") |
Fred Drake | 20af317 | 2000-09-28 19:10:56 +0000 | [diff] [blame] | 604 | |
| 605 | if not _exists("popen4"): |
| 606 | def popen4(cmd, mode="t", bufsize=-1): |
| 607 | import popen2 |
| 608 | stdout, stdin = popen2.popen4(cmd, bufsize) |
| 609 | return stdin, stdout |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 610 | __all__.append("popen4") |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 611 | |
| 612 | import copy_reg as _copy_reg |
| 613 | |
| 614 | def _make_stat_result(tup, dict): |
| 615 | return stat_result(tup, dict) |
| 616 | |
| 617 | def _pickle_stat_result(sr): |
| 618 | (type, args) = sr.__reduce__() |
| 619 | return (_make_stat_result, args) |
| 620 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 621 | try: |
| 622 | _copy_reg.pickle(stat_result, _pickle_stat_result, _make_stat_result) |
| 623 | except NameError: # stat_result may not exist |
| 624 | pass |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 625 | |
| 626 | def _make_statvfs_result(tup, dict): |
| 627 | return statvfs_result(tup, dict) |
| 628 | |
| 629 | def _pickle_statvfs_result(sr): |
| 630 | (type, args) = sr.__reduce__() |
| 631 | return (_make_statvfs_result, args) |
| 632 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 633 | try: |
| 634 | _copy_reg.pickle(statvfs_result, _pickle_statvfs_result, |
| 635 | _make_statvfs_result) |
Michael W. Hudson | e5363b7 | 2002-03-15 10:21:59 +0000 | [diff] [blame] | 636 | except NameError: # statvfs_result may not exist |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 637 | pass |