119
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
121
def fancy_rename(old, new, rename_func, unlink_func):
122
"""A fancy rename, when you don't have atomic rename.
124
:param old: The old path, to rename from
125
:param new: The new path, to rename to
126
:param rename_func: The potentially non-atomic rename function
127
:param unlink_func: A way to delete the target file if the full rename succeeds
130
# sftp rename doesn't allow overwriting, so play tricks:
132
base = os.path.basename(new)
133
dirname = os.path.dirname(new)
134
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
135
tmp_name = pathjoin(dirname, tmp_name)
137
# Rename the file out of the way, but keep track if it didn't exist
138
# We don't want to grab just any exception
139
# something like EACCES should prevent us from continuing
140
# The downside is that the rename_func has to throw an exception
141
# with an errno = ENOENT, or NoSuchFile
144
rename_func(new, tmp_name)
145
except (NoSuchFile,), e:
148
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
149
# function raises an IOError with errno == None when a rename fails.
150
# This then gets caught here.
151
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
154
if (not hasattr(e, 'errno')
155
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
162
# This may throw an exception, in which case success will
164
rename_func(old, new)
168
# If the file used to exist, rename it back into place
169
# otherwise just delete it from the tmp location
171
unlink_func(tmp_name)
173
rename_func(tmp_name, new)
175
# Default is to just use the python builtins, but these can be rebound on
176
# particular platforms.
177
abspath = os.path.abspath
178
realpath = os.path.realpath
179
pathjoin = os.path.join
180
normpath = os.path.normpath
182
mkdtemp = tempfile.mkdtemp
184
dirname = os.path.dirname
185
basename = os.path.basename
186
rmtree = shutil.rmtree
188
MIN_ABS_PATHLENGTH = 1
112
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
117
[p,e] = os.path.split(f)
118
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
190
123
if os.name == "posix":
191
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
195
128
_fs_enc = sys.getfilesystemencoding()
196
129
def abspath(path):
197
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
199
131
def realpath(path):
200
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
202
if sys.platform == 'win32':
203
134
# We need to use the Unicode-aware os.path.abspath and
204
135
# os.path.realpath on Windows systems.
206
return os.path.abspath(path).replace('\\', '/')
209
return os.path.realpath(path).replace('\\', '/')
212
return os.path.join(*args).replace('\\', '/')
215
return os.path.normpath(path).replace('\\', '/')
218
return os.getcwdu().replace('\\', '/')
220
def mkdtemp(*args, **kwargs):
221
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
223
def rename(old, new):
224
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
226
MIN_ABS_PATHLENGTH = 3
228
def _win32_delete_readonly(function, path, excinfo):
229
"""Error handler for shutil.rmtree function [for win32]
230
Helps to remove files and dirs marked as read-only.
232
type_, value = excinfo[:2]
233
if function in (os.remove, os.rmdir) \
234
and type_ == OSError \
235
and value.errno == errno.EACCES:
236
bzrlib.osutils.make_writable(path)
241
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
242
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
243
return shutil.rmtree(path, ignore_errors, onerror)
246
def normalizepath(f):
247
if hasattr(os.path, 'realpath'):
251
[p,e] = os.path.split(f)
252
if e == "" or e == "." or e == "..":
255
return pathjoin(F(p), e)
136
abspath = os.path.abspath
137
realpath = os.path.realpath
258
139
def backup_file(fn):
259
140
"""Copy a file to a backup.
308
195
def is_inside(dir, fname):
309
196
"""True if fname is inside dir.
311
The parameters should typically be passed to osutils.normpath first, so
198
The parameters should typically be passed to os.path.normpath first, so
312
199
that . and .. and repeated slashes are eliminated, and the separators
313
200
are canonical for the platform.
315
202
The empty string as a dir name is taken as top-of-tree and matches
318
>>> is_inside('src', pathjoin('src', 'foo.c'))
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
320
207
>>> is_inside('src', 'srccontrol')
322
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
324
211
>>> is_inside('foo.c', 'foo.c')
493
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
495
"""Return a random string of num alphanumeric characters
497
The result only contains lowercase chars because it may be used on
498
case-insensitive filesystems.
501
for raw_byte in rand_bytes(num):
502
s += ALNUM[ord(raw_byte) % 36]
506
365
## TODO: We could later have path objects that remember their list
507
366
## decomposition (might be too tricksy though.)
544
403
if (f == '..') or (f == None) or (f == ''):
545
404
raise BzrError("sorry, %r not allowed in path" % f)
405
return os.path.join(*p)
549
408
def appendpath(p1, p2):
553
return pathjoin(p1, p2)
412
return os.path.join(p1, p2)
556
415
def split_lines(s):
557
416
"""Split s into lines, but without removing the newline characters."""
558
lines = s.split('\n')
559
result = [line + '\n' for line in lines[:-1]]
561
result.append(lines[-1])
417
return StringIO(s).readlines()
565
420
def hardlinks_good():
642
482
# XXX This should raise a NotChildPath exception, as its not tied
643
483
# to branch anymore.
644
raise PathNotChild(rp, base)
652
def safe_unicode(unicode_or_utf8_string):
653
"""Coerce unicode_or_utf8_string into unicode.
655
If it is unicode, it is returned.
656
Otherwise it is decoded from utf-8. If a decoding error
657
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
658
as a BzrBadParameter exception.
660
if isinstance(unicode_or_utf8_string, unicode):
661
return unicode_or_utf8_string
663
return unicode_or_utf8_string.decode('utf8')
664
except UnicodeDecodeError:
665
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
668
def terminal_width():
669
"""Return estimated terminal width."""
671
# TODO: Do something smart on Windows?
673
# TODO: Is there anything that gets a better update when the window
674
# is resized while the program is running? We could use the Python termcap
677
return int(os.environ['COLUMNS'])
678
except (IndexError, KeyError, ValueError):
681
def supports_executable():
682
return sys.platform != "win32"
685
def strip_trailing_slash(path):
686
"""Strip trailing slash, except for root paths.
687
The definition of 'root path' is platform-dependent.
689
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
695
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
698
def check_legal_path(path):
699
"""Check whether the supplied path is legal.
700
This is only required on Windows, so we don't test on other platforms
703
if sys.platform != "win32":
705
if _validWin32PathRE.match(path) is None:
706
raise IllegalPath(path)
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
added
removed
bzrlib/osutils.py
