58
169
# TODO: I'm not really sure this is the best format either.x
171
if _QUOTE_RE is None:
61
172
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
63
174
if _QUOTE_RE.search(f):
64
175
return '"' + f + '"'
70
mode = os.lstat(f)[ST_MODE]
180
_directory_kind = 'directory'
183
"""Return the current umask"""
184
# Assume that people aren't messing with the umask while running
185
# XXX: This is not thread safe, but there is no way to get the
186
# umask without setting it
194
_directory_kind: "/",
196
'tree-reference': '+',
89
200
def kind_marker(kind):
202
return _kind_marker_map[kind]
204
# Slightly faster than using .get(, '') when the common case is that
92
elif kind == 'directory':
94
elif kind == 'symlink':
97
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os, 'lstat'):
107
if e.errno == errno.ENOENT:
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
209
lexists = getattr(os.path, 'lexists', None)
213
stat = getattr(os, 'lstat', os.stat)
217
if e.errno == errno.ENOENT:
220
raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
223
def fancy_rename(old, new, rename_func, unlink_func):
224
"""A fancy rename, when you don't have atomic rename.
226
:param old: The old path, to rename from
227
:param new: The new path, to rename to
228
:param rename_func: The potentially non-atomic rename function
229
:param unlink_func: A way to delete the target file if the full rename
232
# sftp rename doesn't allow overwriting, so play tricks:
233
base = os.path.basename(new)
234
dirname = os.path.dirname(new)
235
# callers use different encodings for the paths so the following MUST
236
# respect that. We rely on python upcasting to unicode if new is unicode
237
# and keeping a str if not.
238
tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
239
os.getpid(), rand_chars(10))
240
tmp_name = pathjoin(dirname, tmp_name)
242
# Rename the file out of the way, but keep track if it didn't exist
243
# We don't want to grab just any exception
244
# something like EACCES should prevent us from continuing
245
# The downside is that the rename_func has to throw an exception
246
# with an errno = ENOENT, or NoSuchFile
249
rename_func(new, tmp_name)
250
except (errors.NoSuchFile,), e:
253
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
254
# function raises an IOError with errno is None when a rename fails.
255
# This then gets caught here.
256
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
259
if (getattr(e, 'errno', None) is None
260
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
269
# This may throw an exception, in which case success will
271
rename_func(old, new)
273
except (IOError, OSError), e:
274
# source and target may be aliases of each other (e.g. on a
275
# case-insensitive filesystem), so we may have accidentally renamed
276
# source by when we tried to rename target
277
failure_exc = sys.exc_info()
278
if (file_existed and e.errno in (None, errno.ENOENT)
279
and old.lower() == new.lower()):
280
# source and target are the same file on a case-insensitive
281
# filesystem, so we don't generate an exception
285
# If the file used to exist, rename it back into place
286
# otherwise just delete it from the tmp location
288
unlink_func(tmp_name)
290
rename_func(tmp_name, new)
291
if failure_exc is not None:
293
raise failure_exc[0], failure_exc[1], failure_exc[2]
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
299
# choke on a Unicode string containing a relative path if
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
302
def _posix_abspath(path):
303
# jam 20060426 rather than encoding to fsencoding
304
# copy posixpath.abspath, but use os.getcwdu instead
305
if not posixpath.isabs(path):
306
path = posixpath.join(getcwd(), path)
307
return _posix_normpath(path)
310
def _posix_realpath(path):
311
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
314
def _posix_normpath(path):
315
path = posixpath.normpath(path)
316
# Bug 861008: posixpath.normpath() returns a path normalized according to
317
# the POSIX standard, which stipulates (for compatibility reasons) that two
318
# leading slashes must not be simplified to one, and only if there are 3 or
319
# more should they be simplified as one. So we treat the leading 2 slashes
320
# as a special case here by simply removing the first slash, as we consider
321
# that breaking POSIX compatibility for this obscure feature is acceptable.
322
# This is not a paranoid precaution, as we notably get paths like this when
323
# the repo is hosted at the root of the filesystem, i.e. in "/".
324
if path.startswith('//'):
329
def _posix_path_from_environ(key):
330
"""Get unicode path from `key` in environment or None if not present
332
Note that posix systems use arbitrary byte strings for filesystem objects,
333
so a path that raises BadFilenameEncoding here may still be accessible.
335
val = os.environ.get(key, None)
339
return val.decode(_fs_enc)
340
except UnicodeDecodeError:
341
# GZ 2011-12-12:Ideally want to include `key` in the exception message
342
raise errors.BadFilenameEncoding(val, _fs_enc)
345
def _posix_getuser_unicode():
346
"""Get username from environment or password database as unicode"""
347
name = getpass.getuser()
348
user_encoding = get_user_encoding()
350
return name.decode(user_encoding)
351
except UnicodeDecodeError:
352
raise errors.BzrError("Encoding of username %r is unsupported by %s "
353
"application locale." % (name, user_encoding))
356
def _win32_fixdrive(path):
357
"""Force drive letters to be consistent.
359
win32 is inconsistent whether it returns lower or upper case
360
and even if it was consistent the user might type the other
361
so we force it to uppercase
362
running python.exe under cmd.exe return capital C:\\
363
running win32 python inside a cygwin shell returns lowercase c:\\
365
drive, path = ntpath.splitdrive(path)
366
return drive.upper() + path
369
def _win32_abspath(path):
370
# Real ntpath.abspath doesn't have a problem with a unicode cwd
371
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
374
def _win98_abspath(path):
375
"""Return the absolute version of a path.
376
Windows 98 safe implementation (python reimplementation
377
of Win32 API function GetFullPathNameW)
382
# \\HOST\path => //HOST/path
383
# //HOST/path => //HOST/path
384
# path => C:/cwd/path
387
# check for absolute path
388
drive = ntpath.splitdrive(path)[0]
389
if drive == '' and path[:2] not in('//','\\\\'):
391
# we cannot simply os.path.join cwd and path
392
# because os.path.join('C:','/path') produce '/path'
393
# and this is incorrect
394
if path[:1] in ('/','\\'):
395
cwd = ntpath.splitdrive(cwd)[0]
397
path = cwd + '\\' + path
398
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
401
def _win32_realpath(path):
402
# Real ntpath.realpath doesn't have a problem with a unicode cwd
403
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
406
def _win32_pathjoin(*args):
407
return ntpath.join(*args).replace('\\', '/')
410
def _win32_normpath(path):
411
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
415
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
418
def _win32_mkdtemp(*args, **kwargs):
419
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
422
def _win32_rename(old, new):
423
"""We expect to be able to atomically replace 'new' with old.
425
On win32, if new exists, it must be moved out of the way first,
429
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
431
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
432
# If we try to rename a non-existant file onto cwd, we get
433
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
434
# if the old path doesn't exist, sometimes we get EACCES
435
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
441
return unicodedata.normalize('NFC', os.getcwdu())
444
# Default is to just use the python builtins, but these can be rebound on
445
# particular platforms.
446
abspath = _posix_abspath
447
realpath = _posix_realpath
448
pathjoin = os.path.join
449
normpath = _posix_normpath
450
path_from_environ = _posix_path_from_environ
451
getuser_unicode = _posix_getuser_unicode
454
dirname = os.path.dirname
455
basename = os.path.basename
456
split = os.path.split
457
splitext = os.path.splitext
458
# These were already lazily imported into local scope
459
# mkdtemp = tempfile.mkdtemp
460
# rmtree = shutil.rmtree
468
MIN_ABS_PATHLENGTH = 1
471
if sys.platform == 'win32':
472
if win32utils.winver == 'Windows 98':
473
abspath = _win98_abspath
475
abspath = _win32_abspath
476
realpath = _win32_realpath
477
pathjoin = _win32_pathjoin
478
normpath = _win32_normpath
479
getcwd = _win32_getcwd
480
mkdtemp = _win32_mkdtemp
481
rename = _win32_rename
483
from bzrlib import _walkdirs_win32
487
lstat = _walkdirs_win32.lstat
488
fstat = _walkdirs_win32.fstat
489
wrap_stat = _walkdirs_win32.wrap_stat
491
MIN_ABS_PATHLENGTH = 3
493
def _win32_delete_readonly(function, path, excinfo):
494
"""Error handler for shutil.rmtree function [for win32]
495
Helps to remove files and dirs marked as read-only.
497
exception = excinfo[1]
498
if function in (os.remove, os.rmdir) \
499
and isinstance(exception, OSError) \
500
and exception.errno == errno.EACCES:
506
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
507
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
508
return shutil.rmtree(path, ignore_errors, onerror)
510
f = win32utils.get_unicode_argv # special function or None
513
path_from_environ = win32utils.get_environ_unicode
514
getuser_unicode = win32utils.get_user_name
516
elif sys.platform == 'darwin':
520
def get_terminal_encoding(trace=False):
521
"""Find the best encoding for printing to the screen.
523
This attempts to check both sys.stdout and sys.stdin to see
524
what encoding they are in, and if that fails it falls back to
525
osutils.get_user_encoding().
526
The problem is that on Windows, locale.getpreferredencoding()
527
is not the same encoding as that used by the console:
528
http://mail.python.org/pipermail/python-list/2003-May/162357.html
530
On my standard US Windows XP, the preferred encoding is
531
cp1252, but the console is cp437
533
:param trace: If True trace the selected encoding via mutter().
535
from bzrlib.trace import mutter
536
output_encoding = getattr(sys.stdout, 'encoding', None)
537
if not output_encoding:
538
input_encoding = getattr(sys.stdin, 'encoding', None)
539
if not input_encoding:
540
output_encoding = get_user_encoding()
542
mutter('encoding stdout as osutils.get_user_encoding() %r',
545
output_encoding = input_encoding
547
mutter('encoding stdout as sys.stdin encoding %r',
551
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
552
if output_encoding == 'cp0':
553
# invalid encoding (cp0 means 'no codepage' on Windows)
554
output_encoding = get_user_encoding()
556
mutter('cp0 is invalid encoding.'
557
' encoding stdout as osutils.get_user_encoding() %r',
561
codecs.lookup(output_encoding)
563
sys.stderr.write('bzr: warning:'
564
' unknown terminal encoding %s.\n'
565
' Using encoding %s instead.\n'
566
% (output_encoding, get_user_encoding())
568
output_encoding = get_user_encoding()
570
return output_encoding
112
573
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
574
if getattr(os.path, 'realpath', None) is not None:
117
578
[p,e] = os.path.split(f)
118
579
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
123
if os.name == "posix":
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
125
# choke on a Unicode string containing a relative path if
126
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
128
_fs_enc = sys.getfilesystemencoding()
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
134
# We need to use the Unicode-aware os.path.abspath and
135
# os.path.realpath on Windows systems.
136
abspath = os.path.abspath
137
realpath = os.path.realpath
140
"""Copy a file to a backup.
142
Backups are named in GNU-style, with a ~ suffix.
144
If the file is already a backup, it's not copied.
150
if has_symlinks() and os.path.islink(fn):
151
target = os.readlink(fn)
152
os.symlink(target, bfn)
160
outf = file(bfn, 'wb')
582
return pathjoin(F(p), e)
174
586
"""True if f is an accessible directory."""
176
return S_ISDIR(os.lstat(f)[ST_MODE])
588
return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
462
1210
def relpath(base, path):
463
"""Return path relative to base, or raise exception.
1211
"""Return path relative to base, or raise PathNotChild exception.
465
1213
The path may be either an absolute path or a path relative to the
466
1214
current working directory.
468
1216
os.path.commonprefix (python2.4) has a bad bug that it works just
469
1217
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
470
avoids that problem."""
1218
avoids that problem.
1220
NOTE: `base` should not have a trailing slash otherwise you'll get
1221
PathNotChild exceptions regardless of `path`.
1224
if len(base) < MIN_ABS_PATHLENGTH:
1225
# must have space for e.g. a drive letter
1226
raise ValueError(gettext('%r is too short to calculate a relative path')
471
1229
rp = abspath(path)
475
while len(head) >= len(base):
1234
if len(head) <= len(base) and head != base:
1235
raise errors.PathNotChild(rp, base)
476
1236
if head == base:
478
head, tail = os.path.split(head)
1238
head, tail = split(head)
482
# XXX This should raise a NotChildPath exception, as its not tied
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
1243
return pathjoin(*reversed(s))
1248
def _cicp_canonical_relpath(base, path):
1249
"""Return the canonical path relative to base.
1251
Like relpath, but on case-insensitive-case-preserving file-systems, this
1252
will return the relpath as stored on the file-system rather than in the
1253
case specified in the input string, for all existing portions of the path.
1255
This will cause O(N) behaviour if called for every path in a tree; if you
1256
have a number of paths to convert, you should use canonical_relpaths().
1258
# TODO: it should be possible to optimize this for Windows by using the
1259
# win32 API FindFiles function to look for the specified name - but using
1260
# os.listdir() still gives us the correct, platform agnostic semantics in
1263
rel = relpath(base, path)
1264
# '.' will have been turned into ''
1268
abs_base = abspath(base)
1270
_listdir = os.listdir
1272
# use an explicit iterator so we can easily consume the rest on early exit.
1273
bit_iter = iter(rel.split('/'))
1274
for bit in bit_iter:
1277
next_entries = _listdir(current)
1278
except OSError: # enoent, eperm, etc
1279
# We can't find this in the filesystem, so just append the
1281
current = pathjoin(current, bit, *list(bit_iter))
1283
for look in next_entries:
1284
if lbit == look.lower():
1285
current = pathjoin(current, look)
1288
# got to the end, nothing matched, so we just return the
1289
# non-existing bits as they were specified (the filename may be
1290
# the target of a move, for example).
1291
current = pathjoin(current, bit, *list(bit_iter))
1293
return current[len(abs_base):].lstrip('/')
1295
# XXX - TODO - we need better detection/integration of case-insensitive
1296
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1297
# filesystems), for example, so could probably benefit from the same basic
1298
# support there. For now though, only Windows and OSX get that support, and
1299
# they get it for *all* file-systems!
1300
if sys.platform in ('win32', 'darwin'):
1301
canonical_relpath = _cicp_canonical_relpath
1303
canonical_relpath = relpath
1305
def canonical_relpaths(base, paths):
1306
"""Create an iterable to canonicalize a sequence of relative paths.
1308
The intent is for this implementation to use a cache, vastly speeding
1309
up multiple transformations in the same directory.
1311
# but for now, we haven't optimized...
1312
return [canonical_relpath(base, p) for p in paths]
1315
def decode_filename(filename):
1316
"""Decode the filename using the filesystem encoding
1318
If it is unicode, it is returned.
1319
Otherwise it is decoded from the the filesystem's encoding. If decoding
1320
fails, a errors.BadFilenameEncoding exception is raised.
1322
if type(filename) is unicode:
1325
return filename.decode(_fs_enc)
1326
except UnicodeDecodeError:
1327
raise errors.BadFilenameEncoding(filename, _fs_enc)
1330
def safe_unicode(unicode_or_utf8_string):
1331
"""Coerce unicode_or_utf8_string into unicode.
1333
If it is unicode, it is returned.
1334
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1335
wrapped in a BzrBadParameterNotUnicode exception.
1337
if isinstance(unicode_or_utf8_string, unicode):
1338
return unicode_or_utf8_string
1340
return unicode_or_utf8_string.decode('utf8')
1341
except UnicodeDecodeError:
1342
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1345
def safe_utf8(unicode_or_utf8_string):
1346
"""Coerce unicode_or_utf8_string to a utf8 string.
1348
If it is a str, it is returned.
1349
If it is Unicode, it is encoded into a utf-8 string.
1351
if isinstance(unicode_or_utf8_string, str):
1352
# TODO: jam 20070209 This is overkill, and probably has an impact on
1353
# performance if we are dealing with lots of apis that want a
1356
# Make sure it is a valid utf-8 string
1357
unicode_or_utf8_string.decode('utf-8')
1358
except UnicodeDecodeError:
1359
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1360
return unicode_or_utf8_string
1361
return unicode_or_utf8_string.encode('utf-8')
1364
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1365
' Revision id generators should be creating utf8'
1369
def safe_revision_id(unicode_or_utf8_string, warn=True):
1370
"""Revision ids should now be utf8, but at one point they were unicode.
1372
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1374
:param warn: Functions that are sanitizing user data can set warn=False
1375
:return: None or a utf8 revision id.
1377
if (unicode_or_utf8_string is None
1378
or unicode_or_utf8_string.__class__ == str):
1379
return unicode_or_utf8_string
1381
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1383
return cache_utf8.encode(unicode_or_utf8_string)
1386
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1387
' generators should be creating utf8 file ids.')
1390
def safe_file_id(unicode_or_utf8_string, warn=True):
1391
"""File ids should now be utf8, but at one point they were unicode.
1393
This is the same as safe_utf8, except it uses the cached encode functions
1394
to save a little bit of performance.
1396
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1398
:param warn: Functions that are sanitizing user data can set warn=False
1399
:return: None or a utf8 file id.
1401
if (unicode_or_utf8_string is None
1402
or unicode_or_utf8_string.__class__ == str):
1403
return unicode_or_utf8_string
1405
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1407
return cache_utf8.encode(unicode_or_utf8_string)
1410
_platform_normalizes_filenames = False
1411
if sys.platform == 'darwin':
1412
_platform_normalizes_filenames = True
1415
def normalizes_filenames():
1416
"""Return True if this platform normalizes unicode filenames.
1420
return _platform_normalizes_filenames
1423
def _accessible_normalized_filename(path):
1424
"""Get the unicode normalized path, and if you can access the file.
1426
On platforms where the system normalizes filenames (Mac OSX),
1427
you can access a file by any path which will normalize correctly.
1428
On platforms where the system does not normalize filenames
1429
(everything else), you have to access a file by its exact path.
1431
Internally, bzr only supports NFC normalization, since that is
1432
the standard for XML documents.
1434
So return the normalized path, and a flag indicating if the file
1435
can be accessed by that path.
1438
return unicodedata.normalize('NFC', unicode(path)), True
1441
def _inaccessible_normalized_filename(path):
1442
__doc__ = _accessible_normalized_filename.__doc__
1444
normalized = unicodedata.normalize('NFC', unicode(path))
1445
return normalized, normalized == path
1448
if _platform_normalizes_filenames:
1449
normalized_filename = _accessible_normalized_filename
1451
normalized_filename = _inaccessible_normalized_filename
1454
def set_signal_handler(signum, handler, restart_syscall=True):
1455
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1456
on platforms that support that.
1458
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1459
automatically restart (by calling `signal.siginterrupt(signum,
1460
False)`). May be ignored if the feature is not available on this
1461
platform or Python version.
1465
siginterrupt = signal.siginterrupt
1467
# This python implementation doesn't provide signal support, hence no
1470
except AttributeError:
1471
# siginterrupt doesn't exist on this platform, or for this version
1473
siginterrupt = lambda signum, flag: None
1475
def sig_handler(*args):
1476
# Python resets the siginterrupt flag when a signal is
1477
# received. <http://bugs.python.org/issue8354>
1478
# As a workaround for some cases, set it back the way we want it.
1479
siginterrupt(signum, False)
1480
# Now run the handler function passed to set_signal_handler.
1483
sig_handler = handler
1484
old_handler = signal.signal(signum, sig_handler)
1486
siginterrupt(signum, False)
1490
default_terminal_width = 80
1491
"""The default terminal width for ttys.
1493
This is defined so that higher levels can share a common fallback value when
1494
terminal_width() returns None.
1497
# Keep some state so that terminal_width can detect if _terminal_size has
1498
# returned a different size since the process started. See docstring and
1499
# comments of terminal_width for details.
1500
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1501
_terminal_size_state = 'no_data'
1502
_first_terminal_size = None
1504
def terminal_width():
1505
"""Return terminal width.
1507
None is returned if the width can't established precisely.
1510
- if BZR_COLUMNS is set, returns its value
1511
- if there is no controlling terminal, returns None
1512
- query the OS, if the queried size has changed since the last query,
1514
- if COLUMNS is set, returns its value,
1515
- if the OS has a value (even though it's never changed), return its value.
1517
From there, we need to query the OS to get the size of the controlling
1520
On Unices we query the OS by:
1521
- get termios.TIOCGWINSZ
1522
- if an error occurs or a negative value is obtained, returns None
1524
On Windows we query the OS by:
1525
- win32utils.get_console_size() decides,
1526
- returns None on error (provided default value)
1528
# Note to implementors: if changing the rules for determining the width,
1529
# make sure you've considered the behaviour in these cases:
1530
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1531
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1533
# - (add more interesting cases here, if you find any)
1534
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1535
# but we don't want to register a signal handler because it is impossible
1536
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1537
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1538
# time so we can notice if the reported size has changed, which should have
1541
# If BZR_COLUMNS is set, take it, user is always right
1542
# Except if they specified 0 in which case, impose no limit here
1544
width = int(os.environ['BZR_COLUMNS'])
1545
except (KeyError, ValueError):
1547
if width is not None:
1553
isatty = getattr(sys.stdout, 'isatty', None)
1554
if isatty is None or not isatty():
1555
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1559
width, height = os_size = _terminal_size(None, None)
1560
global _first_terminal_size, _terminal_size_state
1561
if _terminal_size_state == 'no_data':
1562
_first_terminal_size = os_size
1563
_terminal_size_state = 'unchanged'
1564
elif (_terminal_size_state == 'unchanged' and
1565
_first_terminal_size != os_size):
1566
_terminal_size_state = 'changed'
1568
# If the OS claims to know how wide the terminal is, and this value has
1569
# ever changed, use that.
1570
if _terminal_size_state == 'changed':
1571
if width is not None and width > 0:
1574
# If COLUMNS is set, use it.
1576
return int(os.environ['COLUMNS'])
1577
except (KeyError, ValueError):
1580
# Finally, use an unchanged size from the OS, if we have one.
1581
if _terminal_size_state == 'unchanged':
1582
if width is not None and width > 0:
1585
# The width could not be determined.
1589
def _win32_terminal_size(width, height):
1590
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1591
return width, height
1594
def _ioctl_terminal_size(width, height):
1596
import struct, fcntl, termios
1597
s = struct.pack('HHHH', 0, 0, 0, 0)
1598
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1599
height, width = struct.unpack('HHHH', x)[0:2]
1600
except (IOError, AttributeError):
1602
return width, height
1604
_terminal_size = None
1605
"""Returns the terminal size as (width, height).
1607
:param width: Default value for width.
1608
:param height: Default value for height.
1610
This is defined specifically for each OS and query the size of the controlling
1611
terminal. If any error occurs, the provided default values should be returned.
1613
if sys.platform == 'win32':
1614
_terminal_size = _win32_terminal_size
1616
_terminal_size = _ioctl_terminal_size
1619
def supports_executable():
1620
return sys.platform != "win32"
1623
def supports_posix_readonly():
1624
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1626
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1627
directory controls creation/deletion, etc.
1629
And under win32, readonly means that the directory itself cannot be
1630
deleted. The contents of a readonly directory can be changed, unlike POSIX
1631
where files in readonly directories cannot be added, deleted or renamed.
1633
return sys.platform != "win32"
1636
def set_or_unset_env(env_variable, value):
1637
"""Modify the environment, setting or removing the env_variable.
1639
:param env_variable: The environment variable in question
1640
:param value: The value to set the environment to. If None, then
1641
the variable will be removed.
1642
:return: The original value of the environment variable.
1644
orig_val = os.environ.get(env_variable)
1646
if orig_val is not None:
1647
del os.environ[env_variable]
1649
if isinstance(value, unicode):
1650
value = value.encode(get_user_encoding())
1651
os.environ[env_variable] = value
1655
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1658
def check_legal_path(path):
1659
"""Check whether the supplied path is legal.
1660
This is only required on Windows, so we don't test on other platforms
1663
if sys.platform != "win32":
1665
if _validWin32PathRE.match(path) is None:
1666
raise errors.IllegalPath(path)
1669
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1671
def _is_error_enotdir(e):
1672
"""Check if this exception represents ENOTDIR.
1674
Unfortunately, python is very inconsistent about the exception
1675
here. The cases are:
1676
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1677
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1678
which is the windows error code.
1679
3) Windows, Python2.5 uses errno == EINVAL and
1680
winerror == ERROR_DIRECTORY
1682
:param e: An Exception object (expected to be OSError with an errno
1683
attribute, but we should be able to cope with anything)
1684
:return: True if this represents an ENOTDIR error. False otherwise.
1686
en = getattr(e, 'errno', None)
1687
if (en == errno.ENOTDIR
1688
or (sys.platform == 'win32'
1689
and (en == _WIN32_ERROR_DIRECTORY
1690
or (en == errno.EINVAL
1691
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1697
def walkdirs(top, prefix=""):
1698
"""Yield data about all the directories in a tree.
1700
This yields all the data about the contents of a directory at a time.
1701
After each directory has been yielded, if the caller has mutated the list
1702
to exclude some directories, they are then not descended into.
1704
The data yielded is of the form:
1705
((directory-relpath, directory-path-from-top),
1706
[(relpath, basename, kind, lstat, path-from-top), ...]),
1707
- directory-relpath is the relative path of the directory being returned
1708
with respect to top. prefix is prepended to this.
1709
- directory-path-from-root is the path including top for this directory.
1710
It is suitable for use with os functions.
1711
- relpath is the relative path within the subtree being walked.
1712
- basename is the basename of the path
1713
- kind is the kind of the file now. If unknown then the file is not
1714
present within the tree - but it may be recorded as versioned. See
1716
- lstat is the stat data *if* the file was statted.
1717
- planned, not implemented:
1718
path_from_tree_root is the path from the root of the tree.
1720
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1721
allows one to walk a subtree but get paths that are relative to a tree
1723
:return: an iterator over the dirs.
1725
#TODO there is a bit of a smell where the results of the directory-
1726
# summary in this, and the path from the root, may not agree
1727
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1728
# potentially confusing output. We should make this more robust - but
1729
# not at a speed cost. RBC 20060731
1731
_directory = _directory_kind
1732
_listdir = os.listdir
1733
_kind_from_mode = file_kind_from_stat_mode
1734
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1736
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1737
relroot, _, _, _, top = pending.pop()
1739
relprefix = relroot + u'/'
1742
top_slash = top + u'/'
1745
append = dirblock.append
1747
names = sorted(map(decode_filename, _listdir(top)))
1749
if not _is_error_enotdir(e):
1753
abspath = top_slash + name
1754
statvalue = _lstat(abspath)
1755
kind = _kind_from_mode(statvalue.st_mode)
1756
append((relprefix + name, name, kind, statvalue, abspath))
1757
yield (relroot, top), dirblock
1759
# push the user specified dirs from dirblock
1760
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1763
class DirReader(object):
1764
"""An interface for reading directories."""
1766
def top_prefix_to_starting_dir(self, top, prefix=""):
1767
"""Converts top and prefix to a starting dir entry
1769
:param top: A utf8 path
1770
:param prefix: An optional utf8 path to prefix output relative paths
1772
:return: A tuple starting with prefix, and ending with the native
1775
raise NotImplementedError(self.top_prefix_to_starting_dir)
1777
def read_dir(self, prefix, top):
1778
"""Read a specific dir.
1780
:param prefix: A utf8 prefix to be preprended to the path basenames.
1781
:param top: A natively encoded path to read.
1782
:return: A list of the directories contents. Each item contains:
1783
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1785
raise NotImplementedError(self.read_dir)
1788
_selected_dir_reader = None
1791
def _walkdirs_utf8(top, prefix=""):
1792
"""Yield data about all the directories in a tree.
1794
This yields the same information as walkdirs() only each entry is yielded
1795
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1796
are returned as exact byte-strings.
1798
:return: yields a tuple of (dir_info, [file_info])
1799
dir_info is (utf8_relpath, path-from-top)
1800
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1801
if top is an absolute path, path-from-top is also an absolute path.
1802
path-from-top might be unicode or utf8, but it is the correct path to
1803
pass to os functions to affect the file in question. (such as os.lstat)
1805
global _selected_dir_reader
1806
if _selected_dir_reader is None:
1807
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1808
# Win98 doesn't have unicode apis like FindFirstFileW
1809
# TODO: We possibly could support Win98 by falling back to the
1810
# original FindFirstFile, and using TCHAR instead of WCHAR,
1811
# but that gets a bit tricky, and requires custom compiling
1814
from bzrlib._walkdirs_win32 import Win32ReadDir
1815
_selected_dir_reader = Win32ReadDir()
1818
elif _fs_enc in ('utf-8', 'ascii'):
1820
from bzrlib._readdir_pyx import UTF8DirReader
1821
_selected_dir_reader = UTF8DirReader()
1822
except ImportError, e:
1823
failed_to_load_extension(e)
1826
if _selected_dir_reader is None:
1827
# Fallback to the python version
1828
_selected_dir_reader = UnicodeDirReader()
1830
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1831
# But we don't actually uses 1-3 in pending, so set them to None
1832
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1833
read_dir = _selected_dir_reader.read_dir
1834
_directory = _directory_kind
1836
relroot, _, _, _, top = pending[-1].pop()
1839
dirblock = sorted(read_dir(relroot, top))
1840
yield (relroot, top), dirblock
1841
# push the user specified dirs from dirblock
1842
next = [d for d in reversed(dirblock) if d[2] == _directory]
1844
pending.append(next)
1847
class UnicodeDirReader(DirReader):
1848
"""A dir reader for non-utf8 file systems, which transcodes."""
1850
__slots__ = ['_utf8_encode']
1853
self._utf8_encode = codecs.getencoder('utf8')
1855
def top_prefix_to_starting_dir(self, top, prefix=""):
1856
"""See DirReader.top_prefix_to_starting_dir."""
1857
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1859
def read_dir(self, prefix, top):
1860
"""Read a single directory from a non-utf8 file system.
1862
top, and the abspath element in the output are unicode, all other paths
1863
are utf8. Local disk IO is done via unicode calls to listdir etc.
1865
This is currently the fallback code path when the filesystem encoding is
1866
not UTF-8. It may be better to implement an alternative so that we can
1867
safely handle paths that are not properly decodable in the current
1870
See DirReader.read_dir for details.
1872
_utf8_encode = self._utf8_encode
1874
_listdir = os.listdir
1875
_kind_from_mode = file_kind_from_stat_mode
1878
relprefix = prefix + '/'
1881
top_slash = top + u'/'
1884
append = dirblock.append
1885
for name in sorted(_listdir(top)):
1887
name_utf8 = _utf8_encode(name)[0]
1888
except UnicodeDecodeError:
1889
raise errors.BadFilenameEncoding(
1890
_utf8_encode(relprefix)[0] + name, _fs_enc)
1891
abspath = top_slash + name
1892
statvalue = _lstat(abspath)
1893
kind = _kind_from_mode(statvalue.st_mode)
1894
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1898
def copy_tree(from_path, to_path, handlers={}):
1899
"""Copy all of the entries in from_path into to_path.
1901
:param from_path: The base directory to copy.
1902
:param to_path: The target directory. If it does not exist, it will
1904
:param handlers: A dictionary of functions, which takes a source and
1905
destinations for files, directories, etc.
1906
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1907
'file', 'directory', and 'symlink' should always exist.
1908
If they are missing, they will be replaced with 'os.mkdir()',
1909
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1911
# Now, just copy the existing cached tree to the new location
1912
# We use a cheap trick here.
1913
# Absolute paths are prefixed with the first parameter
1914
# relative paths are prefixed with the second.
1915
# So we can get both the source and target returned
1916
# without any extra work.
1918
def copy_dir(source, dest):
1921
def copy_link(source, dest):
1922
"""Copy the contents of a symlink"""
1923
link_to = os.readlink(source)
1924
os.symlink(link_to, dest)
1926
real_handlers = {'file':shutil.copy2,
1927
'symlink':copy_link,
1928
'directory':copy_dir,
1930
real_handlers.update(handlers)
1932
if not os.path.exists(to_path):
1933
real_handlers['directory'](from_path, to_path)
1935
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1936
for relpath, name, kind, st, abspath in entries:
1937
real_handlers[kind](abspath, relpath)
1940
def copy_ownership_from_path(dst, src=None):
1941
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1943
If src is None, the containing directory is used as source. If chown
1944
fails, the error is ignored and a warning is printed.
1946
chown = getattr(os, 'chown', None)
1951
src = os.path.dirname(dst)
1957
chown(dst, s.st_uid, s.st_gid)
1960
'Unable to copy ownership from "%s" to "%s". '
1961
'You may want to set it manually.', src, dst)
1962
trace.log_exception_quietly()
1965
def path_prefix_key(path):
1966
"""Generate a prefix-order path key for path.
1968
This can be used to sort paths in the same way that walkdirs does.
1970
return (dirname(path) , path)
1973
def compare_paths_prefix_order(path_a, path_b):
1974
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1975
key_a = path_prefix_key(path_a)
1976
key_b = path_prefix_key(path_b)
1977
return cmp(key_a, key_b)
1980
_cached_user_encoding = None
1983
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1984
"""Find out what the preferred user encoding is.
1986
This is generally the encoding that is used for command line parameters
1987
and file contents. This may be different from the terminal encoding
1988
or the filesystem encoding.
1990
:return: A string defining the preferred user encoding
1992
global _cached_user_encoding
1993
if deprecated_passed(use_cache):
1994
warn_deprecated("use_cache should only have been used for tests",
1995
DeprecationWarning, stacklevel=2)
1996
if _cached_user_encoding is not None:
1997
return _cached_user_encoding
1999
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2000
# Use the existing locale settings and call nl_langinfo directly
2001
# rather than going through getpreferredencoding. This avoids
2002
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2003
# possibility of the setlocale call throwing an error.
2004
user_encoding = locale.nl_langinfo(locale.CODESET)
2006
# GZ 2011-12-19: On windows could call GetACP directly instead.
2007
user_encoding = locale.getpreferredencoding(False)
2010
user_encoding = codecs.lookup(user_encoding).name
2012
if user_encoding not in ("", "cp0"):
2013
sys.stderr.write('bzr: warning:'
2014
' unknown encoding %s.'
2015
' Continuing with ascii encoding.\n'
2018
user_encoding = 'ascii'
2020
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2021
if user_encoding == 'ascii':
2022
if sys.platform == 'darwin':
2023
# OSX is special-cased in Python to have a UTF-8 filesystem
2024
# encoding and previously had LANG set here if not present.
2025
user_encoding = 'utf-8'
2026
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2027
# for some other posix platforms as well.
2029
_cached_user_encoding = user_encoding
2030
return user_encoding
2033
def get_diff_header_encoding():
2034
return get_terminal_encoding()
2037
def get_host_name():
2038
"""Return the current unicode host name.
2040
This is meant to be used in place of socket.gethostname() because that
2041
behaves inconsistently on different platforms.
2043
if sys.platform == "win32":
2044
return win32utils.get_host_name()
2047
return socket.gethostname().decode(get_user_encoding())
2050
# We must not read/write any more than 64k at a time from/to a socket so we
2051
# don't risk "no buffer space available" errors on some platforms. Windows in
2052
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2054
MAX_SOCKET_CHUNK = 64 * 1024
2056
_end_of_stream_errors = [errno.ECONNRESET]
2057
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2058
_eno = getattr(errno, _eno, None)
2059
if _eno is not None:
2060
_end_of_stream_errors.append(_eno)
2064
def read_bytes_from_socket(sock, report_activity=None,
2065
max_read_size=MAX_SOCKET_CHUNK):
2066
"""Read up to max_read_size of bytes from sock and notify of progress.
2068
Translates "Connection reset by peer" into file-like EOF (return an
2069
empty string rather than raise an error), and repeats the recv if
2070
interrupted by a signal.
2074
bytes = sock.recv(max_read_size)
2075
except socket.error, e:
2077
if eno in _end_of_stream_errors:
2078
# The connection was closed by the other side. Callers expect
2079
# an empty string to signal end-of-stream.
2081
elif eno == errno.EINTR:
2082
# Retry the interrupted recv.
2086
if report_activity is not None:
2087
report_activity(len(bytes), 'read')
2091
def recv_all(socket, count):
2092
"""Receive an exact number of bytes.
2094
Regular Socket.recv() may return less than the requested number of bytes,
2095
depending on what's in the OS buffer. MSG_WAITALL is not available
2096
on all platforms, but this should work everywhere. This will return
2097
less than the requested amount if the remote end closes.
2099
This isn't optimized and is intended mostly for use in testing.
2102
while len(b) < count:
2103
new = read_bytes_from_socket(socket, None, count - len(b))
2110
def send_all(sock, bytes, report_activity=None):
2111
"""Send all bytes on a socket.
2113
Breaks large blocks in smaller chunks to avoid buffering limitations on
2114
some platforms, and catches EINTR which may be thrown if the send is
2115
interrupted by a signal.
2117
This is preferred to socket.sendall(), because it avoids portability bugs
2118
and provides activity reporting.
2120
:param report_activity: Call this as bytes are read, see
2121
Transport._report_activity
2124
byte_count = len(bytes)
2125
while sent_total < byte_count:
2127
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2128
except socket.error, e:
2129
if e.args[0] != errno.EINTR:
2133
report_activity(sent, 'write')
2136
def connect_socket(address):
2137
# Slight variation of the socket.create_connection() function (provided by
2138
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2139
# provide it for previous python versions. Also, we don't use the timeout
2140
# parameter (provided by the python implementation) so we don't implement
2142
err = socket.error('getaddrinfo returns an empty list')
2143
host, port = address
2144
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2145
af, socktype, proto, canonname, sa = res
2148
sock = socket.socket(af, socktype, proto)
2152
except socket.error, err:
2153
# 'err' is now the most recent error
2154
if sock is not None:
2159
def dereference_path(path):
2160
"""Determine the real path to a file.
2162
All parent elements are dereferenced. But the file itself is not
2164
:param path: The original path. May be absolute or relative.
2165
:return: the real path *to* the file
2167
parent, base = os.path.split(path)
2168
# The pathjoin for '.' is a workaround for Python bug #1213894.
2169
# (initial path components aren't dereferenced)
2170
return pathjoin(realpath(pathjoin('.', parent)), base)
2173
def supports_mapi():
2174
"""Return True if we can use MAPI to launch a mail client."""
2175
return sys.platform == "win32"
2178
def resource_string(package, resource_name):
2179
"""Load a resource from a package and return it as a string.
2181
Note: Only packages that start with bzrlib are currently supported.
2183
This is designed to be a lightweight implementation of resource
2184
loading in a way which is API compatible with the same API from
2186
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2187
If and when pkg_resources becomes a standard library, this routine
2190
# Check package name is within bzrlib
2191
if package == "bzrlib":
2192
resource_relpath = resource_name
2193
elif package.startswith("bzrlib."):
2194
package = package[len("bzrlib."):].replace('.', os.sep)
2195
resource_relpath = pathjoin(package, resource_name)
2197
raise errors.BzrError('resource package %s not in bzrlib' % package)
2199
# Map the resource to a file and read its contents
2200
base = dirname(bzrlib.__file__)
2201
if getattr(sys, 'frozen', None): # bzr.exe
2202
base = abspath(pathjoin(base, '..', '..'))
2203
f = file(pathjoin(base, resource_relpath), "rU")
2209
def file_kind_from_stat_mode_thunk(mode):
2210
global file_kind_from_stat_mode
2211
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2213
from bzrlib._readdir_pyx import UTF8DirReader
2214
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2215
except ImportError, e:
2216
# This is one time where we won't warn that an extension failed to
2217
# load. The extension is never available on Windows anyway.
2218
from bzrlib._readdir_py import (
2219
_kind_from_mode as file_kind_from_stat_mode
2221
return file_kind_from_stat_mode(mode)
2222
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2224
def file_stat(f, _lstat=os.lstat):
2229
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2230
raise errors.NoSuchFile(f)
2233
def file_kind(f, _lstat=os.lstat):
2234
stat_value = file_stat(f, _lstat)
2235
return file_kind_from_stat_mode(stat_value.st_mode)
2237
def until_no_eintr(f, *a, **kw):
2238
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2240
WARNING: you must be certain that it is safe to retry the call repeatedly
2241
if EINTR does occur. This is typically only true for low-level operations
2242
like os.read. If in any doubt, don't use this.
2244
Keep in mind that this is not a complete solution to EINTR. There is
2245
probably code in the Python standard library and other dependencies that
2246
may encounter EINTR if a signal arrives (and there is signal handler for
2247
that signal). So this function can reduce the impact for IO that bzrlib
2248
directly controls, but it is not a complete solution.
2250
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2254
except (IOError, OSError), e:
2255
if e.errno == errno.EINTR:
2260
@deprecated_function(deprecated_in((2, 2, 0)))
2261
def re_compile_checked(re_string, flags=0, where=""):
2262
"""Return a compiled re, or raise a sensible error.
2264
This should only be used when compiling user-supplied REs.
2266
:param re_string: Text form of regular expression.
2267
:param flags: eg re.IGNORECASE
2268
:param where: Message explaining to the user the context where
2269
it occurred, eg 'log search filter'.
2271
# from https://bugs.launchpad.net/bzr/+bug/251352
2273
re_obj = re.compile(re_string, flags)
2276
except errors.InvalidPattern, e:
2278
where = ' in ' + where
2279
# despite the name 'error' is a type
2280
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2284
if sys.platform == "win32":
2287
return msvcrt.getch()
2292
fd = sys.stdin.fileno()
2293
settings = termios.tcgetattr(fd)
2296
ch = sys.stdin.read(1)
2298
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2301
if sys.platform.startswith('linux'):
2302
def _local_concurrency():
2304
return os.sysconf('SC_NPROCESSORS_ONLN')
2305
except (ValueError, OSError, AttributeError):
2307
elif sys.platform == 'darwin':
2308
def _local_concurrency():
2309
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2310
stdout=subprocess.PIPE).communicate()[0]
2311
elif "bsd" in sys.platform:
2312
def _local_concurrency():
2313
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2314
stdout=subprocess.PIPE).communicate()[0]
2315
elif sys.platform == 'sunos5':
2316
def _local_concurrency():
2317
return subprocess.Popen(['psrinfo', '-p',],
2318
stdout=subprocess.PIPE).communicate()[0]
2319
elif sys.platform == "win32":
2320
def _local_concurrency():
2321
# This appears to return the number of cores.
2322
return os.environ.get('NUMBER_OF_PROCESSORS')
2324
def _local_concurrency():
2329
_cached_local_concurrency = None
2331
def local_concurrency(use_cache=True):
2332
"""Return how many processes can be run concurrently.
2334
Rely on platform specific implementations and default to 1 (one) if
2335
anything goes wrong.
2337
global _cached_local_concurrency
2339
if _cached_local_concurrency is not None and use_cache:
2340
return _cached_local_concurrency
2342
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2343
if concurrency is None:
2345
import multiprocessing
2346
concurrency = multiprocessing.cpu_count()
2347
except (ImportError, NotImplementedError):
2348
# multiprocessing is only available on Python >= 2.6
2349
# and multiprocessing.cpu_count() isn't implemented on all
2352
concurrency = _local_concurrency()
2353
except (OSError, IOError):
2356
concurrency = int(concurrency)
2357
except (TypeError, ValueError):
2360
_cached_concurrency = concurrency
2364
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2365
"""A stream writer that doesn't decode str arguments."""
2367
def __init__(self, encode, stream, errors='strict'):
2368
codecs.StreamWriter.__init__(self, stream, errors)
2369
self.encode = encode
2371
def write(self, object):
2372
if type(object) is str:
2373
self.stream.write(object)
2375
data, _ = self.encode(object, self.errors)
2376
self.stream.write(data)
2378
if sys.platform == 'win32':
2379
def open_file(filename, mode='r', bufsize=-1):
2380
"""This function is used to override the ``open`` builtin.
2382
But it uses O_NOINHERIT flag so the file handle is not inherited by
2383
child processes. Deleting or renaming a closed file opened with this
2384
function is not blocking child processes.
2386
writing = 'w' in mode
2387
appending = 'a' in mode
2388
updating = '+' in mode
2389
binary = 'b' in mode
2392
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2393
# for flags for each modes.
2403
flags |= os.O_WRONLY
2404
flags |= os.O_CREAT | os.O_TRUNC
2409
flags |= os.O_WRONLY
2410
flags |= os.O_CREAT | os.O_APPEND
2415
flags |= os.O_RDONLY
2417
return os.fdopen(os.open(filename, flags), mode, bufsize)
2422
def available_backup_name(base, exists):
2423
"""Find a non-existing backup file name.
2425
This will *not* create anything, this only return a 'free' entry. This
2426
should be used for checking names in a directory below a locked
2427
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2428
Leap) and generally discouraged.
2430
:param base: The base name.
2432
:param exists: A callable returning True if the path parameter exists.
2435
name = "%s.~%d~" % (base, counter)
2438
name = "%s.~%d~" % (base, counter)
2442
def set_fd_cloexec(fd):
2443
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2444
support for this is not available.
2448
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2449
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2450
except (ImportError, AttributeError):
2451
# Either the fcntl module or specific constants are not present
2455
def find_executable_on_path(name):
2456
"""Finds an executable on the PATH.
2458
On Windows, this will try to append each extension in the PATHEXT
2459
environment variable to the name, if it cannot be found with the name
2462
:param name: The base name of the executable.
2463
:return: The path to the executable found or None.
2465
path = os.environ.get('PATH')
2468
path = path.split(os.pathsep)
2469
if sys.platform == 'win32':
2470
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2471
exts = [ext.lower() for ext in exts]
2472
base, ext = os.path.splitext(name)
2474
if ext.lower() not in exts:
2482
f = os.path.join(d, name) + ext
2483
if os.access(f, os.X_OK):
2488
def _posix_is_local_pid_dead(pid):
2489
"""True if pid doesn't correspond to live process on this machine"""
2491
# Special meaning of unix kill: just check if it's there.
2494
if e.errno == errno.ESRCH:
2495
# On this machine, and really not found: as sure as we can be
2498
elif e.errno == errno.EPERM:
2499
# exists, though not ours
2502
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2503
# Don't really know.
2506
# Exists and our process: not dead.
2509
if sys.platform == "win32":
2510
is_local_pid_dead = win32utils.is_local_pid_dead
2512
is_local_pid_dead = _posix_is_local_pid_dead
2515
def fdatasync(fileno):
2516
"""Flush file contents to disk if possible.
2518
:param fileno: Integer OS file handle.
2519
:raises TransportNotPossible: If flushing to disk is not possible.
2521
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2526
def ensure_empty_directory_exists(path, exception_class):
2527
"""Make sure a local directory exists and is empty.
2529
If it does not exist, it is created. If it exists and is not empty, an
2530
instance of exception_class is raised.
2535
if e.errno != errno.EEXIST:
2537
if os.listdir(path) != []:
2538
raise exception_class(path)
2541
def is_environment_error(evalue):
2542
"""True if exception instance is due to a process environment issue
2544
This includes OSError and IOError, but also other errors that come from
2545
the operating system or core libraries but are not subclasses of those.
2547
if isinstance(evalue, (EnvironmentError, select.error)):
2549
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
bzrlib/osutils.py
