Georg Brandl | bde4ad4 | 2006-01-20 21:36:02 +0000 | [diff] [blame] | 1 | r"""OS routines for Mac, 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: |
Alexandre Vassalotti | eca20b6 | 2008-05-16 02:54:33 +0000 | [diff] [blame] | 4 | - all functions from posix, nt, os2, or ce, e.g. unlink, stat, etc. |
| 5 | - os.path is either posixpath or ntpath |
| 6 | - os.name is either 'posix', 'nt', 'os2' or 'ce'. |
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 '\\') |
Georg Brandl | ed5b9b3 | 2008-12-05 07:45:54 +0000 | [diff] [blame] | 10 | - os.extsep is the extension separator (always '.') |
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 |
Martin v. Löwis | bdec50f | 2004-06-08 08:29:33 +0000 | [diff] [blame] | 15 | - os.devnull is the file path of the null device ('/dev/null', etc.) |
Guido van Rossum | 31104f4 | 1992-01-14 18:28:36 +0000 | [diff] [blame] | 16 | |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 17 | Programs that import and use 'os' stand a better chance of being |
| 18 | portable between different platforms. Of course, they must then |
| 19 | only use functions that are defined by all platforms (e.g., unlink |
| 20 | and opendir), and leave all pathname manipulation to os.path |
| 21 | (e.g., split and join). |
| 22 | """ |
Guido van Rossum | 31104f4 | 1992-01-14 18:28:36 +0000 | [diff] [blame] | 23 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 24 | #' |
| 25 | |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 26 | import sys, errno |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 27 | import stat as st |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 28 | |
| 29 | _names = sys.builtin_module_names |
| 30 | |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 31 | # Note: more names are added to __all__ later. |
Brett Cannon | 13962fc | 2008-08-18 01:45:29 +0000 | [diff] [blame] | 32 | __all__ = ["altsep", "curdir", "pardir", "sep", "pathsep", "linesep", |
Petri Lehtinen | 3bc37f2 | 2012-05-23 21:36:16 +0300 | [diff] [blame] | 33 | "defpath", "name", "path", "devnull", "SEEK_SET", "SEEK_CUR", |
| 34 | "SEEK_END", "fsencode", "fsdecode", "get_exec_path", "fdopen", |
| 35 | "popen", "extsep"] |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 36 | |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 37 | def _exists(name): |
| 38 | return name in globals() |
| 39 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 40 | def _get_exports_list(module): |
| 41 | try: |
| 42 | return list(module.__all__) |
| 43 | except AttributeError: |
| 44 | return [n for n in dir(module) if n[0] != '_'] |
| 45 | |
Brett Cannon | fd07415 | 2012-04-14 14:10:13 -0400 | [diff] [blame] | 46 | # Any new dependencies of the os module and/or changes in path separator |
| 47 | # requires updating importlib as well. |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 48 | if 'posix' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 49 | name = 'posix' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 50 | linesep = '\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 51 | from posix import * |
| 52 | try: |
| 53 | from posix import _exit |
Petri Lehtinen | 3bc37f2 | 2012-05-23 21:36:16 +0300 | [diff] [blame] | 54 | __all__.append('_exit') |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 55 | except ImportError: |
| 56 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 57 | import posixpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 58 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 59 | try: |
| 60 | from posix import _have_functions |
| 61 | except ImportError: |
| 62 | pass |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 63 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 64 | elif 'nt' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 65 | name = 'nt' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 66 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 67 | from nt import * |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 68 | try: |
| 69 | from nt import _exit |
Petri Lehtinen | 3bc37f2 | 2012-05-23 21:36:16 +0300 | [diff] [blame] | 70 | __all__.append('_exit') |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 71 | except ImportError: |
| 72 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 73 | import ntpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 74 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 75 | import nt |
| 76 | __all__.extend(_get_exports_list(nt)) |
| 77 | del nt |
| 78 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 79 | try: |
| 80 | from nt import _have_functions |
| 81 | except ImportError: |
| 82 | pass |
| 83 | |
Guido van Rossum | 8e9ebfd | 1997-11-22 21:53:48 +0000 | [diff] [blame] | 84 | elif 'os2' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 85 | name = 'os2' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 86 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 87 | from os2 import * |
| 88 | try: |
| 89 | from os2 import _exit |
Petri Lehtinen | 3bc37f2 | 2012-05-23 21:36:16 +0300 | [diff] [blame] | 90 | __all__.append('_exit') |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 91 | except ImportError: |
| 92 | pass |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 93 | if sys.version.find('EMX GCC') == -1: |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 94 | import ntpath as path |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 95 | else: |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 96 | import os2emxpath as path |
Andrew MacIntyre | 89f9865 | 2003-12-02 12:33:01 +0000 | [diff] [blame] | 97 | from _emx_link import link |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 98 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 99 | import os2 |
| 100 | __all__.extend(_get_exports_list(os2)) |
| 101 | del os2 |
| 102 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 103 | try: |
| 104 | from os2 import _have_functions |
| 105 | except ImportError: |
| 106 | pass |
| 107 | |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 108 | elif 'ce' in _names: |
| 109 | name = 'ce' |
| 110 | linesep = '\r\n' |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 111 | from ce import * |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 112 | try: |
| 113 | from ce import _exit |
Petri Lehtinen | 3bc37f2 | 2012-05-23 21:36:16 +0300 | [diff] [blame] | 114 | __all__.append('_exit') |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 115 | except ImportError: |
| 116 | pass |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 117 | # We can use the standard Windows path. |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 118 | import ntpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 119 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 120 | import ce |
| 121 | __all__.extend(_get_exports_list(ce)) |
| 122 | del ce |
| 123 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 124 | try: |
| 125 | from ce import _have_functions |
| 126 | except ImportError: |
| 127 | pass |
| 128 | |
Guido van Rossum | 2979b01 | 1994-08-01 11:18:30 +0000 | [diff] [blame] | 129 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 130 | raise ImportError('no os specific module found') |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 131 | |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 132 | sys.modules['os.path'] = path |
Georg Brandl | ed5b9b3 | 2008-12-05 07:45:54 +0000 | [diff] [blame] | 133 | from os.path import (curdir, pardir, sep, pathsep, defpath, extsep, altsep, |
| 134 | devnull) |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 135 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 136 | del _names |
| 137 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 138 | |
| 139 | if _exists("_have_functions"): |
| 140 | _globals = globals() |
| 141 | def _add(str, fn): |
| 142 | if (fn in _globals) and (str in _have_functions): |
| 143 | _set.add(_globals[fn]) |
| 144 | |
| 145 | _set = set() |
| 146 | _add("HAVE_FACCESSAT", "access") |
| 147 | _add("HAVE_FCHMODAT", "chmod") |
| 148 | _add("HAVE_FCHOWNAT", "chown") |
| 149 | _add("HAVE_FSTATAT", "stat") |
| 150 | _add("HAVE_FUTIMESAT", "utime") |
| 151 | _add("HAVE_LINKAT", "link") |
| 152 | _add("HAVE_MKDIRAT", "mkdir") |
| 153 | _add("HAVE_MKFIFOAT", "mkfifo") |
| 154 | _add("HAVE_MKNODAT", "mknod") |
| 155 | _add("HAVE_OPENAT", "open") |
| 156 | _add("HAVE_READLINKAT", "readlink") |
| 157 | _add("HAVE_RENAMEAT", "rename") |
| 158 | _add("HAVE_SYMLINKAT", "symlink") |
| 159 | _add("HAVE_UNLINKAT", "unlink") |
Larry Hastings | b698d8e | 2012-06-23 16:55:07 -0700 | [diff] [blame] | 160 | _add("HAVE_UNLINKAT", "rmdir") |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 161 | _add("HAVE_UTIMENSAT", "utime") |
| 162 | supports_dir_fd = _set |
| 163 | |
| 164 | _set = set() |
| 165 | _add("HAVE_FACCESSAT", "access") |
| 166 | supports_effective_ids = _set |
| 167 | |
| 168 | _set = set() |
| 169 | _add("HAVE_FCHDIR", "chdir") |
| 170 | _add("HAVE_FCHMOD", "chmod") |
| 171 | _add("HAVE_FCHOWN", "chown") |
| 172 | _add("HAVE_FDOPENDIR", "listdir") |
| 173 | _add("HAVE_FEXECVE", "execve") |
| 174 | _set.add(stat) # fstat always works |
Georg Brandl | 306336b | 2012-06-24 12:55:33 +0200 | [diff] [blame] | 175 | _add("HAVE_FTRUNCATE", "truncate") |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 176 | _add("HAVE_FUTIMENS", "utime") |
| 177 | _add("HAVE_FUTIMES", "utime") |
Georg Brandl | 306336b | 2012-06-24 12:55:33 +0200 | [diff] [blame] | 178 | _add("HAVE_FPATHCONF", "pathconf") |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 179 | if _exists("statvfs") and _exists("fstatvfs"): # mac os x10.3 |
| 180 | _add("HAVE_FSTATVFS", "statvfs") |
| 181 | supports_fd = _set |
| 182 | |
| 183 | _set = set() |
| 184 | _add("HAVE_FACCESSAT", "access") |
Larry Hastings | dbbc0c8 | 2012-06-22 19:50:21 -0700 | [diff] [blame] | 185 | # Some platforms don't support lchmod(). Often the function exists |
| 186 | # anyway, as a stub that always returns ENOSUP or perhaps EOPNOTSUPP. |
| 187 | # (No, I don't know why that's a good design.) ./configure will detect |
| 188 | # this and reject it--so HAVE_LCHMOD still won't be defined on such |
| 189 | # platforms. This is Very Helpful. |
| 190 | # |
| 191 | # However, sometimes platforms without a working lchmod() *do* have |
| 192 | # fchmodat(). (Examples: Linux kernel 3.2 with glibc 2.15, |
| 193 | # OpenIndiana 3.x.) And fchmodat() has a flag that theoretically makes |
| 194 | # it behave like lchmod(). So in theory it would be a suitable |
| 195 | # replacement for lchmod(). But when lchmod() doesn't work, fchmodat()'s |
| 196 | # flag doesn't work *either*. Sadly ./configure isn't sophisticated |
| 197 | # enough to detect this condition--it only determines whether or not |
| 198 | # fchmodat() minimally works. |
| 199 | # |
| 200 | # Therefore we simply ignore fchmodat() when deciding whether or not |
| 201 | # os.chmod supports follow_symlinks. Just checking lchmod() is |
| 202 | # sufficient. After all--if you have a working fchmodat(), your |
| 203 | # lchmod() almost certainly works too. |
| 204 | # |
| 205 | # _add("HAVE_FCHMODAT", "chmod") |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 206 | _add("HAVE_FCHOWNAT", "chown") |
| 207 | _add("HAVE_FSTATAT", "stat") |
| 208 | _add("HAVE_LCHFLAGS", "chflags") |
| 209 | _add("HAVE_LCHMOD", "chmod") |
| 210 | if _exists("lchown"): # mac os x10.3 |
| 211 | _add("HAVE_LCHOWN", "chown") |
| 212 | _add("HAVE_LINKAT", "link") |
| 213 | _add("HAVE_LUTIMES", "utime") |
| 214 | _add("HAVE_LSTAT", "stat") |
| 215 | _add("HAVE_FSTATAT", "stat") |
| 216 | _add("HAVE_UTIMENSAT", "utime") |
| 217 | _add("MS_WINDOWS", "stat") |
| 218 | supports_follow_symlinks = _set |
| 219 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 220 | del _set |
| 221 | del _have_functions |
| 222 | del _globals |
| 223 | del _add |
| 224 | |
| 225 | |
Martin v. Löwis | 22b457e | 2005-01-16 08:40:58 +0000 | [diff] [blame] | 226 | # Python uses fixed values for the SEEK_ constants; they are mapped |
| 227 | # to native constants if necessary in posixmodule.c |
Jesus Cea | 9436361 | 2012-06-22 18:32:07 +0200 | [diff] [blame] | 228 | # Other possible SEEK values are directly imported from posixmodule.c |
Martin v. Löwis | 22b457e | 2005-01-16 08:40:58 +0000 | [diff] [blame] | 229 | SEEK_SET = 0 |
| 230 | SEEK_CUR = 1 |
| 231 | SEEK_END = 2 |
| 232 | |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 233 | |
| 234 | def _get_masked_mode(mode): |
| 235 | mask = umask(0) |
| 236 | umask(mask) |
| 237 | return mode & ~mask |
| 238 | |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 239 | # Super directory utilities. |
| 240 | # (Inspired by Eric Raymond; the doc strings are mostly his) |
| 241 | |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 242 | def makedirs(name, mode=0o777, exist_ok=False): |
| 243 | """makedirs(path [, mode=0o777][, exist_ok=False]) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 244 | |
| 245 | Super-mkdir; create a leaf directory and all intermediate ones. |
| 246 | Works like mkdir, except that any intermediate path segment (not |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 247 | just the rightmost) will be created if it does not exist. If the |
| 248 | target directory with the same mode as we specified already exists, |
| 249 | raises an OSError if exist_ok is False, otherwise no exception is |
| 250 | raised. This is recursive. |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 251 | |
| 252 | """ |
| 253 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 254 | if not tail: |
| 255 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 256 | if head and tail and not path.exists(head): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 257 | try: |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 258 | makedirs(head, mode, exist_ok) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 259 | except OSError as e: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 260 | # be happy if someone already created the path |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 261 | if e.errno != errno.EEXIST: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 262 | raise |
Andrew M. Kuchling | 6fccc8a | 2003-12-23 16:33:28 +0000 | [diff] [blame] | 263 | if tail == curdir: # xxx/newdir/. exists if xxx/newdir exists |
| 264 | return |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 265 | try: |
| 266 | mkdir(name, mode) |
| 267 | except OSError as e: |
Gregory P. Smith | a81c856 | 2012-06-03 14:30:44 -0700 | [diff] [blame] | 268 | dir_exists = path.isdir(name) |
| 269 | expected_mode = _get_masked_mode(mode) |
| 270 | if dir_exists: |
| 271 | # S_ISGID is automatically copied by the OS from parent to child |
| 272 | # directories on mkdir. Don't consider it being set to be a mode |
| 273 | # mismatch as mkdir does not unset it when not specified in mode. |
| 274 | actual_mode = st.S_IMODE(lstat(name).st_mode) & ~st.S_ISGID |
| 275 | else: |
| 276 | actual_mode = -1 |
| 277 | if not (e.errno == errno.EEXIST and exist_ok and dir_exists and |
| 278 | actual_mode == expected_mode): |
| 279 | if dir_exists and actual_mode != expected_mode: |
| 280 | e.strerror += ' (mode %o != expected mode %o)' % ( |
| 281 | actual_mode, expected_mode) |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 282 | raise |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 283 | |
| 284 | def removedirs(name): |
Fred Drake | cadb9eb | 2002-07-02 21:28:04 +0000 | [diff] [blame] | 285 | """removedirs(path) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 286 | |
Fredrik Lundh | 96c1c7a | 2005-11-12 15:55:04 +0000 | [diff] [blame] | 287 | Super-rmdir; remove a leaf directory and all empty intermediate |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 288 | ones. Works like rmdir except that, if the leaf directory is |
| 289 | successfully removed, directories corresponding to rightmost path |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 290 | segments will be pruned away until either the whole path is |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 291 | consumed or an error occurs. Errors during this latter phase are |
| 292 | ignored -- they generally mean that a directory was not empty. |
| 293 | |
| 294 | """ |
| 295 | rmdir(name) |
| 296 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 297 | if not tail: |
| 298 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 299 | while head and tail: |
| 300 | try: |
| 301 | rmdir(head) |
| 302 | except error: |
| 303 | break |
| 304 | head, tail = path.split(head) |
| 305 | |
| 306 | def renames(old, new): |
Fred Drake | cadb9eb | 2002-07-02 21:28:04 +0000 | [diff] [blame] | 307 | """renames(old, new) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 308 | |
| 309 | Super-rename; create directories as necessary and delete any left |
| 310 | empty. Works like rename, except creation of any intermediate |
| 311 | directories needed to make the new pathname good is attempted |
| 312 | first. After the rename, directories corresponding to rightmost |
| 313 | path segments of the old name will be pruned way until either the |
| 314 | whole path is consumed or a nonempty directory is found. |
| 315 | |
| 316 | Note: this function can fail with the new directory structure made |
| 317 | if you lack permissions needed to unlink the leaf directory or |
| 318 | file. |
| 319 | |
| 320 | """ |
| 321 | head, tail = path.split(new) |
| 322 | if head and tail and not path.exists(head): |
| 323 | makedirs(head) |
| 324 | rename(old, new) |
| 325 | head, tail = path.split(old) |
| 326 | if head and tail: |
| 327 | try: |
| 328 | removedirs(head) |
| 329 | except error: |
| 330 | pass |
| 331 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 332 | __all__.extend(["makedirs", "removedirs", "renames"]) |
| 333 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 334 | def walk(top, topdown=True, onerror=None, followlinks=False): |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 335 | """Directory tree generator. |
| 336 | |
| 337 | For each directory in the directory tree rooted at top (including top |
| 338 | itself, but excluding '.' and '..'), yields a 3-tuple |
| 339 | |
| 340 | dirpath, dirnames, filenames |
| 341 | |
| 342 | dirpath is a string, the path to the directory. dirnames is a list of |
| 343 | the names of the subdirectories in dirpath (excluding '.' and '..'). |
| 344 | filenames is a list of the names of the non-directory files in dirpath. |
| 345 | Note that the names in the lists are just names, with no path components. |
| 346 | To get a full path (which begins with top) to a file or directory in |
| 347 | dirpath, do os.path.join(dirpath, name). |
| 348 | |
| 349 | If optional arg 'topdown' is true or not specified, the triple for a |
| 350 | directory is generated before the triples for any of its subdirectories |
| 351 | (directories are generated top down). If topdown is false, the triple |
| 352 | for a directory is generated after the triples for all of its |
| 353 | subdirectories (directories are generated bottom up). |
| 354 | |
| 355 | When topdown is true, the caller can modify the dirnames list in-place |
| 356 | (e.g., via del or slice assignment), and walk will only recurse into the |
| 357 | subdirectories whose names remain in dirnames; this can be used to prune |
| 358 | the search, or to impose a specific order of visiting. Modifying |
| 359 | dirnames when topdown is false is ineffective, since the directories in |
| 360 | dirnames have already been generated by the time dirnames itself is |
| 361 | generated. |
| 362 | |
Guido van Rossum | bf1bef8 | 2003-05-13 18:01:19 +0000 | [diff] [blame] | 363 | By default errors from the os.listdir() call are ignored. If |
| 364 | optional arg 'onerror' is specified, it should be a function; it |
| 365 | will be called with one argument, an os.error instance. It can |
| 366 | report the error to continue with the walk, or raise the exception |
| 367 | to abort the walk. Note that the filename is available as the |
| 368 | filename attribute of the exception object. |
| 369 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 370 | By default, os.walk does not follow symbolic links to subdirectories on |
| 371 | systems that support them. In order to get this functionality, set the |
| 372 | optional argument 'followlinks' to true. |
| 373 | |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 374 | Caution: if you pass a relative pathname for top, don't change the |
| 375 | current working directory between resumptions of walk. walk never |
| 376 | changes the current directory, and assumes that the client doesn't |
| 377 | either. |
| 378 | |
| 379 | Example: |
| 380 | |
Christian Heimes | 5d8da20 | 2008-05-06 13:58:24 +0000 | [diff] [blame] | 381 | import os |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 382 | from os.path import join, getsize |
Christian Heimes | 5d8da20 | 2008-05-06 13:58:24 +0000 | [diff] [blame] | 383 | for root, dirs, files in os.walk('python/Lib/email'): |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 384 | print(root, "consumes", end="") |
| 385 | print(sum([getsize(join(root, name)) for name in files]), end="") |
| 386 | print("bytes in", len(files), "non-directory files") |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 387 | if 'CVS' in dirs: |
| 388 | dirs.remove('CVS') # don't visit CVS directories |
| 389 | """ |
| 390 | |
Benjamin Peterson | f6489f9 | 2009-11-25 17:46:26 +0000 | [diff] [blame] | 391 | islink, join, isdir = path.islink, path.join, path.isdir |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 392 | |
| 393 | # We may not have read permission for top, in which case we can't |
Alexandre Vassalotti | 4e6531e | 2008-05-09 20:00:17 +0000 | [diff] [blame] | 394 | # get a list of the files the directory contains. os.walk |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 395 | # always suppressed the exception then, rather than blow up for a |
| 396 | # minor reason when (say) a thousand readable directories are still |
| 397 | # left to visit. That logic is copied here. |
| 398 | try: |
| 399 | # Note that listdir and error are globals in this module due |
| 400 | # to earlier import-*. |
| 401 | names = listdir(top) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 402 | except error as err: |
Guido van Rossum | bf1bef8 | 2003-05-13 18:01:19 +0000 | [diff] [blame] | 403 | if onerror is not None: |
| 404 | onerror(err) |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 405 | return |
| 406 | |
| 407 | dirs, nondirs = [], [] |
| 408 | for name in names: |
| 409 | if isdir(join(top, name)): |
| 410 | dirs.append(name) |
| 411 | else: |
| 412 | nondirs.append(name) |
| 413 | |
| 414 | if topdown: |
| 415 | yield top, dirs, nondirs |
| 416 | for name in dirs: |
Benjamin Peterson | f6489f9 | 2009-11-25 17:46:26 +0000 | [diff] [blame] | 417 | new_path = join(top, name) |
| 418 | if followlinks or not islink(new_path): |
Benjamin Peterson | 569d087 | 2012-05-10 16:17:35 -0500 | [diff] [blame] | 419 | yield from walk(new_path, topdown, onerror, followlinks) |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 420 | if not topdown: |
| 421 | yield top, dirs, nondirs |
| 422 | |
| 423 | __all__.append("walk") |
| 424 | |
Larry Hastings | c48fe98 | 2012-06-25 04:49:05 -0700 | [diff] [blame] | 425 | if {open, stat} <= supports_dir_fd and {listdir, stat} <= supports_fd: |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 426 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 427 | def fwalk(top=".", topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None): |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 428 | """Directory tree generator. |
| 429 | |
| 430 | This behaves exactly like walk(), except that it yields a 4-tuple |
| 431 | |
| 432 | dirpath, dirnames, filenames, dirfd |
| 433 | |
| 434 | `dirpath`, `dirnames` and `filenames` are identical to walk() output, |
| 435 | and `dirfd` is a file descriptor referring to the directory `dirpath`. |
| 436 | |
Larry Hastings | c48fe98 | 2012-06-25 04:49:05 -0700 | [diff] [blame] | 437 | The advantage of fwalk() over walk() is that it's safe against symlink |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 438 | races (when follow_symlinks is False). |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 439 | |
Larry Hastings | c48fe98 | 2012-06-25 04:49:05 -0700 | [diff] [blame] | 440 | If dir_fd is not None, it should be a file descriptor open to a directory, |
| 441 | and top should be relative; top will then be relative to that directory. |
| 442 | (dir_fd is always supported for fwalk.) |
| 443 | |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 444 | Caution: |
| 445 | Since fwalk() yields file descriptors, those are only valid until the |
| 446 | next iteration step, so you should dup() them if you want to keep them |
| 447 | for a longer period. |
| 448 | |
| 449 | Example: |
| 450 | |
| 451 | import os |
| 452 | for root, dirs, files, rootfd in os.fwalk('python/Lib/email'): |
| 453 | print(root, "consumes", end="") |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 454 | print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]), |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 455 | end="") |
| 456 | print("bytes in", len(files), "non-directory files") |
| 457 | if 'CVS' in dirs: |
| 458 | dirs.remove('CVS') # don't visit CVS directories |
| 459 | """ |
| 460 | # Note: To guard against symlink races, we use the standard |
| 461 | # lstat()/open()/fstat() trick. |
Larry Hastings | c48fe98 | 2012-06-25 04:49:05 -0700 | [diff] [blame] | 462 | orig_st = stat(top, follow_symlinks=False, dir_fd=dir_fd) |
| 463 | topfd = open(top, O_RDONLY, dir_fd=dir_fd) |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 464 | try: |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 465 | if (follow_symlinks or (st.S_ISDIR(orig_st.st_mode) and |
| 466 | path.samestat(orig_st, stat(topfd)))): |
| 467 | yield from _fwalk(topfd, top, topdown, onerror, follow_symlinks) |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 468 | finally: |
| 469 | close(topfd) |
| 470 | |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 471 | def _fwalk(topfd, toppath, topdown, onerror, follow_symlinks): |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 472 | # Note: This uses O(depth of the directory tree) file descriptors: if |
| 473 | # necessary, it can be adapted to only require O(1) FDs, see issue |
| 474 | # #13734. |
| 475 | |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 476 | names = listdir(topfd) |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 477 | dirs, nondirs = [], [] |
| 478 | for name in names: |
Hynek Schlawack | 66bfcc1 | 2012-05-15 16:32:21 +0200 | [diff] [blame] | 479 | try: |
| 480 | # Here, we don't use AT_SYMLINK_NOFOLLOW to be consistent with |
| 481 | # walk() which reports symlinks to directories as directories. |
| 482 | # We do however check for symlinks before recursing into |
| 483 | # a subdirectory. |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 484 | if st.S_ISDIR(stat(name, dir_fd=topfd).st_mode): |
Hynek Schlawack | 66bfcc1 | 2012-05-15 16:32:21 +0200 | [diff] [blame] | 485 | dirs.append(name) |
| 486 | else: |
| 487 | nondirs.append(name) |
| 488 | except FileNotFoundError: |
| 489 | try: |
| 490 | # Add dangling symlinks, ignore disappeared files |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 491 | if st.S_ISLNK(stat(name, dir_fd=topfd, follow_symlinks=False) |
Hynek Schlawack | 66bfcc1 | 2012-05-15 16:32:21 +0200 | [diff] [blame] | 492 | .st_mode): |
| 493 | nondirs.append(name) |
| 494 | except FileNotFoundError: |
| 495 | continue |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 496 | |
| 497 | if topdown: |
| 498 | yield toppath, dirs, nondirs, topfd |
| 499 | |
| 500 | for name in dirs: |
| 501 | try: |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 502 | orig_st = stat(name, dir_fd=topfd, follow_symlinks=follow_symlinks) |
Larry Hastings | 9cf065c | 2012-06-22 16:30:09 -0700 | [diff] [blame] | 503 | dirfd = open(name, O_RDONLY, dir_fd=topfd) |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 504 | except error as err: |
| 505 | if onerror is not None: |
| 506 | onerror(err) |
| 507 | return |
| 508 | try: |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 509 | if follow_symlinks or path.samestat(orig_st, stat(dirfd)): |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 510 | dirpath = path.join(toppath, name) |
Larry Hastings | b403806 | 2012-07-15 10:57:38 -0700 | [diff] [blame] | 511 | yield from _fwalk(dirfd, dirpath, topdown, onerror, follow_symlinks) |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 512 | finally: |
| 513 | close(dirfd) |
| 514 | |
| 515 | if not topdown: |
| 516 | yield toppath, dirs, nondirs, topfd |
| 517 | |
| 518 | __all__.append("fwalk") |
| 519 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 520 | # Make sure os.environ exists, at least |
| 521 | try: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 522 | environ |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 523 | except NameError: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 524 | environ = {} |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 525 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 526 | def execl(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 527 | """execl(file, *args) |
| 528 | |
| 529 | Execute the executable file with argument list args, replacing the |
| 530 | current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 531 | execv(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 532 | |
| 533 | def execle(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 534 | """execle(file, *args, env) |
| 535 | |
| 536 | Execute the executable file with argument list args and |
| 537 | environment env, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 538 | env = args[-1] |
| 539 | execve(file, args[:-1], env) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 540 | |
| 541 | def execlp(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 542 | """execlp(file, *args) |
| 543 | |
| 544 | Execute the executable file (which is searched for along $PATH) |
| 545 | with argument list args, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 546 | execvp(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 547 | |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 548 | def execlpe(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 549 | """execlpe(file, *args, env) |
| 550 | |
| 551 | Execute the executable file (which is searched for along $PATH) |
| 552 | with argument list args and environment env, replacing the current |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 553 | process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 554 | env = args[-1] |
| 555 | execvpe(file, args[:-1], env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 556 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 557 | def execvp(file, args): |
Matthias Klose | a09c54f | 2010-01-31 16:48:44 +0000 | [diff] [blame] | 558 | """execvp(file, args) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 559 | |
| 560 | Execute the executable file (which is searched for along $PATH) |
| 561 | with argument list args, replacing the current process. |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 562 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 563 | _execvpe(file, args) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 564 | |
| 565 | def execvpe(file, args, env): |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 566 | """execvpe(file, args, env) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 567 | |
| 568 | Execute the executable file (which is searched for along $PATH) |
| 569 | with argument list args and environment env , replacing the |
| 570 | current process. |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 571 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 572 | _execvpe(file, args, env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 573 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 574 | __all__.extend(["execl","execle","execlp","execlpe","execvp","execvpe"]) |
| 575 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 576 | def _execvpe(file, args, env=None): |
| 577 | if env is not None: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 578 | exec_func = execve |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 579 | argrest = (args, env) |
| 580 | else: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 581 | exec_func = execv |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 582 | argrest = (args,) |
| 583 | env = environ |
Guido van Rossum | aed51d8 | 2002-08-05 16:13:24 +0000 | [diff] [blame] | 584 | |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 585 | head, tail = path.split(file) |
| 586 | if head: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 587 | exec_func(file, *argrest) |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 588 | return |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 589 | last_exc = saved_exc = None |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 590 | saved_tb = None |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 591 | path_list = get_exec_path(env) |
| 592 | if name != 'nt': |
| 593 | file = fsencode(file) |
| 594 | path_list = map(fsencode, path_list) |
| 595 | for dir in path_list: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 596 | fullname = path.join(dir, file) |
| 597 | try: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 598 | exec_func(fullname, *argrest) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 599 | except error as e: |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 600 | last_exc = e |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 601 | tb = sys.exc_info()[2] |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 602 | if (e.errno != errno.ENOENT and e.errno != errno.ENOTDIR |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 603 | and saved_exc is None): |
| 604 | saved_exc = e |
| 605 | saved_tb = tb |
| 606 | if saved_exc: |
Benjamin Peterson | 4b06819 | 2009-02-20 03:19:25 +0000 | [diff] [blame] | 607 | raise saved_exc.with_traceback(saved_tb) |
| 608 | raise last_exc.with_traceback(tb) |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 609 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 610 | |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 611 | def get_exec_path(env=None): |
| 612 | """Returns the sequence of directories that will be searched for the |
| 613 | named executable (similar to a shell) when launching a process. |
| 614 | |
| 615 | *env* must be an environment variable dict or None. If *env* is None, |
| 616 | os.environ will be used. |
| 617 | """ |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 618 | # Use a local import instead of a global import to limit the number of |
| 619 | # modules loaded at startup: the os module is always loaded at startup by |
| 620 | # Python. It may also avoid a bootstrap issue. |
Victor Stinner | 6f35eda | 2010-10-29 00:38:58 +0000 | [diff] [blame] | 621 | import warnings |
| 622 | |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 623 | if env is None: |
| 624 | env = environ |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 625 | |
Victor Stinner | bb4f218 | 2010-11-07 15:43:39 +0000 | [diff] [blame] | 626 | # {b'PATH': ...}.get('PATH') and {'PATH': ...}.get(b'PATH') emit a |
| 627 | # BytesWarning when using python -b or python -bb: ignore the warning |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 628 | with warnings.catch_warnings(): |
| 629 | warnings.simplefilter("ignore", BytesWarning) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 630 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 631 | try: |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 632 | path_list = env.get('PATH') |
| 633 | except TypeError: |
| 634 | path_list = None |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 635 | |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 636 | if supports_bytes_environ: |
| 637 | try: |
| 638 | path_listb = env[b'PATH'] |
| 639 | except (KeyError, TypeError): |
| 640 | pass |
| 641 | else: |
| 642 | if path_list is not None: |
| 643 | raise ValueError( |
| 644 | "env cannot contain 'PATH' and b'PATH' keys") |
| 645 | path_list = path_listb |
| 646 | |
| 647 | if path_list is not None and isinstance(path_list, bytes): |
| 648 | path_list = fsdecode(path_list) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 649 | |
| 650 | if path_list is None: |
| 651 | path_list = defpath |
| 652 | return path_list.split(pathsep) |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 653 | |
| 654 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 655 | # Change environ to automatically call putenv(), unsetenv if they exist. |
Raymond Hettinger | 158c9c2 | 2011-02-22 00:41:50 +0000 | [diff] [blame] | 656 | from collections.abc import MutableMapping |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 657 | |
| 658 | class _Environ(MutableMapping): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 659 | def __init__(self, data, encodekey, decodekey, encodevalue, decodevalue, putenv, unsetenv): |
| 660 | self.encodekey = encodekey |
| 661 | self.decodekey = decodekey |
| 662 | self.encodevalue = encodevalue |
| 663 | self.decodevalue = decodevalue |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 664 | self.putenv = putenv |
| 665 | self.unsetenv = unsetenv |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 666 | self._data = data |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 667 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 668 | def __getitem__(self, key): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 669 | value = self._data[self.encodekey(key)] |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 670 | return self.decodevalue(value) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 671 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 672 | def __setitem__(self, key, value): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 673 | key = self.encodekey(key) |
| 674 | value = self.encodevalue(value) |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 675 | self.putenv(key, value) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 676 | self._data[key] = value |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 677 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 678 | def __delitem__(self, key): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 679 | key = self.encodekey(key) |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 680 | self.unsetenv(key) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 681 | del self._data[key] |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 682 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 683 | def __iter__(self): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 684 | for key in self._data: |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 685 | yield self.decodekey(key) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 686 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 687 | def __len__(self): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 688 | return len(self._data) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 689 | |
| 690 | def __repr__(self): |
Victor Stinner | bed7117 | 2010-07-28 21:25:42 +0000 | [diff] [blame] | 691 | return 'environ({{{}}})'.format(', '.join( |
Victor Stinner | d73c1a3 | 2010-07-28 21:23:23 +0000 | [diff] [blame] | 692 | ('{!r}: {!r}'.format(self.decodekey(key), self.decodevalue(value)) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 693 | for key, value in self._data.items()))) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 694 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 695 | def copy(self): |
| 696 | return dict(self) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 697 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 698 | def setdefault(self, key, value): |
| 699 | if key not in self: |
| 700 | self[key] = value |
| 701 | return self[key] |
| 702 | |
| 703 | try: |
| 704 | _putenv = putenv |
| 705 | except NameError: |
| 706 | _putenv = lambda key, value: None |
Martin v. Löwis | a90f438 | 2001-03-07 09:05:45 +0000 | [diff] [blame] | 707 | else: |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 708 | __all__.append("putenv") |
Guido van Rossum | 3b8e20d | 1996-07-24 00:55:17 +0000 | [diff] [blame] | 709 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 710 | try: |
| 711 | _unsetenv = unsetenv |
| 712 | except NameError: |
| 713 | _unsetenv = lambda key: _putenv(key, "") |
| 714 | else: |
| 715 | __all__.append("unsetenv") |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 716 | |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 717 | def _createenviron(): |
| 718 | if name in ('os2', 'nt'): |
| 719 | # Where Env Var Names Must Be UPPERCASE |
| 720 | def check_str(value): |
| 721 | if not isinstance(value, str): |
| 722 | raise TypeError("str expected, not %s" % type(value).__name__) |
| 723 | return value |
| 724 | encode = check_str |
| 725 | decode = str |
| 726 | def encodekey(key): |
| 727 | return encode(key).upper() |
| 728 | data = {} |
| 729 | for key, value in environ.items(): |
| 730 | data[encodekey(key)] = value |
| 731 | else: |
| 732 | # Where Env Var Names Can Be Mixed Case |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 733 | encoding = sys.getfilesystemencoding() |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 734 | def encode(value): |
| 735 | if not isinstance(value, str): |
| 736 | raise TypeError("str expected, not %s" % type(value).__name__) |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 737 | return value.encode(encoding, 'surrogateescape') |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 738 | def decode(value): |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 739 | return value.decode(encoding, 'surrogateescape') |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 740 | encodekey = encode |
| 741 | data = environ |
| 742 | return _Environ(data, |
| 743 | encodekey, decode, |
| 744 | encode, decode, |
| 745 | _putenv, _unsetenv) |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 746 | |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 747 | # unicode environ |
| 748 | environ = _createenviron() |
| 749 | del _createenviron |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 750 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 751 | |
Jack Jansen | b11ce9b | 2003-01-08 16:33:40 +0000 | [diff] [blame] | 752 | def getenv(key, default=None): |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 753 | """Get an environment variable, return None if it doesn't exist. |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 754 | The optional second argument can specify an alternate default. |
| 755 | key, default and the result are str.""" |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 756 | return environ.get(key, default) |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 757 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 758 | supports_bytes_environ = name not in ('os2', 'nt') |
| 759 | __all__.extend(("getenv", "supports_bytes_environ")) |
| 760 | |
| 761 | if supports_bytes_environ: |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 762 | def _check_bytes(value): |
| 763 | if not isinstance(value, bytes): |
| 764 | raise TypeError("bytes expected, not %s" % type(value).__name__) |
| 765 | return value |
| 766 | |
| 767 | # bytes environ |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 768 | environb = _Environ(environ._data, |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 769 | _check_bytes, bytes, |
| 770 | _check_bytes, bytes, |
| 771 | _putenv, _unsetenv) |
| 772 | del _check_bytes |
| 773 | |
| 774 | def getenvb(key, default=None): |
| 775 | """Get an environment variable, return None if it doesn't exist. |
| 776 | The optional second argument can specify an alternate default. |
| 777 | key, default and the result are bytes.""" |
| 778 | return environb.get(key, default) |
Victor Stinner | 70120e2 | 2010-07-29 17:19:38 +0000 | [diff] [blame] | 779 | |
| 780 | __all__.extend(("environb", "getenvb")) |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 781 | |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 782 | def _fscodec(): |
| 783 | encoding = sys.getfilesystemencoding() |
| 784 | if encoding == 'mbcs': |
Victor Stinner | e882aac | 2010-10-24 21:12:26 +0000 | [diff] [blame] | 785 | errors = 'strict' |
Victor Stinner | 313a120 | 2010-06-11 23:56:51 +0000 | [diff] [blame] | 786 | else: |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 787 | errors = 'surrogateescape' |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 788 | |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 789 | def fsencode(filename): |
| 790 | """ |
| 791 | Encode filename to the filesystem encoding with 'surrogateescape' error |
| 792 | handler, return bytes unchanged. On Windows, use 'strict' error handler if |
| 793 | the file system encoding is 'mbcs' (which is the default encoding). |
| 794 | """ |
| 795 | if isinstance(filename, bytes): |
| 796 | return filename |
| 797 | elif isinstance(filename, str): |
| 798 | return filename.encode(encoding, errors) |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 799 | else: |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 800 | raise TypeError("expect bytes or str, not %s" % type(filename).__name__) |
| 801 | |
| 802 | def fsdecode(filename): |
| 803 | """ |
| 804 | Decode filename from the filesystem encoding with 'surrogateescape' error |
| 805 | handler, return str unchanged. On Windows, use 'strict' error handler if |
| 806 | the file system encoding is 'mbcs' (which is the default encoding). |
| 807 | """ |
| 808 | if isinstance(filename, str): |
| 809 | return filename |
| 810 | elif isinstance(filename, bytes): |
| 811 | return filename.decode(encoding, errors) |
| 812 | else: |
| 813 | raise TypeError("expect bytes or str, not %s" % type(filename).__name__) |
| 814 | |
| 815 | return fsencode, fsdecode |
| 816 | |
| 817 | fsencode, fsdecode = _fscodec() |
| 818 | del _fscodec |
Victor Stinner | 449c466 | 2010-05-08 11:10:09 +0000 | [diff] [blame] | 819 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 820 | # Supply spawn*() (probably only for Unix) |
| 821 | if _exists("fork") and not _exists("spawnv") and _exists("execv"): |
| 822 | |
| 823 | P_WAIT = 0 |
| 824 | P_NOWAIT = P_NOWAITO = 1 |
| 825 | |
Petri Lehtinen | 3bc37f2 | 2012-05-23 21:36:16 +0300 | [diff] [blame] | 826 | __all__.extend(["P_WAIT", "P_NOWAIT", "P_NOWAITO"]) |
| 827 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 828 | # XXX Should we support P_DETACH? I suppose it could fork()**2 |
| 829 | # and close the std I/O streams. Also, P_OVERLAY is the same |
| 830 | # as execv*()? |
| 831 | |
| 832 | def _spawnvef(mode, file, args, env, func): |
| 833 | # Internal helper; func is the exec*() function to use |
| 834 | pid = fork() |
| 835 | if not pid: |
| 836 | # Child |
| 837 | try: |
| 838 | if env is None: |
| 839 | func(file, args) |
| 840 | else: |
| 841 | func(file, args, env) |
| 842 | except: |
| 843 | _exit(127) |
| 844 | else: |
| 845 | # Parent |
| 846 | if mode == P_NOWAIT: |
| 847 | return pid # Caller is responsible for waiting! |
| 848 | while 1: |
| 849 | wpid, sts = waitpid(pid, 0) |
| 850 | if WIFSTOPPED(sts): |
| 851 | continue |
| 852 | elif WIFSIGNALED(sts): |
| 853 | return -WTERMSIG(sts) |
| 854 | elif WIFEXITED(sts): |
| 855 | return WEXITSTATUS(sts) |
| 856 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 857 | raise error("Not stopped, signaled or exited???") |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 858 | |
| 859 | def spawnv(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 860 | """spawnv(mode, file, args) -> integer |
| 861 | |
| 862 | Execute file with arguments from args in a subprocess. |
| 863 | If mode == P_NOWAIT return the pid of the process. |
| 864 | 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] | 865 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 866 | return _spawnvef(mode, file, args, None, execv) |
| 867 | |
| 868 | def spawnve(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 869 | """spawnve(mode, file, args, env) -> integer |
| 870 | |
| 871 | Execute file with arguments from args in a subprocess with the |
| 872 | specified environment. |
| 873 | If mode == P_NOWAIT return the pid of the process. |
| 874 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 875 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 876 | return _spawnvef(mode, file, args, env, execve) |
| 877 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 878 | # Note: spawnvp[e] is't currently supported on Windows |
| 879 | |
| 880 | def spawnvp(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 881 | """spawnvp(mode, file, args) -> integer |
| 882 | |
| 883 | Execute file (which is looked for along $PATH) with arguments from |
| 884 | args in a subprocess. |
| 885 | If mode == P_NOWAIT return the pid of the process. |
| 886 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 887 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 888 | return _spawnvef(mode, file, args, None, execvp) |
| 889 | |
| 890 | def spawnvpe(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 891 | """spawnvpe(mode, file, args, env) -> integer |
| 892 | |
| 893 | Execute file (which is looked for along $PATH) with arguments from |
| 894 | args in a subprocess with the supplied environment. |
| 895 | If mode == P_NOWAIT return the pid of the process. |
| 896 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 897 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 898 | return _spawnvef(mode, file, args, env, execvpe) |
| 899 | |
| 900 | if _exists("spawnv"): |
| 901 | # These aren't supplied by the basic Windows code |
| 902 | # but can be easily implemented in Python |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 903 | |
| 904 | def spawnl(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 905 | """spawnl(mode, file, *args) -> integer |
| 906 | |
| 907 | Execute file with arguments from args in a subprocess. |
| 908 | If mode == P_NOWAIT return the pid of the process. |
| 909 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 910 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 911 | return spawnv(mode, file, args) |
| 912 | |
| 913 | def spawnle(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 914 | """spawnle(mode, file, *args, env) -> integer |
| 915 | |
| 916 | Execute file with arguments from args in a subprocess with the |
| 917 | supplied environment. |
| 918 | If mode == P_NOWAIT return the pid of the process. |
| 919 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 920 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 921 | env = args[-1] |
| 922 | return spawnve(mode, file, args[:-1], env) |
| 923 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 924 | |
| 925 | __all__.extend(["spawnv", "spawnve", "spawnl", "spawnle",]) |
| 926 | |
| 927 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 928 | if _exists("spawnvp"): |
| 929 | # At the moment, Windows doesn't implement spawnvp[e], |
| 930 | # so it won't have spawnlp[e] either. |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 931 | def spawnlp(mode, file, *args): |
Neal Norwitz | b7f6810 | 2003-07-02 02:49:33 +0000 | [diff] [blame] | 932 | """spawnlp(mode, file, *args) -> integer |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 933 | |
| 934 | Execute file (which is looked for along $PATH) with arguments from |
| 935 | args in a subprocess with the supplied environment. |
| 936 | If mode == P_NOWAIT return the pid of the process. |
| 937 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 938 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 939 | return spawnvp(mode, file, args) |
| 940 | |
| 941 | def spawnlpe(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 942 | """spawnlpe(mode, file, *args, env) -> integer |
| 943 | |
| 944 | Execute file (which is looked for along $PATH) with arguments from |
| 945 | args in a subprocess with the supplied environment. |
| 946 | If mode == P_NOWAIT return the pid of the process. |
| 947 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 948 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 949 | env = args[-1] |
| 950 | return spawnvpe(mode, file, args[:-1], env) |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 951 | |
| 952 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 953 | __all__.extend(["spawnvp", "spawnvpe", "spawnlp", "spawnlpe",]) |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 954 | |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 955 | import copyreg as _copyreg |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 956 | |
| 957 | def _make_stat_result(tup, dict): |
| 958 | return stat_result(tup, dict) |
| 959 | |
| 960 | def _pickle_stat_result(sr): |
| 961 | (type, args) = sr.__reduce__() |
| 962 | return (_make_stat_result, args) |
| 963 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 964 | try: |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 965 | _copyreg.pickle(stat_result, _pickle_stat_result, _make_stat_result) |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 966 | except NameError: # stat_result may not exist |
| 967 | pass |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 968 | |
| 969 | def _make_statvfs_result(tup, dict): |
| 970 | return statvfs_result(tup, dict) |
| 971 | |
| 972 | def _pickle_statvfs_result(sr): |
| 973 | (type, args) = sr.__reduce__() |
| 974 | return (_make_statvfs_result, args) |
| 975 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 976 | try: |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 977 | _copyreg.pickle(statvfs_result, _pickle_statvfs_result, |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 978 | _make_statvfs_result) |
Michael W. Hudson | e5363b7 | 2002-03-15 10:21:59 +0000 | [diff] [blame] | 979 | except NameError: # statvfs_result may not exist |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 980 | pass |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 981 | |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 982 | # Supply os.popen() |
Antoine Pitrou | 877766d | 2011-03-19 17:00:37 +0100 | [diff] [blame] | 983 | def popen(cmd, mode="r", buffering=-1): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 984 | if not isinstance(cmd, str): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 985 | raise TypeError("invalid cmd type (%s, expected string)" % type(cmd)) |
| 986 | if mode not in ("r", "w"): |
| 987 | raise ValueError("invalid mode %r" % mode) |
Benjamin Peterson | b29614e | 2012-10-09 11:16:03 -0400 | [diff] [blame] | 988 | if buffering == 0 or buffering is None: |
Antoine Pitrou | 877766d | 2011-03-19 17:00:37 +0100 | [diff] [blame] | 989 | raise ValueError("popen() does not support unbuffered streams") |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 990 | import subprocess, io |
| 991 | if mode == "r": |
| 992 | proc = subprocess.Popen(cmd, |
| 993 | shell=True, |
| 994 | stdout=subprocess.PIPE, |
| 995 | bufsize=buffering) |
| 996 | return _wrap_close(io.TextIOWrapper(proc.stdout), proc) |
| 997 | else: |
| 998 | proc = subprocess.Popen(cmd, |
| 999 | shell=True, |
| 1000 | stdin=subprocess.PIPE, |
| 1001 | bufsize=buffering) |
| 1002 | return _wrap_close(io.TextIOWrapper(proc.stdin), proc) |
| 1003 | |
| 1004 | # Helper for popen() -- a proxy for a file whose close waits for the process |
| 1005 | class _wrap_close: |
| 1006 | def __init__(self, stream, proc): |
| 1007 | self._stream = stream |
| 1008 | self._proc = proc |
| 1009 | def close(self): |
| 1010 | self._stream.close() |
Amaury Forgeot d'Arc | 97e5f28 | 2009-07-11 09:35:13 +0000 | [diff] [blame] | 1011 | returncode = self._proc.wait() |
| 1012 | if returncode == 0: |
| 1013 | return None |
| 1014 | if name == 'nt': |
| 1015 | return returncode |
| 1016 | else: |
| 1017 | return returncode << 8 # Shift left to match old behavior |
Antoine Pitrou | ac62535 | 2009-12-09 00:01:27 +0000 | [diff] [blame] | 1018 | def __enter__(self): |
| 1019 | return self |
| 1020 | def __exit__(self, *args): |
| 1021 | self.close() |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 1022 | def __getattr__(self, name): |
| 1023 | return getattr(self._stream, name) |
Thomas Heller | 476157b | 2007-09-04 11:27:47 +0000 | [diff] [blame] | 1024 | def __iter__(self): |
| 1025 | return iter(self._stream) |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 1026 | |
Amaury Forgeot d'Arc | bdbddf8 | 2008-08-01 00:06:49 +0000 | [diff] [blame] | 1027 | # Supply os.fdopen() |
| 1028 | def fdopen(fd, *args, **kwargs): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 1029 | if not isinstance(fd, int): |
| 1030 | raise TypeError("invalid fd type (%s, expected integer)" % type(fd)) |
| 1031 | import io |
Amaury Forgeot d'Arc | bdbddf8 | 2008-08-01 00:06:49 +0000 | [diff] [blame] | 1032 | return io.open(fd, *args, **kwargs) |