172
58
# TODO: I'm not really sure this is the best format either.x
174
if _QUOTE_RE is None:
175
61
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
177
63
if _QUOTE_RE.search(f):
178
64
return '"' + f + '"'
183
_directory_kind = 'directory'
187
"""Return the current umask"""
188
# Assume that people aren't messing with the umask while running
189
# XXX: This is not thread safe, but there is no way to get the
190
# umask without setting it
198
_directory_kind: "/",
200
'tree-reference': '+',
70
mode = os.lstat(f)[ST_MODE]
204
89
def kind_marker(kind):
206
return _kind_marker_map[kind]
208
# Slightly faster than using .get(, '') when the common case is that
213
lexists = getattr(os.path, 'lexists', None)
217
stat = getattr(os, 'lstat', os.stat)
221
if e.errno == errno.ENOENT:
224
raise errors.BzrError(
225
gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
228
def fancy_rename(old, new, rename_func, unlink_func):
229
"""A fancy rename, when you don't have atomic rename.
231
:param old: The old path, to rename from
232
:param new: The new path, to rename to
233
:param rename_func: The potentially non-atomic rename function
234
:param unlink_func: A way to delete the target file if the full rename
237
# sftp rename doesn't allow overwriting, so play tricks:
238
base = os.path.basename(new)
239
dirname = os.path.dirname(new)
240
# callers use different encodings for the paths so the following MUST
241
# respect that. We rely on python upcasting to unicode if new is unicode
242
# and keeping a str if not.
243
tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
244
os.getpid(), rand_chars(10))
245
tmp_name = pathjoin(dirname, tmp_name)
247
# Rename the file out of the way, but keep track if it didn't exist
248
# We don't want to grab just any exception
249
# something like EACCES should prevent us from continuing
250
# The downside is that the rename_func has to throw an exception
251
# with an errno = ENOENT, or NoSuchFile
254
rename_func(new, tmp_name)
255
except (errors.NoSuchFile,):
258
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
259
# function raises an IOError with errno is None when a rename fails.
260
# This then gets caught here.
261
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
263
except Exception as e:
264
if (getattr(e, 'errno', None) is None
265
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
272
# This may throw an exception, in which case success will
274
rename_func(old, new)
276
except (IOError, OSError) as e:
277
# source and target may be aliases of each other (e.g. on a
278
# case-insensitive filesystem), so we may have accidentally renamed
279
# source by when we tried to rename target
280
if (file_existed and e.errno in (None, errno.ENOENT)
281
and old.lower() == new.lower()):
282
# source and target are the same file on a case-insensitive
283
# filesystem, so we don't generate an exception
289
# If the file used to exist, rename it back into place
290
# otherwise just delete it from the tmp location
292
unlink_func(tmp_name)
294
rename_func(tmp_name, new)
297
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
298
# choke on a Unicode string containing a relative path if
299
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
301
def _posix_abspath(path):
302
# jam 20060426 rather than encoding to fsencoding
303
# copy posixpath.abspath, but use os.getcwdu instead
304
if not posixpath.isabs(path):
305
path = posixpath.join(getcwd(), path)
306
return _posix_normpath(path)
309
def _posix_realpath(path):
310
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
313
def _posix_normpath(path):
314
path = posixpath.normpath(path)
315
# Bug 861008: posixpath.normpath() returns a path normalized according to
316
# the POSIX standard, which stipulates (for compatibility reasons) that two
317
# leading slashes must not be simplified to one, and only if there are 3 or
318
# more should they be simplified as one. So we treat the leading 2 slashes
319
# as a special case here by simply removing the first slash, as we consider
320
# that breaking POSIX compatibility for this obscure feature is acceptable.
321
# This is not a paranoid precaution, as we notably get paths like this when
322
# the repo is hosted at the root of the filesystem, i.e. in "/".
323
if path.startswith('//'):
328
def _posix_path_from_environ(key):
329
"""Get unicode path from `key` in environment or None if not present
331
Note that posix systems use arbitrary byte strings for filesystem objects,
332
so a path that raises BadFilenameEncoding here may still be accessible.
334
val = os.environ.get(key, None)
335
if PY3 or val is None:
338
return val.decode(_fs_enc)
339
except UnicodeDecodeError:
340
# GZ 2011-12-12:Ideally want to include `key` in the exception message
341
raise errors.BadFilenameEncoding(val, _fs_enc)
344
def _posix_get_home_dir():
345
"""Get the home directory of the current user as a unicode path"""
346
path = posixpath.expanduser("~")
348
return path.decode(_fs_enc)
349
except AttributeError:
351
except UnicodeDecodeError:
352
raise errors.BadFilenameEncoding(path, _fs_enc)
355
def _posix_getuser_unicode():
356
"""Get username from environment or password database as unicode"""
357
name = getpass.getuser()
360
user_encoding = get_user_encoding()
362
return name.decode(user_encoding)
363
except UnicodeDecodeError:
364
raise errors.BzrError("Encoding of username %r is unsupported by %s "
365
"application locale." % (name, user_encoding))
368
def _win32_fixdrive(path):
369
"""Force drive letters to be consistent.
371
win32 is inconsistent whether it returns lower or upper case
372
and even if it was consistent the user might type the other
373
so we force it to uppercase
374
running python.exe under cmd.exe return capital C:\\
375
running win32 python inside a cygwin shell returns lowercase c:\\
377
drive, path = ntpath.splitdrive(path)
378
return drive.upper() + path
381
def _win32_abspath(path):
382
# Real ntpath.abspath doesn't have a problem with a unicode cwd
383
return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
386
def _win32_realpath(path):
387
# Real ntpath.realpath doesn't have a problem with a unicode cwd
388
return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
391
def _win32_pathjoin(*args):
392
return ntpath.join(*args).replace('\\', '/')
395
def _win32_normpath(path):
396
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
400
return _win32_fixdrive(_getcwd().replace('\\', '/'))
403
def _win32_mkdtemp(*args, **kwargs):
404
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
407
def _win32_rename(old, new):
408
"""We expect to be able to atomically replace 'new' with old.
410
On win32, if new exists, it must be moved out of the way first,
414
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
416
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
417
# If we try to rename a non-existant file onto cwd, we get
418
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
419
# if the old path doesn't exist, sometimes we get EACCES
420
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
426
return unicodedata.normalize('NFC', _getcwd())
429
def _rename_wrap_exception(rename_func):
430
"""Adds extra information to any exceptions that come from rename().
432
The exception has an updated message and 'old_filename' and 'new_filename'
436
def _rename_wrapper(old, new):
438
rename_func(old, new)
440
detailed_error = OSError(e.errno, e.strerror +
441
" [occurred when renaming '%s' to '%s']" %
443
detailed_error.old_filename = old
444
detailed_error.new_filename = new
447
return _rename_wrapper
450
if sys.version_info > (3,):
456
# Default rename wraps os.rename()
457
rename = _rename_wrap_exception(os.rename)
459
# Default is to just use the python builtins, but these can be rebound on
460
# particular platforms.
461
abspath = _posix_abspath
462
realpath = _posix_realpath
463
pathjoin = os.path.join
464
normpath = _posix_normpath
465
path_from_environ = _posix_path_from_environ
466
_get_home_dir = _posix_get_home_dir
467
getuser_unicode = _posix_getuser_unicode
469
dirname = os.path.dirname
470
basename = os.path.basename
471
split = os.path.split
472
splitext = os.path.splitext
473
# These were already lazily imported into local scope
474
# mkdtemp = tempfile.mkdtemp
475
# rmtree = shutil.rmtree
484
MIN_ABS_PATHLENGTH = 1
487
if sys.platform == 'win32':
488
abspath = _win32_abspath
489
realpath = _win32_realpath
490
pathjoin = _win32_pathjoin
491
normpath = _win32_normpath
492
getcwd = _win32_getcwd
493
mkdtemp = _win32_mkdtemp
494
rename = _rename_wrap_exception(_win32_rename)
496
from . import _walkdirs_win32
500
lstat = _walkdirs_win32.lstat
501
fstat = _walkdirs_win32.fstat
502
wrap_stat = _walkdirs_win32.wrap_stat
504
MIN_ABS_PATHLENGTH = 3
506
def _win32_delete_readonly(function, path, excinfo):
507
"""Error handler for shutil.rmtree function [for win32]
508
Helps to remove files and dirs marked as read-only.
510
exception = excinfo[1]
511
if function in (os.remove, os.rmdir) \
512
and isinstance(exception, OSError) \
513
and exception.errno == errno.EACCES:
519
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
520
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
521
return shutil.rmtree(path, ignore_errors, onerror)
523
get_unicode_argv = getattr(win32utils, 'get_unicode_argv', get_unicode_argv)
524
path_from_environ = win32utils.get_environ_unicode
525
_get_home_dir = win32utils.get_home_location
526
getuser_unicode = win32utils.get_user_name
528
elif sys.platform == 'darwin':
532
def get_terminal_encoding(trace=False):
533
"""Find the best encoding for printing to the screen.
535
This attempts to check both sys.stdout and sys.stdin to see
536
what encoding they are in, and if that fails it falls back to
537
osutils.get_user_encoding().
538
The problem is that on Windows, locale.getpreferredencoding()
539
is not the same encoding as that used by the console:
540
http://mail.python.org/pipermail/python-list/2003-May/162357.html
542
On my standard US Windows XP, the preferred encoding is
543
cp1252, but the console is cp437
545
:param trace: If True trace the selected encoding via mutter().
547
from .trace import mutter
548
output_encoding = getattr(sys.stdout, 'encoding', None)
549
if not output_encoding:
550
input_encoding = getattr(sys.stdin, 'encoding', None)
551
if not input_encoding:
552
output_encoding = get_user_encoding()
554
mutter('encoding stdout as osutils.get_user_encoding() %r',
557
output_encoding = input_encoding
559
mutter('encoding stdout as sys.stdin encoding %r',
563
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
564
if output_encoding == 'cp0':
565
# invalid encoding (cp0 means 'no codepage' on Windows)
566
output_encoding = get_user_encoding()
568
mutter('cp0 is invalid encoding.'
569
' encoding stdout as osutils.get_user_encoding() %r',
573
codecs.lookup(output_encoding)
575
sys.stderr.write('brz: warning:'
576
' unknown terminal encoding %s.\n'
577
' Using encoding %s instead.\n'
578
% (output_encoding, get_user_encoding())
580
output_encoding = get_user_encoding()
582
return output_encoding
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))
585
112
def normalizepath(f):
586
if getattr(os.path, 'realpath', None) is not None:
113
if hasattr(os.path, 'realpath'):
590
[p, e] = os.path.split(f)
117
[p,e] = os.path.split(f)
591
118
if e == "" or e == "." or e == "..":
594
return pathjoin(F(p), 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')
598
174
"""True if f is an accessible directory."""
600
return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
176
return S_ISDIR(os.lstat(f)[ST_MODE])
1265
462
def relpath(base, path):
1266
"""Return path relative to base, or raise PathNotChild exception.
463
"""Return path relative to base, or raise exception.
1268
465
The path may be either an absolute path or a path relative to the
1269
466
current working directory.
1271
468
os.path.commonprefix (python2.4) has a bad bug that it works just
1272
469
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1273
avoids that problem.
1275
NOTE: `base` should not have a trailing slash otherwise you'll get
1276
PathNotChild exceptions regardless of `path`.
1279
if len(base) < MIN_ABS_PATHLENGTH:
1280
# must have space for e.g. a drive letter
1281
raise ValueError(gettext('%r is too short to calculate a relative path')
470
avoids that problem."""
1284
471
rp = abspath(path)
1289
if len(head) <= len(base) and head != base:
1290
raise errors.PathNotChild(rp, base)
475
while len(head) >= len(base):
1291
476
if head == base:
1293
head, tail = split(head)
478
head, tail = os.path.split(head)
1298
return pathjoin(*reversed(s))
1303
def _cicp_canonical_relpath(base, path):
1304
"""Return the canonical path relative to base.
1306
Like relpath, but on case-insensitive-case-preserving file-systems, this
1307
will return the relpath as stored on the file-system rather than in the
1308
case specified in the input string, for all existing portions of the path.
1310
This will cause O(N) behaviour if called for every path in a tree; if you
1311
have a number of paths to convert, you should use canonical_relpaths().
1313
# TODO: it should be possible to optimize this for Windows by using the
1314
# win32 API FindFiles function to look for the specified name - but using
1315
# os.listdir() still gives us the correct, platform agnostic semantics in
1318
rel = relpath(base, path)
1319
# '.' will have been turned into ''
1323
abs_base = abspath(base)
1325
_listdir = os.listdir
1327
# use an explicit iterator so we can easily consume the rest on early exit.
1328
bit_iter = iter(rel.split('/'))
1329
for bit in bit_iter:
1332
next_entries = _listdir(current)
1333
except OSError: # enoent, eperm, etc
1334
# We can't find this in the filesystem, so just append the
1336
current = pathjoin(current, bit, *list(bit_iter))
1338
for look in next_entries:
1339
if lbit == look.lower():
1340
current = pathjoin(current, look)
1343
# got to the end, nothing matched, so we just return the
1344
# non-existing bits as they were specified (the filename may be
1345
# the target of a move, for example).
1346
current = pathjoin(current, bit, *list(bit_iter))
1348
return current[len(abs_base):].lstrip('/')
1351
# XXX - TODO - we need better detection/integration of case-insensitive
1352
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1353
# filesystems), for example, so could probably benefit from the same basic
1354
# support there. For now though, only Windows and OSX get that support, and
1355
# they get it for *all* file-systems!
1356
if sys.platform in ('win32', 'darwin'):
1357
canonical_relpath = _cicp_canonical_relpath
1359
canonical_relpath = relpath
1362
def canonical_relpaths(base, paths):
1363
"""Create an iterable to canonicalize a sequence of relative paths.
1365
The intent is for this implementation to use a cache, vastly speeding
1366
up multiple transformations in the same directory.
1368
# but for now, we haven't optimized...
1369
return [canonical_relpath(base, p) for p in paths]
1372
def decode_filename(filename):
1373
"""Decode the filename using the filesystem encoding
1375
If it is unicode, it is returned.
1376
Otherwise it is decoded from the the filesystem's encoding. If decoding
1377
fails, a errors.BadFilenameEncoding exception is raised.
1379
if isinstance(filename, text_type):
1382
return filename.decode(_fs_enc)
1383
except UnicodeDecodeError:
1384
raise errors.BadFilenameEncoding(filename, _fs_enc)
1387
def safe_unicode(unicode_or_utf8_string):
1388
"""Coerce unicode_or_utf8_string into unicode.
1390
If it is unicode, it is returned.
1391
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1392
wrapped in a BzrBadParameterNotUnicode exception.
1394
if isinstance(unicode_or_utf8_string, text_type):
1395
return unicode_or_utf8_string
1397
return unicode_or_utf8_string.decode('utf8')
1398
except UnicodeDecodeError:
1399
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1402
def safe_utf8(unicode_or_utf8_string):
1403
"""Coerce unicode_or_utf8_string to a utf8 string.
1405
If it is a str, it is returned.
1406
If it is Unicode, it is encoded into a utf-8 string.
1408
if isinstance(unicode_or_utf8_string, bytes):
1409
# TODO: jam 20070209 This is overkill, and probably has an impact on
1410
# performance if we are dealing with lots of apis that want a
1413
# Make sure it is a valid utf-8 string
1414
unicode_or_utf8_string.decode('utf-8')
1415
except UnicodeDecodeError:
1416
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1417
return unicode_or_utf8_string
1418
return unicode_or_utf8_string.encode('utf-8')
1421
def safe_revision_id(unicode_or_utf8_string):
1422
"""Revision ids should now be utf8, but at one point they were unicode.
1424
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1426
:return: None or a utf8 revision id.
1428
if (unicode_or_utf8_string is None
1429
or unicode_or_utf8_string.__class__ == bytes):
1430
return unicode_or_utf8_string
1431
raise TypeError('Unicode revision ids are no longer supported. '
1432
'Revision id generators should be creating utf8 revision '
1436
def safe_file_id(unicode_or_utf8_string):
1437
"""File ids should now be utf8, but at one point they were unicode.
1439
This is the same as safe_utf8, except it uses the cached encode functions
1440
to save a little bit of performance.
1442
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1444
:return: None or a utf8 file id.
1446
if (unicode_or_utf8_string is None
1447
or unicode_or_utf8_string.__class__ == bytes):
1448
return unicode_or_utf8_string
1449
raise TypeError('Unicode file ids are no longer supported. '
1450
'File id generators should be creating utf8 file ids.')
1453
_platform_normalizes_filenames = False
1454
if sys.platform == 'darwin':
1455
_platform_normalizes_filenames = True
1458
def normalizes_filenames():
1459
"""Return True if this platform normalizes unicode filenames.
1463
return _platform_normalizes_filenames
1466
def _accessible_normalized_filename(path):
1467
"""Get the unicode normalized path, and if you can access the file.
1469
On platforms where the system normalizes filenames (Mac OSX),
1470
you can access a file by any path which will normalize correctly.
1471
On platforms where the system does not normalize filenames
1472
(everything else), you have to access a file by its exact path.
1474
Internally, bzr only supports NFC normalization, since that is
1475
the standard for XML documents.
1477
So return the normalized path, and a flag indicating if the file
1478
can be accessed by that path.
1481
if isinstance(path, bytes):
1482
path = path.decode(sys.getfilesystemencoding())
1483
return unicodedata.normalize('NFC', path), True
1486
def _inaccessible_normalized_filename(path):
1487
__doc__ = _accessible_normalized_filename.__doc__
1489
if isinstance(path, bytes):
1490
path = path.decode(sys.getfilesystemencoding())
1491
normalized = unicodedata.normalize('NFC', path)
1492
return normalized, normalized == path
1495
if _platform_normalizes_filenames:
1496
normalized_filename = _accessible_normalized_filename
1498
normalized_filename = _inaccessible_normalized_filename
1501
def set_signal_handler(signum, handler, restart_syscall=True):
1502
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1503
on platforms that support that.
1505
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1506
automatically restart (by calling `signal.siginterrupt(signum,
1507
False)`). May be ignored if the feature is not available on this
1508
platform or Python version.
1512
siginterrupt = signal.siginterrupt
1514
# This python implementation doesn't provide signal support, hence no
1517
except AttributeError:
1518
# siginterrupt doesn't exist on this platform, or for this version
1520
def siginterrupt(signum, flag): return None
1522
def sig_handler(*args):
1523
# Python resets the siginterrupt flag when a signal is
1524
# received. <http://bugs.python.org/issue8354>
1525
# As a workaround for some cases, set it back the way we want it.
1526
siginterrupt(signum, False)
1527
# Now run the handler function passed to set_signal_handler.
1530
sig_handler = handler
1531
old_handler = signal.signal(signum, sig_handler)
1533
siginterrupt(signum, False)
1537
default_terminal_width = 80
1538
"""The default terminal width for ttys.
1540
This is defined so that higher levels can share a common fallback value when
1541
terminal_width() returns None.
1544
# Keep some state so that terminal_width can detect if _terminal_size has
1545
# returned a different size since the process started. See docstring and
1546
# comments of terminal_width for details.
1547
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1548
_terminal_size_state = 'no_data'
1549
_first_terminal_size = None
1552
def terminal_width():
1553
"""Return terminal width.
1555
None is returned if the width can't established precisely.
1558
- if BRZ_COLUMNS is set, returns its value
1559
- if there is no controlling terminal, returns None
1560
- query the OS, if the queried size has changed since the last query,
1562
- if COLUMNS is set, returns its value,
1563
- if the OS has a value (even though it's never changed), return its value.
1565
From there, we need to query the OS to get the size of the controlling
1568
On Unices we query the OS by:
1569
- get termios.TIOCGWINSZ
1570
- if an error occurs or a negative value is obtained, returns None
1572
On Windows we query the OS by:
1573
- win32utils.get_console_size() decides,
1574
- returns None on error (provided default value)
1576
# Note to implementors: if changing the rules for determining the width,
1577
# make sure you've considered the behaviour in these cases:
1578
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1579
# - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1581
# - (add more interesting cases here, if you find any)
1582
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1583
# but we don't want to register a signal handler because it is impossible
1584
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1585
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1586
# time so we can notice if the reported size has changed, which should have
1589
# If BRZ_COLUMNS is set, take it, user is always right
1590
# Except if they specified 0 in which case, impose no limit here
1592
width = int(os.environ['BRZ_COLUMNS'])
1593
except (KeyError, ValueError):
1595
if width is not None:
1601
isatty = getattr(sys.stdout, 'isatty', None)
1602
if isatty is None or not isatty():
1603
# Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1607
width, height = os_size = _terminal_size(None, None)
1608
global _first_terminal_size, _terminal_size_state
1609
if _terminal_size_state == 'no_data':
1610
_first_terminal_size = os_size
1611
_terminal_size_state = 'unchanged'
1612
elif (_terminal_size_state == 'unchanged' and
1613
_first_terminal_size != os_size):
1614
_terminal_size_state = 'changed'
1616
# If the OS claims to know how wide the terminal is, and this value has
1617
# ever changed, use that.
1618
if _terminal_size_state == 'changed':
1619
if width is not None and width > 0:
1622
# If COLUMNS is set, use it.
1624
return int(os.environ['COLUMNS'])
1625
except (KeyError, ValueError):
1628
# Finally, use an unchanged size from the OS, if we have one.
1629
if _terminal_size_state == 'unchanged':
1630
if width is not None and width > 0:
1633
# The width could not be determined.
1637
def _win32_terminal_size(width, height):
1638
width, height = win32utils.get_console_size(
1639
defaultx=width, defaulty=height)
1640
return width, height
1643
def _ioctl_terminal_size(width, height):
1648
s = struct.pack('HHHH', 0, 0, 0, 0)
1649
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1650
height, width = struct.unpack('HHHH', x)[0:2]
1651
except (IOError, AttributeError):
1653
return width, height
1656
_terminal_size = None
1657
"""Returns the terminal size as (width, height).
1659
:param width: Default value for width.
1660
:param height: Default value for height.
1662
This is defined specifically for each OS and query the size of the controlling
1663
terminal. If any error occurs, the provided default values should be returned.
1665
if sys.platform == 'win32':
1666
_terminal_size = _win32_terminal_size
1668
_terminal_size = _ioctl_terminal_size
1671
def supports_executable(path):
1672
"""Return if filesystem at path supports executable bit.
1674
:param path: Path for which to check the file system
1675
:return: boolean indicating whether executable bit can be stored/relied upon
1677
if sys.platform == 'win32':
1680
fs_type = get_fs_type(path)
1681
except errors.DependencyNotPresent as e:
1682
trace.mutter('Unable to get fs type for %r: %s', path, e)
1684
if fs_type in ('vfat', 'ntfs'):
1685
# filesystems known to not support executable bit
1690
def supports_symlinks(path):
1691
"""Return if the filesystem at path supports the creation of symbolic links.
1694
if not has_symlinks():
1697
fs_type = get_fs_type(path)
1698
except errors.DependencyNotPresent as e:
1699
trace.mutter('Unable to get fs type for %r: %s', path, e)
1701
if fs_type in ('vfat', 'ntfs'):
1702
# filesystems known to not support symlinks
1707
def supports_posix_readonly():
1708
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1710
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1711
directory controls creation/deletion, etc.
1713
And under win32, readonly means that the directory itself cannot be
1714
deleted. The contents of a readonly directory can be changed, unlike POSIX
1715
where files in readonly directories cannot be added, deleted or renamed.
1717
return sys.platform != "win32"
1720
def set_or_unset_env(env_variable, value):
1721
"""Modify the environment, setting or removing the env_variable.
1723
:param env_variable: The environment variable in question
1724
:param value: The value to set the environment to. If None, then
1725
the variable will be removed.
1726
:return: The original value of the environment variable.
1728
orig_val = os.environ.get(env_variable)
1730
if orig_val is not None:
1731
del os.environ[env_variable]
1733
if not PY3 and isinstance(value, text_type):
1734
value = value.encode(get_user_encoding())
1735
os.environ[env_variable] = value
1739
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1742
def check_legal_path(path):
1743
"""Check whether the supplied path is legal.
1744
This is only required on Windows, so we don't test on other platforms
1747
if sys.platform != "win32":
1749
if _validWin32PathRE.match(path) is None:
1750
raise errors.IllegalPath(path)
1753
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1756
def _is_error_enotdir(e):
1757
"""Check if this exception represents ENOTDIR.
1759
Unfortunately, python is very inconsistent about the exception
1760
here. The cases are:
1761
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1762
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1763
which is the windows error code.
1764
3) Windows, Python2.5 uses errno == EINVAL and
1765
winerror == ERROR_DIRECTORY
1767
:param e: An Exception object (expected to be OSError with an errno
1768
attribute, but we should be able to cope with anything)
1769
:return: True if this represents an ENOTDIR error. False otherwise.
1771
en = getattr(e, 'errno', None)
1772
if (en == errno.ENOTDIR or
1773
(sys.platform == 'win32' and
1774
(en == _WIN32_ERROR_DIRECTORY or
1776
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1782
def walkdirs(top, prefix=""):
1783
"""Yield data about all the directories in a tree.
1785
This yields all the data about the contents of a directory at a time.
1786
After each directory has been yielded, if the caller has mutated the list
1787
to exclude some directories, they are then not descended into.
1789
The data yielded is of the form:
1790
((directory-relpath, directory-path-from-top),
1791
[(relpath, basename, kind, lstat, path-from-top), ...]),
1792
- directory-relpath is the relative path of the directory being returned
1793
with respect to top. prefix is prepended to this.
1794
- directory-path-from-root is the path including top for this directory.
1795
It is suitable for use with os functions.
1796
- relpath is the relative path within the subtree being walked.
1797
- basename is the basename of the path
1798
- kind is the kind of the file now. If unknown then the file is not
1799
present within the tree - but it may be recorded as versioned. See
1801
- lstat is the stat data *if* the file was statted.
1802
- planned, not implemented:
1803
path_from_tree_root is the path from the root of the tree.
1805
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1806
allows one to walk a subtree but get paths that are relative to a tree
1808
:return: an iterator over the dirs.
1810
# TODO there is a bit of a smell where the results of the directory-
1811
# summary in this, and the path from the root, may not agree
1812
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1813
# potentially confusing output. We should make this more robust - but
1814
# not at a speed cost. RBC 20060731
1816
_directory = _directory_kind
1817
_listdir = os.listdir
1818
_kind_from_mode = file_kind_from_stat_mode
1819
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1821
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1822
relroot, _, _, _, top = pending.pop()
1824
relprefix = relroot + u'/'
1827
top_slash = top + u'/'
1830
append = dirblock.append
1832
names = sorted(map(decode_filename, _listdir(top)))
1833
except OSError as e:
1834
if not _is_error_enotdir(e):
1838
abspath = top_slash + name
1839
statvalue = _lstat(abspath)
1840
kind = _kind_from_mode(statvalue.st_mode)
1841
append((relprefix + name, name, kind, statvalue, abspath))
1842
yield (relroot, top), dirblock
1844
# push the user specified dirs from dirblock
1845
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1848
class DirReader(object):
1849
"""An interface for reading directories."""
1851
def top_prefix_to_starting_dir(self, top, prefix=""):
1852
"""Converts top and prefix to a starting dir entry
1854
:param top: A utf8 path
1855
:param prefix: An optional utf8 path to prefix output relative paths
1857
:return: A tuple starting with prefix, and ending with the native
1860
raise NotImplementedError(self.top_prefix_to_starting_dir)
1862
def read_dir(self, prefix, top):
1863
"""Read a specific dir.
1865
:param prefix: A utf8 prefix to be preprended to the path basenames.
1866
:param top: A natively encoded path to read.
1867
:return: A list of the directories contents. Each item contains:
1868
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1870
raise NotImplementedError(self.read_dir)
1873
_selected_dir_reader = None
1876
def _walkdirs_utf8(top, prefix=""):
1877
"""Yield data about all the directories in a tree.
1879
This yields the same information as walkdirs() only each entry is yielded
1880
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1881
are returned as exact byte-strings.
1883
:return: yields a tuple of (dir_info, [file_info])
1884
dir_info is (utf8_relpath, path-from-top)
1885
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1886
if top is an absolute path, path-from-top is also an absolute path.
1887
path-from-top might be unicode or utf8, but it is the correct path to
1888
pass to os functions to affect the file in question. (such as os.lstat)
1890
global _selected_dir_reader
1891
if _selected_dir_reader is None:
1892
if sys.platform == "win32":
1894
from ._walkdirs_win32 import Win32ReadDir
1895
_selected_dir_reader = Win32ReadDir()
1898
elif _fs_enc in ('utf-8', 'ascii'):
1900
from ._readdir_pyx import UTF8DirReader
1901
_selected_dir_reader = UTF8DirReader()
1902
except ImportError as e:
1903
failed_to_load_extension(e)
1906
if _selected_dir_reader is None:
1907
# Fallback to the python version
1908
_selected_dir_reader = UnicodeDirReader()
1910
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1911
# But we don't actually uses 1-3 in pending, so set them to None
1912
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1913
read_dir = _selected_dir_reader.read_dir
1914
_directory = _directory_kind
1916
relroot, _, _, _, top = pending[-1].pop()
1919
dirblock = sorted(read_dir(relroot, top))
1920
yield (relroot, top), dirblock
1921
# push the user specified dirs from dirblock
1922
next = [d for d in reversed(dirblock) if d[2] == _directory]
1924
pending.append(next)
1927
class UnicodeDirReader(DirReader):
1928
"""A dir reader for non-utf8 file systems, which transcodes."""
1930
__slots__ = ['_utf8_encode']
1933
self._utf8_encode = codecs.getencoder('utf8')
1935
def top_prefix_to_starting_dir(self, top, prefix=""):
1936
"""See DirReader.top_prefix_to_starting_dir."""
1937
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1939
def read_dir(self, prefix, top):
1940
"""Read a single directory from a non-utf8 file system.
1942
top, and the abspath element in the output are unicode, all other paths
1943
are utf8. Local disk IO is done via unicode calls to listdir etc.
1945
This is currently the fallback code path when the filesystem encoding is
1946
not UTF-8. It may be better to implement an alternative so that we can
1947
safely handle paths that are not properly decodable in the current
1950
See DirReader.read_dir for details.
1952
_utf8_encode = self._utf8_encode
1954
def _fs_decode(s): return s.decode(_fs_enc)
1956
def _fs_encode(s): return s.encode(_fs_enc)
1958
_listdir = os.listdir
1959
_kind_from_mode = file_kind_from_stat_mode
1962
relprefix = prefix + b'/'
1965
top_slash = top + '/'
1968
append = dirblock.append
1969
for name_native in _listdir(top.encode('utf-8')):
1971
name = _fs_decode(name_native)
1972
except UnicodeDecodeError:
1973
raise errors.BadFilenameEncoding(
1974
relprefix + name_native, _fs_enc)
1975
name_utf8 = _utf8_encode(name)[0]
1976
abspath = top_slash + name
1977
statvalue = _lstat(abspath)
1978
kind = _kind_from_mode(statvalue.st_mode)
1979
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1980
return sorted(dirblock)
1983
def copy_tree(from_path, to_path, handlers={}):
1984
"""Copy all of the entries in from_path into to_path.
1986
:param from_path: The base directory to copy.
1987
:param to_path: The target directory. If it does not exist, it will
1989
:param handlers: A dictionary of functions, which takes a source and
1990
destinations for files, directories, etc.
1991
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1992
'file', 'directory', and 'symlink' should always exist.
1993
If they are missing, they will be replaced with 'os.mkdir()',
1994
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1996
# Now, just copy the existing cached tree to the new location
1997
# We use a cheap trick here.
1998
# Absolute paths are prefixed with the first parameter
1999
# relative paths are prefixed with the second.
2000
# So we can get both the source and target returned
2001
# without any extra work.
2003
def copy_dir(source, dest):
2006
def copy_link(source, dest):
2007
"""Copy the contents of a symlink"""
2008
link_to = os.readlink(source)
2009
os.symlink(link_to, dest)
2011
real_handlers = {'file': shutil.copy2,
2012
'symlink': copy_link,
2013
'directory': copy_dir,
2015
real_handlers.update(handlers)
2017
if not os.path.exists(to_path):
2018
real_handlers['directory'](from_path, to_path)
2020
for dir_info, entries in walkdirs(from_path, prefix=to_path):
2021
for relpath, name, kind, st, abspath in entries:
2022
real_handlers[kind](abspath, relpath)
2025
def copy_ownership_from_path(dst, src=None):
2026
"""Copy usr/grp ownership from src file/dir to dst file/dir.
2028
If src is None, the containing directory is used as source. If chown
2029
fails, the error is ignored and a warning is printed.
2031
chown = getattr(os, 'chown', None)
2036
src = os.path.dirname(dst)
2042
chown(dst, s.st_uid, s.st_gid)
2045
'Unable to copy ownership from "%s" to "%s". '
2046
'You may want to set it manually.', src, dst)
2047
trace.log_exception_quietly()
2050
def path_prefix_key(path):
2051
"""Generate a prefix-order path key for path.
2053
This can be used to sort paths in the same way that walkdirs does.
2055
return (dirname(path), path)
2058
def compare_paths_prefix_order(path_a, path_b):
2059
"""Compare path_a and path_b to generate the same order walkdirs uses."""
2060
key_a = path_prefix_key(path_a)
2061
key_b = path_prefix_key(path_b)
2062
return (key_a > key_b) - (key_a < key_b)
2065
_cached_user_encoding = None
2068
def get_user_encoding():
2069
"""Find out what the preferred user encoding is.
2071
This is generally the encoding that is used for command line parameters
2072
and file contents. This may be different from the terminal encoding
2073
or the filesystem encoding.
2075
:return: A string defining the preferred user encoding
2077
global _cached_user_encoding
2078
if _cached_user_encoding is not None:
2079
return _cached_user_encoding
2081
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2082
# Use the existing locale settings and call nl_langinfo directly
2083
# rather than going through getpreferredencoding. This avoids
2084
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2085
# possibility of the setlocale call throwing an error.
2086
user_encoding = locale.nl_langinfo(locale.CODESET)
2088
# GZ 2011-12-19: On windows could call GetACP directly instead.
2089
user_encoding = locale.getpreferredencoding(False)
2092
user_encoding = codecs.lookup(user_encoding).name
2094
if user_encoding not in ("", "cp0"):
2095
sys.stderr.write('brz: warning:'
2096
' unknown encoding %s.'
2097
' Continuing with ascii encoding.\n'
2100
user_encoding = 'ascii'
2102
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2103
if user_encoding == 'ascii':
2104
if sys.platform == 'darwin':
2105
# OSX is special-cased in Python to have a UTF-8 filesystem
2106
# encoding and previously had LANG set here if not present.
2107
user_encoding = 'utf-8'
2108
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2109
# for some other posix platforms as well.
2111
_cached_user_encoding = user_encoding
2112
return user_encoding
2115
def get_diff_header_encoding():
2116
return get_terminal_encoding()
2119
def get_host_name():
2120
"""Return the current unicode host name.
2122
This is meant to be used in place of socket.gethostname() because that
2123
behaves inconsistently on different platforms.
2125
if sys.platform == "win32":
2126
return win32utils.get_host_name()
2130
return socket.gethostname()
2131
return socket.gethostname().decode(get_user_encoding())
2134
# We must not read/write any more than 64k at a time from/to a socket so we
2135
# don't risk "no buffer space available" errors on some platforms. Windows in
2136
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2138
MAX_SOCKET_CHUNK = 64 * 1024
2140
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2141
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2142
_eno = getattr(errno, _eno, None)
2143
if _eno is not None:
2144
_end_of_stream_errors.append(_eno)
2148
def read_bytes_from_socket(sock, report_activity=None,
2149
max_read_size=MAX_SOCKET_CHUNK):
2150
"""Read up to max_read_size of bytes from sock and notify of progress.
2152
Translates "Connection reset by peer" into file-like EOF (return an
2153
empty string rather than raise an error), and repeats the recv if
2154
interrupted by a signal.
2158
data = sock.recv(max_read_size)
2159
except socket.error as e:
2161
if eno in _end_of_stream_errors:
2162
# The connection was closed by the other side. Callers expect
2163
# an empty string to signal end-of-stream.
2165
elif eno == errno.EINTR:
2166
# Retry the interrupted recv.
2170
if report_activity is not None:
2171
report_activity(len(data), 'read')
2175
def recv_all(socket, count):
2176
"""Receive an exact number of bytes.
2178
Regular Socket.recv() may return less than the requested number of bytes,
2179
depending on what's in the OS buffer. MSG_WAITALL is not available
2180
on all platforms, but this should work everywhere. This will return
2181
less than the requested amount if the remote end closes.
2183
This isn't optimized and is intended mostly for use in testing.
2186
while len(b) < count:
2187
new = read_bytes_from_socket(socket, None, count - len(b))
2194
def send_all(sock, bytes, report_activity=None):
2195
"""Send all bytes on a socket.
2197
Breaks large blocks in smaller chunks to avoid buffering limitations on
2198
some platforms, and catches EINTR which may be thrown if the send is
2199
interrupted by a signal.
2201
This is preferred to socket.sendall(), because it avoids portability bugs
2202
and provides activity reporting.
2204
:param report_activity: Call this as bytes are read, see
2205
Transport._report_activity
2208
byte_count = len(bytes)
2209
view = memoryview(bytes)
2210
while sent_total < byte_count:
2212
sent = sock.send(view[sent_total:sent_total + MAX_SOCKET_CHUNK])
2213
except (socket.error, IOError) as e:
2214
if e.args[0] in _end_of_stream_errors:
2215
raise errors.ConnectionReset(
2216
"Error trying to write to socket", e)
2217
if e.args[0] != errno.EINTR:
2221
raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2224
if report_activity is not None:
2225
report_activity(sent, 'write')
2228
def connect_socket(address):
2229
# Slight variation of the socket.create_connection() function (provided by
2230
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2231
# provide it for previous python versions. Also, we don't use the timeout
2232
# parameter (provided by the python implementation) so we don't implement
2234
err = socket.error('getaddrinfo returns an empty list')
2235
host, port = address
2236
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2237
af, socktype, proto, canonname, sa = res
2240
sock = socket.socket(af, socktype, proto)
2244
except socket.error as e:
2246
# 'err' is now the most recent error
2247
if sock is not None:
2252
def dereference_path(path):
2253
"""Determine the real path to a file.
2255
All parent elements are dereferenced. But the file itself is not
2257
:param path: The original path. May be absolute or relative.
2258
:return: the real path *to* the file
2260
parent, base = os.path.split(path)
2261
# The pathjoin for '.' is a workaround for Python bug #1213894.
2262
# (initial path components aren't dereferenced)
2263
return pathjoin(realpath(pathjoin('.', parent)), base)
2266
def supports_mapi():
2267
"""Return True if we can use MAPI to launch a mail client."""
2268
return sys.platform == "win32"
2271
def resource_string(package, resource_name):
2272
"""Load a resource from a package and return it as a string.
2274
Note: Only packages that start with breezy are currently supported.
2276
This is designed to be a lightweight implementation of resource
2277
loading in a way which is API compatible with the same API from
2279
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2280
If and when pkg_resources becomes a standard library, this routine
2283
# Check package name is within breezy
2284
if package == "breezy":
2285
resource_relpath = resource_name
2286
elif package.startswith("breezy."):
2287
package = package[len("breezy."):].replace('.', os.sep)
2288
resource_relpath = pathjoin(package, resource_name)
2290
raise errors.BzrError('resource package %s not in breezy' % package)
2292
# Map the resource to a file and read its contents
2293
base = dirname(breezy.__file__)
2294
if getattr(sys, 'frozen', None): # bzr.exe
2295
base = abspath(pathjoin(base, '..', '..'))
2296
with open(pathjoin(base, resource_relpath), "rt") as f:
2300
def file_kind_from_stat_mode_thunk(mode):
2301
global file_kind_from_stat_mode
2302
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2304
from ._readdir_pyx import UTF8DirReader
2305
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2307
# This is one time where we won't warn that an extension failed to
2308
# load. The extension is never available on Windows anyway.
2309
from ._readdir_py import (
2310
_kind_from_mode as file_kind_from_stat_mode
2312
return file_kind_from_stat_mode(mode)
2315
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2318
def file_stat(f, _lstat=os.lstat):
2322
except OSError as e:
2323
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2324
raise errors.NoSuchFile(f)
2328
def file_kind(f, _lstat=os.lstat):
2329
stat_value = file_stat(f, _lstat)
2330
return file_kind_from_stat_mode(stat_value.st_mode)
2333
def until_no_eintr(f, *a, **kw):
2334
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2336
WARNING: you must be certain that it is safe to retry the call repeatedly
2337
if EINTR does occur. This is typically only true for low-level operations
2338
like os.read. If in any doubt, don't use this.
2340
Keep in mind that this is not a complete solution to EINTR. There is
2341
probably code in the Python standard library and other dependencies that
2342
may encounter EINTR if a signal arrives (and there is signal handler for
2343
that signal). So this function can reduce the impact for IO that breezy
2344
directly controls, but it is not a complete solution.
2346
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2350
except (IOError, OSError) as e:
2351
if e.errno == errno.EINTR:
2356
if sys.platform == "win32":
2359
return msvcrt.getch()
2364
fd = sys.stdin.fileno()
2365
settings = termios.tcgetattr(fd)
2368
ch = sys.stdin.read(1)
2370
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2373
if sys.platform.startswith('linux'):
2374
def _local_concurrency():
2376
return os.sysconf('SC_NPROCESSORS_ONLN')
2377
except (ValueError, OSError, AttributeError):
2379
elif sys.platform == 'darwin':
2380
def _local_concurrency():
2381
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2382
stdout=subprocess.PIPE).communicate()[0]
2383
elif "bsd" in sys.platform:
2384
def _local_concurrency():
2385
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2386
stdout=subprocess.PIPE).communicate()[0]
2387
elif sys.platform == 'sunos5':
2388
def _local_concurrency():
2389
return subprocess.Popen(['psrinfo', '-p', ],
2390
stdout=subprocess.PIPE).communicate()[0]
2391
elif sys.platform == "win32":
2392
def _local_concurrency():
2393
# This appears to return the number of cores.
2394
return os.environ.get('NUMBER_OF_PROCESSORS')
2396
def _local_concurrency():
2401
_cached_local_concurrency = None
2404
def local_concurrency(use_cache=True):
2405
"""Return how many processes can be run concurrently.
2407
Rely on platform specific implementations and default to 1 (one) if
2408
anything goes wrong.
2410
global _cached_local_concurrency
2412
if _cached_local_concurrency is not None and use_cache:
2413
return _cached_local_concurrency
2415
concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2416
if concurrency is None:
2417
import multiprocessing
2419
concurrency = multiprocessing.cpu_count()
2420
except NotImplementedError:
2421
# multiprocessing.cpu_count() isn't implemented on all platforms
2423
concurrency = _local_concurrency()
2424
except (OSError, IOError):
2427
concurrency = int(concurrency)
2428
except (TypeError, ValueError):
2431
_cached_local_concurrency = concurrency
2435
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2436
"""A stream writer that doesn't decode str arguments."""
2438
def __init__(self, encode, stream, errors='strict'):
2439
codecs.StreamWriter.__init__(self, stream, errors)
2440
self.encode = encode
2442
def write(self, object):
2443
if isinstance(object, str):
2444
self.stream.write(object)
2446
data, _ = self.encode(object, self.errors)
2447
self.stream.write(data)
2450
if sys.platform == 'win32':
2451
def open_file(filename, mode='r', bufsize=-1):
2452
"""This function is used to override the ``open`` builtin.
2454
But it uses O_NOINHERIT flag so the file handle is not inherited by
2455
child processes. Deleting or renaming a closed file opened with this
2456
function is not blocking child processes.
2458
writing = 'w' in mode
2459
appending = 'a' in mode
2460
updating = '+' in mode
2461
binary = 'b' in mode
2464
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2465
# for flags for each modes.
2475
flags |= os.O_WRONLY
2476
flags |= os.O_CREAT | os.O_TRUNC
2481
flags |= os.O_WRONLY
2482
flags |= os.O_CREAT | os.O_APPEND
2487
flags |= os.O_RDONLY
2489
return os.fdopen(os.open(filename, flags), mode, bufsize)
2494
def available_backup_name(base, exists):
2495
"""Find a non-existing backup file name.
2497
This will *not* create anything, this only return a 'free' entry. This
2498
should be used for checking names in a directory below a locked
2499
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2500
Leap) and generally discouraged.
2502
:param base: The base name.
2504
:param exists: A callable returning True if the path parameter exists.
2507
name = "%s.~%d~" % (base, counter)
2510
name = "%s.~%d~" % (base, counter)
2514
def set_fd_cloexec(fd):
2515
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2516
support for this is not available.
2520
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2521
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2522
except (ImportError, AttributeError):
2523
# Either the fcntl module or specific constants are not present
2527
def find_executable_on_path(name):
2528
"""Finds an executable on the PATH.
2530
On Windows, this will try to append each extension in the PATHEXT
2531
environment variable to the name, if it cannot be found with the name
2534
:param name: The base name of the executable.
2535
:return: The path to the executable found or None.
2537
if sys.platform == 'win32':
2538
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2539
exts = [ext.lower() for ext in exts]
2540
base, ext = os.path.splitext(name)
2542
if ext.lower() not in exts:
2548
path = os.environ.get('PATH')
2549
if path is not None:
2550
path = path.split(os.pathsep)
2553
f = os.path.join(d, name) + ext
2554
if os.access(f, os.X_OK):
2556
if sys.platform == 'win32':
2557
app_path = win32utils.get_app_path(name)
2558
if app_path != name:
2563
def _posix_is_local_pid_dead(pid):
2564
"""True if pid doesn't correspond to live process on this machine"""
2566
# Special meaning of unix kill: just check if it's there.
2568
except OSError as e:
2569
if e.errno == errno.ESRCH:
2570
# On this machine, and really not found: as sure as we can be
2573
elif e.errno == errno.EPERM:
2574
# exists, though not ours
2577
trace.mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2578
# Don't really know.
2581
# Exists and our process: not dead.
2585
if sys.platform == "win32":
2586
is_local_pid_dead = win32utils.is_local_pid_dead
2588
is_local_pid_dead = _posix_is_local_pid_dead
2590
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2591
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2592
if getattr(errno, name, None) is not None]
2595
def fdatasync(fileno):
2596
"""Flush file contents to disk if possible.
2598
:param fileno: Integer OS file handle.
2599
:raises TransportNotPossible: If flushing to disk is not possible.
2601
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2605
except IOError as e:
2606
# See bug #1075108, on some platforms fdatasync exists, but can
2607
# raise ENOTSUP. However, we are calling fdatasync to be helpful
2608
# and reduce the chance of corruption-on-powerloss situations. It
2609
# is not a mandatory call, so it is ok to suppress failures.
2610
trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2611
if getattr(e, 'errno', None) not in _fdatasync_ignored:
2615
def ensure_empty_directory_exists(path, exception_class):
2616
"""Make sure a local directory exists and is empty.
2618
If it does not exist, it is created. If it exists and is not empty, an
2619
instance of exception_class is raised.
2623
except OSError as e:
2624
if e.errno != errno.EEXIST:
2626
if os.listdir(path) != []:
2627
raise exception_class(path)
2630
def is_environment_error(evalue):
2631
"""True if exception instance is due to a process environment issue
2633
This includes OSError and IOError, but also other errors that come from
2634
the operating system or core libraries but are not subclasses of those.
2636
if isinstance(evalue, (EnvironmentError, select.error)):
2638
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2643
def read_mtab(path):
2644
"""Read an fstab-style file and extract mountpoint+filesystem information.
2646
:param path: Path to read from
2647
:yield: Tuples with mountpoints (as bytestrings) and filesystem names
2649
with open(path, 'rb') as f:
2651
if line.startswith(b'#'):
2656
yield cols[1], cols[2].decode('ascii', 'replace')
2659
MTAB_PATH = '/etc/mtab'
2661
class FilesystemFinder(object):
2662
"""Find the filesystem for a particular path."""
2664
def __init__(self, mountpoints):
2667
self._mountpoints = sorted(mountpoints, key=key, reverse=True)
2671
"""Create a FilesystemFinder from an mtab-style file.
2673
Note that this will silenty ignore mtab if it doesn't exist or can not
2676
# TODO(jelmer): Use inotify to be notified when /etc/mtab changes and
2677
# we need to re-read it.
2679
return cls(read_mtab(MTAB_PATH))
2680
except EnvironmentError as e:
2681
trace.mutter('Unable to read mtab: %s', e)
2684
def find(self, path):
2685
"""Find the filesystem used by a particular path.
2687
:param path: Path to find (bytestring or text type)
2688
:return: Filesystem name (as text type) or None, if the filesystem is
2691
for mountpoint, filesystem in self._mountpoints:
2692
if is_inside(mountpoint, path):
2697
_FILESYSTEM_FINDER = None
2700
def get_fs_type(path):
2701
"""Return the filesystem type for the partition a path is in.
2703
:param path: Path to search filesystem type for
2704
:return: A FS type, as string. E.g. "ext2"
2706
global _FILESYSTEM_FINDER
2707
if _FILESYSTEM_FINDER is None:
2708
_FILESYSTEM_FINDER = FilesystemFinder.from_mtab()
2710
if not isinstance(path, bytes):
2711
path = path.encode(_fs_enc)
2713
return _FILESYSTEM_FINDER.find(path)
2717
perf_counter = time.perf_counter
2719
perf_counter = time.clock
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)
added
removed
bzrlib/osutils.py
