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