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 | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 14 | import sys |
Guido van Rossum | 40d9304 | 1990-10-21 16:17:34 +0000 | [diff] [blame] | 15 | import stat |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 16 | import genericpath |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 17 | from genericpath import * |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 18 | |
Skip Montanaro | c62c81e | 2001-02-12 02:00:42 +0000 | [diff] [blame] | 19 | __all__ = ["normcase","isabs","join","splitdrive","split","splitext", |
| 20 | "basename","dirname","commonprefix","getsize","getmtime", |
Georg Brandl | f0de6a1 | 2005-08-22 18:02:59 +0000 | [diff] [blame] | 21 | "getatime","getctime","islink","exists","lexists","isdir","isfile", |
Benjamin Peterson | d71ca41 | 2008-05-08 23:44:58 +0000 | [diff] [blame] | 22 | "ismount", "expanduser","expandvars","normpath","abspath", |
Neal Norwitz | 61cdac6 | 2003-01-03 18:01:57 +0000 | [diff] [blame] | 23 | "samefile","sameopenfile","samestat", |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 24 | "curdir","pardir","sep","pathsep","defpath","altsep","extsep", |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 25 | "devnull","realpath","supports_unicode_filenames","relpath"] |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 26 | |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 27 | # Strings representing various path-related bits and pieces. |
| 28 | # These are primarily for export; internally, they are hardcoded. |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 29 | curdir = '.' |
| 30 | pardir = '..' |
| 31 | extsep = '.' |
| 32 | sep = '/' |
| 33 | pathsep = ':' |
| 34 | defpath = ':/bin:/usr/bin' |
| 35 | altsep = None |
Martin v. Löwis | bdec50f | 2004-06-08 08:29:33 +0000 | [diff] [blame] | 36 | devnull = '/dev/null' |
Skip Montanaro | 117910d | 2003-02-14 19:35:31 +0000 | [diff] [blame] | 37 | |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 38 | def _get_sep(path): |
| 39 | if isinstance(path, bytes): |
| 40 | return b'/' |
| 41 | else: |
| 42 | return '/' |
| 43 | |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 44 | # Normalize the case of a pathname. Trivial in Posix, string.lower on Mac. |
| 45 | # On MS-DOS this may also turn slashes into backslashes; however, other |
| 46 | # normalizations (such as optimizing '../' away) are not allowed |
| 47 | # (another function should be defined to do that). |
| 48 | |
| 49 | def normcase(s): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 50 | """Normalize case of pathname. Has no effect under Posix""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 51 | # TODO: on Mac OS X, this should really return s.lower(). |
Ezio Melotti | 5a3ef5b | 2010-06-25 10:56:11 +0000 | [diff] [blame] | 52 | if not isinstance(s, (bytes, str)): |
| 53 | raise TypeError("normcase() argument must be str or bytes, " |
| 54 | "not '{}'".format(s.__class__.__name__)) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 55 | return s |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 56 | |
| 57 | |
Jeremy Hylton | a05e293 | 2000-06-28 14:48:01 +0000 | [diff] [blame] | 58 | # Return whether a path is absolute. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 59 | # Trivial in Posix, harder on the Mac or MS-DOS. |
| 60 | |
| 61 | def isabs(s): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 62 | """Test whether a path is absolute""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 63 | sep = _get_sep(s) |
| 64 | return s.startswith(sep) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 65 | |
| 66 | |
Barry Warsaw | 384d249 | 1997-02-18 21:53:25 +0000 | [diff] [blame] | 67 | # Join pathnames. |
| 68 | # Ignore the previous parts if a part is absolute. |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 69 | # 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] | 70 | |
Barry Warsaw | 384d249 | 1997-02-18 21:53:25 +0000 | [diff] [blame] | 71 | def join(a, *p): |
Guido van Rossum | 04110fb | 2007-08-24 16:32:05 +0000 | [diff] [blame] | 72 | """Join two or more pathname components, inserting '/' as needed. |
| 73 | If any component is an absolute path, all previous path components |
R David Murray | e3de175 | 2012-07-21 14:33:56 -0400 | [diff] [blame] | 74 | will be discarded. An empty last part will result in a path that |
| 75 | ends with a separator.""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 76 | sep = _get_sep(a) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 77 | path = a |
Hynek Schlawack | 4774946 | 2012-07-15 16:21:30 +0200 | [diff] [blame] | 78 | try: |
| 79 | for b in p: |
| 80 | if b.startswith(sep): |
| 81 | path = b |
| 82 | elif not path or path.endswith(sep): |
| 83 | path += b |
| 84 | else: |
| 85 | path += sep + b |
| 86 | except TypeError: |
Hynek Schlawack | c5a4566 | 2012-07-17 13:05:43 +0200 | [diff] [blame] | 87 | valid_types = all(isinstance(s, (str, bytes, bytearray)) |
| 88 | for s in (a, ) + p) |
| 89 | if valid_types: |
| 90 | # Must have a mixture of text and binary data |
Hynek Schlawack | 4774946 | 2012-07-15 16:21:30 +0200 | [diff] [blame] | 91 | raise TypeError("Can't mix strings and bytes in path components.") |
Hynek Schlawack | c5a4566 | 2012-07-17 13:05:43 +0200 | [diff] [blame] | 92 | raise |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 93 | return path |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 94 | |
| 95 | |
Guido van Rossum | 2684738 | 1992-03-31 18:54:35 +0000 | [diff] [blame] | 96 | # 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] | 97 | # rest). If the path ends in '/', tail will be empty. If there is no |
| 98 | # '/' in the path, head will be empty. |
| 99 | # Trailing '/'es are stripped from head unless it is the root. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 100 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 101 | def split(p): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 102 | """Split a pathname. Returns tuple "(head, tail)" where "tail" is |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 103 | everything after the final slash. Either part may be empty.""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 104 | sep = _get_sep(p) |
| 105 | i = p.rfind(sep) + 1 |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 106 | head, tail = p[:i], p[i:] |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 107 | if head and head != sep*len(head): |
| 108 | head = head.rstrip(sep) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 109 | return head, tail |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 110 | |
| 111 | |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 112 | # Split a path in root and extension. |
Guido van Rossum | 422869a | 1996-08-20 20:24:17 +0000 | [diff] [blame] | 113 | # 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] | 114 | # pathname component; the root is everything before that. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 115 | # It is always true that root + ext == p. |
| 116 | |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 117 | def splitext(p): |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 118 | if isinstance(p, bytes): |
| 119 | sep = b'/' |
| 120 | extsep = b'.' |
| 121 | else: |
| 122 | sep = '/' |
| 123 | extsep = '.' |
| 124 | return genericpath._splitext(p, sep, None, extsep) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 125 | splitext.__doc__ = genericpath._splitext.__doc__ |
Guido van Rossum | 4d0fdc3 | 1991-08-16 13:27:58 +0000 | [diff] [blame] | 126 | |
Guido van Rossum | 221df24 | 1995-08-07 20:17:55 +0000 | [diff] [blame] | 127 | # Split a pathname into a drive specification and the rest of the |
| 128 | # path. Useful on DOS/Windows/NT; on Unix, the drive is always empty. |
| 129 | |
| 130 | def splitdrive(p): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 131 | """Split a pathname into drive and path. On Posix, drive is always |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 132 | empty.""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 133 | return p[:0], p |
Guido van Rossum | 221df24 | 1995-08-07 20:17:55 +0000 | [diff] [blame] | 134 | |
| 135 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 136 | # Return the tail (basename) part of a path, same as split(path)[1]. |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 137 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 138 | def basename(p): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 139 | """Returns the final component of a pathname""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 140 | sep = _get_sep(p) |
| 141 | i = p.rfind(sep) + 1 |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 142 | return p[i:] |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 143 | |
| 144 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 145 | # Return the head (dirname) part of a path, same as split(path)[0]. |
Guido van Rossum | c629d34 | 1992-11-05 10:43:02 +0000 | [diff] [blame] | 146 | |
| 147 | def dirname(p): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 148 | """Returns the directory component of a pathname""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 149 | sep = _get_sep(p) |
| 150 | i = p.rfind(sep) + 1 |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 151 | head = p[:i] |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 152 | if head and head != sep*len(head): |
| 153 | head = head.rstrip(sep) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 154 | return head |
Guido van Rossum | c629d34 | 1992-11-05 10:43:02 +0000 | [diff] [blame] | 155 | |
| 156 | |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 157 | # Is a path a symbolic link? |
Guido van Rossum | d3876d3 | 1996-07-23 03:47:28 +0000 | [diff] [blame] | 158 | # 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] | 159 | |
| 160 | def islink(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 161 | """Test whether a path is a symbolic link""" |
| 162 | try: |
| 163 | st = os.lstat(path) |
| 164 | except (os.error, AttributeError): |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 165 | return False |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 166 | return stat.S_ISLNK(st.st_mode) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 167 | |
Johannes Gijsbers | ae882f7 | 2004-08-30 10:19:56 +0000 | [diff] [blame] | 168 | # Being true for dangling symbolic links is also useful. |
| 169 | |
| 170 | def lexists(path): |
| 171 | """Test whether a path exists. Returns True for broken symbolic links""" |
| 172 | try: |
Georg Brandl | 89fad14 | 2010-03-14 10:23:39 +0000 | [diff] [blame] | 173 | os.lstat(path) |
Johannes Gijsbers | ae882f7 | 2004-08-30 10:19:56 +0000 | [diff] [blame] | 174 | except os.error: |
| 175 | return False |
| 176 | return True |
| 177 | |
| 178 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 179 | # Are two filenames really pointing to the same file? |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 180 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 181 | def samefile(f1, f2): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 182 | """Test whether two pathnames reference the same actual file""" |
| 183 | s1 = os.stat(f1) |
| 184 | s2 = os.stat(f2) |
| 185 | return samestat(s1, s2) |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 186 | |
| 187 | |
| 188 | # Are two open files really referencing the same file? |
| 189 | # (Not necessarily the same file descriptor!) |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 190 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 191 | def sameopenfile(fp1, fp2): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 192 | """Test whether two open file objects reference the same file""" |
| 193 | s1 = os.fstat(fp1) |
| 194 | s2 = os.fstat(fp2) |
| 195 | return samestat(s1, s2) |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 196 | |
| 197 | |
| 198 | # Are two stat buffers (obtained from stat, fstat or lstat) |
| 199 | # describing the same file? |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 200 | |
Guido van Rossum | d3778f9 | 1991-11-12 15:37:40 +0000 | [diff] [blame] | 201 | def samestat(s1, s2): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 202 | """Test whether two stat buffers reference the same file""" |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 203 | return s1.st_ino == s2.st_ino and \ |
| 204 | s1.st_dev == s2.st_dev |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 205 | |
| 206 | |
| 207 | # Is a path a mount point? |
Guido van Rossum | d3876d3 | 1996-07-23 03:47:28 +0000 | [diff] [blame] | 208 | # (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] | 209 | |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 210 | def ismount(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 211 | """Test whether a path is a mount point""" |
Georg Brandl | e6c5950 | 2010-08-01 15:30:56 +0000 | [diff] [blame] | 212 | if islink(path): |
| 213 | # A symlink can never be a mount point |
| 214 | return False |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 215 | try: |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 216 | s1 = os.lstat(path) |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 217 | if isinstance(path, bytes): |
| 218 | parent = join(path, b'..') |
| 219 | else: |
| 220 | parent = join(path, '..') |
| 221 | s2 = os.lstat(parent) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 222 | except os.error: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 223 | return False # It doesn't exist -- so not a mount point :-) |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 224 | dev1 = s1.st_dev |
| 225 | dev2 = s2.st_dev |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 226 | if dev1 != dev2: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 227 | return True # path/.. on a different device as path |
Raymond Hettinger | 32200ae | 2002-06-01 19:51:15 +0000 | [diff] [blame] | 228 | ino1 = s1.st_ino |
| 229 | ino2 = s2.st_ino |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 230 | if ino1 == ino2: |
Tim Peters | bc0e910 | 2002-04-04 22:55:58 +0000 | [diff] [blame] | 231 | return True # path/.. is the same i-node as path |
| 232 | return False |
Guido van Rossum | c636014 | 1990-10-13 19:23:40 +0000 | [diff] [blame] | 233 | |
| 234 | |
Guido van Rossum | 7ac4878 | 1992-01-14 18:29:32 +0000 | [diff] [blame] | 235 | # Expand paths beginning with '~' or '~user'. |
| 236 | # '~' means $HOME; '~user' means that user's home directory. |
| 237 | # If the path doesn't begin with '~', or if the user or $HOME is unknown, |
| 238 | # the path is returned unchanged (leaving error reporting to whatever |
| 239 | # function is called with the expanded path as argument). |
| 240 | # See also module 'glob' for expansion of *, ? and [...] in pathnames. |
| 241 | # (A function should also be defined to do full *sh-style environment |
| 242 | # variable expansion.) |
| 243 | |
| 244 | def expanduser(path): |
Tim Peters | 2344fae | 2001-01-15 00:50:52 +0000 | [diff] [blame] | 245 | """Expand ~ and ~user constructions. If user or $HOME is unknown, |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 246 | do nothing.""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 247 | if isinstance(path, bytes): |
| 248 | tilde = b'~' |
| 249 | else: |
| 250 | tilde = '~' |
| 251 | if not path.startswith(tilde): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 252 | return path |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 253 | sep = _get_sep(path) |
| 254 | i = path.find(sep, 1) |
Walter Dörwald | a9da5ae | 2003-06-19 10:21:14 +0000 | [diff] [blame] | 255 | if i < 0: |
| 256 | i = len(path) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 257 | if i == 1: |
Walter Dörwald | a9da5ae | 2003-06-19 10:21:14 +0000 | [diff] [blame] | 258 | if 'HOME' not in os.environ: |
Neal Norwitz | 609ba81 | 2002-09-05 21:08:25 +0000 | [diff] [blame] | 259 | import pwd |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 260 | userhome = pwd.getpwuid(os.getuid()).pw_dir |
Neal Norwitz | 609ba81 | 2002-09-05 21:08:25 +0000 | [diff] [blame] | 261 | else: |
| 262 | userhome = os.environ['HOME'] |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 263 | else: |
| 264 | import pwd |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 265 | name = path[1:i] |
| 266 | if isinstance(name, bytes): |
| 267 | name = str(name, 'ASCII') |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 268 | try: |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 269 | pwent = pwd.getpwnam(name) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 270 | except KeyError: |
| 271 | return path |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 272 | userhome = pwent.pw_dir |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 273 | if isinstance(path, bytes): |
Victor Stinner | 16004ac | 2010-09-29 16:59:18 +0000 | [diff] [blame] | 274 | userhome = os.fsencode(userhome) |
Benjamin Peterson | ef3e4c2 | 2009-04-11 19:48:14 +0000 | [diff] [blame] | 275 | root = b'/' |
| 276 | else: |
| 277 | root = '/' |
Jesus Cea | 7f0d888 | 2012-05-10 05:10:50 +0200 | [diff] [blame] | 278 | userhome = userhome.rstrip(root) |
| 279 | return (userhome + path[i:]) or root |
Guido van Rossum | 4732ccf | 1992-08-09 13:54:50 +0000 | [diff] [blame] | 280 | |
| 281 | |
| 282 | # Expand paths containing shell variable substitutions. |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 283 | # This expands the forms $variable and ${variable} only. |
Jeremy Hylton | a05e293 | 2000-06-28 14:48:01 +0000 | [diff] [blame] | 284 | # Non-existent variables are left unchanged. |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 285 | |
| 286 | _varprog = None |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 287 | _varprogb = None |
Guido van Rossum | 4732ccf | 1992-08-09 13:54:50 +0000 | [diff] [blame] | 288 | |
| 289 | def expandvars(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 290 | """Expand shell variables of form $var and ${var}. Unknown variables |
Fred Drake | c0ab93e | 2000-09-28 16:22:52 +0000 | [diff] [blame] | 291 | are left unchanged.""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 292 | global _varprog, _varprogb |
| 293 | if isinstance(path, bytes): |
| 294 | if b'$' not in path: |
| 295 | return path |
| 296 | if not _varprogb: |
| 297 | import re |
| 298 | _varprogb = re.compile(br'\$(\w+|\{[^}]*\})', re.ASCII) |
| 299 | search = _varprogb.search |
| 300 | start = b'{' |
| 301 | end = b'}' |
| 302 | else: |
| 303 | if '$' not in path: |
| 304 | return path |
| 305 | if not _varprog: |
| 306 | import re |
| 307 | _varprog = re.compile(r'\$(\w+|\{[^}]*\})', re.ASCII) |
| 308 | search = _varprog.search |
| 309 | start = '{' |
| 310 | end = '}' |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 311 | i = 0 |
Guido van Rossum | 8ca162f | 2002-04-07 06:36:23 +0000 | [diff] [blame] | 312 | while True: |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 313 | m = search(path, i) |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 314 | if not m: |
| 315 | break |
| 316 | i, j = m.span(0) |
| 317 | name = m.group(1) |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 318 | if name.startswith(start) and name.endswith(end): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 319 | name = name[1:-1] |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 320 | if isinstance(name, bytes): |
| 321 | name = str(name, 'ASCII') |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 322 | if name in os.environ: |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 323 | tail = path[j:] |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 324 | value = os.environ[name] |
| 325 | if isinstance(path, bytes): |
| 326 | value = value.encode('ASCII') |
| 327 | path = path[:i] + value |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 328 | i = len(path) |
Walter Dörwald | 77cdeaf | 2003-06-17 13:13:40 +0000 | [diff] [blame] | 329 | path += tail |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 330 | else: |
| 331 | i = j |
| 332 | return path |
Guido van Rossum | c629d34 | 1992-11-05 10:43:02 +0000 | [diff] [blame] | 333 | |
| 334 | |
| 335 | # Normalize a path, e.g. A//B, A/./B and A/foo/../B all become A/B. |
| 336 | # It should be understood that this may change the meaning of the path |
| 337 | # if it contains symbolic links! |
| 338 | |
| 339 | def normpath(path): |
Guido van Rossum | 346f7af | 1997-12-05 19:04:51 +0000 | [diff] [blame] | 340 | """Normalize path, eliminating double slashes, etc.""" |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 341 | if isinstance(path, bytes): |
| 342 | sep = b'/' |
| 343 | empty = b'' |
| 344 | dot = b'.' |
| 345 | dotdot = b'..' |
| 346 | else: |
| 347 | sep = '/' |
| 348 | empty = '' |
| 349 | dot = '.' |
| 350 | dotdot = '..' |
| 351 | if path == empty: |
| 352 | return dot |
| 353 | initial_slashes = path.startswith(sep) |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 354 | # POSIX allows one or two initial slashes, but treats three or more |
| 355 | # as single slash. |
Tim Peters | 658cba6 | 2001-02-09 20:06:00 +0000 | [diff] [blame] | 356 | if (initial_slashes and |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 357 | path.startswith(sep*2) and not path.startswith(sep*3)): |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 358 | initial_slashes = 2 |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 359 | comps = path.split(sep) |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 360 | new_comps = [] |
| 361 | for comp in comps: |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 362 | if comp in (empty, dot): |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 363 | continue |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 364 | if (comp != dotdot or (not initial_slashes and not new_comps) or |
| 365 | (new_comps and new_comps[-1] == dotdot)): |
Skip Montanaro | 018dfae | 2000-07-19 17:09:51 +0000 | [diff] [blame] | 366 | new_comps.append(comp) |
| 367 | elif new_comps: |
| 368 | new_comps.pop() |
| 369 | comps = new_comps |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 370 | path = sep.join(comps) |
Marc-André Lemburg | bf222c9 | 2001-01-29 11:29:44 +0000 | [diff] [blame] | 371 | if initial_slashes: |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 372 | path = sep*initial_slashes + path |
| 373 | return path or dot |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 374 | |
| 375 | |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 376 | def abspath(path): |
Guido van Rossum | 54f22ed | 2000-02-04 15:10:34 +0000 | [diff] [blame] | 377 | """Return an absolute path.""" |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 378 | if not isabs(path): |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 379 | if isinstance(path, bytes): |
| 380 | cwd = os.getcwdb() |
| 381 | else: |
| 382 | cwd = os.getcwd() |
| 383 | path = join(cwd, path) |
Guido van Rossum | e294cf6 | 1999-01-29 18:05:18 +0000 | [diff] [blame] | 384 | return normpath(path) |
Guido van Rossum | 83eeef4 | 2001-09-17 15:16:09 +0000 | [diff] [blame] | 385 | |
| 386 | |
| 387 | # Return a canonical path (i.e. the absolute location of a file on the |
| 388 | # filesystem). |
| 389 | |
| 390 | def realpath(filename): |
| 391 | """Return the canonical path of the specified filename, eliminating any |
| 392 | symbolic links encountered in the path.""" |
Serhiy Storchaka | df32691 | 2013-02-10 12:22:07 +0200 | [diff] [blame] | 393 | path, ok = _joinrealpath(filename[:0], filename, {}) |
| 394 | return abspath(path) |
| 395 | |
| 396 | # Join two paths, normalizing ang eliminating any symbolic links |
| 397 | # encountered in the second path. |
| 398 | def _joinrealpath(path, rest, seen): |
| 399 | if isinstance(path, bytes): |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 400 | sep = b'/' |
Serhiy Storchaka | df32691 | 2013-02-10 12:22:07 +0200 | [diff] [blame] | 401 | curdir = b'.' |
| 402 | pardir = b'..' |
Johannes Gijsbers | 4ec4064 | 2004-08-14 15:01:53 +0000 | [diff] [blame] | 403 | else: |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 404 | sep = '/' |
Serhiy Storchaka | df32691 | 2013-02-10 12:22:07 +0200 | [diff] [blame] | 405 | curdir = '.' |
| 406 | pardir = '..' |
Tim Peters | a45cacf | 2004-08-20 03:47:14 +0000 | [diff] [blame] | 407 | |
Serhiy Storchaka | df32691 | 2013-02-10 12:22:07 +0200 | [diff] [blame] | 408 | if isabs(rest): |
| 409 | rest = rest[1:] |
| 410 | path = sep |
| 411 | |
| 412 | while rest: |
| 413 | name, _, rest = rest.partition(sep) |
| 414 | if not name or name == curdir: |
| 415 | # current dir |
| 416 | continue |
| 417 | if name == pardir: |
| 418 | # parent dir |
| 419 | if path: |
Serhiy Storchaka | 467393d | 2013-02-18 12:21:04 +0200 | [diff] [blame] | 420 | path, name = split(path) |
| 421 | if name == pardir: |
| 422 | path = join(path, pardir, pardir) |
Brett Cannon | f50299c | 2004-07-10 22:55:15 +0000 | [diff] [blame] | 423 | else: |
Serhiy Storchaka | 467393d | 2013-02-18 12:21:04 +0200 | [diff] [blame] | 424 | path = pardir |
Serhiy Storchaka | df32691 | 2013-02-10 12:22:07 +0200 | [diff] [blame] | 425 | continue |
| 426 | newpath = join(path, name) |
| 427 | if not islink(newpath): |
| 428 | path = newpath |
| 429 | continue |
| 430 | # Resolve the symbolic link |
| 431 | if newpath in seen: |
| 432 | # Already seen this path |
| 433 | path = seen[newpath] |
| 434 | if path is not None: |
| 435 | # use cached value |
| 436 | continue |
| 437 | # The symlink is not resolved, so we must have a symlink loop. |
| 438 | # Return already resolved part + rest of the path unchanged. |
| 439 | return join(newpath, rest), False |
| 440 | seen[newpath] = None # not resolved symlink |
| 441 | path, ok = _joinrealpath(path, os.readlink(newpath), seen) |
| 442 | if not ok: |
| 443 | return join(path, rest), False |
| 444 | seen[newpath] = path # resolved symlink |
Tim Peters | b64bec3 | 2001-09-18 02:26:39 +0000 | [diff] [blame] | 445 | |
Serhiy Storchaka | df32691 | 2013-02-10 12:22:07 +0200 | [diff] [blame] | 446 | return path, True |
Tim Peters | a45cacf | 2004-08-20 03:47:14 +0000 | [diff] [blame] | 447 | |
Brett Cannon | f50299c | 2004-07-10 22:55:15 +0000 | [diff] [blame] | 448 | |
Victor Stinner | e797c16 | 2010-09-17 23:34:26 +0000 | [diff] [blame] | 449 | supports_unicode_filenames = (sys.platform == 'darwin') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 450 | |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 451 | def relpath(path, start=None): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 452 | """Return a relative version of a path""" |
| 453 | |
| 454 | if not path: |
| 455 | raise ValueError("no path specified") |
| 456 | |
Guido van Rossum | f0af3e3 | 2008-10-02 18:55:37 +0000 | [diff] [blame] | 457 | if isinstance(path, bytes): |
| 458 | curdir = b'.' |
| 459 | sep = b'/' |
| 460 | pardir = b'..' |
| 461 | else: |
| 462 | curdir = '.' |
| 463 | sep = '/' |
| 464 | pardir = '..' |
| 465 | |
| 466 | if start is None: |
| 467 | start = curdir |
| 468 | |
Hirokazu Yamamoto | b08820a | 2010-10-18 12:13:18 +0000 | [diff] [blame] | 469 | start_list = [x for x in abspath(start).split(sep) if x] |
| 470 | path_list = [x for x in abspath(path).split(sep) if x] |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 471 | |
| 472 | # Work out how much of the filepath is shared by start and path. |
| 473 | i = len(commonprefix([start_list, path_list])) |
| 474 | |
| 475 | rel_list = [pardir] * (len(start_list)-i) + path_list[i:] |
Christian Heimes | faf2f63 | 2008-01-06 16:59:19 +0000 | [diff] [blame] | 476 | if not rel_list: |
| 477 | return curdir |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 478 | return join(*rel_list) |