28
27
lazy_import(globals(), """
29
28
from datetime import datetime
30
from ntpath import (abspath as _nt_abspath,
32
normpath as _nt_normpath,
33
realpath as _nt_realpath,
34
splitdrive as _nt_splitdrive,
34
# We need to import both shutil and rmtree as we export the later on posix
35
# and need the former on windows
37
from shutil import rmtree
40
# We need to import both tempfile and mkdtemp as we export the later on posix
41
# and need the former on windows
43
from tempfile import mkdtemp
44
from tempfile import (
46
49
from bzrlib import (
53
from bzrlib.i18n import gettext
56
57
from bzrlib.symbol_versioning import (
102
111
mod = os.lstat(filename).st_mode
103
112
if not stat.S_ISLNK(mod):
104
113
mod = mod & 0777555
105
chmod_if_possible(filename, mod)
114
os.chmod(filename, mod)
108
117
def make_writable(filename):
109
118
mod = os.lstat(filename).st_mode
110
119
if not stat.S_ISLNK(mod):
112
chmod_if_possible(filename, mod)
115
def chmod_if_possible(filename, mode):
116
# Set file mode if that can be safely done.
117
# Sometimes even on unix the filesystem won't allow it - see
118
# https://bugs.launchpad.net/bzr/+bug/606537
120
# It is probably faster to just do the chmod, rather than
121
# doing a stat, and then trying to compare
122
os.chmod(filename, mode)
123
except (IOError, OSError),e:
124
# Permission/access denied seems to commonly happen on smbfs; there's
125
# probably no point warning about it.
126
# <https://bugs.launchpad.net/bzr/+bug/606537>
127
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
128
trace.mutter("ignore error on chmod of %r: %r" % (
121
os.chmod(filename, mod)
134
124
def minimum_path_selection(paths):
286
276
rename_func(tmp_name, new)
287
277
if failure_exc is not None:
289
raise failure_exc[0], failure_exc[1], failure_exc[2]
278
raise failure_exc[0], failure_exc[1], failure_exc[2]
294
281
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
295
282
# choke on a Unicode string containing a relative path if
296
283
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
285
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
298
286
def _posix_abspath(path):
299
287
# jam 20060426 rather than encoding to fsencoding
300
288
# copy posixpath.abspath, but use os.getcwdu instead
301
289
if not posixpath.isabs(path):
302
290
path = posixpath.join(getcwd(), path)
303
return _posix_normpath(path)
291
return posixpath.normpath(path)
306
294
def _posix_realpath(path):
307
295
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
310
def _posix_normpath(path):
311
path = posixpath.normpath(path)
312
# Bug 861008: posixpath.normpath() returns a path normalized according to
313
# the POSIX standard, which stipulates (for compatibility reasons) that two
314
# leading slashes must not be simplified to one, and only if there are 3 or
315
# more should they be simplified as one. So we treat the leading 2 slashes
316
# as a special case here by simply removing the first slash, as we consider
317
# that breaking POSIX compatibility for this obscure feature is acceptable.
318
# This is not a paranoid precaution, as we notably get paths like this when
319
# the repo is hosted at the root of the filesystem, i.e. in "/".
320
if path.startswith('//'):
325
def _posix_path_from_environ(key):
326
"""Get unicode path from `key` in environment or None if not present
328
Note that posix systems use arbitrary byte strings for filesystem objects,
329
so a path that raises BadFilenameEncoding here may still be accessible.
331
val = os.environ.get(key, None)
335
return val.decode(_fs_enc)
336
except UnicodeDecodeError:
337
# GZ 2011-12-12:Ideally want to include `key` in the exception message
338
raise errors.BadFilenameEncoding(val, _fs_enc)
341
def _posix_getuser_unicode():
342
"""Get username from environment or password database as unicode"""
343
name = getpass.getuser()
344
user_encoding = get_user_encoding()
346
return name.decode(user_encoding)
347
except UnicodeDecodeError:
348
raise errors.BzrError("Encoding of username %r is unsupported by %s "
349
"application locale." % (name, user_encoding))
352
298
def _win32_fixdrive(path):
353
299
"""Force drive letters to be consistent.
358
304
running python.exe under cmd.exe return capital C:\\
359
305
running win32 python inside a cygwin shell returns lowercase c:\\
361
drive, path = ntpath.splitdrive(path)
307
drive, path = _nt_splitdrive(path)
362
308
return drive.upper() + path
365
311
def _win32_abspath(path):
366
# Real ntpath.abspath doesn't have a problem with a unicode cwd
367
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
312
# Real _nt_abspath doesn't have a problem with a unicode cwd
313
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
370
316
def _win98_abspath(path):
381
327
# /path => C:/path
382
328
path = unicode(path)
383
329
# check for absolute path
384
drive = ntpath.splitdrive(path)[0]
330
drive = _nt_splitdrive(path)[0]
385
331
if drive == '' and path[:2] not in('//','\\\\'):
386
332
cwd = os.getcwdu()
387
333
# we cannot simply os.path.join cwd and path
388
334
# because os.path.join('C:','/path') produce '/path'
389
335
# and this is incorrect
390
336
if path[:1] in ('/','\\'):
391
cwd = ntpath.splitdrive(cwd)[0]
337
cwd = _nt_splitdrive(cwd)[0]
393
339
path = cwd + '\\' + path
394
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
340
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
397
343
def _win32_realpath(path):
398
# Real ntpath.realpath doesn't have a problem with a unicode cwd
399
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
344
# Real _nt_realpath doesn't have a problem with a unicode cwd
345
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
402
348
def _win32_pathjoin(*args):
403
return ntpath.join(*args).replace('\\', '/')
349
return _nt_join(*args).replace('\\', '/')
406
352
def _win32_normpath(path):
407
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
410
356
def _win32_getcwd():
534
460
input_encoding = getattr(sys.stdin, 'encoding', None)
535
461
if not input_encoding:
536
462
output_encoding = get_user_encoding()
538
mutter('encoding stdout as osutils.get_user_encoding() %r',
463
mutter('encoding stdout as osutils.get_user_encoding() %r',
541
466
output_encoding = input_encoding
543
mutter('encoding stdout as sys.stdin encoding %r',
467
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
547
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
548
470
if output_encoding == 'cp0':
549
471
# invalid encoding (cp0 means 'no codepage' on Windows)
550
472
output_encoding = get_user_encoding()
552
mutter('cp0 is invalid encoding.'
473
mutter('cp0 is invalid encoding.'
553
474
' encoding stdout as osutils.get_user_encoding() %r',
1310
1233
# but for now, we haven't optimized...
1311
1234
return [canonical_relpath(base, p) for p in paths]
1314
def decode_filename(filename):
1315
"""Decode the filename using the filesystem encoding
1317
If it is unicode, it is returned.
1318
Otherwise it is decoded from the the filesystem's encoding. If decoding
1319
fails, a errors.BadFilenameEncoding exception is raised.
1321
if type(filename) is unicode:
1324
return filename.decode(_fs_enc)
1325
except UnicodeDecodeError:
1326
raise errors.BadFilenameEncoding(filename, _fs_enc)
1329
1236
def safe_unicode(unicode_or_utf8_string):
1330
1237
"""Coerce unicode_or_utf8_string into unicode.
1509
1410
- if BZR_COLUMNS is set, returns its value
1510
1411
- if there is no controlling terminal, returns None
1511
- query the OS, if the queried size has changed since the last query,
1513
1412
- if COLUMNS is set, returns its value,
1514
- if the OS has a value (even though it's never changed), return its value.
1516
1414
From there, we need to query the OS to get the size of the controlling
1519
On Unices we query the OS by:
1520
1418
- get termios.TIOCGWINSZ
1521
1419
- if an error occurs or a negative value is obtained, returns None
1523
On Windows we query the OS by:
1524
1423
- win32utils.get_console_size() decides,
1525
1424
- returns None on error (provided default value)
1527
# Note to implementors: if changing the rules for determining the width,
1528
# make sure you've considered the behaviour in these cases:
1529
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1530
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1532
# - (add more interesting cases here, if you find any)
1533
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1534
# but we don't want to register a signal handler because it is impossible
1535
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1536
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1537
# time so we can notice if the reported size has changed, which should have
1540
1427
# If BZR_COLUMNS is set, take it, user is always right
1541
# Except if they specified 0 in which case, impose no limit here
1543
width = int(os.environ['BZR_COLUMNS'])
1429
return int(os.environ['BZR_COLUMNS'])
1544
1430
except (KeyError, ValueError):
1546
if width is not None:
1552
1433
isatty = getattr(sys.stdout, 'isatty', None)
1553
if isatty is None or not isatty():
1434
if isatty is None or not isatty():
1554
1435
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1558
width, height = os_size = _terminal_size(None, None)
1559
global _first_terminal_size, _terminal_size_state
1560
if _terminal_size_state == 'no_data':
1561
_first_terminal_size = os_size
1562
_terminal_size_state = 'unchanged'
1563
elif (_terminal_size_state == 'unchanged' and
1564
_first_terminal_size != os_size):
1565
_terminal_size_state = 'changed'
1567
# If the OS claims to know how wide the terminal is, and this value has
1568
# ever changed, use that.
1569
if _terminal_size_state == 'changed':
1570
if width is not None and width > 0:
1573
# If COLUMNS is set, use it.
1438
# If COLUMNS is set, take it, the terminal knows better (even inside a
1439
# given terminal, the application can decide to set COLUMNS to a lower
1440
# value (splitted screen) or a bigger value (scroll bars))
1575
1442
return int(os.environ['COLUMNS'])
1576
1443
except (KeyError, ValueError):
1579
# Finally, use an unchanged size from the OS, if we have one.
1580
if _terminal_size_state == 'unchanged':
1581
if width is not None and width > 0:
1446
width, height = _terminal_size(None, None)
1448
# Consider invalid values as meaning no width
1584
# The width could not be determined.
1588
1454
def _win32_terminal_size(width, height):
1615
1481
_terminal_size = _ioctl_terminal_size
1484
def _terminal_size_changed(signum, frame):
1485
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1486
width, height = _terminal_size(None, None)
1487
if width is not None:
1488
os.environ['COLUMNS'] = str(width)
1491
_registered_sigwinch = False
1492
def watch_sigwinch():
1493
"""Register for SIGWINCH, once and only once.
1495
Do nothing if the signal module is not available.
1497
global _registered_sigwinch
1498
if not _registered_sigwinch:
1501
if getattr(signal, "SIGWINCH", None) is not None:
1502
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1504
# python doesn't provide signal support, nothing we can do about it
1506
_registered_sigwinch = True
1618
1509
def supports_executable():
1619
1510
return sys.platform != "win32"
2052
1942
return user_encoding
2055
def get_diff_header_encoding():
2056
return get_terminal_encoding()
2059
_message_encoding = None
2062
def get_message_encoding():
2063
"""Return the encoding used for messages
2065
While the message encoding is a general setting it should usually only be
2066
needed for decoding system error strings such as from OSError instances.
2068
global _message_encoding
2069
if _message_encoding is None:
2070
if os.name == "posix":
2072
# This is a process-global setting that can change, but should in
2073
# general just get set once at process startup then be constant.
2074
_message_encoding = locale.getlocale(locale.LC_MESSAGES)[1]
2076
# On windows want the result of GetACP() which this boils down to.
2077
_message_encoding = get_user_encoding()
2078
return _message_encoding or "ascii"
2081
1945
def get_host_name():
2082
1946
"""Return the current unicode host name.
2178
2034
report_activity(sent, 'write')
2181
def connect_socket(address):
2182
# Slight variation of the socket.create_connection() function (provided by
2183
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2184
# provide it for previous python versions. Also, we don't use the timeout
2185
# parameter (provided by the python implementation) so we don't implement
2187
err = socket.error('getaddrinfo returns an empty list')
2188
host, port = address
2189
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2190
af, socktype, proto, canonname, sa = res
2193
sock = socket.socket(af, socktype, proto)
2197
except socket.error, err:
2198
# 'err' is now the most recent error
2199
if sock is not None:
2204
2037
def dereference_path(path):
2205
2038
"""Determine the real path to a file.
2266
2097
return file_kind_from_stat_mode(mode)
2267
2098
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2269
def file_stat(f, _lstat=os.lstat):
2101
def file_kind(f, _lstat=os.lstat):
2103
return file_kind_from_stat_mode(_lstat(f).st_mode)
2273
2104
except OSError, e:
2274
2105
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2275
2106
raise errors.NoSuchFile(f)
2278
def file_kind(f, _lstat=os.lstat):
2279
stat_value = file_stat(f, _lstat)
2280
return file_kind_from_stat_mode(stat_value.st_mode)
2282
2110
def until_no_eintr(f, *a, **kw):
2283
2111
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2285
2113
WARNING: you must be certain that it is safe to retry the call repeatedly
2286
2114
if EINTR does occur. This is typically only true for low-level operations
2287
2115
like os.read. If in any doubt, don't use this.
2343
2170
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2346
if sys.platform.startswith('linux'):
2174
if sys.platform == 'linux2':
2347
2175
def _local_concurrency():
2349
return os.sysconf('SC_NPROCESSORS_ONLN')
2350
except (ValueError, OSError, AttributeError):
2177
prefix = 'processor'
2178
for line in file('/proc/cpuinfo', 'rb'):
2179
if line.startswith(prefix):
2180
concurrency = int(line[line.find(':')+1:]) + 1
2352
2182
elif sys.platform == 'darwin':
2353
2183
def _local_concurrency():
2354
2184
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2355
2185
stdout=subprocess.PIPE).communicate()[0]
2356
elif "bsd" in sys.platform:
2186
elif sys.platform[0:7] == 'freebsd':
2357
2187
def _local_concurrency():
2358
2188
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2359
2189
stdout=subprocess.PIPE).communicate()[0]
2387
2217
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2388
2218
if concurrency is None:
2390
import multiprocessing
2391
concurrency = multiprocessing.cpu_count()
2392
except (ImportError, NotImplementedError):
2393
# multiprocessing is only available on Python >= 2.6
2394
# and multiprocessing.cpu_count() isn't implemented on all
2397
concurrency = _local_concurrency()
2398
except (OSError, IOError):
2220
concurrency = _local_concurrency()
2221
except (OSError, IOError):
2401
2224
concurrency = int(concurrency)
2402
2225
except (TypeError, ValueError):
2464
2287
open_file = open
2467
def available_backup_name(base, exists):
2468
"""Find a non-existing backup file name.
2470
This will *not* create anything, this only return a 'free' entry. This
2471
should be used for checking names in a directory below a locked
2472
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2473
Leap) and generally discouraged.
2475
:param base: The base name.
2477
:param exists: A callable returning True if the path parameter exists.
2480
name = "%s.~%d~" % (base, counter)
2483
name = "%s.~%d~" % (base, counter)
2487
def set_fd_cloexec(fd):
2488
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2489
support for this is not available.
2493
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2494
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2495
except (ImportError, AttributeError):
2496
# Either the fcntl module or specific constants are not present
2500
def find_executable_on_path(name):
2501
"""Finds an executable on the PATH.
2503
On Windows, this will try to append each extension in the PATHEXT
2504
environment variable to the name, if it cannot be found with the name
2507
:param name: The base name of the executable.
2508
:return: The path to the executable found or None.
2510
path = os.environ.get('PATH')
2513
path = path.split(os.pathsep)
2514
if sys.platform == 'win32':
2515
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2516
exts = [ext.lower() for ext in exts]
2517
base, ext = os.path.splitext(name)
2519
if ext.lower() not in exts:
2527
f = os.path.join(d, name) + ext
2528
if os.access(f, os.X_OK):
2533
def _posix_is_local_pid_dead(pid):
2534
"""True if pid doesn't correspond to live process on this machine"""
2536
# Special meaning of unix kill: just check if it's there.
2539
if e.errno == errno.ESRCH:
2540
# On this machine, and really not found: as sure as we can be
2543
elif e.errno == errno.EPERM:
2544
# exists, though not ours
2547
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2548
# Don't really know.
2551
# Exists and our process: not dead.
2554
if sys.platform == "win32":
2555
is_local_pid_dead = win32utils.is_local_pid_dead
2557
is_local_pid_dead = _posix_is_local_pid_dead
2560
def fdatasync(fileno):
2561
"""Flush file contents to disk if possible.
2563
:param fileno: Integer OS file handle.
2564
:raises TransportNotPossible: If flushing to disk is not possible.
2566
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2571
def ensure_empty_directory_exists(path, exception_class):
2572
"""Make sure a local directory exists and is empty.
2574
If it does not exist, it is created. If it exists and is not empty, an
2575
instance of exception_class is raised.
2580
if e.errno != errno.EEXIST:
2582
if os.listdir(path) != []:
2583
raise exception_class(path)
2586
def is_environment_error(evalue):
2587
"""True if exception instance is due to a process environment issue
2589
This includes OSError and IOError, but also other errors that come from
2590
the operating system or core libraries but are not subclasses of those.
2592
if isinstance(evalue, (EnvironmentError, select.error)):
2594
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2290
def getuser_unicode():
2291
"""Return the username as unicode.
2294
user_encoding = get_user_encoding()
2295
username = getpass.getuser().decode(user_encoding)
2296
except UnicodeDecodeError:
2297
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
