1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
29
from ntpath import (abspath as _nt_abspath,
31
normpath as _nt_normpath,
32
realpath as _nt_realpath,
33
splitdrive as _nt_splitdrive,
43
from tempfile import (
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter
61
# On win32, O_BINARY is used to indicate the file should
62
# be opened in binary mode, rather than text mode.
63
# On other platforms, O_BINARY doesn't exist, because
64
# they always open in binary mode, so it is okay to
65
# OR with 0 on those platforms
66
O_BINARY = getattr(os, 'O_BINARY', 0)
69
def make_readonly(filename):
70
"""Make a filename read-only."""
71
mod = os.stat(filename).st_mode
73
os.chmod(filename, mod)
76
def make_writable(filename):
77
mod = os.stat(filename).st_mode
79
os.chmod(filename, mod)
86
"""Return a quoted filename filename
88
This previously used backslash quoting, but that works poorly on
90
# TODO: I'm not really sure this is the best format either.x
93
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
95
if _QUOTE_RE.search(f):
101
_directory_kind = 'directory'
104
stat.S_IFDIR:_directory_kind,
105
stat.S_IFCHR:'chardev',
106
stat.S_IFBLK:'block',
109
stat.S_IFLNK:'symlink',
110
stat.S_IFSOCK:'socket',
114
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
115
"""Generate a file kind from a stat mode. This is used in walkdirs.
117
Its performance is critical: Do not mutate without careful benchmarking.
120
return _formats[stat_mode & 0170000]
125
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
127
return _mapper(_lstat(f).st_mode)
129
if getattr(e, 'errno', None) == errno.ENOENT:
130
raise errors.NoSuchFile(f)
135
"""Return the current umask"""
136
# Assume that people aren't messing with the umask while running
137
# XXX: This is not thread safe, but there is no way to get the
138
# umask without setting it
144
def kind_marker(kind):
147
elif kind == _directory_kind:
149
elif kind == 'symlink':
152
raise errors.BzrError('invalid file kind %r' % kind)
154
lexists = getattr(os.path, 'lexists', None)
158
if getattr(os, 'lstat') is not None:
164
if e.errno == errno.ENOENT:
167
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
170
def fancy_rename(old, new, rename_func, unlink_func):
171
"""A fancy rename, when you don't have atomic rename.
173
:param old: The old path, to rename from
174
:param new: The new path, to rename to
175
:param rename_func: The potentially non-atomic rename function
176
:param unlink_func: A way to delete the target file if the full rename succeeds
179
# sftp rename doesn't allow overwriting, so play tricks:
181
base = os.path.basename(new)
182
dirname = os.path.dirname(new)
183
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
184
tmp_name = pathjoin(dirname, tmp_name)
186
# Rename the file out of the way, but keep track if it didn't exist
187
# We don't want to grab just any exception
188
# something like EACCES should prevent us from continuing
189
# The downside is that the rename_func has to throw an exception
190
# with an errno = ENOENT, or NoSuchFile
193
rename_func(new, tmp_name)
194
except (errors.NoSuchFile,), e:
197
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
198
# function raises an IOError with errno is None when a rename fails.
199
# This then gets caught here.
200
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
203
if (getattr(e, 'errno', None) is None
204
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
211
# This may throw an exception, in which case success will
213
rename_func(old, new)
217
# If the file used to exist, rename it back into place
218
# otherwise just delete it from the tmp location
220
unlink_func(tmp_name)
222
rename_func(tmp_name, new)
225
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
226
# choke on a Unicode string containing a relative path if
227
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
229
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
230
def _posix_abspath(path):
231
# jam 20060426 rather than encoding to fsencoding
232
# copy posixpath.abspath, but use os.getcwdu instead
233
if not posixpath.isabs(path):
234
path = posixpath.join(getcwd(), path)
235
return posixpath.normpath(path)
238
def _posix_realpath(path):
239
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
242
def _win32_fixdrive(path):
243
"""Force drive letters to be consistent.
245
win32 is inconsistent whether it returns lower or upper case
246
and even if it was consistent the user might type the other
247
so we force it to uppercase
248
running python.exe under cmd.exe return capital C:\\
249
running win32 python inside a cygwin shell returns lowercase c:\\
251
drive, path = _nt_splitdrive(path)
252
return drive.upper() + path
255
def _win32_abspath(path):
256
# Real _nt_abspath doesn't have a problem with a unicode cwd
257
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
260
def _win32_realpath(path):
261
# Real _nt_realpath doesn't have a problem with a unicode cwd
262
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
265
def _win32_pathjoin(*args):
266
return _nt_join(*args).replace('\\', '/')
269
def _win32_normpath(path):
270
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
274
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
277
def _win32_mkdtemp(*args, **kwargs):
278
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
281
def _win32_rename(old, new):
282
"""We expect to be able to atomically replace 'new' with old.
284
On win32, if new exists, it must be moved out of the way first,
288
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
290
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
291
# If we try to rename a non-existant file onto cwd, we get
292
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
293
# if the old path doesn't exist, sometimes we get EACCES
294
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
300
return unicodedata.normalize('NFKC', os.getcwdu())
303
# Default is to just use the python builtins, but these can be rebound on
304
# particular platforms.
305
abspath = _posix_abspath
306
realpath = _posix_realpath
307
pathjoin = os.path.join
308
normpath = os.path.normpath
311
dirname = os.path.dirname
312
basename = os.path.basename
313
# These were already imported into local scope
314
# mkdtemp = tempfile.mkdtemp
315
# rmtree = shutil.rmtree
317
MIN_ABS_PATHLENGTH = 1
320
if sys.platform == 'win32':
321
abspath = _win32_abspath
322
realpath = _win32_realpath
323
pathjoin = _win32_pathjoin
324
normpath = _win32_normpath
325
getcwd = _win32_getcwd
326
mkdtemp = _win32_mkdtemp
327
rename = _win32_rename
329
MIN_ABS_PATHLENGTH = 3
331
def _win32_delete_readonly(function, path, excinfo):
332
"""Error handler for shutil.rmtree function [for win32]
333
Helps to remove files and dirs marked as read-only.
335
exception = excinfo[1]
336
if function in (os.remove, os.rmdir) \
337
and isinstance(exception, OSError) \
338
and exception.errno == errno.EACCES:
344
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
345
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
346
return shutil.rmtree(path, ignore_errors, onerror)
347
elif sys.platform == 'darwin':
351
def get_terminal_encoding():
352
"""Find the best encoding for printing to the screen.
354
This attempts to check both sys.stdout and sys.stdin to see
355
what encoding they are in, and if that fails it falls back to
356
bzrlib.user_encoding.
357
The problem is that on Windows, locale.getpreferredencoding()
358
is not the same encoding as that used by the console:
359
http://mail.python.org/pipermail/python-list/2003-May/162357.html
361
On my standard US Windows XP, the preferred encoding is
362
cp1252, but the console is cp437
364
output_encoding = getattr(sys.stdout, 'encoding', None)
365
if not output_encoding:
366
input_encoding = getattr(sys.stdin, 'encoding', None)
367
if not input_encoding:
368
output_encoding = bzrlib.user_encoding
369
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
371
output_encoding = input_encoding
372
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
374
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
375
if output_encoding == 'cp0':
376
# invalid encoding (cp0 means 'no codepage' on Windows)
377
output_encoding = bzrlib.user_encoding
378
mutter('cp0 is invalid encoding.'
379
' encoding stdout as bzrlib.user_encoding %r', output_encoding)
380
return output_encoding
383
def normalizepath(f):
384
if getattr(os.path, 'realpath', None) is not None:
388
[p,e] = os.path.split(f)
389
if e == "" or e == "." or e == "..":
392
return pathjoin(F(p), e)
396
"""Copy a file to a backup.
398
Backups are named in GNU-style, with a ~ suffix.
400
If the file is already a backup, it's not copied.
406
if has_symlinks() and os.path.islink(fn):
407
target = os.readlink(fn)
408
os.symlink(target, bfn)
416
outf = file(bfn, 'wb')
424
"""True if f is an accessible directory."""
426
return S_ISDIR(os.lstat(f)[ST_MODE])
432
"""True if f is a regular file."""
434
return S_ISREG(os.lstat(f)[ST_MODE])
439
"""True if f is a symlink."""
441
return S_ISLNK(os.lstat(f)[ST_MODE])
445
def is_inside(dir, fname):
446
"""True if fname is inside dir.
448
The parameters should typically be passed to osutils.normpath first, so
449
that . and .. and repeated slashes are eliminated, and the separators
450
are canonical for the platform.
452
The empty string as a dir name is taken as top-of-tree and matches
455
# XXX: Most callers of this can actually do something smarter by
456
# looking at the inventory
466
return fname.startswith(dir)
469
def is_inside_any(dir_list, fname):
470
"""True if fname is inside any of given dirs."""
471
for dirname in dir_list:
472
if is_inside(dirname, fname):
478
def is_inside_or_parent_of_any(dir_list, fname):
479
"""True if fname is a child or a parent of any of the given files."""
480
for dirname in dir_list:
481
if is_inside(dirname, fname) or is_inside(fname, dirname):
487
def pumpfile(fromfile, tofile):
488
"""Copy contents of one file to another."""
491
b = fromfile.read(BUFSIZE)
497
def file_iterator(input_file, readsize=32768):
499
b = input_file.read(readsize)
506
if getattr(f, 'tell', None) is not None:
519
def sha_strings(strings):
520
"""Return the sha-1 of concatenation of strings"""
522
map(s.update, strings)
532
def fingerprint_file(f):
537
return {'size': size,
538
'sha1': s.hexdigest()}
541
def compare_files(a, b):
542
"""Returns true if equal in contents"""
553
def local_time_offset(t=None):
554
"""Return offset of local zone from GMT, either at present or at time t."""
555
# python2.3 localtime() can't take None
559
if time.localtime(t).tm_isdst and time.daylight:
562
return -time.timezone
565
def format_date(t, offset=0, timezone='original', date_fmt=None,
567
## TODO: Perhaps a global option to use either universal or local time?
568
## Or perhaps just let people set $TZ?
569
assert isinstance(t, float)
571
if timezone == 'utc':
574
elif timezone == 'original':
577
tt = time.gmtime(t + offset)
578
elif timezone == 'local':
579
tt = time.localtime(t)
580
offset = local_time_offset(t)
582
raise errors.BzrError("unsupported timezone format %r" % timezone,
583
['options are "utc", "original", "local"'])
585
date_fmt = "%a %Y-%m-%d %H:%M:%S"
587
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
590
return (time.strftime(date_fmt, tt) + offset_str)
593
def compact_date(when):
594
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
597
def format_delta(delta):
598
"""Get a nice looking string for a time delta.
600
:param delta: The time difference in seconds, can be positive or negative.
601
positive indicates time in the past, negative indicates time in the
602
future. (usually time.time() - stored_time)
603
:return: String formatted to show approximate resolution
609
direction = 'in the future'
613
if seconds < 90: # print seconds up to 90 seconds
615
return '%d second %s' % (seconds, direction,)
617
return '%d seconds %s' % (seconds, direction)
619
minutes = int(seconds / 60)
620
seconds -= 60 * minutes
625
if minutes < 90: # print minutes, seconds up to 90 minutes
627
return '%d minute, %d second%s %s' % (
628
minutes, seconds, plural_seconds, direction)
630
return '%d minutes, %d second%s %s' % (
631
minutes, seconds, plural_seconds, direction)
633
hours = int(minutes / 60)
634
minutes -= 60 * hours
641
return '%d hour, %d minute%s %s' % (hours, minutes,
642
plural_minutes, direction)
643
return '%d hours, %d minute%s %s' % (hours, minutes,
644
plural_minutes, direction)
647
"""Return size of given open file."""
648
return os.fstat(f.fileno())[ST_SIZE]
651
# Define rand_bytes based on platform.
653
# Python 2.4 and later have os.urandom,
654
# but it doesn't work on some arches
656
rand_bytes = os.urandom
657
except (NotImplementedError, AttributeError):
658
# If python doesn't have os.urandom, or it doesn't work,
659
# then try to first pull random data from /dev/urandom
661
rand_bytes = file('/dev/urandom', 'rb').read
662
# Otherwise, use this hack as a last resort
663
except (IOError, OSError):
664
# not well seeded, but better than nothing
669
s += chr(random.randint(0, 255))
674
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
676
"""Return a random string of num alphanumeric characters
678
The result only contains lowercase chars because it may be used on
679
case-insensitive filesystems.
682
for raw_byte in rand_bytes(num):
683
s += ALNUM[ord(raw_byte) % 36]
687
## TODO: We could later have path objects that remember their list
688
## decomposition (might be too tricksy though.)
691
"""Turn string into list of parts."""
692
assert isinstance(p, basestring)
694
# split on either delimiter because people might use either on
696
ps = re.split(r'[\\/]', p)
701
raise errors.BzrError("sorry, %r not allowed in path" % f)
702
elif (f == '.') or (f == ''):
709
assert isinstance(p, list)
711
if (f == '..') or (f is None) or (f == ''):
712
raise errors.BzrError("sorry, %r not allowed in path" % f)
716
@deprecated_function(zero_nine)
717
def appendpath(p1, p2):
721
return pathjoin(p1, p2)
725
"""Split s into lines, but without removing the newline characters."""
726
lines = s.split('\n')
727
result = [line + '\n' for line in lines[:-1]]
729
result.append(lines[-1])
733
def hardlinks_good():
734
return sys.platform not in ('win32', 'cygwin', 'darwin')
737
def link_or_copy(src, dest):
738
"""Hardlink a file, or copy it if it can't be hardlinked."""
739
if not hardlinks_good():
740
shutil.copyfile(src, dest)
744
except (OSError, IOError), e:
745
if e.errno != errno.EXDEV:
747
shutil.copyfile(src, dest)
749
def delete_any(full_path):
750
"""Delete a file or directory."""
754
# We may be renaming a dangling inventory id
755
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
761
if getattr(os, 'symlink', None) is not None:
767
def contains_whitespace(s):
768
"""True if there are any whitespace characters in s."""
769
for ch in string.whitespace:
776
def contains_linebreaks(s):
777
"""True if there is any vertical whitespace in s."""
785
def relpath(base, path):
786
"""Return path relative to base, or raise exception.
788
The path may be either an absolute path or a path relative to the
789
current working directory.
791
os.path.commonprefix (python2.4) has a bad bug that it works just
792
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
796
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
797
' exceed the platform minimum length (which is %d)' %
804
while len(head) >= len(base):
807
head, tail = os.path.split(head)
811
raise errors.PathNotChild(rp, base)
819
def safe_unicode(unicode_or_utf8_string):
820
"""Coerce unicode_or_utf8_string into unicode.
822
If it is unicode, it is returned.
823
Otherwise it is decoded from utf-8. If a decoding error
824
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
825
as a BzrBadParameter exception.
827
if isinstance(unicode_or_utf8_string, unicode):
828
return unicode_or_utf8_string
830
return unicode_or_utf8_string.decode('utf8')
831
except UnicodeDecodeError:
832
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
835
_platform_normalizes_filenames = False
836
if sys.platform == 'darwin':
837
_platform_normalizes_filenames = True
840
def normalizes_filenames():
841
"""Return True if this platform normalizes unicode filenames.
843
Mac OSX does, Windows/Linux do not.
845
return _platform_normalizes_filenames
848
def _accessible_normalized_filename(path):
849
"""Get the unicode normalized path, and if you can access the file.
851
On platforms where the system normalizes filenames (Mac OSX),
852
you can access a file by any path which will normalize correctly.
853
On platforms where the system does not normalize filenames
854
(Windows, Linux), you have to access a file by its exact path.
856
Internally, bzr only supports NFC/NFKC normalization, since that is
857
the standard for XML documents.
859
So return the normalized path, and a flag indicating if the file
860
can be accessed by that path.
863
return unicodedata.normalize('NFKC', unicode(path)), True
866
def _inaccessible_normalized_filename(path):
867
__doc__ = _accessible_normalized_filename.__doc__
869
normalized = unicodedata.normalize('NFKC', unicode(path))
870
return normalized, normalized == path
873
if _platform_normalizes_filenames:
874
normalized_filename = _accessible_normalized_filename
876
normalized_filename = _inaccessible_normalized_filename
879
def terminal_width():
880
"""Return estimated terminal width."""
881
if sys.platform == 'win32':
882
import bzrlib.win32console
883
return bzrlib.win32console.get_console_size()[0]
886
import struct, fcntl, termios
887
s = struct.pack('HHHH', 0, 0, 0, 0)
888
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
889
width = struct.unpack('HHHH', x)[1]
894
width = int(os.environ['COLUMNS'])
903
def supports_executable():
904
return sys.platform != "win32"
907
def set_or_unset_env(env_variable, value):
908
"""Modify the environment, setting or removing the env_variable.
910
:param env_variable: The environment variable in question
911
:param value: The value to set the environment to. If None, then
912
the variable will be removed.
913
:return: The original value of the environment variable.
915
orig_val = os.environ.get(env_variable)
917
if orig_val is not None:
918
del os.environ[env_variable]
920
if isinstance(value, unicode):
921
value = value.encode(bzrlib.user_encoding)
922
os.environ[env_variable] = value
926
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
929
def check_legal_path(path):
930
"""Check whether the supplied path is legal.
931
This is only required on Windows, so we don't test on other platforms
934
if sys.platform != "win32":
936
if _validWin32PathRE.match(path) is None:
937
raise errors.IllegalPath(path)
940
def walkdirs(top, prefix=""):
941
"""Yield data about all the directories in a tree.
943
This yields all the data about the contents of a directory at a time.
944
After each directory has been yielded, if the caller has mutated the list
945
to exclude some directories, they are then not descended into.
947
The data yielded is of the form:
948
((directory-relpath, directory-path-from-top),
949
[(relpath, basename, kind, lstat), ...]),
950
- directory-relpath is the relative path of the directory being returned
951
with respect to top. prefix is prepended to this.
952
- directory-path-from-root is the path including top for this directory.
953
It is suitable for use with os functions.
954
- relpath is the relative path within the subtree being walked.
955
- basename is the basename of the path
956
- kind is the kind of the file now. If unknown then the file is not
957
present within the tree - but it may be recorded as versioned. See
959
- lstat is the stat data *if* the file was statted.
960
- planned, not implemented:
961
path_from_tree_root is the path from the root of the tree.
963
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
964
allows one to walk a subtree but get paths that are relative to a tree
966
:return: an iterator over the dirs.
968
#TODO there is a bit of a smell where the results of the directory-
969
# summary in this, and the path from the root, may not agree
970
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
971
# potentially confusing output. We should make this more robust - but
972
# not at a speed cost. RBC 20060731
975
_directory = _directory_kind
976
_listdir = os.listdir
977
pending = [(prefix, "", _directory, None, top)]
980
currentdir = pending.pop()
981
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
984
relroot = currentdir[0] + '/'
987
for name in sorted(_listdir(top)):
988
abspath = top + '/' + name
989
statvalue = lstat(abspath)
990
dirblock.append((relroot + name, name,
991
file_kind_from_stat_mode(statvalue.st_mode),
993
yield (currentdir[0], top), dirblock
994
# push the user specified dirs from dirblock
995
for dir in reversed(dirblock):
996
if dir[2] == _directory:
1000
def copy_tree(from_path, to_path, handlers={}):
1001
"""Copy all of the entries in from_path into to_path.
1003
:param from_path: The base directory to copy.
1004
:param to_path: The target directory. If it does not exist, it will
1006
:param handlers: A dictionary of functions, which takes a source and
1007
destinations for files, directories, etc.
1008
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1009
'file', 'directory', and 'symlink' should always exist.
1010
If they are missing, they will be replaced with 'os.mkdir()',
1011
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1013
# Now, just copy the existing cached tree to the new location
1014
# We use a cheap trick here.
1015
# Absolute paths are prefixed with the first parameter
1016
# relative paths are prefixed with the second.
1017
# So we can get both the source and target returned
1018
# without any extra work.
1020
def copy_dir(source, dest):
1023
def copy_link(source, dest):
1024
"""Copy the contents of a symlink"""
1025
link_to = os.readlink(source)
1026
os.symlink(link_to, dest)
1028
real_handlers = {'file':shutil.copy2,
1029
'symlink':copy_link,
1030
'directory':copy_dir,
1032
real_handlers.update(handlers)
1034
if not os.path.exists(to_path):
1035
real_handlers['directory'](from_path, to_path)
1037
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1038
for relpath, name, kind, st, abspath in entries:
1039
real_handlers[kind](abspath, relpath)
1042
def path_prefix_key(path):
1043
"""Generate a prefix-order path key for path.
1045
This can be used to sort paths in the same way that walkdirs does.
1047
return (dirname(path) , path)
1050
def compare_paths_prefix_order(path_a, path_b):
1051
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1052
key_a = path_prefix_key(path_a)
1053
key_b = path_prefix_key(path_b)
1054
return cmp(key_a, key_b)
1057
_cached_user_encoding = None
1060
def get_user_encoding():
1061
"""Find out what the preferred user encoding is.
1063
This is generally the encoding that is used for command line parameters
1064
and file contents. This may be different from the terminal encoding
1065
or the filesystem encoding.
1067
:return: A string defining the preferred user encoding
1069
global _cached_user_encoding
1070
if _cached_user_encoding is not None:
1071
return _cached_user_encoding
1073
if sys.platform == 'darwin':
1074
# work around egregious python 2.4 bug
1075
sys.platform = 'posix'
1079
sys.platform = 'darwin'
1084
_cached_user_encoding = locale.getpreferredencoding()
1085
except locale.Error, e:
1086
sys.stderr.write('bzr: warning: %s\n'
1087
' Could not determine what text encoding to use.\n'
1088
' This error usually means your Python interpreter\n'
1089
' doesn\'t support the locale set by $LANG (%s)\n'
1090
" Continuing with ascii encoding.\n"
1091
% (e, os.environ.get('LANG')))
1093
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1094
# treat that as ASCII, and not support printing unicode characters to the
1096
if _cached_user_encoding in (None, 'cp0'):
1097
_cached_user_encoding = 'ascii'
1098
return _cached_user_encoding
1101
def recv_all(socket, bytes):
1102
"""Receive an exact number of bytes.
1104
Regular Socket.recv() may return less than the requested number of bytes,
1105
dependning on what's in the OS buffer. MSG_WAITALL is not available
1106
on all platforms, but this should work everywhere. This will return
1107
less than the requested amount if the remote end closes.
1109
This isn't optimized and is intended mostly for use in testing.
1112
while len(b) < bytes:
1113
new = socket.recv(bytes - len(b))
1119
def dereference_path(path):
1120
"""Determine the real path to a file.
1122
All parent elements are dereferenced. But the file itself is not
1124
:param path: The original path. May be absolute or relative.
1125
:return: the real path *to* the file
1127
parent, base = os.path.split(path)
1128
# The pathjoin for '.' is a workaround for Python bug #1213894.
1129
# (initial path components aren't dereferenced)
1130
return pathjoin(realpath(pathjoin('.', parent)), base)
added
removed
bzrlib/osutils.py
