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", |
Martin v. Löwis | 22b457e | 2005-01-16 08:40:58 +0000 | [diff] [blame] | 33 | "defpath", "name", "path", "devnull", |
| 34 | "SEEK_SET", "SEEK_CUR", "SEEK_END"] |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 35 | |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 36 | def _exists(name): |
| 37 | return name in globals() |
| 38 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 39 | def _get_exports_list(module): |
| 40 | try: |
| 41 | return list(module.__all__) |
| 42 | except AttributeError: |
| 43 | return [n for n in dir(module) if n[0] != '_'] |
| 44 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 45 | if 'posix' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 46 | name = 'posix' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 47 | linesep = '\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 48 | from posix import * |
| 49 | try: |
| 50 | from posix import _exit |
| 51 | except ImportError: |
| 52 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 53 | import posixpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 54 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 55 | import posix |
| 56 | __all__.extend(_get_exports_list(posix)) |
| 57 | del posix |
| 58 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 59 | elif 'nt' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 60 | name = 'nt' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 61 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 62 | from nt import * |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 63 | try: |
| 64 | from nt import _exit |
| 65 | except ImportError: |
| 66 | pass |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 67 | import ntpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 68 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 69 | import nt |
| 70 | __all__.extend(_get_exports_list(nt)) |
| 71 | del nt |
| 72 | |
Guido van Rossum | 8e9ebfd | 1997-11-22 21:53:48 +0000 | [diff] [blame] | 73 | elif 'os2' in _names: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 74 | name = 'os2' |
Guido van Rossum | e9387ea | 1998-05-22 15:26:04 +0000 | [diff] [blame] | 75 | linesep = '\r\n' |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 76 | from os2 import * |
| 77 | try: |
| 78 | from os2 import _exit |
| 79 | except ImportError: |
| 80 | pass |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 81 | if sys.version.find('EMX GCC') == -1: |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 82 | import ntpath as path |
Andrew MacIntyre | 5cef571 | 2002-02-24 05:32:32 +0000 | [diff] [blame] | 83 | else: |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 84 | import os2emxpath as path |
Andrew MacIntyre | 89f9865 | 2003-12-02 12:33:01 +0000 | [diff] [blame] | 85 | from _emx_link import link |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 86 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 87 | import os2 |
| 88 | __all__.extend(_get_exports_list(os2)) |
| 89 | del os2 |
| 90 | |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 91 | elif 'ce' in _names: |
| 92 | name = 'ce' |
| 93 | linesep = '\r\n' |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 94 | from ce import * |
Tim Peters | 6757c1e | 2003-01-08 21:20:57 +0000 | [diff] [blame] | 95 | try: |
| 96 | from ce import _exit |
| 97 | except ImportError: |
| 98 | pass |
Guido van Rossum | 18df5d4 | 1999-06-11 01:37:27 +0000 | [diff] [blame] | 99 | # We can use the standard Windows path. |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 100 | import ntpath as path |
Tim Peters | f2715e0 | 2003-02-19 02:35:07 +0000 | [diff] [blame] | 101 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 102 | import ce |
| 103 | __all__.extend(_get_exports_list(ce)) |
| 104 | del ce |
| 105 | |
Guido van Rossum | 2979b01 | 1994-08-01 11:18:30 +0000 | [diff] [blame] | 106 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 107 | raise ImportError('no os specific module found') |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 108 | |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 109 | sys.modules['os.path'] = path |
Georg Brandl | ed5b9b3 | 2008-12-05 07:45:54 +0000 | [diff] [blame] | 110 | from os.path import (curdir, pardir, sep, pathsep, defpath, extsep, altsep, |
| 111 | devnull) |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 112 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 113 | del _names |
| 114 | |
Martin v. Löwis | 22b457e | 2005-01-16 08:40:58 +0000 | [diff] [blame] | 115 | # Python uses fixed values for the SEEK_ constants; they are mapped |
| 116 | # to native constants if necessary in posixmodule.c |
| 117 | SEEK_SET = 0 |
| 118 | SEEK_CUR = 1 |
| 119 | SEEK_END = 2 |
| 120 | |
Terry Reedy | 5a22b65 | 2010-12-02 07:05:56 +0000 | [diff] [blame] | 121 | |
| 122 | def _get_masked_mode(mode): |
| 123 | mask = umask(0) |
| 124 | umask(mask) |
| 125 | return mode & ~mask |
| 126 | |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 127 | def _are_same_file(stat1, stat2): |
| 128 | """Helper function that checks whether two stat results refer to the same |
| 129 | file. |
| 130 | """ |
| 131 | return (stat1.st_ino == stat2.st_ino and stat1.st_dev == stat2.st_dev) |
| 132 | # |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 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): |
| 302 | for x in walk(new_path, topdown, onerror, followlinks): |
Tim Peters | c4e0940 | 2003-04-25 07:11:48 +0000 | [diff] [blame] | 303 | yield x |
| 304 | if not topdown: |
| 305 | yield top, dirs, nondirs |
| 306 | |
| 307 | __all__.append("walk") |
| 308 | |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 309 | if _exists("openat"): |
| 310 | |
| 311 | def fwalk(top, topdown=True, onerror=None, followlinks=False): |
| 312 | """Directory tree generator. |
| 313 | |
| 314 | This behaves exactly like walk(), except that it yields a 4-tuple |
| 315 | |
| 316 | dirpath, dirnames, filenames, dirfd |
| 317 | |
| 318 | `dirpath`, `dirnames` and `filenames` are identical to walk() output, |
| 319 | and `dirfd` is a file descriptor referring to the directory `dirpath`. |
| 320 | |
| 321 | The advantage of walkfd() over walk() is that it's safe against symlink |
| 322 | races (when followlinks is False). |
| 323 | |
| 324 | Caution: |
| 325 | Since fwalk() yields file descriptors, those are only valid until the |
| 326 | next iteration step, so you should dup() them if you want to keep them |
| 327 | for a longer period. |
| 328 | |
| 329 | Example: |
| 330 | |
| 331 | import os |
| 332 | for root, dirs, files, rootfd in os.fwalk('python/Lib/email'): |
| 333 | print(root, "consumes", end="") |
| 334 | print(sum([os.fstatat(rootfd, name).st_size for name in files]), |
| 335 | end="") |
| 336 | print("bytes in", len(files), "non-directory files") |
| 337 | if 'CVS' in dirs: |
| 338 | dirs.remove('CVS') # don't visit CVS directories |
| 339 | """ |
| 340 | # Note: To guard against symlink races, we use the standard |
| 341 | # lstat()/open()/fstat() trick. |
| 342 | orig_st = lstat(top) |
| 343 | topfd = open(top, O_RDONLY) |
| 344 | try: |
| 345 | if (followlinks or (st.S_ISDIR(orig_st.st_mode) and |
| 346 | _are_same_file(orig_st, fstat(topfd)))): |
| 347 | for x in _fwalk(topfd, top, topdown, onerror, followlinks): |
| 348 | yield x |
| 349 | finally: |
| 350 | close(topfd) |
| 351 | |
| 352 | def _fwalk(topfd, toppath, topdown, onerror, followlinks): |
| 353 | # Note: This uses O(depth of the directory tree) file descriptors: if |
| 354 | # necessary, it can be adapted to only require O(1) FDs, see issue |
| 355 | # #13734. |
| 356 | |
| 357 | # whether to follow symlinks |
| 358 | flag = 0 if followlinks else AT_SYMLINK_NOFOLLOW |
| 359 | |
Charles-François Natali | 7794090 | 2012-02-06 19:54:48 +0100 | [diff] [blame] | 360 | names = flistdir(topfd) |
Charles-François Natali | 7372b06 | 2012-02-05 15:15:38 +0100 | [diff] [blame] | 361 | dirs, nondirs = [], [] |
| 362 | for name in names: |
| 363 | # Here, we don't use AT_SYMLINK_NOFOLLOW to be consistent with |
| 364 | # walk() which reports symlinks to directories as directories. We do |
| 365 | # however check for symlinks before recursing into a subdirectory. |
| 366 | if st.S_ISDIR(fstatat(topfd, name).st_mode): |
| 367 | dirs.append(name) |
| 368 | else: |
| 369 | nondirs.append(name) |
| 370 | |
| 371 | if topdown: |
| 372 | yield toppath, dirs, nondirs, topfd |
| 373 | |
| 374 | for name in dirs: |
| 375 | try: |
| 376 | orig_st = fstatat(topfd, name, flag) |
| 377 | dirfd = openat(topfd, name, O_RDONLY) |
| 378 | except error as err: |
| 379 | if onerror is not None: |
| 380 | onerror(err) |
| 381 | return |
| 382 | try: |
| 383 | if followlinks or _are_same_file(orig_st, fstat(dirfd)): |
| 384 | dirpath = path.join(toppath, name) |
| 385 | for x in _fwalk(dirfd, dirpath, topdown, onerror, followlinks): |
| 386 | yield x |
| 387 | finally: |
| 388 | close(dirfd) |
| 389 | |
| 390 | if not topdown: |
| 391 | yield toppath, dirs, nondirs, topfd |
| 392 | |
| 393 | __all__.append("fwalk") |
| 394 | |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 395 | # Make sure os.environ exists, at least |
| 396 | try: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 397 | environ |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 398 | except NameError: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 399 | environ = {} |
Guido van Rossum | a28dab5 | 1997-08-29 22:36:47 +0000 | [diff] [blame] | 400 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 401 | def execl(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 402 | """execl(file, *args) |
| 403 | |
| 404 | Execute the executable file with argument list args, replacing the |
| 405 | current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 406 | execv(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 407 | |
| 408 | def execle(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 409 | """execle(file, *args, env) |
| 410 | |
| 411 | Execute the executable file with argument list args and |
| 412 | environment env, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 413 | env = args[-1] |
| 414 | execve(file, args[:-1], env) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 415 | |
| 416 | def execlp(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 417 | """execlp(file, *args) |
| 418 | |
| 419 | Execute the executable file (which is searched for along $PATH) |
| 420 | with argument list args, replacing the current process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 421 | execvp(file, args) |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 422 | |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 423 | def execlpe(file, *args): |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 424 | """execlpe(file, *args, env) |
| 425 | |
| 426 | Execute the executable file (which is searched for along $PATH) |
| 427 | with argument list args and environment env, replacing the current |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 428 | process. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 429 | env = args[-1] |
| 430 | execvpe(file, args[:-1], env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 431 | |
Guido van Rossum | e65cce5 | 1993-11-08 15:05:21 +0000 | [diff] [blame] | 432 | def execvp(file, args): |
Matthias Klose | a09c54f | 2010-01-31 16:48:44 +0000 | [diff] [blame] | 433 | """execvp(file, args) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 434 | |
| 435 | Execute the executable file (which is searched for along $PATH) |
| 436 | with argument list args, replacing the current process. |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 437 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 438 | _execvpe(file, args) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 439 | |
| 440 | def execvpe(file, args, env): |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 441 | """execvpe(file, args, env) |
Guido van Rossum | 7da3cc5 | 2000-04-25 10:53:22 +0000 | [diff] [blame] | 442 | |
| 443 | Execute the executable file (which is searched for along $PATH) |
| 444 | with argument list args and environment env , replacing the |
| 445 | current process. |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 446 | args may be a list or tuple of strings. """ |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 447 | _execvpe(file, args, env) |
Guido van Rossum | 030afb1 | 1995-03-14 17:27:18 +0000 | [diff] [blame] | 448 | |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 449 | __all__.extend(["execl","execle","execlp","execlpe","execvp","execvpe"]) |
| 450 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 451 | def _execvpe(file, args, env=None): |
| 452 | if env is not None: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 453 | exec_func = execve |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 454 | argrest = (args, env) |
| 455 | else: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 456 | exec_func = execv |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 457 | argrest = (args,) |
| 458 | env = environ |
Guido van Rossum | aed51d8 | 2002-08-05 16:13:24 +0000 | [diff] [blame] | 459 | |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 460 | head, tail = path.split(file) |
| 461 | if head: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 462 | exec_func(file, *argrest) |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 463 | return |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 464 | last_exc = saved_exc = None |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 465 | saved_tb = None |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 466 | path_list = get_exec_path(env) |
| 467 | if name != 'nt': |
| 468 | file = fsencode(file) |
| 469 | path_list = map(fsencode, path_list) |
| 470 | for dir in path_list: |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 471 | fullname = path.join(dir, file) |
| 472 | try: |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 473 | exec_func(fullname, *argrest) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 474 | except error as e: |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 475 | last_exc = e |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 476 | tb = sys.exc_info()[2] |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 477 | if (e.errno != errno.ENOENT and e.errno != errno.ENOTDIR |
Guido van Rossum | 683c0fe | 2002-09-03 16:36:17 +0000 | [diff] [blame] | 478 | and saved_exc is None): |
| 479 | saved_exc = e |
| 480 | saved_tb = tb |
| 481 | if saved_exc: |
Benjamin Peterson | 4b06819 | 2009-02-20 03:19:25 +0000 | [diff] [blame] | 482 | raise saved_exc.with_traceback(saved_tb) |
| 483 | raise last_exc.with_traceback(tb) |
Guido van Rossum | d74fb6b | 2001-03-02 06:43:49 +0000 | [diff] [blame] | 484 | |
Guido van Rossum | cd16bf6 | 2007-06-13 18:07:49 +0000 | [diff] [blame] | 485 | |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 486 | def get_exec_path(env=None): |
| 487 | """Returns the sequence of directories that will be searched for the |
| 488 | named executable (similar to a shell) when launching a process. |
| 489 | |
| 490 | *env* must be an environment variable dict or None. If *env* is None, |
| 491 | os.environ will be used. |
| 492 | """ |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 493 | # Use a local import instead of a global import to limit the number of |
| 494 | # modules loaded at startup: the os module is always loaded at startup by |
| 495 | # Python. It may also avoid a bootstrap issue. |
Victor Stinner | 6f35eda | 2010-10-29 00:38:58 +0000 | [diff] [blame] | 496 | import warnings |
| 497 | |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 498 | if env is None: |
| 499 | env = environ |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 500 | |
Victor Stinner | bb4f218 | 2010-11-07 15:43:39 +0000 | [diff] [blame] | 501 | # {b'PATH': ...}.get('PATH') and {'PATH': ...}.get(b'PATH') emit a |
| 502 | # BytesWarning when using python -b or python -bb: ignore the warning |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 503 | with warnings.catch_warnings(): |
| 504 | warnings.simplefilter("ignore", BytesWarning) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 505 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 506 | try: |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 507 | path_list = env.get('PATH') |
| 508 | except TypeError: |
| 509 | path_list = None |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 510 | |
Victor Stinner | 273b766 | 2010-11-06 12:59:33 +0000 | [diff] [blame] | 511 | if supports_bytes_environ: |
| 512 | try: |
| 513 | path_listb = env[b'PATH'] |
| 514 | except (KeyError, TypeError): |
| 515 | pass |
| 516 | else: |
| 517 | if path_list is not None: |
| 518 | raise ValueError( |
| 519 | "env cannot contain 'PATH' and b'PATH' keys") |
| 520 | path_list = path_listb |
| 521 | |
| 522 | if path_list is not None and isinstance(path_list, bytes): |
| 523 | path_list = fsdecode(path_list) |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 524 | |
| 525 | if path_list is None: |
| 526 | path_list = defpath |
| 527 | return path_list.split(pathsep) |
Gregory P. Smith | b6e8c7e | 2010-02-27 07:22:22 +0000 | [diff] [blame] | 528 | |
| 529 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 530 | # Change environ to automatically call putenv(), unsetenv if they exist. |
Raymond Hettinger | 158c9c2 | 2011-02-22 00:41:50 +0000 | [diff] [blame] | 531 | from collections.abc import MutableMapping |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 532 | |
| 533 | class _Environ(MutableMapping): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 534 | def __init__(self, data, encodekey, decodekey, encodevalue, decodevalue, putenv, unsetenv): |
| 535 | self.encodekey = encodekey |
| 536 | self.decodekey = decodekey |
| 537 | self.encodevalue = encodevalue |
| 538 | self.decodevalue = decodevalue |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 539 | self.putenv = putenv |
| 540 | self.unsetenv = unsetenv |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 541 | self._data = data |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 542 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 543 | def __getitem__(self, key): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 544 | value = self._data[self.encodekey(key)] |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 545 | return self.decodevalue(value) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 546 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 547 | def __setitem__(self, key, value): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 548 | key = self.encodekey(key) |
| 549 | value = self.encodevalue(value) |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 550 | self.putenv(key, value) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 551 | self._data[key] = value |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 552 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 553 | def __delitem__(self, key): |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 554 | key = self.encodekey(key) |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 555 | self.unsetenv(key) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 556 | del self._data[key] |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 557 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 558 | def __iter__(self): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 559 | for key in self._data: |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 560 | yield self.decodekey(key) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 561 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 562 | def __len__(self): |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 563 | return len(self._data) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 564 | |
| 565 | def __repr__(self): |
Victor Stinner | bed7117 | 2010-07-28 21:25:42 +0000 | [diff] [blame] | 566 | return 'environ({{{}}})'.format(', '.join( |
Victor Stinner | d73c1a3 | 2010-07-28 21:23:23 +0000 | [diff] [blame] | 567 | ('{!r}: {!r}'.format(self.decodekey(key), self.decodevalue(value)) |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 568 | for key, value in self._data.items()))) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 569 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 570 | def copy(self): |
| 571 | return dict(self) |
Ezio Melotti | 19e4acf | 2010-02-22 15:59:01 +0000 | [diff] [blame] | 572 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 573 | def setdefault(self, key, value): |
| 574 | if key not in self: |
| 575 | self[key] = value |
| 576 | return self[key] |
| 577 | |
| 578 | try: |
| 579 | _putenv = putenv |
| 580 | except NameError: |
| 581 | _putenv = lambda key, value: None |
Martin v. Löwis | a90f438 | 2001-03-07 09:05:45 +0000 | [diff] [blame] | 582 | else: |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 583 | __all__.append("putenv") |
Guido van Rossum | 3b8e20d | 1996-07-24 00:55:17 +0000 | [diff] [blame] | 584 | |
Skip Montanaro | 289bc05 | 2007-08-17 02:30:27 +0000 | [diff] [blame] | 585 | try: |
| 586 | _unsetenv = unsetenv |
| 587 | except NameError: |
| 588 | _unsetenv = lambda key: _putenv(key, "") |
| 589 | else: |
| 590 | __all__.append("unsetenv") |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 591 | |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 592 | def _createenviron(): |
| 593 | if name in ('os2', 'nt'): |
| 594 | # Where Env Var Names Must Be UPPERCASE |
| 595 | def check_str(value): |
| 596 | if not isinstance(value, str): |
| 597 | raise TypeError("str expected, not %s" % type(value).__name__) |
| 598 | return value |
| 599 | encode = check_str |
| 600 | decode = str |
| 601 | def encodekey(key): |
| 602 | return encode(key).upper() |
| 603 | data = {} |
| 604 | for key, value in environ.items(): |
| 605 | data[encodekey(key)] = value |
| 606 | else: |
| 607 | # Where Env Var Names Can Be Mixed Case |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 608 | encoding = sys.getfilesystemencoding() |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 609 | def encode(value): |
| 610 | if not isinstance(value, str): |
| 611 | raise TypeError("str expected, not %s" % type(value).__name__) |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 612 | return value.encode(encoding, 'surrogateescape') |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 613 | def decode(value): |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 614 | return value.decode(encoding, 'surrogateescape') |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 615 | encodekey = encode |
| 616 | data = environ |
| 617 | return _Environ(data, |
| 618 | encodekey, decode, |
| 619 | encode, decode, |
| 620 | _putenv, _unsetenv) |
Guido van Rossum | c524d95 | 2001-10-19 01:31:59 +0000 | [diff] [blame] | 621 | |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 622 | # unicode environ |
| 623 | environ = _createenviron() |
| 624 | del _createenviron |
Guido van Rossum | 61de0ac | 1997-12-05 21:24:30 +0000 | [diff] [blame] | 625 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 626 | |
Jack Jansen | b11ce9b | 2003-01-08 16:33:40 +0000 | [diff] [blame] | 627 | def getenv(key, default=None): |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 628 | """Get an environment variable, return None if it doesn't exist. |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 629 | The optional second argument can specify an alternate default. |
| 630 | key, default and the result are str.""" |
Tim Peters | 2c60f7a | 2003-01-29 03:49:43 +0000 | [diff] [blame] | 631 | return environ.get(key, default) |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 632 | |
Victor Stinner | b745a74 | 2010-05-18 17:17:23 +0000 | [diff] [blame] | 633 | supports_bytes_environ = name not in ('os2', 'nt') |
| 634 | __all__.extend(("getenv", "supports_bytes_environ")) |
| 635 | |
| 636 | if supports_bytes_environ: |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 637 | def _check_bytes(value): |
| 638 | if not isinstance(value, bytes): |
| 639 | raise TypeError("bytes expected, not %s" % type(value).__name__) |
| 640 | return value |
| 641 | |
| 642 | # bytes environ |
Victor Stinner | 3d75d0c | 2010-09-10 22:18:16 +0000 | [diff] [blame] | 643 | environb = _Environ(environ._data, |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 644 | _check_bytes, bytes, |
| 645 | _check_bytes, bytes, |
| 646 | _putenv, _unsetenv) |
| 647 | del _check_bytes |
| 648 | |
| 649 | def getenvb(key, default=None): |
| 650 | """Get an environment variable, return None if it doesn't exist. |
| 651 | The optional second argument can specify an alternate default. |
| 652 | key, default and the result are bytes.""" |
| 653 | return environb.get(key, default) |
Victor Stinner | 70120e2 | 2010-07-29 17:19:38 +0000 | [diff] [blame] | 654 | |
| 655 | __all__.extend(("environb", "getenvb")) |
Victor Stinner | 84ae118 | 2010-05-06 22:05:07 +0000 | [diff] [blame] | 656 | |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 657 | def _fscodec(): |
| 658 | encoding = sys.getfilesystemencoding() |
| 659 | if encoding == 'mbcs': |
Victor Stinner | e882aac | 2010-10-24 21:12:26 +0000 | [diff] [blame] | 660 | errors = 'strict' |
Victor Stinner | 313a120 | 2010-06-11 23:56:51 +0000 | [diff] [blame] | 661 | else: |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 662 | errors = 'surrogateescape' |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 663 | |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 664 | def fsencode(filename): |
| 665 | """ |
| 666 | Encode filename to the filesystem encoding with 'surrogateescape' error |
| 667 | handler, return bytes unchanged. On Windows, use 'strict' error handler if |
| 668 | the file system encoding is 'mbcs' (which is the default encoding). |
| 669 | """ |
| 670 | if isinstance(filename, bytes): |
| 671 | return filename |
| 672 | elif isinstance(filename, str): |
| 673 | return filename.encode(encoding, errors) |
Victor Stinner | e8d5145 | 2010-08-19 01:05:19 +0000 | [diff] [blame] | 674 | else: |
Victor Stinner | df6d6cb | 2010-10-24 20:32:26 +0000 | [diff] [blame] | 675 | raise TypeError("expect bytes or str, not %s" % type(filename).__name__) |
| 676 | |
| 677 | def fsdecode(filename): |
| 678 | """ |
| 679 | Decode filename from the filesystem encoding with 'surrogateescape' error |
| 680 | handler, return str unchanged. On Windows, use 'strict' error handler if |
| 681 | the file system encoding is 'mbcs' (which is the default encoding). |
| 682 | """ |
| 683 | if isinstance(filename, str): |
| 684 | return filename |
| 685 | elif isinstance(filename, bytes): |
| 686 | return filename.decode(encoding, errors) |
| 687 | else: |
| 688 | raise TypeError("expect bytes or str, not %s" % type(filename).__name__) |
| 689 | |
| 690 | return fsencode, fsdecode |
| 691 | |
| 692 | fsencode, fsdecode = _fscodec() |
| 693 | del _fscodec |
Victor Stinner | 449c466 | 2010-05-08 11:10:09 +0000 | [diff] [blame] | 694 | |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 695 | # Supply spawn*() (probably only for Unix) |
| 696 | if _exists("fork") and not _exists("spawnv") and _exists("execv"): |
| 697 | |
| 698 | P_WAIT = 0 |
| 699 | P_NOWAIT = P_NOWAITO = 1 |
| 700 | |
| 701 | # XXX Should we support P_DETACH? I suppose it could fork()**2 |
| 702 | # and close the std I/O streams. Also, P_OVERLAY is the same |
| 703 | # as execv*()? |
| 704 | |
| 705 | def _spawnvef(mode, file, args, env, func): |
| 706 | # Internal helper; func is the exec*() function to use |
| 707 | pid = fork() |
| 708 | if not pid: |
| 709 | # Child |
| 710 | try: |
| 711 | if env is None: |
| 712 | func(file, args) |
| 713 | else: |
| 714 | func(file, args, env) |
| 715 | except: |
| 716 | _exit(127) |
| 717 | else: |
| 718 | # Parent |
| 719 | if mode == P_NOWAIT: |
| 720 | return pid # Caller is responsible for waiting! |
| 721 | while 1: |
| 722 | wpid, sts = waitpid(pid, 0) |
| 723 | if WIFSTOPPED(sts): |
| 724 | continue |
| 725 | elif WIFSIGNALED(sts): |
| 726 | return -WTERMSIG(sts) |
| 727 | elif WIFEXITED(sts): |
| 728 | return WEXITSTATUS(sts) |
| 729 | else: |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 730 | raise error("Not stopped, signaled or exited???") |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 731 | |
| 732 | def spawnv(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 733 | """spawnv(mode, file, args) -> integer |
| 734 | |
| 735 | Execute file with arguments from args in a subprocess. |
| 736 | If mode == P_NOWAIT return the pid of the process. |
| 737 | 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] | 738 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 739 | return _spawnvef(mode, file, args, None, execv) |
| 740 | |
| 741 | def spawnve(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 742 | """spawnve(mode, file, args, env) -> integer |
| 743 | |
| 744 | Execute file with arguments from args in a subprocess with the |
| 745 | specified environment. |
| 746 | If mode == P_NOWAIT return the pid of the process. |
| 747 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 748 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 749 | return _spawnvef(mode, file, args, env, execve) |
| 750 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 751 | # Note: spawnvp[e] is't currently supported on Windows |
| 752 | |
| 753 | def spawnvp(mode, file, args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 754 | """spawnvp(mode, file, args) -> integer |
| 755 | |
| 756 | Execute file (which is looked for along $PATH) with arguments from |
| 757 | args in a subprocess. |
| 758 | If mode == P_NOWAIT return the pid of the process. |
| 759 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 760 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 761 | return _spawnvef(mode, file, args, None, execvp) |
| 762 | |
| 763 | def spawnvpe(mode, file, args, env): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 764 | """spawnvpe(mode, file, args, env) -> integer |
| 765 | |
| 766 | Execute file (which is looked for along $PATH) with arguments from |
| 767 | args in a subprocess with the supplied environment. |
| 768 | If mode == P_NOWAIT return the pid of the process. |
| 769 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 770 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 771 | return _spawnvef(mode, file, args, env, execvpe) |
| 772 | |
| 773 | if _exists("spawnv"): |
| 774 | # These aren't supplied by the basic Windows code |
| 775 | # but can be easily implemented in Python |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 776 | |
| 777 | def spawnl(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 778 | """spawnl(mode, file, *args) -> integer |
| 779 | |
| 780 | Execute file with arguments from args in a subprocess. |
| 781 | If mode == P_NOWAIT return the pid of the process. |
| 782 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 783 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 784 | return spawnv(mode, file, args) |
| 785 | |
| 786 | def spawnle(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 787 | """spawnle(mode, file, *args, env) -> integer |
| 788 | |
| 789 | Execute file with arguments from args in a subprocess with the |
| 790 | supplied environment. |
| 791 | If mode == P_NOWAIT return the pid of the process. |
| 792 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 793 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 794 | env = args[-1] |
| 795 | return spawnve(mode, file, args[:-1], env) |
| 796 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 797 | |
| 798 | __all__.extend(["spawnv", "spawnve", "spawnl", "spawnle",]) |
| 799 | |
| 800 | |
Guido van Rossum | dd7cbbf | 1999-11-02 20:44:07 +0000 | [diff] [blame] | 801 | if _exists("spawnvp"): |
| 802 | # At the moment, Windows doesn't implement spawnvp[e], |
| 803 | # so it won't have spawnlp[e] either. |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 804 | def spawnlp(mode, file, *args): |
Neal Norwitz | b7f6810 | 2003-07-02 02:49:33 +0000 | [diff] [blame] | 805 | """spawnlp(mode, file, *args) -> integer |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 806 | |
| 807 | Execute file (which is looked for along $PATH) with arguments from |
| 808 | args in a subprocess with the supplied environment. |
| 809 | If mode == P_NOWAIT return the pid of the process. |
| 810 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 811 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 812 | return spawnvp(mode, file, args) |
| 813 | |
| 814 | def spawnlpe(mode, file, *args): |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 815 | """spawnlpe(mode, file, *args, env) -> integer |
| 816 | |
| 817 | Execute file (which is looked for along $PATH) with arguments from |
| 818 | args in a subprocess with the supplied environment. |
| 819 | If mode == P_NOWAIT return the pid of the process. |
| 820 | If mode == P_WAIT return the process's exit code if it exits normally; |
| 821 | otherwise return -SIG, where SIG is the signal that killed it. """ |
Guido van Rossum | 5a2ca93 | 1999-11-02 13:27:32 +0000 | [diff] [blame] | 822 | env = args[-1] |
| 823 | return spawnvpe(mode, file, args[:-1], env) |
Guido van Rossum | e0cd291 | 2000-04-21 18:35:36 +0000 | [diff] [blame] | 824 | |
| 825 | |
Andrew MacIntyre | 69e18c9 | 2004-04-04 07:11:43 +0000 | [diff] [blame] | 826 | __all__.extend(["spawnvp", "spawnvpe", "spawnlp", "spawnlpe",]) |
Skip Montanaro | 269b83b | 2001-02-06 01:07:02 +0000 | [diff] [blame] | 827 | |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 828 | import copyreg as _copyreg |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 829 | |
| 830 | def _make_stat_result(tup, dict): |
| 831 | return stat_result(tup, dict) |
| 832 | |
| 833 | def _pickle_stat_result(sr): |
| 834 | (type, args) = sr.__reduce__() |
| 835 | return (_make_stat_result, args) |
| 836 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 837 | try: |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 838 | _copyreg.pickle(stat_result, _pickle_stat_result, _make_stat_result) |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 839 | except NameError: # stat_result may not exist |
| 840 | pass |
Michael W. Hudson | 0e02530 | 2002-03-06 17:11:18 +0000 | [diff] [blame] | 841 | |
| 842 | def _make_statvfs_result(tup, dict): |
| 843 | return statvfs_result(tup, dict) |
| 844 | |
| 845 | def _pickle_statvfs_result(sr): |
| 846 | (type, args) = sr.__reduce__() |
| 847 | return (_make_statvfs_result, args) |
| 848 | |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 849 | try: |
Alexandre Vassalotti | f7fa63d | 2008-05-11 08:55:36 +0000 | [diff] [blame] | 850 | _copyreg.pickle(statvfs_result, _pickle_statvfs_result, |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 851 | _make_statvfs_result) |
Michael W. Hudson | e5363b7 | 2002-03-15 10:21:59 +0000 | [diff] [blame] | 852 | except NameError: # statvfs_result may not exist |
Michael W. Hudson | ce00b73 | 2002-03-15 10:18:58 +0000 | [diff] [blame] | 853 | pass |
Martin v. Löwis | dc3883f | 2004-08-29 15:46:35 +0000 | [diff] [blame] | 854 | |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 855 | # Supply os.popen() |
Antoine Pitrou | 877766d | 2011-03-19 17:00:37 +0100 | [diff] [blame] | 856 | def popen(cmd, mode="r", buffering=-1): |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 857 | if not isinstance(cmd, str): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 858 | raise TypeError("invalid cmd type (%s, expected string)" % type(cmd)) |
| 859 | if mode not in ("r", "w"): |
| 860 | raise ValueError("invalid mode %r" % mode) |
Antoine Pitrou | 877766d | 2011-03-19 17:00:37 +0100 | [diff] [blame] | 861 | if buffering == 0 or buffering == None: |
| 862 | raise ValueError("popen() does not support unbuffered streams") |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 863 | import subprocess, io |
| 864 | if mode == "r": |
| 865 | proc = subprocess.Popen(cmd, |
| 866 | shell=True, |
| 867 | stdout=subprocess.PIPE, |
| 868 | bufsize=buffering) |
| 869 | return _wrap_close(io.TextIOWrapper(proc.stdout), proc) |
| 870 | else: |
| 871 | proc = subprocess.Popen(cmd, |
| 872 | shell=True, |
| 873 | stdin=subprocess.PIPE, |
| 874 | bufsize=buffering) |
| 875 | return _wrap_close(io.TextIOWrapper(proc.stdin), proc) |
| 876 | |
| 877 | # Helper for popen() -- a proxy for a file whose close waits for the process |
| 878 | class _wrap_close: |
| 879 | def __init__(self, stream, proc): |
| 880 | self._stream = stream |
| 881 | self._proc = proc |
| 882 | def close(self): |
| 883 | self._stream.close() |
Amaury Forgeot d'Arc | 97e5f28 | 2009-07-11 09:35:13 +0000 | [diff] [blame] | 884 | returncode = self._proc.wait() |
| 885 | if returncode == 0: |
| 886 | return None |
| 887 | if name == 'nt': |
| 888 | return returncode |
| 889 | else: |
| 890 | return returncode << 8 # Shift left to match old behavior |
Antoine Pitrou | ac62535 | 2009-12-09 00:01:27 +0000 | [diff] [blame] | 891 | def __enter__(self): |
| 892 | return self |
| 893 | def __exit__(self, *args): |
| 894 | self.close() |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 895 | def __getattr__(self, name): |
| 896 | return getattr(self._stream, name) |
Thomas Heller | 476157b | 2007-09-04 11:27:47 +0000 | [diff] [blame] | 897 | def __iter__(self): |
| 898 | return iter(self._stream) |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 899 | |
Amaury Forgeot d'Arc | bdbddf8 | 2008-08-01 00:06:49 +0000 | [diff] [blame] | 900 | # Supply os.fdopen() |
| 901 | def fdopen(fd, *args, **kwargs): |
Guido van Rossum | c2f93dc | 2007-05-24 00:50:02 +0000 | [diff] [blame] | 902 | if not isinstance(fd, int): |
| 903 | raise TypeError("invalid fd type (%s, expected integer)" % type(fd)) |
| 904 | import io |
Amaury Forgeot d'Arc | bdbddf8 | 2008-08-01 00:06:49 +0000 | [diff] [blame] | 905 | return io.open(fd, *args, **kwargs) |