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 | |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 117 | |
| 118 | def _get_masked_mode(mode): |
| 119 | mask = umask(0) |
| 120 | umask(mask) |
| 121 | return mode & ~mask |
| 122 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 123 | #' |
| 124 | |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 125 | # Super directory utilities. |
| 126 | # (Inspired by Eric Raymond; the doc strings are mostly his) |
| 127 | |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 128 | def makedirs(name, mode=0o777, exist_ok=False): |
| 129 | """makedirs(path [, mode=0o777][, exist_ok=False]) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 130 | |
| 131 | Super-mkdir; create a leaf directory and all intermediate ones. |
| 132 | Works like mkdir, except that any intermediate path segment (not |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 133 | just the rightmost) will be created if it does not exist. If the |
| 134 | target directory with the same mode as we specified already exists, |
| 135 | raises an OSError if exist_ok is False, otherwise no exception is |
| 136 | raised. This is recursive. |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 137 | |
| 138 | """ |
| 139 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 140 | if not tail: |
| 141 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 142 | if head and tail and not path.exists(head): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 143 | try: |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 144 | makedirs(head, mode, exist_ok) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 145 | except OSError as e: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 146 | # be happy if someone already created the path |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 147 | if e.errno != errno.EEXIST: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 148 | raise |
Andrew M. Kuchling | 6fccc8a | 2003-12-23 16:33:28 +0000 | [diff] [blame] | 149 | if tail == curdir: # xxx/newdir/. exists if xxx/newdir exists |
| 150 | return |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 151 | try: |
| 152 | mkdir(name, mode) |
| 153 | except OSError as e: |
| 154 | import stat as st |
Gregory P. Smith | a81c856 | 2012-06-03 14:30:44 -0700 | [diff] [blame] | 155 | dir_exists = path.isdir(name) |
| 156 | expected_mode = _get_masked_mode(mode) |
| 157 | if dir_exists: |
| 158 | # S_ISGID is automatically copied by the OS from parent to child |
| 159 | # directories on mkdir. Don't consider it being set to be a mode |
| 160 | # mismatch as mkdir does not unset it when not specified in mode. |
| 161 | actual_mode = st.S_IMODE(lstat(name).st_mode) & ~st.S_ISGID |
| 162 | else: |
| 163 | actual_mode = -1 |
| 164 | if not (e.errno == errno.EEXIST and exist_ok and dir_exists and |
| 165 | actual_mode == expected_mode): |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 166 | raise |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 167 | |
| 168 | def removedirs(name): |
Fred Drake | cadb9eb | 2002-07-02 21:28:04 +0000 | [diff] [blame] | 169 | """removedirs(path) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 170 | |
Fredrik Lundh | 96c1c7a | 2005-11-12 15:55:04 +0000 | [diff] [blame] | 171 | Super-rmdir; remove a leaf directory and all empty intermediate |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 172 | ones. Works like rmdir except that, if the leaf directory is |
| 173 | successfully removed, directories corresponding to rightmost path |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 174 | segments will be pruned away until either the whole path is |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 175 | consumed or an error occurs. Errors during this latter phase are |
| 176 | ignored -- they generally mean that a directory was not empty. |
| 177 | |
| 178 | """ |
| 179 | rmdir(name) |
| 180 | head, tail = path.split(name) |
Fred Drake | 9f2550f | 2000-07-25 15:16:40 +0000 | [diff] [blame] | 181 | if not tail: |
| 182 | head, tail = path.split(head) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 183 | while head and tail: |
| 184 | try: |
| 185 | rmdir(head) |
| 186 | except error: |
| 187 | break |
| 188 | head, tail = path.split(head) |
| 189 | |
| 190 | def renames(old, new): |
Fred Drake | cadb9eb | 2002-07-02 21:28:04 +0000 | [diff] [blame] | 191 | """renames(old, new) |
Guido van Rossum | 4def7de | 1998-07-24 20:48:03 +0000 | [diff] [blame] | 192 | |
| 193 | Super-rename; create directories as necessary and delete any left |
| 194 | empty. Works like rename, except creation of any intermediate |
| 195 | directories needed to make the new pathname good is attempted |
| 196 | first. After the rename, directories corresponding to rightmost |
| 197 | path segments of the old name will be pruned way until either the |
| 198 | whole path is consumed or a nonempty directory is found. |
| 199 | |
| 200 | Note: this function can fail with the new directory structure made |
| 201 | if you lack permissions needed to unlink the leaf directory or |
| 202 | file. |
| 203 | |
| 204 | """ |
| 205 | head, tail = path.split(new) |
| 206 | if head and tail and not path.exists(head): |
| 207 | makedirs(head) |
| 208 | rename(old, new) |
| 209 | head, tail = path.split(old) |
| 210 | if head and tail: |
| 211 | try: |
| 212 | removedirs(head) |
| 213 | except error: |
| 214 | pass |
| 215 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 216 | __all__.extend(["makedirs", "removedirs", "renames"]) |
| 217 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 218 | def walk(top, topdown=True, onerror=None, followlinks=False): |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 219 | """Directory tree generator. |
| 220 | |
| 221 | For each directory in the directory tree rooted at top (including top |
| 222 | itself, but excluding '.' and '..'), yields a 3-tuple |
| 223 | |
| 224 | dirpath, dirnames, filenames |
| 225 | |
| 226 | dirpath is a string, the path to the directory. dirnames is a list of |
| 227 | the names of the subdirectories in dirpath (excluding '.' and '..'). |
| 228 | filenames is a list of the names of the non-directory files in dirpath. |
| 229 | Note that the names in the lists are just names, with no path components. |
| 230 | To get a full path (which begins with top) to a file or directory in |
| 231 | dirpath, do os.path.join(dirpath, name). |
| 232 | |
| 233 | If optional arg 'topdown' is true or not specified, the triple for a |
| 234 | directory is generated before the triples for any of its subdirectories |
| 235 | (directories are generated top down). If topdown is false, the triple |
| 236 | for a directory is generated after the triples for all of its |
| 237 | subdirectories (directories are generated bottom up). |
| 238 | |
| 239 | When topdown is true, the caller can modify the dirnames list in-place |
| 240 | (e.g., via del or slice assignment), and walk will only recurse into the |
| 241 | subdirectories whose names remain in dirnames; this can be used to prune |
| 242 | the search, or to impose a specific order of visiting. Modifying |
| 243 | dirnames when topdown is false is ineffective, since the directories in |
| 244 | dirnames have already been generated by the time dirnames itself is |
| 245 | generated. |
| 246 | |
Guido van Rossum | bf1bef8 | 2003-05-13 18:01:19 +0000 | [diff] [blame] | 247 | By default errors from the os.listdir() call are ignored. If |
| 248 | optional arg 'onerror' is specified, it should be a function; it |
| 249 | will be called with one argument, an os.error instance. It can |
| 250 | report the error to continue with the walk, or raise the exception |
| 251 | to abort the walk. Note that the filename is available as the |
| 252 | filename attribute of the exception object. |
| 253 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 254 | By default, os.walk does not follow symbolic links to subdirectories on |
| 255 | systems that support them. In order to get this functionality, set the |
| 256 | optional argument 'followlinks' to true. |
| 257 | |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 258 | Caution: if you pass a relative pathname for top, don't change the |
| 259 | current working directory between resumptions of walk. walk never |
| 260 | changes the current directory, and assumes that the client doesn't |
| 261 | either. |
| 262 | |
| 263 | Example: |
| 264 | |
Christian Heimes | 5d8da20 | 2008-05-06 13:58:24 +0000 | [diff] [blame] | 265 | import os |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 266 | from os.path import join, getsize |
Christian Heimes | 5d8da20 | 2008-05-06 13:58:24 +0000 | [diff] [blame] | 267 | for root, dirs, files in os.walk('python/Lib/email'): |
Neal Norwitz | 752abd0 | 2008-05-13 04:55:24 +0000 | [diff] [blame] | 268 | print(root, "consumes", end="") |
| 269 | print(sum([getsize(join(root, name)) for name in files]), end="") |
| 270 | print("bytes in", len(files), "non-directory files") |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 271 | if 'CVS' in dirs: |
| 272 | dirs.remove('CVS') # don't visit CVS directories |
| 273 | """ |
| 274 | |
Benjamin Peterson | f6489f9 | 2009-11-25 17:46:26 +0000 | [diff] [blame] | 275 | islink, join, isdir = path.islink, path.join, path.isdir |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 276 | |
| 277 | # 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] | 278 | # get a list of the files the directory contains. os.walk |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 279 | # always suppressed the exception then, rather than blow up for a |
| 280 | # minor reason when (say) a thousand readable directories are still |
| 281 | # left to visit. That logic is copied here. |
| 282 | try: |
| 283 | # Note that listdir and error are globals in this module due |
| 284 | # to earlier import-*. |
| 285 | names = listdir(top) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 286 | except error as err: |
Guido van Rossum | bf1bef8 | 2003-05-13 18:01:19 +0000 | [diff] [blame] | 287 | if onerror is not None: |
| 288 | onerror(err) |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 289 | return |
| 290 | |
| 291 | dirs, nondirs = [], [] |
| 292 | for name in names: |
| 293 | if isdir(join(top, name)): |
| 294 | dirs.append(name) |
| 295 | else: |
| 296 | nondirs.append(name) |
| 297 | |
| 298 | if topdown: |
| 299 | yield top, dirs, nondirs |
| 300 | for name in dirs: |
Benjamin Peterson | f6489f9 | 2009-11-25 17:46:26 +0000 | [diff] [blame] | 301 | new_path = join(top, name) |
| 302 | if followlinks or not islink(new_path): |
| 303 | for x in walk(new_path, topdown, onerror, followlinks): |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 304 | yield x |
| 305 | if not topdown: |
| 306 | yield top, dirs, nondirs |
| 307 | |
| 308 | __all__.append("walk") |
| 309 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 310 | # Make sure os.environ exists, at least |
| 311 | try: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 312 | environ |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 313 | except NameError: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 314 | environ = {} |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 315 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 316 | def execl(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 317 | """execl(file, *args) |
| 318 | |
| 319 | Execute the executable file with argument list args, replacing the |
| 320 | current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 321 | execv(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 322 | |
| 323 | def execle(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 324 | """execle(file, *args, env) |
| 325 | |
| 326 | Execute the executable file with argument list args and |
| 327 | environment env, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 328 | env = args[-1] |
| 329 | execve(file, args[:-1], env) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 330 | |
| 331 | def execlp(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 332 | """execlp(file, *args) |
| 333 | |
| 334 | Execute the executable file (which is searched for along $PATH) |
| 335 | with argument list args, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 336 | execvp(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 337 | |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 338 | def execlpe(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 339 | """execlpe(file, *args, env) |
| 340 | |
| 341 | Execute the executable file (which is searched for along $PATH) |
| 342 | with argument list args and environment env, replacing the current |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 343 | process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 344 | env = args[-1] |
| 345 | execvpe(file, args[:-1], env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 346 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 347 | def execvp(file, args): |
Matthias Klose | a09c54f | 2010-01-31 16:48:44 +0000 | [diff] [blame] | 348 | """execvp(file, args) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 349 | |
| 350 | Execute the executable file (which is searched for along $PATH) |
| 351 | with argument list args, replacing the current process. |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 352 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 353 | _execvpe(file, args) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 354 | |
| 355 | def execvpe(file, args, env): |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 356 | """execvpe(file, args, env) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 357 | |
| 358 | Execute the executable file (which is searched for along $PATH) |
| 359 | with argument list args and environment env , replacing the |
| 360 | current process. |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 361 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 362 | _execvpe(file, args, env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 363 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 364 | __all__.extend(["execl","execle","execlp","execlpe","execvp","execvpe"]) |
| 365 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 366 | def _execvpe(file, args, env=None): |
| 367 | if env is not None: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 368 | exec_func = execve |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 369 | argrest = (args, env) |
| 370 | else: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 371 | exec_func = execv |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 372 | argrest = (args,) |
| 373 | env = environ |
Guido van Rossum | aed51d8 | 2002-08-05 16:13:24 +0000 | [diff] [blame] | 374 | |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 375 | head, tail = path.split(file) |
| 376 | if head: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 377 | exec_func(file, *argrest) |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 378 | return |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 379 | last_exc = saved_exc = None |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 380 | saved_tb = None |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 381 | path_list = get_exec_path(env) |
| 382 | if name != 'nt': |
| 383 | file = fsencode(file) |
| 384 | path_list = map(fsencode, path_list) |
| 385 | for dir in path_list: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 386 | fullname = path.join(dir, file) |
| 387 | try: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 388 | exec_func(fullname, *argrest) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 389 | except error as e: |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 390 | last_exc = e |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 391 | tb = sys.exc_info()[2] |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 392 | if (e.errno != errno.ENOENT and e.errno != errno.ENOTDIR |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 393 | and saved_exc is None): |
| 394 | saved_exc = e |
| 395 | saved_tb = tb |
| 396 | if saved_exc: |
Benjamin Peterson | 4b06819 | 2009-02-20 03:19:25 +0000 | [diff] [blame] | 397 | raise saved_exc.with_traceback(saved_tb) |
| 398 | raise last_exc.with_traceback(tb) |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 399 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 400 | |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 401 | def get_exec_path(env=None): |
| 402 | """Returns the sequence of directories that will be searched for the |
| 403 | named executable (similar to a shell) when launching a process. |
| 404 | |
| 405 | *env* must be an environment variable dict or None. If *env* is None, |
| 406 | os.environ will be used. |
| 407 | """ |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 408 | # Use a local import instead of a global import to limit the number of |
| 409 | # modules loaded at startup: the os module is always loaded at startup by |
| 410 | # Python. It may also avoid a bootstrap issue. |
Victor Stinner | 6f35eda | 2010-10-29 00:38:58 +0000 | [diff] [blame] | 411 | import warnings |
| 412 | |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 413 | if env is None: |
| 414 | env = environ |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 415 | |
Victor Stinner | bb4f218 | 2010-11-07 15:43:39 +0000 | [diff] [blame] | 416 | # {b'PATH': ...}.get('PATH') and {'PATH': ...}.get(b'PATH') emit a |
| 417 | # BytesWarning when using python -b or python -bb: ignore the warning |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 418 | with warnings.catch_warnings(): |
| 419 | warnings.simplefilter("ignore", BytesWarning) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 420 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 421 | try: |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 422 | path_list = env.get('PATH') |
| 423 | except TypeError: |
| 424 | path_list = None |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 425 | |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 426 | if supports_bytes_environ: |
| 427 | try: |
| 428 | path_listb = env[b'PATH'] |
| 429 | except (KeyError, TypeError): |
| 430 | pass |
| 431 | else: |
| 432 | if path_list is not None: |
| 433 | raise ValueError( |
| 434 | "env cannot contain 'PATH' and b'PATH' keys") |
| 435 | path_list = path_listb |
| 436 | |
| 437 | if path_list is not None and isinstance(path_list, bytes): |
| 438 | path_list = fsdecode(path_list) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 439 | |
| 440 | if path_list is None: |
| 441 | path_list = defpath |
| 442 | return path_list.split(pathsep) |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 443 | |
| 444 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 445 | # Change environ to automatically call putenv(), unsetenv if they exist. |
| 446 | from _abcoll import MutableMapping # Can't use collections (bootstrap) |
| 447 | |
| 448 | class _Environ(MutableMapping): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 449 | def __init__(self, data, encodekey, decodekey, encodevalue, decodevalue, putenv, unsetenv): |
| 450 | self.encodekey = encodekey |
| 451 | self.decodekey = decodekey |
| 452 | self.encodevalue = encodevalue |
| 453 | self.decodevalue = decodevalue |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 454 | self.putenv = putenv |
| 455 | self.unsetenv = unsetenv |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 456 | self._data = data |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 457 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 458 | def __getitem__(self, key): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 459 | value = self._data[self.encodekey(key)] |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 460 | return self.decodevalue(value) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 461 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 462 | def __setitem__(self, key, value): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 463 | key = self.encodekey(key) |
| 464 | value = self.encodevalue(value) |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 465 | self.putenv(key, value) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 466 | self._data[key] = value |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 467 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 468 | def __delitem__(self, key): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 469 | key = self.encodekey(key) |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 470 | self.unsetenv(key) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 471 | del self._data[key] |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 472 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 473 | def __iter__(self): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 474 | for key in self._data: |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 475 | yield self.decodekey(key) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 476 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 477 | def __len__(self): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 478 | return len(self._data) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 479 | |
| 480 | def __repr__(self): |
Victor Stinner | bed7117 | 2010-07-28 21:25:42 +0000 | [diff] [blame] | 481 | return 'environ({{{}}})'.format(', '.join( |
Victor Stinner | d73c1a3 | 2010-07-28 21:23:23 +0000 | [diff] [blame] | 482 | ('{!r}: {!r}'.format(self.decodekey(key), self.decodevalue(value)) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 483 | for key, value in self._data.items()))) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 484 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 485 | def copy(self): |
| 486 | return dict(self) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 487 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 488 | def setdefault(self, key, value): |
| 489 | if key not in self: |
| 490 | self[key] = value |
| 491 | return self[key] |
| 492 | |
| 493 | try: |
| 494 | _putenv = putenv |
| 495 | except NameError: |
| 496 | _putenv = lambda key, value: None |
Martin v. Löwis | a90f438 | 2001-03-07 09:05:45 +0000 | [diff] [blame] | 497 | else: |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 498 | __all__.append("putenv") |
Guido van Rossum | 3b8e20d | 1996-07-24 00:55:17 +0000 | [diff] [blame] | 499 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 500 | try: |
| 501 | _unsetenv = unsetenv |
| 502 | except NameError: |
| 503 | _unsetenv = lambda key: _putenv(key, "") |
| 504 | else: |
| 505 | __all__.append("unsetenv") |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 506 | |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 507 | def _createenviron(): |
| 508 | if name in ('os2', 'nt'): |
| 509 | # Where Env Var Names Must Be UPPERCASE |
| 510 | def check_str(value): |
| 511 | if not isinstance(value, str): |
| 512 | raise TypeError("str expected, not %s" % type(value).__name__) |
| 513 | return value |
| 514 | encode = check_str |
| 515 | decode = str |
| 516 | def encodekey(key): |
| 517 | return encode(key).upper() |
| 518 | data = {} |
| 519 | for key, value in environ.items(): |
| 520 | data[encodekey(key)] = value |
| 521 | else: |
| 522 | # Where Env Var Names Can Be Mixed Case |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 523 | encoding = sys.getfilesystemencoding() |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 524 | def encode(value): |
| 525 | if not isinstance(value, str): |
| 526 | raise TypeError("str expected, not %s" % type(value).__name__) |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 527 | return value.encode(encoding, 'surrogateescape') |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 528 | def decode(value): |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 529 | return value.decode(encoding, 'surrogateescape') |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 530 | encodekey = encode |
| 531 | data = environ |
| 532 | return _Environ(data, |
| 533 | encodekey, decode, |
| 534 | encode, decode, |
| 535 | _putenv, _unsetenv) |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 536 | |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 537 | # unicode environ |
| 538 | environ = _createenviron() |
| 539 | del _createenviron |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 540 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 541 | |
Jack Jansen | b11ce9b | 2003-01-08 16:33:40 +0000 | [diff] [blame] | 542 | def getenv(key, default=None): |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 543 | """Get an environment variable, return None if it doesn't exist. |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 544 | The optional second argument can specify an alternate default. |
| 545 | key, default and the result are str.""" |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 546 | return environ.get(key, default) |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 547 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 548 | supports_bytes_environ = name not in ('os2', 'nt') |
| 549 | __all__.extend(("getenv", "supports_bytes_environ")) |
| 550 | |
| 551 | if supports_bytes_environ: |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 552 | def _check_bytes(value): |
| 553 | if not isinstance(value, bytes): |
| 554 | raise TypeError("bytes expected, not %s" % type(value).__name__) |
| 555 | return value |
| 556 | |
| 557 | # bytes environ |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 558 | environb = _Environ(environ._data, |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 559 | _check_bytes, bytes, |
| 560 | _check_bytes, bytes, |
| 561 | _putenv, _unsetenv) |
| 562 | del _check_bytes |
| 563 | |
| 564 | def getenvb(key, default=None): |
| 565 | """Get an environment variable, return None if it doesn't exist. |
| 566 | The optional second argument can specify an alternate default. |
| 567 | key, default and the result are bytes.""" |
| 568 | return environb.get(key, default) |
Victor Stinner | 70120e2 | 2010-07-29 17:19:38 +0000 | [diff] [blame] | 569 | |
| 570 | __all__.extend(("environb", "getenvb")) |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 571 | |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 572 | def _fscodec(): |
| 573 | encoding = sys.getfilesystemencoding() |
| 574 | if encoding == 'mbcs': |
Victor Stinner | e882aac | 2010-10-24 21:12:26 +0000 | [diff] [blame] | 575 | errors = 'strict' |
Victor Stinner | 313a120 | 2010-06-11 23:56:51 +0000 | [diff] [blame] | 576 | else: |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 577 | errors = 'surrogateescape' |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 578 | |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 579 | def fsencode(filename): |
| 580 | """ |
| 581 | Encode filename to the filesystem encoding with 'surrogateescape' error |
| 582 | handler, return bytes unchanged. On Windows, use 'strict' error handler if |
| 583 | the file system encoding is 'mbcs' (which is the default encoding). |
| 584 | """ |
| 585 | if isinstance(filename, bytes): |
| 586 | return filename |
| 587 | elif isinstance(filename, str): |
| 588 | return filename.encode(encoding, errors) |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 589 | else: |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 590 | raise TypeError("expect bytes or str, not %s" % type(filename).__name__) |
| 591 | |
| 592 | def fsdecode(filename): |
| 593 | """ |
| 594 | Decode filename from the filesystem encoding with 'surrogateescape' error |
| 595 | handler, return str unchanged. On Windows, use 'strict' error handler if |
| 596 | the file system encoding is 'mbcs' (which is the default encoding). |
| 597 | """ |
| 598 | if isinstance(filename, str): |
| 599 | return filename |
| 600 | elif isinstance(filename, bytes): |
| 601 | return filename.decode(encoding, errors) |
| 602 | else: |
| 603 | raise TypeError("expect bytes or str, not %s" % type(filename).__name__) |
| 604 | |
| 605 | return fsencode, fsdecode |
| 606 | |
| 607 | fsencode, fsdecode = _fscodec() |
| 608 | del _fscodec |
Victor Stinner | 449c466 | 2010-05-08 11:10:09 +0000 | [diff] [blame] | 609 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 610 | def _exists(name): |
Benjamin Peterson | 87c8d87 | 2009-06-11 22:54:11 +0000 | [diff] [blame] | 611 | return name in globals() |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 612 | |
| 613 | # Supply spawn*() (probably only for Unix) |
| 614 | if _exists("fork") and not _exists("spawnv") and _exists("execv"): |
| 615 | |
| 616 | P_WAIT = 0 |
| 617 | P_NOWAIT = P_NOWAITO = 1 |
| 618 | |
| 619 | # XXX Should we support P_DETACH? I suppose it could fork()**2 |
| 620 | # and close the std I/O streams. Also, P_OVERLAY is the same |
| 621 | # as execv*()? |
| 622 | |
| 623 | def _spawnvef(mode, file, args, env, func): |
| 624 | # Internal helper; func is the exec*() function to use |
| 625 | pid = fork() |
| 626 | if not pid: |
| 627 | # Child |
| 628 | try: |
| 629 | if env is None: |
| 630 | func(file, args) |
| 631 | else: |
| 632 | func(file, args, env) |
| 633 | except: |
| 634 | _exit(127) |
| 635 | else: |
| 636 | # Parent |
| 637 | if mode == P_NOWAIT: |
| 638 | return pid # Caller is responsible for waiting! |
| 639 | while 1: |
| 640 | wpid, sts = waitpid(pid, 0) |
| 641 | if WIFSTOPPED(sts): |
| 642 | continue |
| 643 | elif WIFSIGNALED(sts): |
| 644 | return -WTERMSIG(sts) |
| 645 | elif WIFEXITED(sts): |
| 646 | return WEXITSTATUS(sts) |
| 647 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 648 | raise error("Not stopped, signaled or exited???") |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 649 | |
| 650 | def spawnv(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 651 | """spawnv(mode, file, args) -> integer |
| 652 | |
| 653 | Execute file with arguments from args in a subprocess. |
| 654 | If mode == P_NOWAIT return the pid of the process. |
| 655 | 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] | 656 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 657 | return _spawnvef(mode, file, args, None, execv) |
| 658 | |
| 659 | def spawnve(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 660 | """spawnve(mode, file, args, env) -> integer |
| 661 | |
| 662 | Execute file with arguments from args in a subprocess with the |
| 663 | specified environment. |
| 664 | If mode == P_NOWAIT return the pid of the process. |
| 665 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 666 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 667 | return _spawnvef(mode, file, args, env, execve) |
| 668 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 669 | # Note: spawnvp[e] is't currently supported on Windows |
| 670 | |
| 671 | def spawnvp(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 672 | """spawnvp(mode, file, args) -> integer |
| 673 | |
| 674 | Execute file (which is looked for along $PATH) with arguments from |
| 675 | args in a subprocess. |
| 676 | If mode == P_NOWAIT return the pid of the process. |
| 677 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 678 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 679 | return _spawnvef(mode, file, args, None, execvp) |
| 680 | |
| 681 | def spawnvpe(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 682 | """spawnvpe(mode, file, args, env) -> integer |
| 683 | |
| 684 | Execute file (which is looked for along $PATH) with arguments from |
| 685 | args in a subprocess with the supplied environment. |
| 686 | If mode == P_NOWAIT return the pid of the process. |
| 687 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 688 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 689 | return _spawnvef(mode, file, args, env, execvpe) |
| 690 | |
| 691 | if _exists("spawnv"): |
| 692 | # These aren't supplied by the basic Windows code |
| 693 | # but can be easily implemented in Python |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 694 | |
| 695 | def spawnl(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 696 | """spawnl(mode, file, *args) -> integer |
| 697 | |
| 698 | Execute file with arguments from args in a subprocess. |
| 699 | If mode == P_NOWAIT return the pid of the process. |
| 700 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 701 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 702 | return spawnv(mode, file, args) |
| 703 | |
| 704 | def spawnle(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 705 | """spawnle(mode, file, *args, env) -> integer |
| 706 | |
| 707 | Execute file with arguments from args in a subprocess with the |
| 708 | supplied environment. |
| 709 | If mode == P_NOWAIT return the pid of the process. |
| 710 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 711 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 712 | env = args[-1] |
| 713 | return spawnve(mode, file, args[:-1], env) |
| 714 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 715 | |
| 716 | __all__.extend(["spawnv", "spawnve", "spawnl", "spawnle",]) |
| 717 | |
| 718 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 719 | if _exists("spawnvp"): |
| 720 | # At the moment, Windows doesn't implement spawnvp[e], |
| 721 | # so it won't have spawnlp[e] either. |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 722 | def spawnlp(mode, file, *args): |
Neal Norwitz | b7f6810 | 2003-07-02 02:49:33 +0000 | [diff] [blame] | 723 | """spawnlp(mode, file, *args) -> integer |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 724 | |
| 725 | Execute file (which is looked for along $PATH) with arguments from |
| 726 | args in a subprocess with the supplied environment. |
| 727 | If mode == P_NOWAIT return the pid of the process. |
| 728 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 729 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 730 | return spawnvp(mode, file, args) |
| 731 | |
| 732 | def spawnlpe(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 733 | """spawnlpe(mode, file, *args, env) -> integer |
| 734 | |
| 735 | Execute file (which is looked for along $PATH) with arguments from |
| 736 | args in a subprocess with the supplied environment. |
| 737 | If mode == P_NOWAIT return the pid of the process. |
| 738 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 739 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 740 | env = args[-1] |
| 741 | return spawnvpe(mode, file, args[:-1], env) |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 742 | |
| 743 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 744 | __all__.extend(["spawnvp", "spawnvpe", "spawnlp", "spawnlpe",]) |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 745 | |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 746 | import copyreg as _copyreg |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 747 | |
| 748 | def _make_stat_result(tup, dict): |
| 749 | return stat_result(tup, dict) |
| 750 | |
| 751 | def _pickle_stat_result(sr): |
| 752 | (type, args) = sr.__reduce__() |
| 753 | return (_make_stat_result, args) |
| 754 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 755 | try: |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 756 | _copyreg.pickle(stat_result, _pickle_stat_result, _make_stat_result) |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 757 | except NameError: # stat_result may not exist |
| 758 | pass |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 759 | |
| 760 | def _make_statvfs_result(tup, dict): |
| 761 | return statvfs_result(tup, dict) |
| 762 | |
| 763 | def _pickle_statvfs_result(sr): |
| 764 | (type, args) = sr.__reduce__() |
| 765 | return (_make_statvfs_result, args) |
| 766 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 767 | try: |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 768 | _copyreg.pickle(statvfs_result, _pickle_statvfs_result, |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 769 | _make_statvfs_result) |
Michael W. Hudson | e5363b7 | 2002-03-15 10:21:59 +0000 | [diff] [blame] | 770 | except NameError: # statvfs_result may not exist |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 771 | pass |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 772 | |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 773 | # Supply os.popen() |
Antoine Pitrou | 877766d | 2011-03-19 17:00:37 +0100 | [diff] [blame] | 774 | def popen(cmd, mode="r", buffering=-1): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 775 | if not isinstance(cmd, str): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 776 | raise TypeError("invalid cmd type (%s, expected string)" % type(cmd)) |
| 777 | if mode not in ("r", "w"): |
| 778 | raise ValueError("invalid mode %r" % mode) |
Antoine Pitrou | 877766d | 2011-03-19 17:00:37 +0100 | [diff] [blame] | 779 | if buffering == 0 or buffering == None: |
| 780 | raise ValueError("popen() does not support unbuffered streams") |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 781 | import subprocess, io |
| 782 | if mode == "r": |
| 783 | proc = subprocess.Popen(cmd, |
| 784 | shell=True, |
| 785 | stdout=subprocess.PIPE, |
| 786 | bufsize=buffering) |
| 787 | return _wrap_close(io.TextIOWrapper(proc.stdout), proc) |
| 788 | else: |
| 789 | proc = subprocess.Popen(cmd, |
| 790 | shell=True, |
| 791 | stdin=subprocess.PIPE, |
| 792 | bufsize=buffering) |
| 793 | return _wrap_close(io.TextIOWrapper(proc.stdin), proc) |
| 794 | |
| 795 | # Helper for popen() -- a proxy for a file whose close waits for the process |
| 796 | class _wrap_close: |
| 797 | def __init__(self, stream, proc): |
| 798 | self._stream = stream |
| 799 | self._proc = proc |
| 800 | def close(self): |
| 801 | self._stream.close() |
Amaury Forgeot d'Arc | 97e5f28 | 2009-07-11 09:35:13 +0000 | [diff] [blame] | 802 | returncode = self._proc.wait() |
| 803 | if returncode == 0: |
| 804 | return None |
| 805 | if name == 'nt': |
| 806 | return returncode |
| 807 | else: |
| 808 | return returncode << 8 # Shift left to match old behavior |
Antoine Pitrou | ac62535 | 2009-12-09 00:01:27 +0000 | [diff] [blame] | 809 | def __enter__(self): |
| 810 | return self |
| 811 | def __exit__(self, *args): |
| 812 | self.close() |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 813 | def __getattr__(self, name): |
| 814 | return getattr(self._stream, name) |
Thomas Heller | 476157b | 2007-09-04 11:27:47 +0000 | [diff] [blame] | 815 | def __iter__(self): |
| 816 | return iter(self._stream) |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 817 | |
Amaury Forgeot d'Arc | bdbddf8 | 2008-08-01 00:06:49 +0000 | [diff] [blame] | 818 | # Supply os.fdopen() |
| 819 | def fdopen(fd, *args, **kwargs): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 820 | if not isinstance(fd, int): |
| 821 | raise TypeError("invalid fd type (%s, expected integer)" % type(fd)) |
| 822 | import io |
Amaury Forgeot d'Arc | bdbddf8 | 2008-08-01 00:06:49 +0000 | [diff] [blame] | 823 | return io.open(fd, *args, **kwargs) |