blob: f8ca05165ac9971603c71fe36a9dee5bf114746f [file] [log] [blame]
Guido van Rossum54f22ed2000-02-04 15:10:34 +00001"""Pathname and path-related operations for the Macintosh."""
Guido van Rossum217a5fa1990-12-26 15:40:07 +00002
Guido van Rossum5c1d2291998-03-03 21:49:01 +00003import os
Guido van Rossum217a5fa1990-12-26 15:40:07 +00004from stat import *
5
Skip Montanaro17ab1232001-01-24 06:27:27 +00006__all__ = ["normcase","isabs","join","splitdrive","split","splitext",
7 "basename","dirname","commonprefix","getsize","getmtime",
8 "getatime","islink","exists","isdir","isfile",
9 "walk","expanduser","expandvars","normpath","abspath"]
Guido van Rossumb5e05e91991-01-01 18:10:40 +000010
Fred Drakeb4e460a2000-09-28 16:25:20 +000011# Normalize the case of a pathname. Dummy in Posix, but <s>.lower() here.
Guido van Rossum599f2ed1992-01-14 18:28:18 +000012
Fred Drakeb4e460a2000-09-28 16:25:20 +000013def normcase(path):
14 return path.lower()
Guido van Rossum599f2ed1992-01-14 18:28:18 +000015
16
Guido van Rossum217a5fa1990-12-26 15:40:07 +000017def isabs(s):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000018 """Return true if a path is absolute.
19 On the Mac, relative paths begin with a colon,
20 but as a special case, paths with no colons at all are also relative.
21 Anything else is absolute (the string up to the first colon is the
22 volume name)."""
23
Fred Drake8152d322000-12-12 23:20:45 +000024 return ':' in s and s[0] != ':'
Guido van Rossum217a5fa1990-12-26 15:40:07 +000025
Guido van Rossumb5e05e91991-01-01 18:10:40 +000026
Barry Warsaw384d2491997-02-18 21:53:25 +000027def join(s, *p):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000028 path = s
29 for t in p:
30 if (not s) or isabs(t):
31 path = t
32 continue
33 if t[:1] == ':':
34 t = t[1:]
35 if ':' not in path:
36 path = ':' + path
Fred Drake8152d322000-12-12 23:20:45 +000037 if path[-1:] != ':':
Guido van Rossum54f22ed2000-02-04 15:10:34 +000038 path = path + ':'
39 path = path + t
40 return path
Guido van Rossum217a5fa1990-12-26 15:40:07 +000041
Guido van Rossumb5e05e91991-01-01 18:10:40 +000042
Guido van Rossumb5e05e91991-01-01 18:10:40 +000043def split(s):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000044 """Split a pathname into two parts: the directory leading up to the final
45 bit, and the basename (the filename, without colons, in that directory).
46 The result (s, t) is such that join(s, t) yields the original argument."""
Guido van Rossumb5e05e91991-01-01 18:10:40 +000047
Guido van Rossum54f22ed2000-02-04 15:10:34 +000048 if ':' not in s: return '', s
49 colon = 0
50 for i in range(len(s)):
Fred Drakeb4e460a2000-09-28 16:25:20 +000051 if s[i] == ':': colon = i + 1
Guido van Rossum54f22ed2000-02-04 15:10:34 +000052 path, file = s[:colon-1], s[colon:]
53 if path and not ':' in path:
54 path = path + ':'
55 return path, file
Guido van Rossumb5e05e91991-01-01 18:10:40 +000056
Guido van Rossuma48bf791996-07-23 02:28:32 +000057
58def splitext(p):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000059 """Split a path into root and extension.
60 The extension is everything starting at the last dot in the last
61 pathname component; the root is everything before that.
62 It is always true that root + ext == p."""
Guido van Rossuma48bf791996-07-23 02:28:32 +000063
Guido van Rossum54f22ed2000-02-04 15:10:34 +000064 root, ext = '', ''
65 for c in p:
66 if c == ':':
67 root, ext = root + ext + c, ''
68 elif c == '.':
69 if ext:
70 root, ext = root + ext, c
71 else:
72 ext = c
73 elif ext:
74 ext = ext + c
75 else:
76 root = root + c
77 return root, ext
Guido van Rossuma48bf791996-07-23 02:28:32 +000078
Guido van Rossum0ec31261995-08-10 18:09:16 +000079
80def splitdrive(p):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000081 """Split a pathname into a drive specification and the rest of the
82 path. Useful on DOS/Windows/NT; on the Mac, the drive is always
83 empty (don't use the volume name -- it doesn't have the same
84 syntactic and semantic oddities as DOS drive letters, such as there
85 being a separate current directory per drive)."""
86
87 return '', p
Guido van Rossum0ec31261995-08-10 18:09:16 +000088
89
Guido van Rossumc629d341992-11-05 10:43:02 +000090# Short interfaces to split()
91
92def dirname(s): return split(s)[0]
93def basename(s): return split(s)[1]
94
95
Guido van Rossum217a5fa1990-12-26 15:40:07 +000096def isdir(s):
Guido van Rossum54f22ed2000-02-04 15:10:34 +000097 """Return true if the pathname refers to an existing directory."""
98
99 try:
100 st = os.stat(s)
101 except os.error:
102 return 0
103 return S_ISDIR(st[ST_MODE])
Guido van Rossum217a5fa1990-12-26 15:40:07 +0000104
Guido van Rossumb5e05e91991-01-01 18:10:40 +0000105
Guido van Rossum2bc1f8f1998-07-24 20:49:26 +0000106# Get size, mtime, atime of files.
107
108def getsize(filename):
109 """Return the size of a file, reported by os.stat()."""
110 st = os.stat(filename)
Fred Drake69f87c51999-07-23 15:04:05 +0000111 return st[ST_SIZE]
Guido van Rossum2bc1f8f1998-07-24 20:49:26 +0000112
113def getmtime(filename):
114 """Return the last modification time of a file, reported by os.stat()."""
115 st = os.stat(filename)
Fred Drake69f87c51999-07-23 15:04:05 +0000116 return st[ST_MTIME]
Guido van Rossum2bc1f8f1998-07-24 20:49:26 +0000117
118def getatime(filename):
119 """Return the last access time of a file, reported by os.stat()."""
120 st = os.stat(filename)
Guido van Rossum46d56512000-07-01 10:52:49 +0000121 return st[ST_ATIME]
Guido van Rossum2bc1f8f1998-07-24 20:49:26 +0000122
123
Guido van Rossum7e4b2de1995-01-27 02:41:45 +0000124def islink(s):
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000125 """Return true if the pathname refers to a symbolic link.
126 Always false on the Mac, until we understand Aliases.)"""
Guido van Rossum7e4b2de1995-01-27 02:41:45 +0000127
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000128 return 0
Guido van Rossum7e4b2de1995-01-27 02:41:45 +0000129
Guido van Rossumb5e05e91991-01-01 18:10:40 +0000130
Guido van Rossum217a5fa1990-12-26 15:40:07 +0000131def isfile(s):
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000132 """Return true if the pathname refers to an existing regular file."""
Guido van Rossum217a5fa1990-12-26 15:40:07 +0000133
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000134 try:
135 st = os.stat(s)
136 except os.error:
137 return 0
138 return S_ISREG(st[ST_MODE])
Guido van Rossumb5e05e91991-01-01 18:10:40 +0000139
Guido van Rossumb5e05e91991-01-01 18:10:40 +0000140
Guido van Rossum217a5fa1990-12-26 15:40:07 +0000141def exists(s):
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000142 """Return true if the pathname refers to an existing file or directory."""
Guido van Rossumc629d341992-11-05 10:43:02 +0000143
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000144 try:
145 st = os.stat(s)
146 except os.error:
147 return 0
148 return 1
149
Jack Jansen03c06ee2000-08-23 09:13:40 +0000150# Return the longest prefix of all list elements.
151
152def commonprefix(m):
153 "Given a list of pathnames, returns the longest common leading component"
154 if not m: return ''
155 prefix = m[0]
156 for item in m:
157 for i in range(len(prefix)):
Fred Drake8152d322000-12-12 23:20:45 +0000158 if prefix[:i+1] != item[:i+1]:
Jack Jansen03c06ee2000-08-23 09:13:40 +0000159 prefix = prefix[:i]
160 if i == 0: return ''
161 break
162 return prefix
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000163
Jack Jansenf4e7d2a1995-12-15 13:23:37 +0000164def expandvars(path):
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000165 """Dummy to retain interface-compatibility with other operating systems."""
166 return path
Jack Jansenf4e7d2a1995-12-15 13:23:37 +0000167
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000168
Jack Jansenf4e7d2a1995-12-15 13:23:37 +0000169def expanduser(path):
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000170 """Dummy to retain interface-compatibility with other operating systems."""
171 return path
Guido van Rossum0ec31261995-08-10 18:09:16 +0000172
173norm_error = 'macpath.norm_error: path cannot be normalized'
Guido van Rossumc629d341992-11-05 10:43:02 +0000174
175def normpath(s):
Jack Jansen2fc01092000-08-06 21:18:35 +0000176 """Normalize a pathname. Will return the same result for
177 equivalent paths."""
Jack Jansena68bfe21995-08-07 14:09:27 +0000178
Jack Jansen2fc01092000-08-06 21:18:35 +0000179 if ":" not in s:
180 return ":"+s
181
Fred Drakeb4e460a2000-09-28 16:25:20 +0000182 comps = s.split(":")
Jack Jansen2fc01092000-08-06 21:18:35 +0000183 i = 1
184 while i < len(comps)-1:
185 if comps[i] == "" and comps[i-1] != "":
186 if i > 1:
187 del comps[i-1:i+1]
Fred Drakeb4e460a2000-09-28 16:25:20 +0000188 i = i - 1
Jack Jansen2fc01092000-08-06 21:18:35 +0000189 else:
190 # best way to handle this is to raise an exception
Greg Ward034cbf12001-08-08 20:55:10 +0000191 raise norm_error, 'Cannot use :: immediately after volume name'
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000192 else:
Jack Jansen2fc01092000-08-06 21:18:35 +0000193 i = i + 1
194
Fred Drakeb4e460a2000-09-28 16:25:20 +0000195 s = ":".join(comps)
Jack Jansen2fc01092000-08-06 21:18:35 +0000196
197 # remove trailing ":" except for ":" and "Volume:"
198 if s[-1] == ":" and len(comps) > 2 and s != ":"*len(s):
199 s = s[:-1]
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000200 return s
Guido van Rossum0ec31261995-08-10 18:09:16 +0000201
Jack Jansena68bfe21995-08-07 14:09:27 +0000202
203def walk(top, func, arg):
Tim Peterscf5e6a42001-10-10 04:16:20 +0000204 """Directory tree walk with callback function.
205
206 For each directory in the directory tree rooted at top (including top
207 itself, but excluding '.' and '..'), call func(arg, dirname, fnames).
208 dirname is the name of the directory, and fnames a list of the names of
209 the files and subdirectories in dirname (excluding '.' and '..'). func
210 may modify the fnames list in-place (e.g. via del or slice assignment),
211 and walk will only recurse into the subdirectories whose names remain in
212 fnames; this can be used to implement a filter, or to impose a specific
213 order of visiting. No semantics are defined for, or required of, arg,
214 beyond that arg is always passed to func. It can be used, e.g., to pass
215 a filename pattern, or a mutable object designed to accumulate
216 statistics. Passing None for arg is common."""
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000217
218 try:
219 names = os.listdir(top)
220 except os.error:
221 return
222 func(arg, top, names)
223 for name in names:
224 name = join(top, name)
225 if isdir(name):
226 walk(name, func, arg)
Guido van Rossume294cf61999-01-29 18:05:18 +0000227
228
Guido van Rossume294cf61999-01-29 18:05:18 +0000229def abspath(path):
Guido van Rossum54f22ed2000-02-04 15:10:34 +0000230 """Return an absolute path."""
Guido van Rossume294cf61999-01-29 18:05:18 +0000231 if not isabs(path):
232 path = join(os.getcwd(), path)
233 return normpath(path)
Guido van Rossum83eeef42001-09-17 15:16:09 +0000234
235# realpath is a no-op on systems without islink support
236realpath = abspath