Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 1 | """Common operations on Posix pathnames. |
| 2 | |
| 3 | Instead of importing this module directly, import os and refer to |
| 4 | this module as os.path. The "os.path" name is an alias for this |
| 5 | module on Posix systems; on other systems (e.g. Mac, Windows), |
| 6 | os.path provides the same operations in a manner specific to that |
| 7 | platform, and is an alias to another module (e.g. macpath, ntpath). |
| 8 | |
| 9 | Some of this can actually be useful on non-Posix systems too, e.g. |
| 10 | for manipulation of the pathname component of URLs. |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 11 | """ |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 12 | |
Guido van Rossum | d3876d3 | 1996-07-23 03:47:28 +0000 | [diff] [blame] | 13 | import os |
Guido van Rossum | 40d9304 | 1990-10-21 16:17:34 +0000 | [diff] [blame] | 14 | import stat |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 15 | |
Skip Montanaro | c62c81e | 2001-02-12 02:00:42 +0000 | [diff] [blame] | 16 | __all__ = ["normcase","isabs","join","splitdrive","split","splitext", |
| 17 | "basename","dirname","commonprefix","getsize","getmtime", |
Martin v. Löwis | 96a60e4 | 2002-12-31 13:11:54 +0000 | [diff] [blame] | 18 | "getatime","getctime","islink","exists","isdir","isfile","ismount", |
Skip Montanaro | c62c81e | 2001-02-12 02:00:42 +0000 | [diff] [blame] | 19 | "walk","expanduser","expandvars","normpath","abspath", |
Neal Norwitz | 61cdac6 | 2003-01-03 18:01:57 +0000 | [diff] [blame] | 20 | "samefile","sameopenfile","samestat", |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 21 | "curdir","pardir","sep","pathsep","defpath","altsep","extsep", |
Martin v. Löwis | bdec50f | 2004-06-08 08:29:33 +0000 | [diff] [blame] | 22 | "devnull","realpath","supports_unicode_filenames"] |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 23 | |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 24 | # strings representing various path-related bits and pieces |
| 25 | curdir = '.' |
| 26 | pardir = '..' |
| 27 | extsep = '.' |
| 28 | sep = '/' |
| 29 | pathsep = ':' |
| 30 | defpath = ':/bin:/usr/bin' |
| 31 | altsep = None |
Martin v. Löwis | bdec50f | 2004-06-08 08:29:33 +0000 | [diff] [blame] | 32 | devnull = '/dev/null' |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 33 | |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 34 | # Normalize the case of a pathname. Trivial in Posix, string.lower on Mac. |
| 35 | # On MS-DOS this may also turn slashes into backslashes; however, other |
| 36 | # normalizations (such as optimizing '../' away) are not allowed |
| 37 | # (another function should be defined to do that). |
| 38 | |
| 39 | def normcase(s): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 40 | """Normalize case of pathname. Has no effect under Posix""" |
| 41 | return s |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 42 | |
| 43 | |
Jeremy Hylton | a05e293 | 2000-06-28 14:48:01 +0000 | [diff] [blame] | 44 | # Return whether a path is absolute. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 45 | # Trivial in Posix, harder on the Mac or MS-DOS. |
| 46 | |
| 47 | def isabs(s): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 48 | """Test whether a path is absolute""" |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 49 | return s.startswith('/') |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 50 | |
| 51 | |
Barry Warsaw | 384d249 | 1997-02-18 21:53:25 +0000 | [diff] [blame] | 52 | # Join pathnames. |
| 53 | # Ignore the previous parts if a part is absolute. |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 54 | # Insert a '/' unless the first part is empty or already ends in '/'. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 55 | |
Barry Warsaw | 384d249 | 1997-02-18 21:53:25 +0000 | [diff] [blame] | 56 | def join(a, *p): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 57 | """Join two or more pathname components, inserting '/' as needed""" |
| 58 | path = a |
| 59 | for b in p: |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 60 | if b.startswith('/'): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 61 | path = b |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 62 | elif path == '' or path.endswith('/'): |
| 63 | path += b |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 64 | else: |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 65 | path += '/' + b |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 66 | return path |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 67 | |
| 68 | |
Guido van Rossum | 2684738 | 1992-03-31 18:54:35 +0000 | [diff] [blame] | 69 | # Split a path in head (everything up to the last '/') and tail (the |
Guido van Rossum | a89b1ba | 1995-09-01 20:32:21 +0000 | [diff] [blame] | 70 | # rest). If the path ends in '/', tail will be empty. If there is no |
| 71 | # '/' in the path, head will be empty. |
| 72 | # Trailing '/'es are stripped from head unless it is the root. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 73 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 74 | def split(p): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 75 | """Split a pathname. Returns tuple "(head, tail)" where "tail" is |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 76 | everything after the final slash. Either part may be empty.""" |
Fred Drake | 22fb839 | 2000-09-28 15:04:39 +0000 | [diff] [blame] | 77 | i = p.rfind('/') + 1 |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 78 | head, tail = p[:i], p[i:] |
Fred Drake | 8152d32 | 2000-12-12 23:20:45 +0000 | [diff] [blame] | 79 | if head and head != '/'*len(head): |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 80 | head = head.rstrip('/') |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 81 | return head, tail |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 82 | |
| 83 | |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 84 | # Split a path in root and extension. |
Guido van Rossum | 422869a | 1996-08-20 20:24:17 +0000 | [diff] [blame] | 85 | # The extension is everything starting at the last dot in the last |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 86 | # pathname component; the root is everything before that. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 87 | # It is always true that root + ext == p. |
| 88 | |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 89 | def splitext(p): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 90 | """Split the extension from a pathname. Extension is everything from the |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 91 | last dot to the end. Returns "(root, ext)", either part may be empty.""" |
Martin v. Löwis | de33379 | 2002-12-12 20:30:20 +0000 | [diff] [blame] | 92 | i = p.rfind('.') |
| 93 | if i<=p.rfind('/'): |
| 94 | return p, '' |
| 95 | else: |
| 96 | return p[:i], p[i:] |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 97 | |
| 98 | |
Guido van Rossum | 221df24 | 1995-08-07 20:17:55 +0000 | [diff] [blame] | 99 | # Split a pathname into a drive specification and the rest of the |
| 100 | # path. Useful on DOS/Windows/NT; on Unix, the drive is always empty. |
| 101 | |
| 102 | def splitdrive(p): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 103 | """Split a pathname into drive and path. On Posix, drive is always |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 104 | empty.""" |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 105 | return '', p |
Guido van Rossum | 221df24 | 1995-08-07 20:17:55 +0000 | [diff] [blame] | 106 | |
| 107 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 108 | # Return the tail (basename) part of a path. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 109 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 110 | def basename(p): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 111 | """Returns the final component of a pathname""" |
| 112 | return split(p)[1] |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 113 | |
| 114 | |
Guido van Rossum | c629d34 | 1992-11-05 10:43:02 +0000 | [diff] [blame] | 115 | # Return the head (dirname) part of a path. |
| 116 | |
| 117 | def dirname(p): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 118 | """Returns the directory component of a pathname""" |
| 119 | return split(p)[0] |
Guido van Rossum | c629d34 | 1992-11-05 10:43:02 +0000 | [diff] [blame] | 120 | |
| 121 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 122 | # Return the longest prefix of all list elements. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 123 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 124 | def commonprefix(m): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 125 | "Given a list of pathnames, returns the longest common leading component" |
| 126 | if not m: return '' |
Raymond Hettinger | 74bb7f0 | 2003-12-31 22:44:29 +0000 | [diff] [blame] | 127 | s1 = min(m) |
| 128 | s2 = max(m) |
| 129 | n = min(len(s1), len(s2)) |
| 130 | for i in xrange(n): |
| 131 | if s1[i] != s2[i]: |
| 132 | return s1[:i] |
| 133 | return s1[:n] |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 134 | |
Guido van Rossum | 2bc1f8f | 1998-07-24 20:49:26 +0000 | [diff] [blame] | 135 | # Get size, mtime, atime of files. |
| 136 | |
| 137 | def getsize(filename): |
| 138 | """Return the size of a file, reported by os.stat().""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 139 | return os.stat(filename).st_size |
Guido van Rossum | 2bc1f8f | 1998-07-24 20:49:26 +0000 | [diff] [blame] | 140 | |
| 141 | def getmtime(filename): |
| 142 | """Return the last modification time of a file, reported by os.stat().""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 143 | return os.stat(filename).st_mtime |
Guido van Rossum | 2bc1f8f | 1998-07-24 20:49:26 +0000 | [diff] [blame] | 144 | |
| 145 | def getatime(filename): |
| 146 | """Return the last access time of a file, reported by os.stat().""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 147 | return os.stat(filename).st_atime |
Guido van Rossum | 2bc1f8f | 1998-07-24 20:49:26 +0000 | [diff] [blame] | 148 | |
Martin v. Löwis | 96a60e4 | 2002-12-31 13:11:54 +0000 | [diff] [blame] | 149 | def getctime(filename): |
Fred Drake | 1cd6e4d | 2004-05-12 03:51:40 +0000 | [diff] [blame] | 150 | """Return the metadata change time of a file, reported by os.stat().""" |
Martin v. Löwis | 96a60e4 | 2002-12-31 13:11:54 +0000 | [diff] [blame] | 151 | return os.stat(filename).st_ctime |
Guido van Rossum | 2bc1f8f | 1998-07-24 20:49:26 +0000 | [diff] [blame] | 152 | |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 153 | # Is a path a symbolic link? |
Guido van Rossum | d3876d3 | 1996-07-23 03:47:28 +0000 | [diff] [blame] | 154 | # This will always return false on systems where os.lstat doesn't exist. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 155 | |
| 156 | def islink(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 157 | """Test whether a path is a symbolic link""" |
| 158 | try: |
| 159 | st = os.lstat(path) |
| 160 | except (os.error, AttributeError): |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 161 | return False |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 162 | return stat.S_ISLNK(st.st_mode) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 163 | |
| 164 | |
| 165 | # Does a path exist? |
| 166 | # This is false for dangling symbolic links. |
| 167 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 168 | def exists(path): |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 169 | """Test whether a path exists. Returns False for broken symbolic links""" |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 170 | try: |
| 171 | st = os.stat(path) |
| 172 | except os.error: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 173 | return False |
| 174 | return True |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 175 | |
| 176 | |
Guido van Rossum | d3876d3 | 1996-07-23 03:47:28 +0000 | [diff] [blame] | 177 | # Is a path a directory? |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 178 | # This follows symbolic links, so both islink() and isdir() can be true |
| 179 | # for the same path. |
| 180 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 181 | def isdir(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 182 | """Test whether a path is a directory""" |
| 183 | try: |
| 184 | st = os.stat(path) |
| 185 | except os.error: |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 186 | return False |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 187 | return stat.S_ISDIR(st.st_mode) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 188 | |
| 189 | |
Guido van Rossum | 2684738 | 1992-03-31 18:54:35 +0000 | [diff] [blame] | 190 | # Is a path a regular file? |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 191 | # This follows symbolic links, so both islink() and isfile() can be true |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 192 | # for the same path. |
| 193 | |
| 194 | def isfile(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 195 | """Test whether a path is a regular file""" |
| 196 | try: |
| 197 | st = os.stat(path) |
| 198 | except os.error: |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 199 | return False |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 200 | return stat.S_ISREG(st.st_mode) |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 201 | |
| 202 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 203 | # Are two filenames really pointing to the same file? |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 204 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 205 | def samefile(f1, f2): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 206 | """Test whether two pathnames reference the same actual file""" |
| 207 | s1 = os.stat(f1) |
| 208 | s2 = os.stat(f2) |
| 209 | return samestat(s1, s2) |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 210 | |
| 211 | |
| 212 | # Are two open files really referencing the same file? |
| 213 | # (Not necessarily the same file descriptor!) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 214 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 215 | def sameopenfile(fp1, fp2): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 216 | """Test whether two open file objects reference the same file""" |
| 217 | s1 = os.fstat(fp1) |
| 218 | s2 = os.fstat(fp2) |
| 219 | return samestat(s1, s2) |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 220 | |
| 221 | |
| 222 | # Are two stat buffers (obtained from stat, fstat or lstat) |
| 223 | # describing the same file? |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 224 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 225 | def samestat(s1, s2): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 226 | """Test whether two stat buffers reference the same file""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 227 | return s1.st_ino == s2.st_ino and \ |
| 228 | s1.st_dev == s2.st_dev |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 229 | |
| 230 | |
| 231 | # Is a path a mount point? |
Guido van Rossum | d3876d3 | 1996-07-23 03:47:28 +0000 | [diff] [blame] | 232 | # (Does this work for all UNIXes? Is it even guaranteed to work by Posix?) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 233 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 234 | def ismount(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 235 | """Test whether a path is a mount point""" |
| 236 | try: |
| 237 | s1 = os.stat(path) |
| 238 | s2 = os.stat(join(path, '..')) |
| 239 | except os.error: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 240 | return False # It doesn't exist -- so not a mount point :-) |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 241 | dev1 = s1.st_dev |
| 242 | dev2 = s2.st_dev |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 243 | if dev1 != dev2: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 244 | return True # path/.. on a different device as path |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 245 | ino1 = s1.st_ino |
| 246 | ino2 = s2.st_ino |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 247 | if ino1 == ino2: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 248 | return True # path/.. is the same i-node as path |
| 249 | return False |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 250 | |
| 251 | |
| 252 | # Directory tree walk. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 253 | # For each directory under top (including top itself, but excluding |
| 254 | # '.' and '..'), func(arg, dirname, filenames) is called, where |
| 255 | # dirname is the name of the directory and filenames is the list |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 256 | # of files (and subdirectories etc.) in the directory. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 257 | # The func may modify the filenames list, to implement a filter, |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 258 | # or to impose a different order of visiting. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 259 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 260 | def walk(top, func, arg): |
Tim Peters | cf5e6a4 | 2001-10-10 04:16:20 +0000 | [diff] [blame] | 261 | """Directory tree walk with callback function. |
| 262 | |
| 263 | For each directory in the directory tree rooted at top (including top |
| 264 | itself, but excluding '.' and '..'), call func(arg, dirname, fnames). |
| 265 | dirname is the name of the directory, and fnames a list of the names of |
| 266 | the files and subdirectories in dirname (excluding '.' and '..'). func |
| 267 | may modify the fnames list in-place (e.g. via del or slice assignment), |
| 268 | and walk will only recurse into the subdirectories whose names remain in |
| 269 | fnames; this can be used to implement a filter, or to impose a specific |
| 270 | order of visiting. No semantics are defined for, or required of, arg, |
| 271 | beyond that arg is always passed to func. It can be used, e.g., to pass |
| 272 | a filename pattern, or a mutable object designed to accumulate |
| 273 | statistics. Passing None for arg is common.""" |
| 274 | |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 275 | try: |
| 276 | names = os.listdir(top) |
| 277 | except os.error: |
| 278 | return |
| 279 | func(arg, top, names) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 280 | for name in names: |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 281 | name = join(top, name) |
Guido van Rossum | a490d58 | 2001-04-16 18:12:04 +0000 | [diff] [blame] | 282 | try: |
| 283 | st = os.lstat(name) |
| 284 | except os.error: |
| 285 | continue |
Neal Norwitz | ec7cf13 | 2002-06-06 18:16:14 +0000 | [diff] [blame] | 286 | if stat.S_ISDIR(st.st_mode): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 287 | walk(name, func, arg) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 288 | |
| 289 | |
| 290 | # Expand paths beginning with '~' or '~user'. |
| 291 | # '~' means $HOME; '~user' means that user's home directory. |
| 292 | # If the path doesn't begin with '~', or if the user or $HOME is unknown, |
| 293 | # the path is returned unchanged (leaving error reporting to whatever |
| 294 | # function is called with the expanded path as argument). |
| 295 | # See also module 'glob' for expansion of *, ? and [...] in pathnames. |
| 296 | # (A function should also be defined to do full *sh-style environment |
| 297 | # variable expansion.) |
| 298 | |
| 299 | def expanduser(path): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 300 | """Expand ~ and ~user constructions. If user or $HOME is unknown, |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 301 | do nothing.""" |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 302 | if not path.startswith('~'): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 303 | return path |
Walter Dörwald | a9da5ae | 2003-06-19 10:21:14 +0000 | [diff] [blame] | 304 | i = path.find('/', 1) |
| 305 | if i < 0: |
| 306 | i = len(path) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 307 | if i == 1: |
Walter Dörwald | a9da5ae | 2003-06-19 10:21:14 +0000 | [diff] [blame] | 308 | if 'HOME' not in os.environ: |
Neal Norwitz | 609ba81 | 2002-09-05 21:08:25 +0000 | [diff] [blame] | 309 | import pwd |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 310 | userhome = pwd.getpwuid(os.getuid()).pw_dir |
Neal Norwitz | 609ba81 | 2002-09-05 21:08:25 +0000 | [diff] [blame] | 311 | else: |
| 312 | userhome = os.environ['HOME'] |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 313 | else: |
| 314 | import pwd |
| 315 | try: |
| 316 | pwent = pwd.getpwnam(path[1:i]) |
| 317 | except KeyError: |
| 318 | return path |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 319 | userhome = pwent.pw_dir |
| 320 | if userhome.endswith('/'): |
| 321 | i += 1 |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 322 | return userhome + path[i:] |
Guido van Rossum | 4732ccf | 1992-08-09 13:54:50 +0000 | [diff] [blame] | 323 | |
| 324 | |
| 325 | # Expand paths containing shell variable substitutions. |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 326 | # This expands the forms $variable and ${variable} only. |
Jeremy Hylton | a05e293 | 2000-06-28 14:48:01 +0000 | [diff] [blame] | 327 | # Non-existent variables are left unchanged. |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 328 | |
| 329 | _varprog = None |
Guido van Rossum | 4732ccf | 1992-08-09 13:54:50 +0000 | [diff] [blame] | 330 | |
| 331 | def expandvars(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 332 | """Expand shell variables of form $var and ${var}. Unknown variables |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 333 | are left unchanged.""" |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 334 | global _varprog |
| 335 | if '$' not in path: |
| 336 | return path |
| 337 | if not _varprog: |
| 338 | import re |
| 339 | _varprog = re.compile(r'\$(\w+|\{[^}]*\})') |
| 340 | i = 0 |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 341 | while True: |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 342 | m = _varprog.search(path, i) |
| 343 | if not m: |
| 344 | break |
| 345 | i, j = m.span(0) |
| 346 | name = m.group(1) |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 347 | if name.startswith('{') and name.endswith('}'): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 348 | name = name[1:-1] |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 349 | if name in os.environ: |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 350 | tail = path[j:] |
| 351 | path = path[:i] + os.environ[name] |
| 352 | i = len(path) |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 353 | path += tail |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 354 | else: |
| 355 | i = j |
| 356 | return path |
Guido van Rossum | c629d34 | 1992-11-05 10:43:02 +0000 | [diff] [blame] | 357 | |
| 358 | |
| 359 | # Normalize a path, e.g. A//B, A/./B and A/foo/../B all become A/B. |
| 360 | # It should be understood that this may change the meaning of the path |
| 361 | # if it contains symbolic links! |
| 362 | |
| 363 | def normpath(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 364 | """Normalize path, eliminating double slashes, etc.""" |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 365 | if path == '': |
| 366 | return '.' |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 367 | initial_slashes = path.startswith('/') |
| 368 | # POSIX allows one or two initial slashes, but treats three or more |
| 369 | # as single slash. |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 370 | if (initial_slashes and |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 371 | path.startswith('//') and not path.startswith('///')): |
| 372 | initial_slashes = 2 |
Fred Drake | 22fb839 | 2000-09-28 15:04:39 +0000 | [diff] [blame] | 373 | comps = path.split('/') |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 374 | new_comps = [] |
| 375 | for comp in comps: |
| 376 | if comp in ('', '.'): |
| 377 | continue |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 378 | if (comp != '..' or (not initial_slashes and not new_comps) or |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 379 | (new_comps and new_comps[-1] == '..')): |
| 380 | new_comps.append(comp) |
| 381 | elif new_comps: |
| 382 | new_comps.pop() |
| 383 | comps = new_comps |
Fred Drake | 22fb839 | 2000-09-28 15:04:39 +0000 | [diff] [blame] | 384 | path = '/'.join(comps) |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 385 | if initial_slashes: |
| 386 | path = '/'*initial_slashes + path |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 387 | return path or '.' |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 388 | |
| 389 | |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 390 | def abspath(path): |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 391 | """Return an absolute path.""" |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 392 | if not isabs(path): |
| 393 | path = join(os.getcwd(), path) |
| 394 | return normpath(path) |
Guido van Rossum | 83eeef4 | 2001-09-17 15:16:09 +0000 | [diff] [blame] | 395 | |
| 396 | |
| 397 | # Return a canonical path (i.e. the absolute location of a file on the |
| 398 | # filesystem). |
| 399 | |
| 400 | def realpath(filename): |
| 401 | """Return the canonical path of the specified filename, eliminating any |
| 402 | symbolic links encountered in the path.""" |
| 403 | filename = abspath(filename) |
| 404 | |
| 405 | bits = ['/'] + filename.split('/')[1:] |
| 406 | for i in range(2, len(bits)+1): |
| 407 | component = join(*bits[0:i]) |
| 408 | if islink(component): |
| 409 | resolved = os.readlink(component) |
| 410 | (dir, file) = split(component) |
| 411 | resolved = normpath(join(dir, resolved)) |
| 412 | newpath = join(*([resolved] + bits[i:])) |
| 413 | return realpath(newpath) |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 414 | |
Guido van Rossum | 83eeef4 | 2001-09-17 15:16:09 +0000 | [diff] [blame] | 415 | return filename |
Mark Hammond | 8696ebc | 2002-10-08 02:44:31 +0000 | [diff] [blame] | 416 | |
Just van Rossum | 2d4e988 | 2003-07-17 15:11:49 +0000 | [diff] [blame] | 417 | supports_unicode_filenames = False |