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