69
65
from bzrlib import symbol_versioning
68
# Cross platform wall-clock time functionality with decent resolution.
69
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
70
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
71
# synchronized with ``time.time()``, this is only meant to be used to find
72
# delta times by subtracting from another call to this function.
73
timer_func = time.time
74
if sys.platform == 'win32':
75
timer_func = time.clock
72
77
# On win32, O_BINARY is used to indicate the file should
73
78
# be opened in binary mode, rather than text mode.
74
79
# On other platforms, O_BINARY doesn't exist, because
75
80
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
81
# OR with 0 on those platforms.
82
# O_NOINHERIT and O_TEXT exists only on win32 too.
77
83
O_BINARY = getattr(os, 'O_BINARY', 0)
84
O_TEXT = getattr(os, 'O_TEXT', 0)
85
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
88
def get_unicode_argv():
90
user_encoding = get_user_encoding()
91
return [a.decode(user_encoding) for a in sys.argv[1:]]
92
except UnicodeDecodeError:
93
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
80
97
def make_readonly(filename):
279
315
# /path => C:/path
280
316
path = unicode(path)
281
317
# check for absolute path
282
drive = _nt_splitdrive(path)[0]
318
drive = ntpath.splitdrive(path)[0]
283
319
if drive == '' and path[:2] not in('//','\\\\'):
284
320
cwd = os.getcwdu()
285
321
# we cannot simply os.path.join cwd and path
286
322
# because os.path.join('C:','/path') produce '/path'
287
323
# and this is incorrect
288
324
if path[:1] in ('/','\\'):
289
cwd = _nt_splitdrive(cwd)[0]
325
cwd = ntpath.splitdrive(cwd)[0]
291
327
path = cwd + '\\' + path
292
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
328
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
295
331
def _win32_realpath(path):
296
# Real _nt_realpath doesn't have a problem with a unicode cwd
297
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
332
# Real ntpath.realpath doesn't have a problem with a unicode cwd
333
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
300
336
def _win32_pathjoin(*args):
301
return _nt_join(*args).replace('\\', '/')
337
return ntpath.join(*args).replace('\\', '/')
304
340
def _win32_normpath(path):
305
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
341
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
308
344
def _win32_getcwd():
847
916
return pathjoin(*p)
919
def parent_directories(filename):
920
"""Return the list of parent directories, deepest first.
922
For example, parent_directories("a/b/c") -> ["a/b", "a"].
925
parts = splitpath(dirname(filename))
927
parents.append(joinpath(parts))
932
_extension_load_failures = []
935
def failed_to_load_extension(exception):
936
"""Handle failing to load a binary extension.
938
This should be called from the ImportError block guarding the attempt to
939
import the native extension. If this function returns, the pure-Python
940
implementation should be loaded instead::
943
>>> import bzrlib._fictional_extension_pyx
944
>>> except ImportError, e:
945
>>> bzrlib.osutils.failed_to_load_extension(e)
946
>>> import bzrlib._fictional_extension_py
948
# NB: This docstring is just an example, not a doctest, because doctest
949
# currently can't cope with the use of lazy imports in this namespace --
952
# This currently doesn't report the failure at the time it occurs, because
953
# they tend to happen very early in startup when we can't check config
954
# files etc, and also we want to report all failures but not spam the user
956
from bzrlib import trace
957
exception_str = str(exception)
958
if exception_str not in _extension_load_failures:
959
trace.mutter("failed to load compiled extension: %s" % exception_str)
960
_extension_load_failures.append(exception_str)
963
def report_extension_load_failures():
964
if not _extension_load_failures:
966
from bzrlib.config import GlobalConfig
967
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
969
# the warnings framework should by default show this only once
970
from bzrlib.trace import warning
972
"bzr: warning: some compiled extensions could not be loaded; "
973
"see <https://answers.launchpad.net/bzr/+faq/703>")
974
# we no longer show the specific missing extensions here, because it makes
975
# the message too long and scary - see
976
# https://bugs.launchpad.net/bzr/+bug/430529
851
980
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
981
except ImportError, e:
982
failed_to_load_extension(e)
853
983
from bzrlib._chunks_to_lines_py import chunks_to_lines
893
1023
shutil.copyfile(src, dest)
896
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
897
# Forgiveness than Permission (EAFP) because:
898
# - root can damage a solaris file system by using unlink,
899
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
900
# EACCES, OSX: EPERM) when invoked on a directory.
901
1026
def delete_any(path):
902
"""Delete a file or directory."""
1027
"""Delete a file, symlink or directory.
1029
Will delete even if readonly.
1032
_delete_file_or_dir(path)
1033
except (OSError, IOError), e:
1034
if e.errno in (errno.EPERM, errno.EACCES):
1035
# make writable and try again
1038
except (OSError, IOError):
1040
_delete_file_or_dir(path)
1045
def _delete_file_or_dir(path):
1046
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1047
# Forgiveness than Permission (EAFP) because:
1048
# - root can damage a solaris file system by using unlink,
1049
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1050
# EACCES, OSX: EPERM) when invoked on a directory.
903
1051
if isdir(path): # Takes care of symlinks
1047
1220
# but for now, we haven't optimized...
1048
1221
return [canonical_relpath(base, p) for p in paths]
1224
def decode_filename(filename):
1225
"""Decode the filename using the filesystem encoding
1227
If it is unicode, it is returned.
1228
Otherwise it is decoded from the the filesystem's encoding. If decoding
1229
fails, a errors.BadFilenameEncoding exception is raised.
1231
if type(filename) is unicode:
1234
return filename.decode(_fs_enc)
1235
except UnicodeDecodeError:
1236
raise errors.BadFilenameEncoding(filename, _fs_enc)
1050
1239
def safe_unicode(unicode_or_utf8_string):
1051
1240
"""Coerce unicode_or_utf8_string into unicode.
1053
1242
If it is unicode, it is returned.
1054
Otherwise it is decoded from utf-8. If a decoding error
1055
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
1056
as a BzrBadParameter exception.
1243
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1244
wrapped in a BzrBadParameterNotUnicode exception.
1058
1246
if isinstance(unicode_or_utf8_string, unicode):
1059
1247
return unicode_or_utf8_string
1172
1360
normalized_filename = _inaccessible_normalized_filename
1363
def set_signal_handler(signum, handler, restart_syscall=True):
1364
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1365
on platforms that support that.
1367
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1368
automatically restart (by calling `signal.siginterrupt(signum,
1369
False)`). May be ignored if the feature is not available on this
1370
platform or Python version.
1374
siginterrupt = signal.siginterrupt
1376
# This python implementation doesn't provide signal support, hence no
1379
except AttributeError:
1380
# siginterrupt doesn't exist on this platform, or for this version
1382
siginterrupt = lambda signum, flag: None
1384
def sig_handler(*args):
1385
# Python resets the siginterrupt flag when a signal is
1386
# received. <http://bugs.python.org/issue8354>
1387
# As a workaround for some cases, set it back the way we want it.
1388
siginterrupt(signum, False)
1389
# Now run the handler function passed to set_signal_handler.
1392
sig_handler = handler
1393
old_handler = signal.signal(signum, sig_handler)
1395
siginterrupt(signum, False)
1399
default_terminal_width = 80
1400
"""The default terminal width for ttys.
1402
This is defined so that higher levels can share a common fallback value when
1403
terminal_width() returns None.
1406
# Keep some state so that terminal_width can detect if _terminal_size has
1407
# returned a different size since the process started. See docstring and
1408
# comments of terminal_width for details.
1409
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1410
_terminal_size_state = 'no_data'
1411
_first_terminal_size = None
1175
1413
def terminal_width():
1176
"""Return estimated terminal width."""
1177
if sys.platform == 'win32':
1178
return win32utils.get_console_size()[0]
1414
"""Return terminal width.
1416
None is returned if the width can't established precisely.
1419
- if BZR_COLUMNS is set, returns its value
1420
- if there is no controlling terminal, returns None
1421
- query the OS, if the queried size has changed since the last query,
1423
- if COLUMNS is set, returns its value,
1424
- if the OS has a value (even though it's never changed), return its value.
1426
From there, we need to query the OS to get the size of the controlling
1429
On Unices we query the OS by:
1430
- get termios.TIOCGWINSZ
1431
- if an error occurs or a negative value is obtained, returns None
1433
On Windows we query the OS by:
1434
- win32utils.get_console_size() decides,
1435
- returns None on error (provided default value)
1437
# Note to implementors: if changing the rules for determining the width,
1438
# make sure you've considered the behaviour in these cases:
1439
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1440
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1442
# - (add more interesting cases here, if you find any)
1443
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1444
# but we don't want to register a signal handler because it is impossible
1445
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1446
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1447
# time so we can notice if the reported size has changed, which should have
1450
# If BZR_COLUMNS is set, take it, user is always right
1452
return int(os.environ['BZR_COLUMNS'])
1453
except (KeyError, ValueError):
1456
isatty = getattr(sys.stdout, 'isatty', None)
1457
if isatty is None or not isatty():
1458
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1462
width, height = os_size = _terminal_size(None, None)
1463
global _first_terminal_size, _terminal_size_state
1464
if _terminal_size_state == 'no_data':
1465
_first_terminal_size = os_size
1466
_terminal_size_state = 'unchanged'
1467
elif (_terminal_size_state == 'unchanged' and
1468
_first_terminal_size != os_size):
1469
_terminal_size_state = 'changed'
1471
# If the OS claims to know how wide the terminal is, and this value has
1472
# ever changed, use that.
1473
if _terminal_size_state == 'changed':
1474
if width is not None and width > 0:
1477
# If COLUMNS is set, use it.
1479
return int(os.environ['COLUMNS'])
1480
except (KeyError, ValueError):
1483
# Finally, use an unchanged size from the OS, if we have one.
1484
if _terminal_size_state == 'unchanged':
1485
if width is not None and width > 0:
1488
# The width could not be determined.
1492
def _win32_terminal_size(width, height):
1493
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1494
return width, height
1497
def _ioctl_terminal_size(width, height):
1181
1499
import struct, fcntl, termios
1182
1500
s = struct.pack('HHHH', 0, 0, 0, 0)
1183
1501
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1184
width = struct.unpack('HHHH', x)[1]
1502
height, width = struct.unpack('HHHH', x)[0:2]
1503
except (IOError, AttributeError):
1189
width = int(os.environ['COLUMNS'])
1505
return width, height
1507
_terminal_size = None
1508
"""Returns the terminal size as (width, height).
1510
:param width: Default value for width.
1511
:param height: Default value for height.
1513
This is defined specifically for each OS and query the size of the controlling
1514
terminal. If any error occurs, the provided default values should be returned.
1516
if sys.platform == 'win32':
1517
_terminal_size = _win32_terminal_size
1519
_terminal_size = _ioctl_terminal_size
1198
1522
def supports_executable():
1622
1973
return socket.gethostname().decode(get_user_encoding())
1625
def recv_all(socket, bytes):
1976
# We must not read/write any more than 64k at a time from/to a socket so we
1977
# don't risk "no buffer space available" errors on some platforms. Windows in
1978
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1980
MAX_SOCKET_CHUNK = 64 * 1024
1982
def read_bytes_from_socket(sock, report_activity=None,
1983
max_read_size=MAX_SOCKET_CHUNK):
1984
"""Read up to max_read_size of bytes from sock and notify of progress.
1986
Translates "Connection reset by peer" into file-like EOF (return an
1987
empty string rather than raise an error), and repeats the recv if
1988
interrupted by a signal.
1992
bytes = sock.recv(max_read_size)
1993
except socket.error, e:
1995
if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
1996
# The connection was closed by the other side. Callers expect
1997
# an empty string to signal end-of-stream.
1999
elif eno == errno.EINTR:
2000
# Retry the interrupted recv.
2004
if report_activity is not None:
2005
report_activity(len(bytes), 'read')
2009
def recv_all(socket, count):
1626
2010
"""Receive an exact number of bytes.
1628
2012
Regular Socket.recv() may return less than the requested number of bytes,
1629
dependning on what's in the OS buffer. MSG_WAITALL is not available
2013
depending on what's in the OS buffer. MSG_WAITALL is not available
1630
2014
on all platforms, but this should work everywhere. This will return
1631
2015
less than the requested amount if the remote end closes.
1633
2017
This isn't optimized and is intended mostly for use in testing.
1636
while len(b) < bytes:
1637
new = until_no_eintr(socket.recv, bytes - len(b))
2020
while len(b) < count:
2021
new = read_bytes_from_socket(socket, None, count - len(b))
1644
def send_all(socket, bytes, report_activity=None):
2028
def send_all(sock, bytes, report_activity=None):
1645
2029
"""Send all bytes on a socket.
1647
Regular socket.sendall() can give socket error 10053 on Windows. This
1648
implementation sends no more than 64k at a time, which avoids this problem.
2031
Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
some platforms, and catches EINTR which may be thrown if the send is
2033
interrupted by a signal.
2035
This is preferred to socket.sendall(), because it avoids portability bugs
2036
and provides activity reporting.
1650
2038
:param report_activity: Call this as bytes are read, see
1651
2039
Transport._report_activity
1654
for pos in xrange(0, len(bytes), chunk_size):
1655
block = bytes[pos:pos+chunk_size]
1656
if report_activity is not None:
1657
report_activity(len(block), 'write')
1658
until_no_eintr(socket.sendall, block)
2042
byte_count = len(bytes)
2043
while sent_total < byte_count:
2045
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
except socket.error, e:
2047
if e.args[0] != errno.EINTR:
2051
report_activity(sent, 'write')
1661
2054
def dereference_path(path):
1780
2189
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2193
if sys.platform == 'linux2':
2194
def _local_concurrency():
2196
prefix = 'processor'
2197
for line in file('/proc/cpuinfo', 'rb'):
2198
if line.startswith(prefix):
2199
concurrency = int(line[line.find(':')+1:]) + 1
2201
elif sys.platform == 'darwin':
2202
def _local_concurrency():
2203
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2204
stdout=subprocess.PIPE).communicate()[0]
2205
elif sys.platform[0:7] == 'freebsd':
2206
def _local_concurrency():
2207
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2208
stdout=subprocess.PIPE).communicate()[0]
2209
elif sys.platform == 'sunos5':
2210
def _local_concurrency():
2211
return subprocess.Popen(['psrinfo', '-p',],
2212
stdout=subprocess.PIPE).communicate()[0]
2213
elif sys.platform == "win32":
2214
def _local_concurrency():
2215
# This appears to return the number of cores.
2216
return os.environ.get('NUMBER_OF_PROCESSORS')
2218
def _local_concurrency():
2223
_cached_local_concurrency = None
2225
def local_concurrency(use_cache=True):
2226
"""Return how many processes can be run concurrently.
2228
Rely on platform specific implementations and default to 1 (one) if
2229
anything goes wrong.
2231
global _cached_local_concurrency
2233
if _cached_local_concurrency is not None and use_cache:
2234
return _cached_local_concurrency
2236
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2237
if concurrency is None:
2239
concurrency = _local_concurrency()
2240
except (OSError, IOError):
2243
concurrency = int(concurrency)
2244
except (TypeError, ValueError):
2247
_cached_concurrency = concurrency
2251
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2252
"""A stream writer that doesn't decode str arguments."""
2254
def __init__(self, encode, stream, errors='strict'):
2255
codecs.StreamWriter.__init__(self, stream, errors)
2256
self.encode = encode
2258
def write(self, object):
2259
if type(object) is str:
2260
self.stream.write(object)
2262
data, _ = self.encode(object, self.errors)
2263
self.stream.write(data)
2265
if sys.platform == 'win32':
2266
def open_file(filename, mode='r', bufsize=-1):
2267
"""This function is used to override the ``open`` builtin.
2269
But it uses O_NOINHERIT flag so the file handle is not inherited by
2270
child processes. Deleting or renaming a closed file opened with this
2271
function is not blocking child processes.
2273
writing = 'w' in mode
2274
appending = 'a' in mode
2275
updating = '+' in mode
2276
binary = 'b' in mode
2279
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2280
# for flags for each modes.
2290
flags |= os.O_WRONLY
2291
flags |= os.O_CREAT | os.O_TRUNC
2296
flags |= os.O_WRONLY
2297
flags |= os.O_CREAT | os.O_APPEND
2302
flags |= os.O_RDONLY
2304
return os.fdopen(os.open(filename, flags), mode, bufsize)
2309
def getuser_unicode():
2310
"""Return the username as unicode.
2313
user_encoding = get_user_encoding()
2314
username = getpass.getuser().decode(user_encoding)
2315
except UnicodeDecodeError:
2316
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
