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: |
Martin v. Löwis | 8b10f89 | 2002-10-09 17:23:29 +0000 | [diff] [blame] | 4 | - all functions from posix, nt, os2, mac, or ce, e.g. unlink, stat, etc. |
| 5 | - os.path is one of the modules posixpath, ntpath, or macpath |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 6 | - os.name is 'posix', 'nt', 'os2', 'mac' 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 '\\') |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 10 | - os.altsep is the alternate pathname separator (None or '/') |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 11 | - os.pathsep is the component separator used in $PATH etc |
Guido van Rossum | 4b8c6ea | 2000-02-04 15:39:30 +0000 | [diff] [blame] | 12 | - 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] | 13 | - os.defpath is the default search path for executables |
Martin v. Löwis | bdec50f | 2004-06-08 08:29:33 +0000 | [diff] [blame] | 14 | - 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] | 15 | |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 16 | Programs that import and use 'os' stand a better chance of being |
| 17 | portable between different platforms. Of course, they must then |
| 18 | only use functions that are defined by all platforms (e.g., unlink |
| 19 | and opendir), and leave all pathname manipulation to os.path |
| 20 | (e.g., split and join). |
| 21 | """ |
Guido van Rossum | 31104f4 | 1992-01-14 18:28:36 +0000 | [diff] [blame] | 22 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 23 | #' |
| 24 | |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 25 | import sys, errno |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 26 | |
| 27 | _names = sys.builtin_module_names |
| 28 | |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 29 | # Note: more names are added to __all__ later. |
Skip Montanaro | 6c0a0e1 | 2001-02-28 01:00:58 +0000 | [diff] [blame] | 30 | __all__ = ["altsep", "curdir", "pardir", "sep", "pathsep", "linesep", |
Martin v. Löwis | 22b457e | 2005-01-16 08:40:58 +0000 | [diff] [blame] | 31 | "defpath", "name", "path", "devnull", |
| 32 | "SEEK_SET", "SEEK_CUR", "SEEK_END"] |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 33 | |
| 34 | def _get_exports_list(module): |
| 35 | try: |
| 36 | return list(module.__all__) |
| 37 | except AttributeError: |
| 38 | return [n for n in dir(module) if n[0] != '_'] |
| 39 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 40 | if 'posix' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 41 | name = 'posix' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 42 | linesep = '\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 43 | from posix import * |
| 44 | try: |
| 45 | from posix import _exit |
| 46 | except ImportError: |
| 47 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 48 | import posixpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 49 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 50 | import posix |
| 51 | __all__.extend(_get_exports_list(posix)) |
| 52 | del posix |
| 53 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 54 | elif 'nt' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 55 | name = 'nt' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 56 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 57 | from nt import * |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 58 | try: |
| 59 | from nt import _exit |
| 60 | except ImportError: |
| 61 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 62 | import ntpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 63 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 64 | import nt |
| 65 | __all__.extend(_get_exports_list(nt)) |
| 66 | del nt |
| 67 | |
Guido van Rossum | 8e9ebfd | 1997-11-22 21:53:48 +0000 | [diff] [blame] | 68 | elif 'os2' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 69 | name = 'os2' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 70 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 71 | from os2 import * |
| 72 | try: |
| 73 | from os2 import _exit |
| 74 | except ImportError: |
| 75 | pass |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 76 | if sys.version.find('EMX GCC') == -1: |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 77 | import ntpath as path |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 78 | else: |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 79 | import os2emxpath as path |
Andrew MacIntyre | 89f9865 | 2003-12-02 12:33:01 +0000 | [diff] [blame] | 80 | from _emx_link import link |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 81 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 82 | import os2 |
| 83 | __all__.extend(_get_exports_list(os2)) |
| 84 | del os2 |
| 85 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 86 | elif 'mac' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 87 | name = 'mac' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 88 | linesep = '\r' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 89 | from mac import * |
| 90 | try: |
| 91 | from mac import _exit |
| 92 | except ImportError: |
| 93 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 94 | import macpath 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 mac |
| 97 | __all__.extend(_get_exports_list(mac)) |
| 98 | del mac |
| 99 | |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 100 | elif 'ce' in _names: |
| 101 | name = 'ce' |
| 102 | linesep = '\r\n' |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 103 | from ce import * |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 104 | try: |
| 105 | from ce import _exit |
| 106 | except ImportError: |
| 107 | pass |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 108 | # We can use the standard Windows path. |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 109 | import ntpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 110 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 111 | import ce |
| 112 | __all__.extend(_get_exports_list(ce)) |
| 113 | del ce |
| 114 | |
Guido van Rossum | 2979b01 | 1994-08-01 11:18:30 +0000 | [diff] [blame] | 115 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 116 | raise ImportError('no os specific module found') |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 117 | |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 118 | sys.modules['os.path'] = path |
Skip Montanaro | 7a98be2 | 2007-08-16 14:35:24 +0000 | [diff] [blame] | 119 | from os.path import curdir, pardir, sep, pathsep, defpath, altsep, devnull |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 120 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 121 | del _names |
| 122 | |
Martin v. Löwis | 22b457e | 2005-01-16 08:40:58 +0000 | [diff] [blame] | 123 | # Python uses fixed values for the SEEK_ constants; they are mapped |
| 124 | # to native constants if necessary in posixmodule.c |
| 125 | SEEK_SET = 0 |
| 126 | SEEK_CUR = 1 |
| 127 | SEEK_END = 2 |
| 128 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 129 | #' |
| 130 | |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 131 | # Super directory utilities. |
| 132 | # (Inspired by Eric Raymond; the doc strings are mostly his) |
| 133 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 134 | def makedirs(name, mode=0o777): |
| 135 | """makedirs(path [, mode=0o777]) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 136 | |
| 137 | Super-mkdir; create a leaf directory and all intermediate ones. |
| 138 | Works like mkdir, except that any intermediate path segment (not |
| 139 | just the rightmost) will be created if it does not exist. This is |
| 140 | recursive. |
| 141 | |
| 142 | """ |
| 143 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 144 | if not tail: |
| 145 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 146 | if head and tail and not path.exists(head): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 147 | try: |
| 148 | makedirs(head, mode) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 149 | except OSError as e: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 150 | # be happy if someone already created the path |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 151 | if e.errno != errno.EEXIST: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 152 | raise |
Andrew M. Kuchling | 6fccc8a | 2003-12-23 16:33:28 +0000 | [diff] [blame] | 153 | if tail == curdir: # xxx/newdir/. exists if xxx/newdir exists |
| 154 | return |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 155 | mkdir(name, mode) |
| 156 | |
| 157 | def removedirs(name): |
Fred Drake | cadb9eb | 2002-07-02 21:28:04 +0000 | [diff] [blame] | 158 | """removedirs(path) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 159 | |
Fredrik Lundh | 96c1c7a | 2005-11-12 15:55:04 +0000 | [diff] [blame] | 160 | Super-rmdir; remove a leaf directory and all empty intermediate |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 161 | ones. Works like rmdir except that, if the leaf directory is |
| 162 | successfully removed, directories corresponding to rightmost path |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 163 | segments will be pruned away until either the whole path is |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 164 | consumed or an error occurs. Errors during this latter phase are |
| 165 | ignored -- they generally mean that a directory was not empty. |
| 166 | |
| 167 | """ |
| 168 | rmdir(name) |
| 169 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 170 | if not tail: |
| 171 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 172 | while head and tail: |
| 173 | try: |
| 174 | rmdir(head) |
| 175 | except error: |
| 176 | break |
| 177 | head, tail = path.split(head) |
| 178 | |
| 179 | def renames(old, new): |
Fred Drake | cadb9eb | 2002-07-02 21:28:04 +0000 | [diff] [blame] | 180 | """renames(old, new) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 181 | |
| 182 | Super-rename; create directories as necessary and delete any left |
| 183 | empty. Works like rename, except creation of any intermediate |
| 184 | directories needed to make the new pathname good is attempted |
| 185 | first. After the rename, directories corresponding to rightmost |
| 186 | path segments of the old name will be pruned way until either the |
| 187 | whole path is consumed or a nonempty directory is found. |
| 188 | |
| 189 | Note: this function can fail with the new directory structure made |
| 190 | if you lack permissions needed to unlink the leaf directory or |
| 191 | file. |
| 192 | |
| 193 | """ |
| 194 | head, tail = path.split(new) |
| 195 | if head and tail and not path.exists(head): |
| 196 | makedirs(head) |
| 197 | rename(old, new) |
| 198 | head, tail = path.split(old) |
| 199 | if head and tail: |
| 200 | try: |
| 201 | removedirs(head) |
| 202 | except error: |
| 203 | pass |
| 204 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 205 | __all__.extend(["makedirs", "removedirs", "renames"]) |
| 206 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 207 | def walk(top, topdown=True, onerror=None, followlinks=False): |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 208 | """Directory tree generator. |
| 209 | |
| 210 | For each directory in the directory tree rooted at top (including top |
| 211 | itself, but excluding '.' and '..'), yields a 3-tuple |
| 212 | |
| 213 | dirpath, dirnames, filenames |
| 214 | |
| 215 | dirpath is a string, the path to the directory. dirnames is a list of |
| 216 | the names of the subdirectories in dirpath (excluding '.' and '..'). |
| 217 | filenames is a list of the names of the non-directory files in dirpath. |
| 218 | Note that the names in the lists are just names, with no path components. |
| 219 | To get a full path (which begins with top) to a file or directory in |
| 220 | dirpath, do os.path.join(dirpath, name). |
| 221 | |
| 222 | If optional arg 'topdown' is true or not specified, the triple for a |
| 223 | directory is generated before the triples for any of its subdirectories |
| 224 | (directories are generated top down). If topdown is false, the triple |
| 225 | for a directory is generated after the triples for all of its |
| 226 | subdirectories (directories are generated bottom up). |
| 227 | |
| 228 | When topdown is true, the caller can modify the dirnames list in-place |
| 229 | (e.g., via del or slice assignment), and walk will only recurse into the |
| 230 | subdirectories whose names remain in dirnames; this can be used to prune |
| 231 | the search, or to impose a specific order of visiting. Modifying |
| 232 | dirnames when topdown is false is ineffective, since the directories in |
| 233 | dirnames have already been generated by the time dirnames itself is |
| 234 | generated. |
| 235 | |
Guido van Rossum | bf1bef8 | 2003-05-13 18:01:19 +0000 | [diff] [blame] | 236 | By default errors from the os.listdir() call are ignored. If |
| 237 | optional arg 'onerror' is specified, it should be a function; it |
| 238 | will be called with one argument, an os.error instance. It can |
| 239 | report the error to continue with the walk, or raise the exception |
| 240 | to abort the walk. Note that the filename is available as the |
| 241 | filename attribute of the exception object. |
| 242 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 243 | By default, os.walk does not follow symbolic links to subdirectories on |
| 244 | systems that support them. In order to get this functionality, set the |
| 245 | optional argument 'followlinks' to true. |
| 246 | |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 247 | Caution: if you pass a relative pathname for top, don't change the |
| 248 | current working directory between resumptions of walk. walk never |
| 249 | changes the current directory, and assumes that the client doesn't |
| 250 | either. |
| 251 | |
| 252 | Example: |
| 253 | |
| 254 | from os.path import join, getsize |
| 255 | for root, dirs, files in walk('python/Lib/email'): |
| 256 | print root, "consumes", |
| 257 | print sum([getsize(join(root, name)) for name in files]), |
| 258 | print "bytes in", len(files), "non-directory files" |
| 259 | if 'CVS' in dirs: |
| 260 | dirs.remove('CVS') # don't visit CVS directories |
| 261 | """ |
| 262 | |
| 263 | from os.path import join, isdir, islink |
| 264 | |
| 265 | # We may not have read permission for top, in which case we can't |
| 266 | # get a list of the files the directory contains. os.path.walk |
| 267 | # always suppressed the exception then, rather than blow up for a |
| 268 | # minor reason when (say) a thousand readable directories are still |
| 269 | # left to visit. That logic is copied here. |
| 270 | try: |
| 271 | # Note that listdir and error are globals in this module due |
| 272 | # to earlier import-*. |
| 273 | names = listdir(top) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 274 | except error as err: |
Guido van Rossum | bf1bef8 | 2003-05-13 18:01:19 +0000 | [diff] [blame] | 275 | if onerror is not None: |
| 276 | onerror(err) |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 277 | return |
| 278 | |
| 279 | dirs, nondirs = [], [] |
| 280 | for name in names: |
| 281 | if isdir(join(top, name)): |
| 282 | dirs.append(name) |
| 283 | else: |
| 284 | nondirs.append(name) |
| 285 | |
| 286 | if topdown: |
| 287 | yield top, dirs, nondirs |
| 288 | for name in dirs: |
| 289 | path = join(top, name) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 290 | if followlinks or not islink(path): |
| 291 | for x in walk(path, topdown, onerror, followlinks): |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 292 | yield x |
| 293 | if not topdown: |
| 294 | yield top, dirs, nondirs |
| 295 | |
| 296 | __all__.append("walk") |
| 297 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 298 | # Make sure os.environ exists, at least |
| 299 | try: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 300 | environ |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 301 | except NameError: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 302 | environ = {} |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 303 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 304 | def execl(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 305 | """execl(file, *args) |
| 306 | |
| 307 | Execute the executable file with argument list args, replacing the |
| 308 | current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 309 | execv(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 310 | |
| 311 | def execle(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 312 | """execle(file, *args, env) |
| 313 | |
| 314 | Execute the executable file with argument list args and |
| 315 | environment env, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 316 | env = args[-1] |
| 317 | execve(file, args[:-1], env) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 318 | |
| 319 | def execlp(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 320 | """execlp(file, *args) |
| 321 | |
| 322 | Execute the executable file (which is searched for along $PATH) |
| 323 | with argument list args, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 324 | execvp(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 325 | |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 326 | def execlpe(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 327 | """execlpe(file, *args, env) |
| 328 | |
| 329 | Execute the executable file (which is searched for along $PATH) |
| 330 | with argument list args and environment env, replacing the current |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 331 | process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 332 | env = args[-1] |
| 333 | execvpe(file, args[:-1], env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 334 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 335 | def execvp(file, args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 336 | """execp(file, args) |
| 337 | |
| 338 | Execute the executable file (which is searched for along $PATH) |
| 339 | with argument list args, replacing the current process. |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 340 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 341 | _execvpe(file, args) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 342 | |
| 343 | def execvpe(file, args, env): |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 344 | """execvpe(file, args, env) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 345 | |
| 346 | Execute the executable file (which is searched for along $PATH) |
| 347 | with argument list args and environment env , replacing the |
| 348 | current process. |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 349 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 350 | _execvpe(file, args, env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 351 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 352 | __all__.extend(["execl","execle","execlp","execlpe","execvp","execvpe"]) |
| 353 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 354 | def _execvpe(file, args, env=None): |
| 355 | if env is not None: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 356 | func = execve |
| 357 | argrest = (args, env) |
| 358 | else: |
| 359 | func = execv |
| 360 | argrest = (args,) |
| 361 | env = environ |
Guido van Rossum | aed51d8 | 2002-08-05 16:13:24 +0000 | [diff] [blame] | 362 | |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 363 | head, tail = path.split(file) |
| 364 | if head: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 365 | func(file, *argrest) |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 366 | return |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 367 | if 'PATH' in env: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 368 | envpath = env['PATH'] |
| 369 | else: |
| 370 | envpath = defpath |
Guido van Rossum | 965fdae | 2000-04-04 19:50:04 +0000 | [diff] [blame] | 371 | PATH = envpath.split(pathsep) |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 372 | last_exc = saved_exc = None |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 373 | saved_tb = None |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 374 | for dir in PATH: |
| 375 | fullname = path.join(dir, file) |
| 376 | try: |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 377 | func(fullname, *argrest) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 378 | except error as e: |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 379 | last_exc = e |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 380 | tb = sys.exc_info()[2] |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 381 | if (e.errno != errno.ENOENT and e.errno != errno.ENOTDIR |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 382 | and saved_exc is None): |
| 383 | saved_exc = e |
| 384 | saved_tb = tb |
| 385 | if saved_exc: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 386 | raise error(saved_exc).with_traceback(saved_tb) |
| 387 | raise error(last_exc).with_traceback(tb) |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 388 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 389 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 390 | # Change environ to automatically call putenv(), unsetenv if they exist. |
| 391 | from _abcoll import MutableMapping # Can't use collections (bootstrap) |
| 392 | |
| 393 | class _Environ(MutableMapping): |
| 394 | def __init__(self, environ, keymap, putenv, unsetenv): |
| 395 | self.keymap = keymap |
| 396 | self.putenv = putenv |
| 397 | self.unsetenv = unsetenv |
| 398 | self.data = data = {} |
| 399 | for key, value in environ.items(): |
| 400 | data[keymap(key)] = str(value) |
| 401 | def __getitem__(self, key): |
| 402 | return self.data[self.keymap(key)] |
| 403 | def __setitem__(self, key, value): |
| 404 | value = str(value) |
| 405 | self.putenv(key, value) |
| 406 | self.data[self.keymap(key)] = value |
| 407 | def __delitem__(self, key): |
| 408 | self.unsetenv(key) |
| 409 | del self.data[self.keymap(key)] |
| 410 | def __iter__(self): |
| 411 | for key in self.data: |
| 412 | yield key |
| 413 | def __len__(self): |
| 414 | return len(self.data) |
| 415 | def copy(self): |
| 416 | return dict(self) |
| 417 | def setdefault(self, key, value): |
| 418 | if key not in self: |
| 419 | self[key] = value |
| 420 | return self[key] |
| 421 | |
| 422 | try: |
| 423 | _putenv = putenv |
| 424 | except NameError: |
| 425 | _putenv = lambda key, value: None |
Martin v. Löwis | a90f438 | 2001-03-07 09:05:45 +0000 | [diff] [blame] | 426 | else: |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 427 | __all__.append("putenv") |
Guido van Rossum | 3b8e20d | 1996-07-24 00:55:17 +0000 | [diff] [blame] | 428 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 429 | try: |
| 430 | _unsetenv = unsetenv |
| 431 | except NameError: |
| 432 | _unsetenv = lambda key: _putenv(key, "") |
| 433 | else: |
| 434 | __all__.append("unsetenv") |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 435 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 436 | if name in ('os2', 'nt'): # Where Env Var Names Must Be UPPERCASE |
| 437 | _keymap = lambda key: str(key.upper()) |
| 438 | else: # Where Env Var Names Can Be Mixed Case |
| 439 | _keymap = lambda key: str(key) |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 440 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 441 | environ = _Environ(environ, _keymap, _putenv, _unsetenv) |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 442 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 443 | |
Jack Jansen | b11ce9b | 2003-01-08 16:33:40 +0000 | [diff] [blame] | 444 | def getenv(key, default=None): |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 445 | """Get an environment variable, return None if it doesn't exist. |
| 446 | The optional second argument can specify an alternate default.""" |
| 447 | return environ.get(key, default) |
Jack Jansen | b11ce9b | 2003-01-08 16:33:40 +0000 | [diff] [blame] | 448 | __all__.append("getenv") |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 449 | |
| 450 | def _exists(name): |
| 451 | try: |
| 452 | eval(name) |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 453 | return True |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 454 | except NameError: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 455 | return False |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 456 | |
| 457 | # Supply spawn*() (probably only for Unix) |
| 458 | if _exists("fork") and not _exists("spawnv") and _exists("execv"): |
| 459 | |
| 460 | P_WAIT = 0 |
| 461 | P_NOWAIT = P_NOWAITO = 1 |
| 462 | |
| 463 | # XXX Should we support P_DETACH? I suppose it could fork()**2 |
| 464 | # and close the std I/O streams. Also, P_OVERLAY is the same |
| 465 | # as execv*()? |
| 466 | |
| 467 | def _spawnvef(mode, file, args, env, func): |
| 468 | # Internal helper; func is the exec*() function to use |
| 469 | pid = fork() |
| 470 | if not pid: |
| 471 | # Child |
| 472 | try: |
| 473 | if env is None: |
| 474 | func(file, args) |
| 475 | else: |
| 476 | func(file, args, env) |
| 477 | except: |
| 478 | _exit(127) |
| 479 | else: |
| 480 | # Parent |
| 481 | if mode == P_NOWAIT: |
| 482 | return pid # Caller is responsible for waiting! |
| 483 | while 1: |
| 484 | wpid, sts = waitpid(pid, 0) |
| 485 | if WIFSTOPPED(sts): |
| 486 | continue |
| 487 | elif WIFSIGNALED(sts): |
| 488 | return -WTERMSIG(sts) |
| 489 | elif WIFEXITED(sts): |
| 490 | return WEXITSTATUS(sts) |
| 491 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 492 | raise error("Not stopped, signaled or exited???") |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 493 | |
| 494 | def spawnv(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 495 | """spawnv(mode, file, args) -> integer |
| 496 | |
| 497 | Execute file with arguments from args in a subprocess. |
| 498 | If mode == P_NOWAIT return the pid of the process. |
| 499 | 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] | 500 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 501 | return _spawnvef(mode, file, args, None, execv) |
| 502 | |
| 503 | def spawnve(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 504 | """spawnve(mode, file, args, env) -> integer |
| 505 | |
| 506 | Execute file with arguments from args in a subprocess with the |
| 507 | specified environment. |
| 508 | If mode == P_NOWAIT return the pid of the process. |
| 509 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 510 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 511 | return _spawnvef(mode, file, args, env, execve) |
| 512 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 513 | # Note: spawnvp[e] is't currently supported on Windows |
| 514 | |
| 515 | def spawnvp(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 516 | """spawnvp(mode, file, args) -> integer |
| 517 | |
| 518 | Execute file (which is looked for along $PATH) with arguments from |
| 519 | args in a subprocess. |
| 520 | If mode == P_NOWAIT return the pid of the process. |
| 521 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 522 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 523 | return _spawnvef(mode, file, args, None, execvp) |
| 524 | |
| 525 | def spawnvpe(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 526 | """spawnvpe(mode, file, args, env) -> integer |
| 527 | |
| 528 | Execute file (which is looked for along $PATH) with arguments from |
| 529 | args in a subprocess with the supplied environment. |
| 530 | If mode == P_NOWAIT return the pid of the process. |
| 531 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 532 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 533 | return _spawnvef(mode, file, args, env, execvpe) |
| 534 | |
| 535 | if _exists("spawnv"): |
| 536 | # These aren't supplied by the basic Windows code |
| 537 | # but can be easily implemented in Python |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 538 | |
| 539 | def spawnl(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 540 | """spawnl(mode, file, *args) -> integer |
| 541 | |
| 542 | Execute file with arguments from args in a subprocess. |
| 543 | If mode == P_NOWAIT return the pid of the process. |
| 544 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 545 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 546 | return spawnv(mode, file, args) |
| 547 | |
| 548 | def spawnle(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 549 | """spawnle(mode, file, *args, env) -> integer |
| 550 | |
| 551 | Execute file with arguments from args in a subprocess with the |
| 552 | supplied environment. |
| 553 | If mode == P_NOWAIT return the pid of the process. |
| 554 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 555 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 556 | env = args[-1] |
| 557 | return spawnve(mode, file, args[:-1], env) |
| 558 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 559 | |
| 560 | __all__.extend(["spawnv", "spawnve", "spawnl", "spawnle",]) |
| 561 | |
| 562 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 563 | if _exists("spawnvp"): |
| 564 | # At the moment, Windows doesn't implement spawnvp[e], |
| 565 | # so it won't have spawnlp[e] either. |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 566 | def spawnlp(mode, file, *args): |
Neal Norwitz | b7f6810 | 2003-07-02 02:49:33 +0000 | [diff] [blame] | 567 | """spawnlp(mode, file, *args) -> integer |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 568 | |
| 569 | Execute file (which is looked for along $PATH) with arguments from |
| 570 | args in a subprocess with the supplied environment. |
| 571 | If mode == P_NOWAIT return the pid of the process. |
| 572 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 573 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 574 | return spawnvp(mode, file, args) |
| 575 | |
| 576 | def spawnlpe(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 577 | """spawnlpe(mode, file, *args, env) -> integer |
| 578 | |
| 579 | Execute file (which is looked for along $PATH) with arguments from |
| 580 | args in a subprocess with the supplied environment. |
| 581 | If mode == P_NOWAIT return the pid of the process. |
| 582 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 583 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 584 | env = args[-1] |
| 585 | return spawnvpe(mode, file, args[:-1], env) |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 586 | |
| 587 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 588 | __all__.extend(["spawnvp", "spawnvpe", "spawnlp", "spawnlpe",]) |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 589 | |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 590 | import copy_reg as _copy_reg |
| 591 | |
| 592 | def _make_stat_result(tup, dict): |
| 593 | return stat_result(tup, dict) |
| 594 | |
| 595 | def _pickle_stat_result(sr): |
| 596 | (type, args) = sr.__reduce__() |
| 597 | return (_make_stat_result, args) |
| 598 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 599 | try: |
| 600 | _copy_reg.pickle(stat_result, _pickle_stat_result, _make_stat_result) |
| 601 | except NameError: # stat_result may not exist |
| 602 | pass |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 603 | |
| 604 | def _make_statvfs_result(tup, dict): |
| 605 | return statvfs_result(tup, dict) |
| 606 | |
| 607 | def _pickle_statvfs_result(sr): |
| 608 | (type, args) = sr.__reduce__() |
| 609 | return (_make_statvfs_result, args) |
| 610 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 611 | try: |
| 612 | _copy_reg.pickle(statvfs_result, _pickle_statvfs_result, |
| 613 | _make_statvfs_result) |
Michael W. Hudson | e5363b7 | 2002-03-15 10:21:59 +0000 | [diff] [blame] | 614 | except NameError: # statvfs_result may not exist |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 615 | pass |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 616 | |
| 617 | if not _exists("urandom"): |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 618 | def urandom(n): |
| 619 | """urandom(n) -> str |
Tim Peters | 45e77c5 | 2004-08-29 18:47:31 +0000 | [diff] [blame] | 620 | |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 621 | Return a string of n random bytes suitable for cryptographic use. |
| 622 | |
Tim Peters | 45e77c5 | 2004-08-29 18:47:31 +0000 | [diff] [blame] | 623 | """ |
Georg Brandl | 9e43acf | 2005-07-04 17:16:07 +0000 | [diff] [blame] | 624 | try: |
| 625 | _urandomfd = open("/dev/urandom", O_RDONLY) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 626 | except (OSError, IOError): |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 627 | raise NotImplementedError("/dev/urandom (or equivalent) not found") |
Guido van Rossum | 572dbf8 | 2007-04-27 23:53:51 +0000 | [diff] [blame] | 628 | bs = b"" |
| 629 | while len(bs) < n: |
| 630 | bs += read(_urandomfd, n - len(bs)) |
Georg Brandl | 9e43acf | 2005-07-04 17:16:07 +0000 | [diff] [blame] | 631 | close(_urandomfd) |
Guido van Rossum | 572dbf8 | 2007-04-27 23:53:51 +0000 | [diff] [blame] | 632 | return bs |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 633 | |
| 634 | # Supply os.popen() |
| 635 | def popen(cmd, mode="r", buffering=None): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 636 | if not isinstance(cmd, str): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 637 | raise TypeError("invalid cmd type (%s, expected string)" % type(cmd)) |
| 638 | if mode not in ("r", "w"): |
| 639 | raise ValueError("invalid mode %r" % mode) |
| 640 | import subprocess, io |
| 641 | if mode == "r": |
| 642 | proc = subprocess.Popen(cmd, |
| 643 | shell=True, |
| 644 | stdout=subprocess.PIPE, |
| 645 | bufsize=buffering) |
| 646 | return _wrap_close(io.TextIOWrapper(proc.stdout), proc) |
| 647 | else: |
| 648 | proc = subprocess.Popen(cmd, |
| 649 | shell=True, |
| 650 | stdin=subprocess.PIPE, |
| 651 | bufsize=buffering) |
| 652 | return _wrap_close(io.TextIOWrapper(proc.stdin), proc) |
| 653 | |
| 654 | # Helper for popen() -- a proxy for a file whose close waits for the process |
| 655 | class _wrap_close: |
| 656 | def __init__(self, stream, proc): |
| 657 | self._stream = stream |
| 658 | self._proc = proc |
| 659 | def close(self): |
| 660 | self._stream.close() |
| 661 | return self._proc.wait() << 8 # Shift left to match old behavior |
| 662 | def __getattr__(self, name): |
| 663 | return getattr(self._stream, name) |
Thomas Heller | 476157b | 2007-09-04 11:27:47 +0000 | [diff] [blame] | 664 | def __iter__(self): |
| 665 | return iter(self._stream) |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 666 | |
| 667 | # Supply os.fdopen() (used by subprocess!) |
| 668 | def fdopen(fd, mode="r", buffering=-1): |
| 669 | if not isinstance(fd, int): |
| 670 | raise TypeError("invalid fd type (%s, expected integer)" % type(fd)) |
| 671 | import io |
| 672 | return io.open(fd, mode, buffering) |