69
78
from bzrlib import symbol_versioning
81
# Cross platform wall-clock time functionality with decent resolution.
82
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
83
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
84
# synchronized with ``time.time()``, this is only meant to be used to find
85
# delta times by subtracting from another call to this function.
86
timer_func = time.time
87
if sys.platform == 'win32':
88
timer_func = time.clock
72
90
# On win32, O_BINARY is used to indicate the file should
73
91
# be opened in binary mode, rather than text mode.
74
92
# On other platforms, O_BINARY doesn't exist, because
75
93
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
94
# OR with 0 on those platforms.
95
# O_NOINHERIT and O_TEXT exists only on win32 too.
77
96
O_BINARY = getattr(os, 'O_BINARY', 0)
97
O_TEXT = getattr(os, 'O_TEXT', 0)
98
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
101
def get_unicode_argv():
103
user_encoding = get_user_encoding()
104
return [a.decode(user_encoding) for a in sys.argv[1:]]
105
except UnicodeDecodeError:
106
raise errors.BzrError(("Parameter '%r' is unsupported by the current "
80
110
def make_readonly(filename):
175
213
:param old: The old path, to rename from
176
214
:param new: The new path, to rename to
177
215
:param rename_func: The potentially non-atomic rename function
178
:param unlink_func: A way to delete the target file if the full rename succeeds
216
:param unlink_func: A way to delete the target file if the full rename
181
219
# sftp rename doesn't allow overwriting, so play tricks:
182
220
base = os.path.basename(new)
183
221
dirname = os.path.dirname(new)
184
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
222
# callers use different encodings for the paths so the following MUST
223
# respect that. We rely on python upcasting to unicode if new is unicode
224
# and keeping a str if not.
225
tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
226
os.getpid(), rand_chars(10))
185
227
tmp_name = pathjoin(dirname, tmp_name)
187
229
# Rename the file out of the way, but keep track if it didn't exist
685
741
date_str = time.strftime(date_fmt, tt)
686
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
688
770
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
689
771
show_offset=True):
690
772
"""Return an unicode date string formatted according to the current locale.
847
930
return pathjoin(*p)
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
from bzrlib import trace
971
exception_str = str(exception)
972
if exception_str not in _extension_load_failures:
973
trace.mutter("failed to load compiled extension: %s" % exception_str)
974
_extension_load_failures.append(exception_str)
977
def report_extension_load_failures():
978
if not _extension_load_failures:
980
from bzrlib.config import GlobalConfig
981
if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
983
# the warnings framework should by default show this only once
984
from bzrlib.trace import warning
986
"bzr: warning: some compiled extensions could not be loaded; "
987
"see <https://answers.launchpad.net/bzr/+faq/703>")
988
# we no longer show the specific missing extensions here, because it makes
989
# the message too long and scary - see
990
# https://bugs.launchpad.net/bzr/+bug/430529
851
994
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
995
except ImportError, e:
996
failed_to_load_extension(e)
853
997
from bzrlib._chunks_to_lines_py import chunks_to_lines
893
1037
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
1040
def delete_any(path):
902
"""Delete a file or directory."""
1041
"""Delete a file, symlink or directory.
1043
Will delete even if readonly.
1046
_delete_file_or_dir(path)
1047
except (OSError, IOError), e:
1048
if e.errno in (errno.EPERM, errno.EACCES):
1049
# make writable and try again
1052
except (OSError, IOError):
1054
_delete_file_or_dir(path)
1059
def _delete_file_or_dir(path):
1060
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
1061
# Forgiveness than Permission (EAFP) because:
1062
# - root can damage a solaris file system by using unlink,
1063
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
1064
# EACCES, OSX: EPERM) when invoked on a directory.
903
1065
if isdir(path): # Takes care of symlinks
1027
1210
# the target of a move, for example).
1028
1211
current = pathjoin(current, bit, *list(bit_iter))
1030
return current[len(abs_base)+1:]
1213
return current[len(abs_base):].lstrip('/')
1032
1215
# XXX - TODO - we need better detection/integration of case-insensitive
1033
# file-systems; Linux often sees FAT32 devices, for example, so could
1034
# probably benefit from the same basic support there. For now though, only
1035
# Windows gets that support, and it gets it for *all* file-systems!
1036
if sys.platform == "win32":
1216
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1217
# filesystems), for example, so could probably benefit from the same basic
1218
# support there. For now though, only Windows and OSX get that support, and
1219
# they get it for *all* file-systems!
1220
if sys.platform in ('win32', 'darwin'):
1037
1221
canonical_relpath = _cicp_canonical_relpath
1039
1223
canonical_relpath = relpath
1172
1355
normalized_filename = _inaccessible_normalized_filename
1358
def set_signal_handler(signum, handler, restart_syscall=True):
1359
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1360
on platforms that support that.
1362
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1363
automatically restart (by calling `signal.siginterrupt(signum,
1364
False)`). May be ignored if the feature is not available on this
1365
platform or Python version.
1369
siginterrupt = signal.siginterrupt
1371
# This python implementation doesn't provide signal support, hence no
1374
except AttributeError:
1375
# siginterrupt doesn't exist on this platform, or for this version
1377
siginterrupt = lambda signum, flag: None
1379
def sig_handler(*args):
1380
# Python resets the siginterrupt flag when a signal is
1381
# received. <http://bugs.python.org/issue8354>
1382
# As a workaround for some cases, set it back the way we want it.
1383
siginterrupt(signum, False)
1384
# Now run the handler function passed to set_signal_handler.
1387
sig_handler = handler
1388
old_handler = signal.signal(signum, sig_handler)
1390
siginterrupt(signum, False)
1394
default_terminal_width = 80
1395
"""The default terminal width for ttys.
1397
This is defined so that higher levels can share a common fallback value when
1398
terminal_width() returns None.
1175
1402
def terminal_width():
1176
"""Return estimated terminal width."""
1177
if sys.platform == 'win32':
1178
return win32utils.get_console_size()[0]
1403
"""Return terminal width.
1405
None is returned if the width can't established precisely.
1408
- if BZR_COLUMNS is set, returns its value
1409
- if there is no controlling terminal, returns None
1410
- if COLUMNS is set, returns its value,
1412
From there, we need to query the OS to get the size of the controlling
1416
- get termios.TIOCGWINSZ
1417
- if an error occurs or a negative value is obtained, returns None
1421
- win32utils.get_console_size() decides,
1422
- returns None on error (provided default value)
1425
# If BZR_COLUMNS is set, take it, user is always right
1427
return int(os.environ['BZR_COLUMNS'])
1428
except (KeyError, ValueError):
1431
isatty = getattr(sys.stdout, 'isatty', None)
1432
if isatty is None or not isatty():
1433
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1436
# If COLUMNS is set, take it, the terminal knows better (even inside a
1437
# given terminal, the application can decide to set COLUMNS to a lower
1438
# value (splitted screen) or a bigger value (scroll bars))
1440
return int(os.environ['COLUMNS'])
1441
except (KeyError, ValueError):
1444
width, height = _terminal_size(None, None)
1446
# Consider invalid values as meaning no width
1452
def _win32_terminal_size(width, height):
1453
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1454
return width, height
1457
def _ioctl_terminal_size(width, height):
1181
1459
import struct, fcntl, termios
1182
1460
s = struct.pack('HHHH', 0, 0, 0, 0)
1183
1461
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1184
width = struct.unpack('HHHH', x)[1]
1462
height, width = struct.unpack('HHHH', x)[0:2]
1463
except (IOError, AttributeError):
1465
return width, height
1467
_terminal_size = None
1468
"""Returns the terminal size as (width, height).
1470
:param width: Default value for width.
1471
:param height: Default value for height.
1473
This is defined specifically for each OS and query the size of the controlling
1474
terminal. If any error occurs, the provided default values should be returned.
1476
if sys.platform == 'win32':
1477
_terminal_size = _win32_terminal_size
1479
_terminal_size = _ioctl_terminal_size
1482
def _terminal_size_changed(signum, frame):
1483
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1484
width, height = _terminal_size(None, None)
1485
if width is not None:
1486
os.environ['COLUMNS'] = str(width)
1489
_registered_sigwinch = False
1490
def watch_sigwinch():
1491
"""Register for SIGWINCH, once and only once.
1493
Do nothing if the signal module is not available.
1495
global _registered_sigwinch
1496
if not _registered_sigwinch:
1189
width = int(os.environ['COLUMNS'])
1499
if getattr(signal, "SIGWINCH", None) is not None:
1500
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1502
# python doesn't provide signal support, nothing we can do about it
1504
_registered_sigwinch = True
1198
1507
def supports_executable():
1392
1701
# for win98 anyway.
1394
1703
from bzrlib._walkdirs_win32 import Win32ReadDir
1396
_selected_dir_reader = UnicodeDirReader()
1398
1704
_selected_dir_reader = Win32ReadDir()
1399
elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1707
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1400
1708
# ANSI_X3.4-1968 is a form of ASCII
1401
_selected_dir_reader = UnicodeDirReader()
1404
1710
from bzrlib._readdir_pyx import UTF8DirReader
1406
# No optimised code path
1407
_selected_dir_reader = UnicodeDirReader()
1409
1711
_selected_dir_reader = UTF8DirReader()
1712
except ImportError, e:
1713
failed_to_load_extension(e)
1716
if _selected_dir_reader is None:
1717
# Fallback to the python version
1718
_selected_dir_reader = UnicodeDirReader()
1410
1720
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1411
1721
# But we don't actually uses 1-3 in pending, so set them to None
1412
1722
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1622
1954
return socket.gethostname().decode(get_user_encoding())
1625
def recv_all(socket, bytes):
1957
# We must not read/write any more than 64k at a time from/to a socket so we
1958
# don't risk "no buffer space available" errors on some platforms. Windows in
1959
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
1961
MAX_SOCKET_CHUNK = 64 * 1024
1963
def read_bytes_from_socket(sock, report_activity=None,
1964
max_read_size=MAX_SOCKET_CHUNK):
1965
"""Read up to max_read_size of bytes from sock and notify of progress.
1967
Translates "Connection reset by peer" into file-like EOF (return an
1968
empty string rather than raise an error), and repeats the recv if
1969
interrupted by a signal.
1973
bytes = sock.recv(max_read_size)
1974
except socket.error, e:
1976
if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
1977
# The connection was closed by the other side. Callers expect
1978
# an empty string to signal end-of-stream.
1980
elif eno == errno.EINTR:
1981
# Retry the interrupted recv.
1985
if report_activity is not None:
1986
report_activity(len(bytes), 'read')
1990
def recv_all(socket, count):
1626
1991
"""Receive an exact number of bytes.
1628
1993
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
1994
depending on what's in the OS buffer. MSG_WAITALL is not available
1630
1995
on all platforms, but this should work everywhere. This will return
1631
1996
less than the requested amount if the remote end closes.
1633
1998
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))
2001
while len(b) < count:
2002
new = read_bytes_from_socket(socket, None, count - len(b))
1644
def send_all(socket, bytes, report_activity=None):
2009
def send_all(sock, bytes, report_activity=None):
1645
2010
"""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.
2012
Breaks large blocks in smaller chunks to avoid buffering limitations on
2013
some platforms, and catches EINTR which may be thrown if the send is
2014
interrupted by a signal.
2016
This is preferred to socket.sendall(), because it avoids portability bugs
2017
and provides activity reporting.
1650
2019
:param report_activity: Call this as bytes are read, see
1651
2020
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)
2023
byte_count = len(bytes)
2024
while sent_total < byte_count:
2026
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2027
except socket.error, e:
2028
if e.args[0] != errno.EINTR:
2032
report_activity(sent, 'write')
1661
2035
def dereference_path(path):
1780
2168
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2172
if sys.platform == 'linux2':
2173
def _local_concurrency():
2175
prefix = 'processor'
2176
for line in file('/proc/cpuinfo', 'rb'):
2177
if line.startswith(prefix):
2178
concurrency = int(line[line.find(':')+1:]) + 1
2180
elif sys.platform == 'darwin':
2181
def _local_concurrency():
2182
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2183
stdout=subprocess.PIPE).communicate()[0]
2184
elif sys.platform[0:7] == 'freebsd':
2185
def _local_concurrency():
2186
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2187
stdout=subprocess.PIPE).communicate()[0]
2188
elif sys.platform == 'sunos5':
2189
def _local_concurrency():
2190
return subprocess.Popen(['psrinfo', '-p',],
2191
stdout=subprocess.PIPE).communicate()[0]
2192
elif sys.platform == "win32":
2193
def _local_concurrency():
2194
# This appears to return the number of cores.
2195
return os.environ.get('NUMBER_OF_PROCESSORS')
2197
def _local_concurrency():
2202
_cached_local_concurrency = None
2204
def local_concurrency(use_cache=True):
2205
"""Return how many processes can be run concurrently.
2207
Rely on platform specific implementations and default to 1 (one) if
2208
anything goes wrong.
2210
global _cached_local_concurrency
2212
if _cached_local_concurrency is not None and use_cache:
2213
return _cached_local_concurrency
2215
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2216
if concurrency is None:
2218
concurrency = _local_concurrency()
2219
except (OSError, IOError):
2222
concurrency = int(concurrency)
2223
except (TypeError, ValueError):
2226
_cached_concurrency = concurrency
2230
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2231
"""A stream writer that doesn't decode str arguments."""
2233
def __init__(self, encode, stream, errors='strict'):
2234
codecs.StreamWriter.__init__(self, stream, errors)
2235
self.encode = encode
2237
def write(self, object):
2238
if type(object) is str:
2239
self.stream.write(object)
2241
data, _ = self.encode(object, self.errors)
2242
self.stream.write(data)
2244
if sys.platform == 'win32':
2245
def open_file(filename, mode='r', bufsize=-1):
2246
"""This function is used to override the ``open`` builtin.
2248
But it uses O_NOINHERIT flag so the file handle is not inherited by
2249
child processes. Deleting or renaming a closed file opened with this
2250
function is not blocking child processes.
2252
writing = 'w' in mode
2253
appending = 'a' in mode
2254
updating = '+' in mode
2255
binary = 'b' in mode
2258
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2259
# for flags for each modes.
2269
flags |= os.O_WRONLY
2270
flags |= os.O_CREAT | os.O_TRUNC
2275
flags |= os.O_WRONLY
2276
flags |= os.O_CREAT | os.O_APPEND
2281
flags |= os.O_RDONLY
2283
return os.fdopen(os.open(filename, flags), mode, bufsize)
added
removed
bzrlib/osutils.py
