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