15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from cStringIO import StringIO
21
from ntpath import (abspath as _nt_abspath,
23
normpath as _nt_normpath,
24
realpath as _nt_realpath,
25
splitdrive as _nt_splitdrive,
28
from os import listdir
33
from shutil import copyfile
35
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
36
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
27
from datetime import datetime
31
# We need to import both shutil and rmtree as we export the later on posix
32
# and need the former on windows
34
from shutil import rmtree
37
# We need to import both tempfile and mkdtemp as we export the later on posix
38
# and need the former on windows
40
from tempfile import mkdtemp
51
from bzrlib.symbol_versioning import (
56
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
58
if sys.version_info < (2, 5):
59
import md5 as _mod_md5
61
import sha as _mod_sha
45
from bzrlib.errors import (BzrError,
46
BzrBadParameterNotUnicode,
51
from bzrlib.symbol_versioning import (deprecated_function,
53
from bzrlib.trace import mutter
71
from bzrlib import symbol_versioning
74
# Cross platform wall-clock time functionality with decent resolution.
75
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
76
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
77
# synchronized with ``time.time()``, this is only meant to be used to find
78
# delta times by subtracting from another call to this function.
79
timer_func = time.time
80
if sys.platform == 'win32':
81
timer_func = time.clock
56
83
# On win32, O_BINARY is used to indicate the file should
57
84
# be opened in binary mode, rather than text mode.
58
85
# On other platforms, O_BINARY doesn't exist, because
59
86
# they always open in binary mode, so it is okay to
60
# OR with 0 on those platforms
87
# OR with 0 on those platforms.
88
# O_NOINHERIT and O_TEXT exists only on win32 too.
61
89
O_BINARY = getattr(os, 'O_BINARY', 0)
90
O_TEXT = getattr(os, 'O_TEXT', 0)
91
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
94
def get_unicode_argv():
96
user_encoding = get_user_encoding()
97
return [a.decode(user_encoding) for a in sys.argv[1:]]
98
except UnicodeDecodeError:
99
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
64
103
def make_readonly(filename):
65
104
"""Make a filename read-only."""
66
mod = os.stat(filename).st_mode
68
os.chmod(filename, mod)
105
mod = os.lstat(filename).st_mode
106
if not stat.S_ISLNK(mod):
108
os.chmod(filename, mod)
71
111
def make_writable(filename):
72
mod = os.stat(filename).st_mode
74
os.chmod(filename, mod)
112
mod = os.lstat(filename).st_mode
113
if not stat.S_ISLNK(mod):
115
os.chmod(filename, mod)
118
def minimum_path_selection(paths):
119
"""Return the smallset subset of paths which are outside paths.
121
:param paths: A container (and hence not None) of paths.
122
:return: A set of paths sufficient to include everything in paths via
123
is_inside, drawn from the paths parameter.
129
return path.split('/')
130
sorted_paths = sorted(list(paths), key=sort_key)
132
search_paths = [sorted_paths[0]]
133
for path in sorted_paths[1:]:
134
if not is_inside(search_paths[-1], path):
135
# This path is unique, add it
136
search_paths.append(path)
138
return set(search_paths)
555
715
def local_time_offset(t=None):
556
716
"""Return offset of local zone from GMT, either at present or at time t."""
557
# python2.3 localtime() can't take None
561
if time.localtime(t).tm_isdst and time.daylight:
564
return -time.timezone
567
def format_date(t, offset=0, timezone='original', date_fmt=None,
719
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
720
return offset.days * 86400 + offset.seconds
722
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
723
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
726
def format_date(t, offset=0, timezone='original', date_fmt=None,
568
727
show_offset=True):
569
## TODO: Perhaps a global option to use either universal or local time?
570
## Or perhaps just let people set $TZ?
571
assert isinstance(t, float)
728
"""Return a formatted date string.
730
:param t: Seconds since the epoch.
731
:param offset: Timezone offset in seconds east of utc.
732
:param timezone: How to display the time: 'utc', 'original' for the
733
timezone specified by offset, or 'local' for the process's current
735
:param date_fmt: strftime format.
736
:param show_offset: Whether to append the timezone.
738
(date_fmt, tt, offset_str) = \
739
_format_date(t, offset, timezone, date_fmt, show_offset)
740
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
741
date_str = time.strftime(date_fmt, tt)
742
return date_str + offset_str
745
# Cache of formatted offset strings
749
def format_date_with_offset_in_original_timezone(t, offset=0,
750
_cache=_offset_cache):
751
"""Return a formatted date string in the original timezone.
753
This routine may be faster then format_date.
755
:param t: Seconds since the epoch.
756
:param offset: Timezone offset in seconds east of utc.
760
tt = time.gmtime(t + offset)
761
date_fmt = _default_format_by_weekday_num[tt[6]]
762
date_str = time.strftime(date_fmt, tt)
763
offset_str = _cache.get(offset, None)
764
if offset_str is None:
765
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
766
_cache[offset] = offset_str
767
return date_str + offset_str
770
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
772
"""Return an unicode date string formatted according to the current locale.
774
:param t: Seconds since the epoch.
775
:param offset: Timezone offset in seconds east of utc.
776
:param timezone: How to display the time: 'utc', 'original' for the
777
timezone specified by offset, or 'local' for the process's current
779
:param date_fmt: strftime format.
780
:param show_offset: Whether to append the timezone.
782
(date_fmt, tt, offset_str) = \
783
_format_date(t, offset, timezone, date_fmt, show_offset)
784
date_str = time.strftime(date_fmt, tt)
785
if not isinstance(date_str, unicode):
786
date_str = date_str.decode(get_user_encoding(), 'replace')
787
return date_str + offset_str
790
def _format_date(t, offset, timezone, date_fmt, show_offset):
573
791
if timezone == 'utc':
574
792
tt = time.gmtime(t)
576
794
elif timezone == 'original':
579
797
tt = time.gmtime(t + offset)
580
798
elif timezone == 'local':
581
799
tt = time.localtime(t)
582
800
offset = local_time_offset(t)
584
raise BzrError("unsupported timezone format %r" % timezone,
585
['options are "utc", "original", "local"'])
802
raise errors.UnsupportedTimezoneFormat(timezone)
586
803
if date_fmt is None:
587
804
date_fmt = "%a %Y-%m-%d %H:%M:%S"
589
806
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
592
return (time.strftime(date_fmt, tt) + offset_str)
809
return (date_fmt, tt, offset_str)
595
812
def compact_date(when):
596
813
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
816
def format_delta(delta):
817
"""Get a nice looking string for a time delta.
819
:param delta: The time difference in seconds, can be positive or negative.
820
positive indicates time in the past, negative indicates time in the
821
future. (usually time.time() - stored_time)
822
:return: String formatted to show approximate resolution
828
direction = 'in the future'
832
if seconds < 90: # print seconds up to 90 seconds
834
return '%d second %s' % (seconds, direction,)
836
return '%d seconds %s' % (seconds, direction)
838
minutes = int(seconds / 60)
839
seconds -= 60 * minutes
844
if minutes < 90: # print minutes, seconds up to 90 minutes
846
return '%d minute, %d second%s %s' % (
847
minutes, seconds, plural_seconds, direction)
849
return '%d minutes, %d second%s %s' % (
850
minutes, seconds, plural_seconds, direction)
852
hours = int(minutes / 60)
853
minutes -= 60 * hours
860
return '%d hour, %d minute%s %s' % (hours, minutes,
861
plural_minutes, direction)
862
return '%d hours, %d minute%s %s' % (hours, minutes,
863
plural_minutes, direction)
601
866
"""Return size of given open file."""
602
return os.fstat(f.fileno())[ST_SIZE]
867
return os.fstat(f.fileno())[stat.ST_SIZE]
605
870
# Define rand_bytes based on platform.
669
raise BzrError("sorry, %r not allowed in path" % f)
918
raise errors.BzrError("sorry, %r not allowed in path" % f)
670
919
elif (f == '.') or (f == ''):
677
assert isinstance(p, list)
679
if (f == '..') or (f == None) or (f == ''):
680
raise BzrError("sorry, %r not allowed in path" % f)
928
if (f == '..') or (f is None) or (f == ''):
929
raise errors.BzrError("sorry, %r not allowed in path" % f)
681
930
return pathjoin(*p)
684
@deprecated_function(zero_nine)
685
def appendpath(p1, p2):
689
return pathjoin(p1, p2)
933
def parent_directories(filename):
934
"""Return the list of parent directories, deepest first.
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
939
parts = splitpath(dirname(filename))
941
parents.append(joinpath(parts))
946
_extension_load_failures = []
949
def failed_to_load_extension(exception):
950
"""Handle failing to load a binary extension.
952
This should be called from the ImportError block guarding the attempt to
953
import the native extension. If this function returns, the pure-Python
954
implementation should be loaded instead::
957
>>> import bzrlib._fictional_extension_pyx
958
>>> except ImportError, e:
959
>>> bzrlib.osutils.failed_to_load_extension(e)
960
>>> import bzrlib._fictional_extension_py
962
# NB: This docstring is just an example, not a doctest, because doctest
963
# currently can't cope with the use of lazy imports in this namespace --
966
# This currently doesn't report the failure at the time it occurs, because
967
# they tend to happen very early in startup when we can't check config
968
# files etc, and also we want to report all failures but not spam the user
970
exception_str = str(exception)
971
if exception_str not in _extension_load_failures:
972
trace.mutter("failed to load compiled extension: %s" % exception_str)
973
_extension_load_failures.append(exception_str)
976
def report_extension_load_failures():
977
if not _extension_load_failures:
979
from bzrlib.config import GlobalConfig
980
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
982
# the warnings framework should by default show this only once
983
from bzrlib.trace import warning
985
"bzr: warning: some compiled extensions could not be loaded; "
986
"see <https://answers.launchpad.net/bzr/+faq/703>")
987
# we no longer show the specific missing extensions here, because it makes
988
# the message too long and scary - see
989
# https://bugs.launchpad.net/bzr/+bug/430529
993
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
994
except ImportError, e:
995
failed_to_load_extension(e)
996
from bzrlib._chunks_to_lines_py import chunks_to_lines
692
999
def split_lines(s):
693
1000
"""Split s into lines, but without removing the newline characters."""
1001
# Trivially convert a fulltext into a 'chunked' representation, and let
1002
# chunks_to_lines do the heavy lifting.
1003
if isinstance(s, str):
1004
# chunks_to_lines only supports 8-bit strings
1005
return chunks_to_lines([s])
1007
return _split_lines(s)
1010
def _split_lines(s):
1011
"""Split s into lines, but without removing the newline characters.
1013
This supports Unicode or plain string objects.
694
1015
lines = s.split('\n')
695
1016
result = [line + '\n' for line in lines[:-1]]
705
1026
def link_or_copy(src, dest):
706
1027
"""Hardlink a file, or copy it if it can't be hardlinked."""
707
1028
if not hardlinks_good():
1029
shutil.copyfile(src, dest)
711
1032
os.link(src, dest)
712
1033
except (OSError, IOError), e:
713
1034
if e.errno != errno.EXDEV:
717
def delete_any(full_path):
718
"""Delete a file or directory."""
1036
shutil.copyfile(src, dest)
1039
def delete_any(path):
1040
"""Delete a file, symlink or directory.
1042
Will delete even if readonly.
722
# We may be renaming a dangling inventory id
723
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
1045
_delete_file_or_dir(path)
1046
except (OSError, IOError), e:
1047
if e.errno in (errno.EPERM, errno.EACCES):
1048
# make writable and try again
1051
except (OSError, IOError):
1053
_delete_file_or_dir(path)
1058
def _delete_file_or_dir(path):
1059
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1060
# Forgiveness than Permission (EAFP) because:
1061
# - root can damage a solaris file system by using unlink,
1062
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1063
# EACCES, OSX: EPERM) when invoked on a directory.
1064
if isdir(path): # Takes care of symlinks
728
1070
def has_symlinks():
729
if hasattr(os, 'symlink'):
1071
if getattr(os, 'symlink', None) is not None:
1077
def has_hardlinks():
1078
if getattr(os, 'link', None) is not None:
1084
def host_os_dereferences_symlinks():
1085
return (has_symlinks()
1086
and sys.platform not in ('cygwin', 'win32'))
1089
def readlink(abspath):
1090
"""Return a string representing the path to which the symbolic link points.
1092
:param abspath: The link absolute unicode path.
1094
This his guaranteed to return the symbolic link in unicode in all python
1097
link = abspath.encode(_fs_enc)
1098
target = os.readlink(link)
1099
target = target.decode(_fs_enc)
735
1103
def contains_whitespace(s):
736
1104
"""True if there are any whitespace characters in s."""
737
for ch in string.whitespace:
1105
# string.whitespace can include '\xa0' in certain locales, because it is
1106
# considered "non-breaking-space" as part of ISO-8859-1. But it
1107
# 1) Isn't a breaking whitespace
1108
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
1110
# 3) '\xa0' isn't unicode safe since it is >128.
1112
# This should *not* be a unicode set of characters in case the source
1113
# string is not a Unicode string. We can auto-up-cast the characters since
1114
# they are ascii, but we don't want to auto-up-cast the string in case it
1116
for ch in ' \t\n\r\v\f':
759
1138
os.path.commonprefix (python2.4) has a bad bug that it works just
760
1139
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
761
1140
avoids that problem.
1142
NOTE: `base` should not have a trailing slash otherwise you'll get
1143
PathNotChild exceptions regardless of `path`.
764
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
765
' exceed the platform minimum length (which is %d)' %
1146
if len(base) < MIN_ABS_PATHLENGTH:
1147
# must have space for e.g. a drive letter
1148
raise ValueError('%r is too short to calculate a relative path'
768
1151
rp = abspath(path)
772
while len(head) >= len(base):
1156
if len(head) <= len(base) and head != base:
1157
raise errors.PathNotChild(rp, base)
773
1158
if head == base:
775
head, tail = os.path.split(head)
1160
head, tail = split(head)
779
raise PathNotChild(rp, base)
1165
return pathjoin(*reversed(s))
1170
def _cicp_canonical_relpath(base, path):
1171
"""Return the canonical path relative to base.
1173
Like relpath, but on case-insensitive-case-preserving file-systems, this
1174
will return the relpath as stored on the file-system rather than in the
1175
case specified in the input string, for all existing portions of the path.
1177
This will cause O(N) behaviour if called for every path in a tree; if you
1178
have a number of paths to convert, you should use canonical_relpaths().
1180
# TODO: it should be possible to optimize this for Windows by using the
1181
# win32 API FindFiles function to look for the specified name - but using
1182
# os.listdir() still gives us the correct, platform agnostic semantics in
1185
rel = relpath(base, path)
1186
# '.' will have been turned into ''
1190
abs_base = abspath(base)
1192
_listdir = os.listdir
1194
# use an explicit iterator so we can easily consume the rest on early exit.
1195
bit_iter = iter(rel.split('/'))
1196
for bit in bit_iter:
1199
next_entries = _listdir(current)
1200
except OSError: # enoent, eperm, etc
1201
# We can't find this in the filesystem, so just append the
1203
current = pathjoin(current, bit, *list(bit_iter))
1205
for look in next_entries:
1206
if lbit == look.lower():
1207
current = pathjoin(current, look)
1210
# got to the end, nothing matched, so we just return the
1211
# non-existing bits as they were specified (the filename may be
1212
# the target of a move, for example).
1213
current = pathjoin(current, bit, *list(bit_iter))
1215
return current[len(abs_base):].lstrip('/')
1217
# XXX - TODO - we need better detection/integration of case-insensitive
1218
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1219
# filesystems), for example, so could probably benefit from the same basic
1220
# support there. For now though, only Windows and OSX get that support, and
1221
# they get it for *all* file-systems!
1222
if sys.platform in ('win32', 'darwin'):
1223
canonical_relpath = _cicp_canonical_relpath
1225
canonical_relpath = relpath
1227
def canonical_relpaths(base, paths):
1228
"""Create an iterable to canonicalize a sequence of relative paths.
1230
The intent is for this implementation to use a cache, vastly speeding
1231
up multiple transformations in the same directory.
1233
# but for now, we haven't optimized...
1234
return [canonical_relpath(base, p) for p in paths]
1237
def decode_filename(filename):
1238
"""Decode the filename using the filesystem encoding
1240
If it is unicode, it is returned.
1241
Otherwise it is decoded from the the filesystem's encoding. If decoding
1242
fails, a errors.BadFilenameEncoding exception is raised.
1244
if type(filename) is unicode:
1247
return filename.decode(_fs_enc)
1248
except UnicodeDecodeError:
1249
raise errors.BadFilenameEncoding(filename, _fs_enc)
787
1252
def safe_unicode(unicode_or_utf8_string):
788
1253
"""Coerce unicode_or_utf8_string into unicode.
790
1255
If it is unicode, it is returned.
791
Otherwise it is decoded from utf-8. If a decoding error
792
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
793
as a BzrBadParameter exception.
1256
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1257
wrapped in a BzrBadParameterNotUnicode exception.
795
1259
if isinstance(unicode_or_utf8_string, unicode):
796
1260
return unicode_or_utf8_string
798
1262
return unicode_or_utf8_string.decode('utf8')
799
1263
except UnicodeDecodeError:
800
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
1264
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1267
def safe_utf8(unicode_or_utf8_string):
1268
"""Coerce unicode_or_utf8_string to a utf8 string.
1270
If it is a str, it is returned.
1271
If it is Unicode, it is encoded into a utf-8 string.
1273
if isinstance(unicode_or_utf8_string, str):
1274
# TODO: jam 20070209 This is overkill, and probably has an impact on
1275
# performance if we are dealing with lots of apis that want a
1278
# Make sure it is a valid utf-8 string
1279
unicode_or_utf8_string.decode('utf-8')
1280
except UnicodeDecodeError:
1281
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1282
return unicode_or_utf8_string
1283
return unicode_or_utf8_string.encode('utf-8')
1286
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1287
' Revision id generators should be creating utf8'
1291
def safe_revision_id(unicode_or_utf8_string, warn=True):
1292
"""Revision ids should now be utf8, but at one point they were unicode.
1294
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1296
:param warn: Functions that are sanitizing user data can set warn=False
1297
:return: None or a utf8 revision id.
1299
if (unicode_or_utf8_string is None
1300
or unicode_or_utf8_string.__class__ == str):
1301
return unicode_or_utf8_string
1303
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1305
return cache_utf8.encode(unicode_or_utf8_string)
1308
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1309
' generators should be creating utf8 file ids.')
1312
def safe_file_id(unicode_or_utf8_string, warn=True):
1313
"""File ids should now be utf8, but at one point they were unicode.
1315
This is the same as safe_utf8, except it uses the cached encode functions
1316
to save a little bit of performance.
1318
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1320
:param warn: Functions that are sanitizing user data can set warn=False
1321
:return: None or a utf8 file id.
1323
if (unicode_or_utf8_string is None
1324
or unicode_or_utf8_string.__class__ == str):
1325
return unicode_or_utf8_string
1327
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1329
return cache_utf8.encode(unicode_or_utf8_string)
803
1332
_platform_normalizes_filenames = False
844
1373
normalized_filename = _inaccessible_normalized_filename
1376
def set_signal_handler(signum, handler, restart_syscall=True):
1377
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1378
on platforms that support that.
1380
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1381
automatically restart (by calling `signal.siginterrupt(signum,
1382
False)`). May be ignored if the feature is not available on this
1383
platform or Python version.
1387
siginterrupt = signal.siginterrupt
1389
# This python implementation doesn't provide signal support, hence no
1392
except AttributeError:
1393
# siginterrupt doesn't exist on this platform, or for this version
1395
siginterrupt = lambda signum, flag: None
1397
def sig_handler(*args):
1398
# Python resets the siginterrupt flag when a signal is
1399
# received. <http://bugs.python.org/issue8354>
1400
# As a workaround for some cases, set it back the way we want it.
1401
siginterrupt(signum, False)
1402
# Now run the handler function passed to set_signal_handler.
1405
sig_handler = handler
1406
old_handler = signal.signal(signum, sig_handler)
1408
siginterrupt(signum, False)
1412
default_terminal_width = 80
1413
"""The default terminal width for ttys.
1415
This is defined so that higher levels can share a common fallback value when
1416
terminal_width() returns None.
1419
# Keep some state so that terminal_width can detect if _terminal_size has
1420
# returned a different size since the process started. See docstring and
1421
# comments of terminal_width for details.
1422
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1423
_terminal_size_state = 'no_data'
1424
_first_terminal_size = None
847
1426
def terminal_width():
848
"""Return estimated terminal width."""
849
if sys.platform == 'win32':
850
import bzrlib.win32console
851
return bzrlib.win32console.get_console_size()[0]
1427
"""Return terminal width.
1429
None is returned if the width can't established precisely.
1432
- if BZR_COLUMNS is set, returns its value
1433
- if there is no controlling terminal, returns None
1434
- query the OS, if the queried size has changed since the last query,
1436
- if COLUMNS is set, returns its value,
1437
- if the OS has a value (even though it's never changed), return its value.
1439
From there, we need to query the OS to get the size of the controlling
1442
On Unices we query the OS by:
1443
- get termios.TIOCGWINSZ
1444
- if an error occurs or a negative value is obtained, returns None
1446
On Windows we query the OS by:
1447
- win32utils.get_console_size() decides,
1448
- returns None on error (provided default value)
1450
# Note to implementors: if changing the rules for determining the width,
1451
# make sure you've considered the behaviour in these cases:
1452
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1453
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1455
# - (add more interesting cases here, if you find any)
1456
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1457
# but we don't want to register a signal handler because it is impossible
1458
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1459
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1460
# time so we can notice if the reported size has changed, which should have
1463
# If BZR_COLUMNS is set, take it, user is always right
1464
# Except if they specified 0 in which case, impose no limit here
1466
width = int(os.environ['BZR_COLUMNS'])
1467
except (KeyError, ValueError):
1469
if width is not None:
1475
isatty = getattr(sys.stdout, 'isatty', None)
1476
if isatty is None or not isatty():
1477
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1481
width, height = os_size = _terminal_size(None, None)
1482
global _first_terminal_size, _terminal_size_state
1483
if _terminal_size_state == 'no_data':
1484
_first_terminal_size = os_size
1485
_terminal_size_state = 'unchanged'
1486
elif (_terminal_size_state == 'unchanged' and
1487
_first_terminal_size != os_size):
1488
_terminal_size_state = 'changed'
1490
# If the OS claims to know how wide the terminal is, and this value has
1491
# ever changed, use that.
1492
if _terminal_size_state == 'changed':
1493
if width is not None and width > 0:
1496
# If COLUMNS is set, use it.
1498
return int(os.environ['COLUMNS'])
1499
except (KeyError, ValueError):
1502
# Finally, use an unchanged size from the OS, if we have one.
1503
if _terminal_size_state == 'unchanged':
1504
if width is not None and width > 0:
1507
# The width could not be determined.
1511
def _win32_terminal_size(width, height):
1512
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1513
return width, height
1516
def _ioctl_terminal_size(width, height):
854
1518
import struct, fcntl, termios
855
1519
s = struct.pack('HHHH', 0, 0, 0, 0)
856
1520
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
857
width = struct.unpack('HHHH', x)[1]
1521
height, width = struct.unpack('HHHH', x)[0:2]
1522
except (IOError, AttributeError):
862
width = int(os.environ['COLUMNS'])
1524
return width, height
1526
_terminal_size = None
1527
"""Returns the terminal size as (width, height).
1529
:param width: Default value for width.
1530
:param height: Default value for height.
1532
This is defined specifically for each OS and query the size of the controlling
1533
terminal. If any error occurs, the provided default values should be returned.
1535
if sys.platform == 'win32':
1536
_terminal_size = _win32_terminal_size
1538
_terminal_size = _ioctl_terminal_size
870
1541
def supports_executable():
871
1542
return sys.platform != "win32"
1545
def supports_posix_readonly():
1546
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1548
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1549
directory controls creation/deletion, etc.
1551
And under win32, readonly means that the directory itself cannot be
1552
deleted. The contents of a readonly directory can be changed, unlike POSIX
1553
where files in readonly directories cannot be added, deleted or renamed.
1555
return sys.platform != "win32"
1558
def set_or_unset_env(env_variable, value):
1559
"""Modify the environment, setting or removing the env_variable.
1561
:param env_variable: The environment variable in question
1562
:param value: The value to set the environment to. If None, then
1563
the variable will be removed.
1564
:return: The original value of the environment variable.
1566
orig_val = os.environ.get(env_variable)
1568
if orig_val is not None:
1569
del os.environ[env_variable]
1571
if isinstance(value, unicode):
1572
value = value.encode(get_user_encoding())
1573
os.environ[env_variable] = value
874
1577
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
877
1580
def check_legal_path(path):
878
"""Check whether the supplied path is legal.
1581
"""Check whether the supplied path is legal.
879
1582
This is only required on Windows, so we don't test on other platforms
882
1585
if sys.platform != "win32":
884
1587
if _validWin32PathRE.match(path) is None:
885
raise IllegalPath(path)
1588
raise errors.IllegalPath(path)
1591
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1593
def _is_error_enotdir(e):
1594
"""Check if this exception represents ENOTDIR.
1596
Unfortunately, python is very inconsistent about the exception
1597
here. The cases are:
1598
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1599
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1600
which is the windows error code.
1601
3) Windows, Python2.5 uses errno == EINVAL and
1602
winerror == ERROR_DIRECTORY
1604
:param e: An Exception object (expected to be OSError with an errno
1605
attribute, but we should be able to cope with anything)
1606
:return: True if this represents an ENOTDIR error. False otherwise.
1608
en = getattr(e, 'errno', None)
1609
if (en == errno.ENOTDIR
1610
or (sys.platform == 'win32'
1611
and (en == _WIN32_ERROR_DIRECTORY
1612
or (en == errno.EINVAL
1613
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
888
1619
def walkdirs(top, prefix=""):
889
1620
"""Yield data about all the directories in a tree.
891
1622
This yields all the data about the contents of a directory at a time.
892
1623
After each directory has been yielded, if the caller has mutated the list
893
1624
to exclude some directories, they are then not descended into.
895
1626
The data yielded is of the form:
896
1627
((directory-relpath, directory-path-from-top),
897
[(relpath, basename, kind, lstat), ...]),
1628
[(relpath, basename, kind, lstat, path-from-top), ...]),
898
1629
- directory-relpath is the relative path of the directory being returned
899
1630
with respect to top. prefix is prepended to this.
900
- directory-path-from-root is the path including top for this directory.
1631
- directory-path-from-root is the path including top for this directory.
901
1632
It is suitable for use with os functions.
902
1633
- relpath is the relative path within the subtree being walked.
903
1634
- basename is the basename of the path
905
1636
present within the tree - but it may be recorded as versioned. See
907
1638
- lstat is the stat data *if* the file was statted.
908
- planned, not implemented:
1639
- planned, not implemented:
909
1640
path_from_tree_root is the path from the root of the tree.
911
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1642
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
912
1643
allows one to walk a subtree but get paths that are relative to a tree
913
1644
rooted higher up.
914
1645
:return: an iterator over the dirs.
916
1647
#TODO there is a bit of a smell where the results of the directory-
917
# summary in this, and the path from the root, may not agree
1648
# summary in this, and the path from the root, may not agree
918
1649
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
919
1650
# potentially confusing output. We should make this more robust - but
920
1651
# not at a speed cost. RBC 20060731
923
1653
_directory = _directory_kind
925
pending = [(prefix, "", _directory, None, top)]
1654
_listdir = os.listdir
1655
_kind_from_mode = file_kind_from_stat_mode
1656
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
928
currentdir = pending.pop()
929
1658
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
932
relroot = currentdir[0] + '/'
1659
relroot, _, _, _, top = pending.pop()
1661
relprefix = relroot + u'/'
1664
top_slash = top + u'/'
1667
append = dirblock.append
1669
names = sorted(map(decode_filename, _listdir(top)))
1671
if not _is_error_enotdir(e):
1675
abspath = top_slash + name
1676
statvalue = _lstat(abspath)
1677
kind = _kind_from_mode(statvalue.st_mode)
1678
append((relprefix + name, name, kind, statvalue, abspath))
1679
yield (relroot, top), dirblock
1681
# push the user specified dirs from dirblock
1682
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1685
class DirReader(object):
1686
"""An interface for reading directories."""
1688
def top_prefix_to_starting_dir(self, top, prefix=""):
1689
"""Converts top and prefix to a starting dir entry
1691
:param top: A utf8 path
1692
:param prefix: An optional utf8 path to prefix output relative paths
1694
:return: A tuple starting with prefix, and ending with the native
1697
raise NotImplementedError(self.top_prefix_to_starting_dir)
1699
def read_dir(self, prefix, top):
1700
"""Read a specific dir.
1702
:param prefix: A utf8 prefix to be preprended to the path basenames.
1703
:param top: A natively encoded path to read.
1704
:return: A list of the directories contents. Each item contains:
1705
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1707
raise NotImplementedError(self.read_dir)
1710
_selected_dir_reader = None
1713
def _walkdirs_utf8(top, prefix=""):
1714
"""Yield data about all the directories in a tree.
1716
This yields the same information as walkdirs() only each entry is yielded
1717
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1718
are returned as exact byte-strings.
1720
:return: yields a tuple of (dir_info, [file_info])
1721
dir_info is (utf8_relpath, path-from-top)
1722
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1723
if top is an absolute path, path-from-top is also an absolute path.
1724
path-from-top might be unicode or utf8, but it is the correct path to
1725
pass to os functions to affect the file in question. (such as os.lstat)
1727
global _selected_dir_reader
1728
if _selected_dir_reader is None:
1729
fs_encoding = _fs_enc.upper()
1730
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1731
# Win98 doesn't have unicode apis like FindFirstFileW
1732
# TODO: We possibly could support Win98 by falling back to the
1733
# original FindFirstFile, and using TCHAR instead of WCHAR,
1734
# but that gets a bit tricky, and requires custom compiling
1737
from bzrlib._walkdirs_win32 import Win32ReadDir
1738
_selected_dir_reader = Win32ReadDir()
1741
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1742
# ANSI_X3.4-1968 is a form of ASCII
1744
from bzrlib._readdir_pyx import UTF8DirReader
1745
_selected_dir_reader = UTF8DirReader()
1746
except ImportError, e:
1747
failed_to_load_extension(e)
1750
if _selected_dir_reader is None:
1751
# Fallback to the python version
1752
_selected_dir_reader = UnicodeDirReader()
1754
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1755
# But we don't actually uses 1-3 in pending, so set them to None
1756
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1757
read_dir = _selected_dir_reader.read_dir
1758
_directory = _directory_kind
1760
relroot, _, _, _, top = pending[-1].pop()
1763
dirblock = sorted(read_dir(relroot, top))
1764
yield (relroot, top), dirblock
1765
# push the user specified dirs from dirblock
1766
next = [d for d in reversed(dirblock) if d[2] == _directory]
1768
pending.append(next)
1771
class UnicodeDirReader(DirReader):
1772
"""A dir reader for non-utf8 file systems, which transcodes."""
1774
__slots__ = ['_utf8_encode']
1777
self._utf8_encode = codecs.getencoder('utf8')
1779
def top_prefix_to_starting_dir(self, top, prefix=""):
1780
"""See DirReader.top_prefix_to_starting_dir."""
1781
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1783
def read_dir(self, prefix, top):
1784
"""Read a single directory from a non-utf8 file system.
1786
top, and the abspath element in the output are unicode, all other paths
1787
are utf8. Local disk IO is done via unicode calls to listdir etc.
1789
This is currently the fallback code path when the filesystem encoding is
1790
not UTF-8. It may be better to implement an alternative so that we can
1791
safely handle paths that are not properly decodable in the current
1794
See DirReader.read_dir for details.
1796
_utf8_encode = self._utf8_encode
1798
_listdir = os.listdir
1799
_kind_from_mode = file_kind_from_stat_mode
1802
relprefix = prefix + '/'
1805
top_slash = top + u'/'
1808
append = dirblock.append
935
1809
for name in sorted(_listdir(top)):
936
abspath = top + '/' + name
937
statvalue = lstat(abspath)
938
dirblock.append((relroot + name, name,
939
file_kind_from_stat_mode(statvalue.st_mode),
941
yield (currentdir[0], top), dirblock
942
# push the user specified dirs from dirblock
943
for dir in reversed(dirblock):
944
if dir[2] == _directory:
1811
name_utf8 = _utf8_encode(name)[0]
1812
except UnicodeDecodeError:
1813
raise errors.BadFilenameEncoding(
1814
_utf8_encode(relprefix)[0] + name, _fs_enc)
1815
abspath = top_slash + name
1816
statvalue = _lstat(abspath)
1817
kind = _kind_from_mode(statvalue.st_mode)
1818
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
948
1822
def copy_tree(from_path, to_path, handlers={}):
949
1823
"""Copy all of the entries in from_path into to_path.
951
:param from_path: The base directory to copy.
1825
:param from_path: The base directory to copy.
952
1826
:param to_path: The target directory. If it does not exist, it will
954
1828
:param handlers: A dictionary of functions, which takes a source and
1032
_cached_user_encoding = locale.getpreferredencoding()
1945
user_encoding = locale.getpreferredencoding()
1033
1946
except locale.Error, e:
1034
1947
sys.stderr.write('bzr: warning: %s\n'
1035
' Could not what text encoding to use.\n'
1948
' Could not determine what text encoding to use.\n'
1036
1949
' This error usually means your Python interpreter\n'
1037
1950
' doesn\'t support the locale set by $LANG (%s)\n'
1038
1951
" Continuing with ascii encoding.\n"
1039
1952
% (e, os.environ.get('LANG')))
1041
if _cached_user_encoding is None:
1042
_cached_user_encoding = 'ascii'
1043
return _cached_user_encoding
1953
user_encoding = 'ascii'
1955
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1956
# treat that as ASCII, and not support printing unicode characters to the
1959
# For python scripts run under vim, we get '', so also treat that as ASCII
1960
if user_encoding in (None, 'cp0', ''):
1961
user_encoding = 'ascii'
1965
codecs.lookup(user_encoding)
1967
sys.stderr.write('bzr: warning:'
1968
' unknown encoding %s.'
1969
' Continuing with ascii encoding.\n'
1972
user_encoding = 'ascii'
1975
_cached_user_encoding = user_encoding
1977
return user_encoding
1980
def get_diff_header_encoding():
1981
return get_terminal_encoding()
1984
def get_host_name():
1985
"""Return the current unicode host name.
1987
This is meant to be used in place of socket.gethostname() because that
1988
behaves inconsistently on different platforms.
1990
if sys.platform == "win32":
1992
return win32utils.get_host_name()
1995
return socket.gethostname().decode(get_user_encoding())
1998
# We must not read/write any more than 64k at a time from/to a socket so we
1999
# don't risk "no buffer space available" errors on some platforms. Windows in
2000
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2002
MAX_SOCKET_CHUNK = 64 * 1024
2004
_end_of_stream_errors = [errno.ECONNRESET]
2005
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2006
_eno = getattr(errno, _eno, None)
2007
if _eno is not None:
2008
_end_of_stream_errors.append(_eno)
2012
def read_bytes_from_socket(sock, report_activity=None,
2013
max_read_size=MAX_SOCKET_CHUNK):
2014
"""Read up to max_read_size of bytes from sock and notify of progress.
2016
Translates "Connection reset by peer" into file-like EOF (return an
2017
empty string rather than raise an error), and repeats the recv if
2018
interrupted by a signal.
2022
bytes = sock.recv(max_read_size)
2023
except socket.error, e:
2025
if eno in _end_of_stream_errors:
2026
# The connection was closed by the other side. Callers expect
2027
# an empty string to signal end-of-stream.
2029
elif eno == errno.EINTR:
2030
# Retry the interrupted recv.
2034
if report_activity is not None:
2035
report_activity(len(bytes), 'read')
2039
def recv_all(socket, count):
2040
"""Receive an exact number of bytes.
2042
Regular Socket.recv() may return less than the requested number of bytes,
2043
depending on what's in the OS buffer. MSG_WAITALL is not available
2044
on all platforms, but this should work everywhere. This will return
2045
less than the requested amount if the remote end closes.
2047
This isn't optimized and is intended mostly for use in testing.
2050
while len(b) < count:
2051
new = read_bytes_from_socket(socket, None, count - len(b))
2058
def send_all(sock, bytes, report_activity=None):
2059
"""Send all bytes on a socket.
2061
Breaks large blocks in smaller chunks to avoid buffering limitations on
2062
some platforms, and catches EINTR which may be thrown if the send is
2063
interrupted by a signal.
2065
This is preferred to socket.sendall(), because it avoids portability bugs
2066
and provides activity reporting.
2068
:param report_activity: Call this as bytes are read, see
2069
Transport._report_activity
2072
byte_count = len(bytes)
2073
while sent_total < byte_count:
2075
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2076
except socket.error, e:
2077
if e.args[0] != errno.EINTR:
2081
report_activity(sent, 'write')
2084
def connect_socket(address):
2085
# Slight variation of the socket.create_connection() function (provided by
2086
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2087
# provide it for previous python versions. Also, we don't use the timeout
2088
# parameter (provided by the python implementation) so we don't implement
2090
err = socket.error('getaddrinfo returns an empty list')
2091
host, port = address
2092
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2093
af, socktype, proto, canonname, sa = res
2096
sock = socket.socket(af, socktype, proto)
2100
except socket.error, err:
2101
# 'err' is now the most recent error
2102
if sock is not None:
2107
def dereference_path(path):
2108
"""Determine the real path to a file.
2110
All parent elements are dereferenced. But the file itself is not
2112
:param path: The original path. May be absolute or relative.
2113
:return: the real path *to* the file
2115
parent, base = os.path.split(path)
2116
# The pathjoin for '.' is a workaround for Python bug #1213894.
2117
# (initial path components aren't dereferenced)
2118
return pathjoin(realpath(pathjoin('.', parent)), base)
2121
def supports_mapi():
2122
"""Return True if we can use MAPI to launch a mail client."""
2123
return sys.platform == "win32"
2126
def resource_string(package, resource_name):
2127
"""Load a resource from a package and return it as a string.
2129
Note: Only packages that start with bzrlib are currently supported.
2131
This is designed to be a lightweight implementation of resource
2132
loading in a way which is API compatible with the same API from
2134
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2135
If and when pkg_resources becomes a standard library, this routine
2138
# Check package name is within bzrlib
2139
if package == "bzrlib":
2140
resource_relpath = resource_name
2141
elif package.startswith("bzrlib."):
2142
package = package[len("bzrlib."):].replace('.', os.sep)
2143
resource_relpath = pathjoin(package, resource_name)
2145
raise errors.BzrError('resource package %s not in bzrlib' % package)
2147
# Map the resource to a file and read its contents
2148
base = dirname(bzrlib.__file__)
2149
if getattr(sys, 'frozen', None): # bzr.exe
2150
base = abspath(pathjoin(base, '..', '..'))
2151
f = file(pathjoin(base, resource_relpath), "rU")
2157
def file_kind_from_stat_mode_thunk(mode):
2158
global file_kind_from_stat_mode
2159
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2161
from bzrlib._readdir_pyx import UTF8DirReader
2162
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2163
except ImportError, e:
2164
# This is one time where we won't warn that an extension failed to
2165
# load. The extension is never available on Windows anyway.
2166
from bzrlib._readdir_py import (
2167
_kind_from_mode as file_kind_from_stat_mode
2169
return file_kind_from_stat_mode(mode)
2170
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2173
def file_kind(f, _lstat=os.lstat):
2175
return file_kind_from_stat_mode(_lstat(f).st_mode)
2177
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2178
raise errors.NoSuchFile(f)
2182
def until_no_eintr(f, *a, **kw):
2183
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2185
WARNING: you must be certain that it is safe to retry the call repeatedly
2186
if EINTR does occur. This is typically only true for low-level operations
2187
like os.read. If in any doubt, don't use this.
2189
Keep in mind that this is not a complete solution to EINTR. There is
2190
probably code in the Python standard library and other dependencies that
2191
may encounter EINTR if a signal arrives (and there is signal handler for
2192
that signal). So this function can reduce the impact for IO that bzrlib
2193
directly controls, but it is not a complete solution.
2195
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2199
except (IOError, OSError), e:
2200
if e.errno == errno.EINTR:
2205
@deprecated_function(deprecated_in((2, 2, 0)))
2206
def re_compile_checked(re_string, flags=0, where=""):
2207
"""Return a compiled re, or raise a sensible error.
2209
This should only be used when compiling user-supplied REs.
2211
:param re_string: Text form of regular expression.
2212
:param flags: eg re.IGNORECASE
2213
:param where: Message explaining to the user the context where
2214
it occurred, eg 'log search filter'.
2216
# from https://bugs.launchpad.net/bzr/+bug/251352
2218
re_obj = re.compile(re_string, flags)
2221
except errors.InvalidPattern, e:
2223
where = ' in ' + where
2224
# despite the name 'error' is a type
2225
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2229
if sys.platform == "win32":
2232
return msvcrt.getch()
2237
fd = sys.stdin.fileno()
2238
settings = termios.tcgetattr(fd)
2241
ch = sys.stdin.read(1)
2243
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2246
if sys.platform == 'linux2':
2247
def _local_concurrency():
2249
return os.sysconf('SC_NPROCESSORS_ONLN')
2250
except (ValueError, OSError, AttributeError):
2252
elif sys.platform == 'darwin':
2253
def _local_concurrency():
2254
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2255
stdout=subprocess.PIPE).communicate()[0]
2256
elif "bsd" in sys.platform:
2257
def _local_concurrency():
2258
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2259
stdout=subprocess.PIPE).communicate()[0]
2260
elif sys.platform == 'sunos5':
2261
def _local_concurrency():
2262
return subprocess.Popen(['psrinfo', '-p',],
2263
stdout=subprocess.PIPE).communicate()[0]
2264
elif sys.platform == "win32":
2265
def _local_concurrency():
2266
# This appears to return the number of cores.
2267
return os.environ.get('NUMBER_OF_PROCESSORS')
2269
def _local_concurrency():
2274
_cached_local_concurrency = None
2276
def local_concurrency(use_cache=True):
2277
"""Return how many processes can be run concurrently.
2279
Rely on platform specific implementations and default to 1 (one) if
2280
anything goes wrong.
2282
global _cached_local_concurrency
2284
if _cached_local_concurrency is not None and use_cache:
2285
return _cached_local_concurrency
2287
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2288
if concurrency is None:
2290
import multiprocessing
2292
# multiprocessing is only available on Python >= 2.6
2294
concurrency = _local_concurrency()
2295
except (OSError, IOError):
2298
concurrency = multiprocessing.cpu_count()
2300
concurrency = int(concurrency)
2301
except (TypeError, ValueError):
2304
_cached_concurrency = concurrency
2308
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2309
"""A stream writer that doesn't decode str arguments."""
2311
def __init__(self, encode, stream, errors='strict'):
2312
codecs.StreamWriter.__init__(self, stream, errors)
2313
self.encode = encode
2315
def write(self, object):
2316
if type(object) is str:
2317
self.stream.write(object)
2319
data, _ = self.encode(object, self.errors)
2320
self.stream.write(data)
2322
if sys.platform == 'win32':
2323
def open_file(filename, mode='r', bufsize=-1):
2324
"""This function is used to override the ``open`` builtin.
2326
But it uses O_NOINHERIT flag so the file handle is not inherited by
2327
child processes. Deleting or renaming a closed file opened with this
2328
function is not blocking child processes.
2330
writing = 'w' in mode
2331
appending = 'a' in mode
2332
updating = '+' in mode
2333
binary = 'b' in mode
2336
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2337
# for flags for each modes.
2347
flags |= os.O_WRONLY
2348
flags |= os.O_CREAT | os.O_TRUNC
2353
flags |= os.O_WRONLY
2354
flags |= os.O_CREAT | os.O_APPEND
2359
flags |= os.O_RDONLY
2361
return os.fdopen(os.open(filename, flags), mode, bufsize)
2366
def getuser_unicode():
2367
"""Return the username as unicode.
2370
user_encoding = get_user_encoding()
2371
username = getpass.getuser().decode(user_encoding)
2372
except UnicodeDecodeError:
2373
raise errors.BzrError("Can't decode username as %s." % \
2378
def available_backup_name(base, exists):
2379
"""Find a non-existing backup file name.
2381
This will *not* create anything, this only return a 'free' entry. This
2382
should be used for checking names in a directory below a locked
2383
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2384
Leap) and generally discouraged.
2386
:param base: The base name.
2388
:param exists: A callable returning True if the path parameter exists.
2391
name = "%s.~%d~" % (base, counter)
2394
name = "%s.~%d~" % (base, counter)
2398
def set_fd_cloexec(fd):
2399
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2400
support for this is not available.
2404
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2405
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2406
except (ImportError, AttributeError):
2407
# Either the fcntl module or specific constants are not present
2411
def find_executable_on_path(name):
2412
"""Finds an executable on the PATH.
2414
On Windows, this will try to append each extension in the PATHEXT
2415
environment variable to the name, if it cannot be found with the name
2418
:param name: The base name of the executable.
2419
:return: The path to the executable found or None.
2421
path = os.environ.get('PATH')
2424
path = path.split(os.pathsep)
2425
if sys.platform == 'win32':
2426
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2427
exts = [ext.lower() for ext in exts]
2428
base, ext = os.path.splitext(name)
2430
if ext.lower() not in exts:
2438
f = os.path.join(d, name) + ext
2439
if os.access(f, os.X_OK):
added
removed
bzrlib/osutils.py
