171
299
rename_func(tmp_name, new)
173
# Default is to just use the python builtins
174
abspath = os.path.abspath
175
realpath = os.path.realpath
302
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
303
# choke on a Unicode string containing a relative path if
304
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
306
def _posix_abspath(path):
307
# jam 20060426 rather than encoding to fsencoding
308
# copy posixpath.abspath, but use os.getcwdu instead
309
if not posixpath.isabs(path):
310
path = posixpath.join(getcwd(), path)
311
return _posix_normpath(path)
314
def _posix_realpath(path):
315
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
318
def _posix_normpath(path):
319
path = posixpath.normpath(path)
320
# Bug 861008: posixpath.normpath() returns a path normalized according to
321
# the POSIX standard, which stipulates (for compatibility reasons) that two
322
# leading slashes must not be simplified to one, and only if there are 3 or
323
# more should they be simplified as one. So we treat the leading 2 slashes
324
# as a special case here by simply removing the first slash, as we consider
325
# that breaking POSIX compatibility for this obscure feature is acceptable.
326
# This is not a paranoid precaution, as we notably get paths like this when
327
# the repo is hosted at the root of the filesystem, i.e. in "/".
328
if path.startswith('//'):
333
def _posix_path_from_environ(key):
334
"""Get unicode path from `key` in environment or None if not present
336
Note that posix systems use arbitrary byte strings for filesystem objects,
337
so a path that raises BadFilenameEncoding here may still be accessible.
339
val = os.environ.get(key, None)
340
if PY3 or val is None:
343
return val.decode(_fs_enc)
344
except UnicodeDecodeError:
345
# GZ 2011-12-12:Ideally want to include `key` in the exception message
346
raise errors.BadFilenameEncoding(val, _fs_enc)
349
def _posix_get_home_dir():
350
"""Get the home directory of the current user as a unicode path"""
351
path = posixpath.expanduser("~")
353
return path.decode(_fs_enc)
354
except AttributeError:
356
except UnicodeDecodeError:
357
raise errors.BadFilenameEncoding(path, _fs_enc)
360
def _posix_getuser_unicode():
361
"""Get username from environment or password database as unicode"""
362
name = getpass.getuser()
365
user_encoding = get_user_encoding()
367
return name.decode(user_encoding)
368
except UnicodeDecodeError:
369
raise errors.BzrError("Encoding of username %r is unsupported by %s "
370
"application locale." % (name, user_encoding))
373
def _win32_fixdrive(path):
374
"""Force drive letters to be consistent.
376
win32 is inconsistent whether it returns lower or upper case
377
and even if it was consistent the user might type the other
378
so we force it to uppercase
379
running python.exe under cmd.exe return capital C:\\
380
running win32 python inside a cygwin shell returns lowercase c:\\
382
drive, path = ntpath.splitdrive(path)
383
return drive.upper() + path
386
def _win32_abspath(path):
387
# Real ntpath.abspath doesn't have a problem with a unicode cwd
388
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
391
def _win32_realpath(path):
392
# Real ntpath.realpath doesn't have a problem with a unicode cwd
393
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
396
def _win32_pathjoin(*args):
397
return ntpath.join(*args).replace('\\', '/')
400
def _win32_normpath(path):
401
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
405
return _win32_fixdrive(_getcwd().replace('\\', '/'))
408
def _win32_mkdtemp(*args, **kwargs):
409
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
412
def _win32_rename(old, new):
413
"""We expect to be able to atomically replace 'new' with old.
415
On win32, if new exists, it must be moved out of the way first,
419
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
421
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
422
# If we try to rename a non-existant file onto cwd, we get
423
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
424
# if the old path doesn't exist, sometimes we get EACCES
425
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
431
return unicodedata.normalize('NFC', _getcwd())
434
def _rename_wrap_exception(rename_func):
435
"""Adds extra information to any exceptions that come from rename().
437
The exception has an updated message and 'old_filename' and 'new_filename'
441
def _rename_wrapper(old, new):
443
rename_func(old, new)
445
detailed_error = OSError(e.errno, e.strerror +
446
" [occurred when renaming '%s' to '%s']" %
448
detailed_error.old_filename = old
449
detailed_error.new_filename = new
452
return _rename_wrapper
455
if sys.version_info > (3,):
461
# Default rename wraps os.rename()
462
rename = _rename_wrap_exception(os.rename)
464
# Default is to just use the python builtins, but these can be rebound on
465
# particular platforms.
466
abspath = _posix_abspath
467
realpath = _posix_realpath
176
468
pathjoin = os.path.join
177
normpath = os.path.normpath
179
mkdtemp = tempfile.mkdtemp
469
normpath = _posix_normpath
470
path_from_environ = _posix_path_from_environ
471
_get_home_dir = _posix_get_home_dir
472
getuser_unicode = _posix_getuser_unicode
181
474
dirname = os.path.dirname
182
475
basename = os.path.basename
184
if os.name == "posix":
185
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
# choke on a Unicode string containing a relative path if
187
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
189
_fs_enc = sys.getfilesystemencoding()
191
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
194
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
476
split = os.path.split
477
splitext = os.path.splitext
478
# These were already lazily imported into local scope
479
# mkdtemp = tempfile.mkdtemp
480
# rmtree = shutil.rmtree
488
MIN_ABS_PATHLENGTH = 1
196
491
if sys.platform == 'win32':
197
# We need to use the Unicode-aware os.path.abspath and
198
# os.path.realpath on Windows systems.
200
return os.path.abspath(path).replace('\\', '/')
203
return os.path.realpath(path).replace('\\', '/')
206
return os.path.join(*args).replace('\\', '/')
209
return os.path.normpath(path).replace('\\', '/')
212
return os.getcwdu().replace('\\', '/')
214
def mkdtemp(*args, **kwargs):
215
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
217
def rename(old, new):
218
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
492
abspath = _win32_abspath
493
realpath = _win32_realpath
494
pathjoin = _win32_pathjoin
495
normpath = _win32_normpath
496
getcwd = _win32_getcwd
497
mkdtemp = _win32_mkdtemp
498
rename = _rename_wrap_exception(_win32_rename)
500
from . import _walkdirs_win32
504
lstat = _walkdirs_win32.lstat
505
fstat = _walkdirs_win32.fstat
506
wrap_stat = _walkdirs_win32.wrap_stat
508
MIN_ABS_PATHLENGTH = 3
510
def _win32_delete_readonly(function, path, excinfo):
511
"""Error handler for shutil.rmtree function [for win32]
512
Helps to remove files and dirs marked as read-only.
514
exception = excinfo[1]
515
if function in (os.remove, os.rmdir) \
516
and isinstance(exception, OSError) \
517
and exception.errno == errno.EACCES:
523
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
524
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
525
return shutil.rmtree(path, ignore_errors, onerror)
527
f = win32utils.get_unicode_argv # special function or None
530
path_from_environ = win32utils.get_environ_unicode
531
_get_home_dir = win32utils.get_home_location
532
getuser_unicode = win32utils.get_user_name
534
elif sys.platform == 'darwin':
538
def get_terminal_encoding(trace=False):
539
"""Find the best encoding for printing to the screen.
541
This attempts to check both sys.stdout and sys.stdin to see
542
what encoding they are in, and if that fails it falls back to
543
osutils.get_user_encoding().
544
The problem is that on Windows, locale.getpreferredencoding()
545
is not the same encoding as that used by the console:
546
http://mail.python.org/pipermail/python-list/2003-May/162357.html
548
On my standard US Windows XP, the preferred encoding is
549
cp1252, but the console is cp437
551
:param trace: If True trace the selected encoding via mutter().
553
from .trace import mutter
554
output_encoding = getattr(sys.stdout, 'encoding', None)
555
if not output_encoding:
556
input_encoding = getattr(sys.stdin, 'encoding', None)
557
if not input_encoding:
558
output_encoding = get_user_encoding()
560
mutter('encoding stdout as osutils.get_user_encoding() %r',
563
output_encoding = input_encoding
565
mutter('encoding stdout as sys.stdin encoding %r',
569
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
570
if output_encoding == 'cp0':
571
# invalid encoding (cp0 means 'no codepage' on Windows)
572
output_encoding = get_user_encoding()
574
mutter('cp0 is invalid encoding.'
575
' encoding stdout as osutils.get_user_encoding() %r',
579
codecs.lookup(output_encoding)
581
sys.stderr.write('brz: warning:'
582
' unknown terminal encoding %s.\n'
583
' Using encoding %s instead.\n'
584
% (output_encoding, get_user_encoding())
586
output_encoding = get_user_encoding()
588
return output_encoding
221
591
def normalizepath(f):
222
if hasattr(os.path, 'realpath'):
592
if getattr(os.path, 'realpath', None) is not None:
226
[p,e] = os.path.split(f)
596
[p, e] = os.path.split(f)
227
597
if e == "" or e == "." or e == "..":
230
600
return pathjoin(F(p), e)
234
"""Copy a file to a backup.
236
Backups are named in GNU-style, with a ~ suffix.
238
If the file is already a backup, it's not copied.
244
if has_symlinks() and os.path.islink(fn):
245
target = os.readlink(fn)
246
os.symlink(target, bfn)
254
outf = file(bfn, 'wb')
262
604
"""True if f is an accessible directory."""
264
return S_ISDIR(os.lstat(f)[ST_MODE])
606
return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
594
1260
os.path.commonprefix (python2.4) has a bad bug that it works just
595
1261
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
596
1262
avoids that problem.
1264
NOTE: `base` should not have a trailing slash otherwise you'll get
1265
PathNotChild exceptions regardless of `path`.
598
if sys.platform != "win32":
602
assert len(base) >= minlength, ('Length of base must be equal or exceed the'
603
' platform minimum length (which is %d)' % minlength)
1268
if len(base) < MIN_ABS_PATHLENGTH:
1269
# must have space for e.g. a drive letter
1270
raise ValueError(gettext('%r is too short to calculate a relative path')
604
1273
rp = abspath(path)
608
while len(head) >= len(base):
1278
if len(head) <= len(base) and head != base:
1279
raise errors.PathNotChild(rp, base)
609
1280
if head == base:
611
head, tail = os.path.split(head)
1282
head, tail = split(head)
615
# XXX This should raise a NotChildPath exception, as its not tied
617
raise PathNotChild(rp, base)
1287
return pathjoin(*reversed(s))
1292
def _cicp_canonical_relpath(base, path):
1293
"""Return the canonical path relative to base.
1295
Like relpath, but on case-insensitive-case-preserving file-systems, this
1296
will return the relpath as stored on the file-system rather than in the
1297
case specified in the input string, for all existing portions of the path.
1299
This will cause O(N) behaviour if called for every path in a tree; if you
1300
have a number of paths to convert, you should use canonical_relpaths().
1302
# TODO: it should be possible to optimize this for Windows by using the
1303
# win32 API FindFiles function to look for the specified name - but using
1304
# os.listdir() still gives us the correct, platform agnostic semantics in
1307
rel = relpath(base, path)
1308
# '.' will have been turned into ''
1312
abs_base = abspath(base)
1314
_listdir = os.listdir
1316
# use an explicit iterator so we can easily consume the rest on early exit.
1317
bit_iter = iter(rel.split('/'))
1318
for bit in bit_iter:
1321
next_entries = _listdir(current)
1322
except OSError: # enoent, eperm, etc
1323
# We can't find this in the filesystem, so just append the
1325
current = pathjoin(current, bit, *list(bit_iter))
1327
for look in next_entries:
1328
if lbit == look.lower():
1329
current = pathjoin(current, look)
1332
# got to the end, nothing matched, so we just return the
1333
# non-existing bits as they were specified (the filename may be
1334
# the target of a move, for example).
1335
current = pathjoin(current, bit, *list(bit_iter))
1337
return current[len(abs_base):].lstrip('/')
1339
# XXX - TODO - we need better detection/integration of case-insensitive
1340
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1341
# filesystems), for example, so could probably benefit from the same basic
1342
# support there. For now though, only Windows and OSX get that support, and
1343
# they get it for *all* file-systems!
1344
if sys.platform in ('win32', 'darwin'):
1345
canonical_relpath = _cicp_canonical_relpath
1347
canonical_relpath = relpath
1349
def canonical_relpaths(base, paths):
1350
"""Create an iterable to canonicalize a sequence of relative paths.
1352
The intent is for this implementation to use a cache, vastly speeding
1353
up multiple transformations in the same directory.
1355
# but for now, we haven't optimized...
1356
return [canonical_relpath(base, p) for p in paths]
1359
def decode_filename(filename):
1360
"""Decode the filename using the filesystem encoding
1362
If it is unicode, it is returned.
1363
Otherwise it is decoded from the the filesystem's encoding. If decoding
1364
fails, a errors.BadFilenameEncoding exception is raised.
1366
if isinstance(filename, text_type):
1369
return filename.decode(_fs_enc)
1370
except UnicodeDecodeError:
1371
raise errors.BadFilenameEncoding(filename, _fs_enc)
625
1374
def safe_unicode(unicode_or_utf8_string):
626
1375
"""Coerce unicode_or_utf8_string into unicode.
628
1377
If it is unicode, it is returned.
629
Otherwise it is decoded from utf-8. If a decoding error
630
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
631
as a BzrBadParameter exception.
1378
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1379
wrapped in a BzrBadParameterNotUnicode exception.
633
if isinstance(unicode_or_utf8_string, unicode):
1381
if isinstance(unicode_or_utf8_string, text_type):
634
1382
return unicode_or_utf8_string
636
1384
return unicode_or_utf8_string.decode('utf8')
637
1385
except UnicodeDecodeError:
638
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
1386
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1389
def safe_utf8(unicode_or_utf8_string):
1390
"""Coerce unicode_or_utf8_string to a utf8 string.
1392
If it is a str, it is returned.
1393
If it is Unicode, it is encoded into a utf-8 string.
1395
if isinstance(unicode_or_utf8_string, bytes):
1396
# TODO: jam 20070209 This is overkill, and probably has an impact on
1397
# performance if we are dealing with lots of apis that want a
1400
# Make sure it is a valid utf-8 string
1401
unicode_or_utf8_string.decode('utf-8')
1402
except UnicodeDecodeError:
1403
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1404
return unicode_or_utf8_string
1405
return unicode_or_utf8_string.encode('utf-8')
1408
def safe_revision_id(unicode_or_utf8_string):
1409
"""Revision ids should now be utf8, but at one point they were unicode.
1411
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1413
:return: None or a utf8 revision id.
1415
if (unicode_or_utf8_string is None
1416
or unicode_or_utf8_string.__class__ == bytes):
1417
return unicode_or_utf8_string
1418
raise TypeError('Unicode revision ids are no longer supported. '
1419
'Revision id generators should be creating utf8 revision '
1423
def safe_file_id(unicode_or_utf8_string):
1424
"""File ids should now be utf8, but at one point they were unicode.
1426
This is the same as safe_utf8, except it uses the cached encode functions
1427
to save a little bit of performance.
1429
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1431
:return: None or a utf8 file id.
1433
if (unicode_or_utf8_string is None
1434
or unicode_or_utf8_string.__class__ == bytes):
1435
return unicode_or_utf8_string
1436
raise TypeError('Unicode file ids are no longer supported. '
1437
'File id generators should be creating utf8 file ids.')
1440
_platform_normalizes_filenames = False
1441
if sys.platform == 'darwin':
1442
_platform_normalizes_filenames = True
1445
def normalizes_filenames():
1446
"""Return True if this platform normalizes unicode filenames.
1450
return _platform_normalizes_filenames
1453
def _accessible_normalized_filename(path):
1454
"""Get the unicode normalized path, and if you can access the file.
1456
On platforms where the system normalizes filenames (Mac OSX),
1457
you can access a file by any path which will normalize correctly.
1458
On platforms where the system does not normalize filenames
1459
(everything else), you have to access a file by its exact path.
1461
Internally, bzr only supports NFC normalization, since that is
1462
the standard for XML documents.
1464
So return the normalized path, and a flag indicating if the file
1465
can be accessed by that path.
1468
return unicodedata.normalize('NFC', text_type(path)), True
1471
def _inaccessible_normalized_filename(path):
1472
__doc__ = _accessible_normalized_filename.__doc__
1474
normalized = unicodedata.normalize('NFC', text_type(path))
1475
return normalized, normalized == path
1478
if _platform_normalizes_filenames:
1479
normalized_filename = _accessible_normalized_filename
1481
normalized_filename = _inaccessible_normalized_filename
1484
def set_signal_handler(signum, handler, restart_syscall=True):
1485
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1486
on platforms that support that.
1488
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1489
automatically restart (by calling `signal.siginterrupt(signum,
1490
False)`). May be ignored if the feature is not available on this
1491
platform or Python version.
1495
siginterrupt = signal.siginterrupt
1497
# This python implementation doesn't provide signal support, hence no
1500
except AttributeError:
1501
# siginterrupt doesn't exist on this platform, or for this version
1503
siginterrupt = lambda signum, flag: None
1505
def sig_handler(*args):
1506
# Python resets the siginterrupt flag when a signal is
1507
# received. <http://bugs.python.org/issue8354>
1508
# As a workaround for some cases, set it back the way we want it.
1509
siginterrupt(signum, False)
1510
# Now run the handler function passed to set_signal_handler.
1513
sig_handler = handler
1514
old_handler = signal.signal(signum, sig_handler)
1516
siginterrupt(signum, False)
1520
default_terminal_width = 80
1521
"""The default terminal width for ttys.
1523
This is defined so that higher levels can share a common fallback value when
1524
terminal_width() returns None.
1527
# Keep some state so that terminal_width can detect if _terminal_size has
1528
# returned a different size since the process started. See docstring and
1529
# comments of terminal_width for details.
1530
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1531
_terminal_size_state = 'no_data'
1532
_first_terminal_size = None
641
1534
def terminal_width():
642
"""Return estimated terminal width."""
644
# TODO: Do something smart on Windows?
646
# TODO: Is there anything that gets a better update when the window
647
# is resized while the program is running? We could use the Python termcap
1535
"""Return terminal width.
1537
None is returned if the width can't established precisely.
1540
- if BRZ_COLUMNS is set, returns its value
1541
- if there is no controlling terminal, returns None
1542
- query the OS, if the queried size has changed since the last query,
1544
- if COLUMNS is set, returns its value,
1545
- if the OS has a value (even though it's never changed), return its value.
1547
From there, we need to query the OS to get the size of the controlling
1550
On Unices we query the OS by:
1551
- get termios.TIOCGWINSZ
1552
- if an error occurs or a negative value is obtained, returns None
1554
On Windows we query the OS by:
1555
- win32utils.get_console_size() decides,
1556
- returns None on error (provided default value)
1558
# Note to implementors: if changing the rules for determining the width,
1559
# make sure you've considered the behaviour in these cases:
1560
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1561
# - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1563
# - (add more interesting cases here, if you find any)
1564
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1565
# but we don't want to register a signal handler because it is impossible
1566
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1567
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1568
# time so we can notice if the reported size has changed, which should have
1571
# If BRZ_COLUMNS is set, take it, user is always right
1572
# Except if they specified 0 in which case, impose no limit here
1574
width = int(os.environ['BRZ_COLUMNS'])
1575
except (KeyError, ValueError):
1577
if width is not None:
1583
isatty = getattr(sys.stdout, 'isatty', None)
1584
if isatty is None or not isatty():
1585
# Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1589
width, height = os_size = _terminal_size(None, None)
1590
global _first_terminal_size, _terminal_size_state
1591
if _terminal_size_state == 'no_data':
1592
_first_terminal_size = os_size
1593
_terminal_size_state = 'unchanged'
1594
elif (_terminal_size_state == 'unchanged' and
1595
_first_terminal_size != os_size):
1596
_terminal_size_state = 'changed'
1598
# If the OS claims to know how wide the terminal is, and this value has
1599
# ever changed, use that.
1600
if _terminal_size_state == 'changed':
1601
if width is not None and width > 0:
1604
# If COLUMNS is set, use it.
650
1606
return int(os.environ['COLUMNS'])
651
except (IndexError, KeyError, ValueError):
1607
except (KeyError, ValueError):
1610
# Finally, use an unchanged size from the OS, if we have one.
1611
if _terminal_size_state == 'unchanged':
1612
if width is not None and width > 0:
1615
# The width could not be determined.
1619
def _win32_terminal_size(width, height):
1620
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1621
return width, height
1624
def _ioctl_terminal_size(width, height):
1626
import struct, fcntl, termios
1627
s = struct.pack('HHHH', 0, 0, 0, 0)
1628
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1629
height, width = struct.unpack('HHHH', x)[0:2]
1630
except (IOError, AttributeError):
1632
return width, height
1634
_terminal_size = None
1635
"""Returns the terminal size as (width, height).
1637
:param width: Default value for width.
1638
:param height: Default value for height.
1640
This is defined specifically for each OS and query the size of the controlling
1641
terminal. If any error occurs, the provided default values should be returned.
1643
if sys.platform == 'win32':
1644
_terminal_size = _win32_terminal_size
1646
_terminal_size = _ioctl_terminal_size
654
1649
def supports_executable():
655
1650
return sys.platform != "win32"
1653
def supports_posix_readonly():
1654
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1656
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1657
directory controls creation/deletion, etc.
1659
And under win32, readonly means that the directory itself cannot be
1660
deleted. The contents of a readonly directory can be changed, unlike POSIX
1661
where files in readonly directories cannot be added, deleted or renamed.
1663
return sys.platform != "win32"
1666
def set_or_unset_env(env_variable, value):
1667
"""Modify the environment, setting or removing the env_variable.
1669
:param env_variable: The environment variable in question
1670
:param value: The value to set the environment to. If None, then
1671
the variable will be removed.
1672
:return: The original value of the environment variable.
1674
orig_val = os.environ.get(env_variable)
1676
if orig_val is not None:
1677
del os.environ[env_variable]
1679
if not PY3 and isinstance(value, text_type):
1680
value = value.encode(get_user_encoding())
1681
os.environ[env_variable] = value
1685
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1688
def check_legal_path(path):
1689
"""Check whether the supplied path is legal.
1690
This is only required on Windows, so we don't test on other platforms
1693
if sys.platform != "win32":
1695
if _validWin32PathRE.match(path) is None:
1696
raise errors.IllegalPath(path)
1699
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1701
def _is_error_enotdir(e):
1702
"""Check if this exception represents ENOTDIR.
1704
Unfortunately, python is very inconsistent about the exception
1705
here. The cases are:
1706
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1707
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1708
which is the windows error code.
1709
3) Windows, Python2.5 uses errno == EINVAL and
1710
winerror == ERROR_DIRECTORY
1712
:param e: An Exception object (expected to be OSError with an errno
1713
attribute, but we should be able to cope with anything)
1714
:return: True if this represents an ENOTDIR error. False otherwise.
1716
en = getattr(e, 'errno', None)
1717
if (en == errno.ENOTDIR
1718
or (sys.platform == 'win32'
1719
and (en == _WIN32_ERROR_DIRECTORY
1720
or (en == errno.EINVAL
1721
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1727
def walkdirs(top, prefix=""):
1728
"""Yield data about all the directories in a tree.
1730
This yields all the data about the contents of a directory at a time.
1731
After each directory has been yielded, if the caller has mutated the list
1732
to exclude some directories, they are then not descended into.
1734
The data yielded is of the form:
1735
((directory-relpath, directory-path-from-top),
1736
[(relpath, basename, kind, lstat, path-from-top), ...]),
1737
- directory-relpath is the relative path of the directory being returned
1738
with respect to top. prefix is prepended to this.
1739
- directory-path-from-root is the path including top for this directory.
1740
It is suitable for use with os functions.
1741
- relpath is the relative path within the subtree being walked.
1742
- basename is the basename of the path
1743
- kind is the kind of the file now. If unknown then the file is not
1744
present within the tree - but it may be recorded as versioned. See
1746
- lstat is the stat data *if* the file was statted.
1747
- planned, not implemented:
1748
path_from_tree_root is the path from the root of the tree.
1750
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1751
allows one to walk a subtree but get paths that are relative to a tree
1753
:return: an iterator over the dirs.
1755
#TODO there is a bit of a smell where the results of the directory-
1756
# summary in this, and the path from the root, may not agree
1757
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1758
# potentially confusing output. We should make this more robust - but
1759
# not at a speed cost. RBC 20060731
1761
_directory = _directory_kind
1762
_listdir = os.listdir
1763
_kind_from_mode = file_kind_from_stat_mode
1764
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1766
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1767
relroot, _, _, _, top = pending.pop()
1769
relprefix = relroot + u'/'
1772
top_slash = top + u'/'
1775
append = dirblock.append
1777
names = sorted(map(decode_filename, _listdir(top)))
1778
except OSError as e:
1779
if not _is_error_enotdir(e):
1783
abspath = top_slash + name
1784
statvalue = _lstat(abspath)
1785
kind = _kind_from_mode(statvalue.st_mode)
1786
append((relprefix + name, name, kind, statvalue, abspath))
1787
yield (relroot, top), dirblock
1789
# push the user specified dirs from dirblock
1790
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1793
class DirReader(object):
1794
"""An interface for reading directories."""
1796
def top_prefix_to_starting_dir(self, top, prefix=""):
1797
"""Converts top and prefix to a starting dir entry
1799
:param top: A utf8 path
1800
:param prefix: An optional utf8 path to prefix output relative paths
1802
:return: A tuple starting with prefix, and ending with the native
1805
raise NotImplementedError(self.top_prefix_to_starting_dir)
1807
def read_dir(self, prefix, top):
1808
"""Read a specific dir.
1810
:param prefix: A utf8 prefix to be preprended to the path basenames.
1811
:param top: A natively encoded path to read.
1812
:return: A list of the directories contents. Each item contains:
1813
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1815
raise NotImplementedError(self.read_dir)
1818
_selected_dir_reader = None
1821
def _walkdirs_utf8(top, prefix=""):
1822
"""Yield data about all the directories in a tree.
1824
This yields the same information as walkdirs() only each entry is yielded
1825
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1826
are returned as exact byte-strings.
1828
:return: yields a tuple of (dir_info, [file_info])
1829
dir_info is (utf8_relpath, path-from-top)
1830
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1831
if top is an absolute path, path-from-top is also an absolute path.
1832
path-from-top might be unicode or utf8, but it is the correct path to
1833
pass to os functions to affect the file in question. (such as os.lstat)
1835
global _selected_dir_reader
1836
if _selected_dir_reader is None:
1837
if sys.platform == "win32":
1839
from ._walkdirs_win32 import Win32ReadDir
1840
_selected_dir_reader = Win32ReadDir()
1843
elif _fs_enc in ('utf-8', 'ascii'):
1845
from ._readdir_pyx import UTF8DirReader
1846
_selected_dir_reader = UTF8DirReader()
1847
except ImportError as e:
1848
failed_to_load_extension(e)
1851
if _selected_dir_reader is None:
1852
# Fallback to the python version
1853
_selected_dir_reader = UnicodeDirReader()
1855
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1856
# But we don't actually uses 1-3 in pending, so set them to None
1857
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1858
read_dir = _selected_dir_reader.read_dir
1859
_directory = _directory_kind
1861
relroot, _, _, _, top = pending[-1].pop()
1864
dirblock = sorted(read_dir(relroot, top))
1865
yield (relroot, top), dirblock
1866
# push the user specified dirs from dirblock
1867
next = [d for d in reversed(dirblock) if d[2] == _directory]
1869
pending.append(next)
1872
class UnicodeDirReader(DirReader):
1873
"""A dir reader for non-utf8 file systems, which transcodes."""
1875
__slots__ = ['_utf8_encode']
1878
self._utf8_encode = codecs.getencoder('utf8')
1880
def top_prefix_to_starting_dir(self, top, prefix=""):
1881
"""See DirReader.top_prefix_to_starting_dir."""
1882
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1884
def read_dir(self, prefix, top):
1885
"""Read a single directory from a non-utf8 file system.
1887
top, and the abspath element in the output are unicode, all other paths
1888
are utf8. Local disk IO is done via unicode calls to listdir etc.
1890
This is currently the fallback code path when the filesystem encoding is
1891
not UTF-8. It may be better to implement an alternative so that we can
1892
safely handle paths that are not properly decodable in the current
1895
See DirReader.read_dir for details.
1897
_utf8_encode = self._utf8_encode
1899
_listdir = os.listdir
1900
_kind_from_mode = file_kind_from_stat_mode
1903
relprefix = prefix + b'/'
1906
top_slash = top + '/'
1909
append = dirblock.append
1910
for name in sorted(_listdir(top)):
1912
name_utf8 = _utf8_encode(name)[0]
1913
except UnicodeDecodeError:
1914
raise errors.BadFilenameEncoding(
1915
_utf8_encode(relprefix)[0] + name, _fs_enc)
1916
abspath = top_slash + name
1917
statvalue = _lstat(abspath)
1918
kind = _kind_from_mode(statvalue.st_mode)
1919
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1923
def copy_tree(from_path, to_path, handlers={}):
1924
"""Copy all of the entries in from_path into to_path.
1926
:param from_path: The base directory to copy.
1927
:param to_path: The target directory. If it does not exist, it will
1929
:param handlers: A dictionary of functions, which takes a source and
1930
destinations for files, directories, etc.
1931
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1932
'file', 'directory', and 'symlink' should always exist.
1933
If they are missing, they will be replaced with 'os.mkdir()',
1934
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1936
# Now, just copy the existing cached tree to the new location
1937
# We use a cheap trick here.
1938
# Absolute paths are prefixed with the first parameter
1939
# relative paths are prefixed with the second.
1940
# So we can get both the source and target returned
1941
# without any extra work.
1943
def copy_dir(source, dest):
1946
def copy_link(source, dest):
1947
"""Copy the contents of a symlink"""
1948
link_to = os.readlink(source)
1949
os.symlink(link_to, dest)
1951
real_handlers = {'file': shutil.copy2,
1952
'symlink': copy_link,
1953
'directory': copy_dir,
1955
real_handlers.update(handlers)
1957
if not os.path.exists(to_path):
1958
real_handlers['directory'](from_path, to_path)
1960
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1961
for relpath, name, kind, st, abspath in entries:
1962
real_handlers[kind](abspath, relpath)
1965
def copy_ownership_from_path(dst, src=None):
1966
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1968
If src is None, the containing directory is used as source. If chown
1969
fails, the error is ignored and a warning is printed.
1971
chown = getattr(os, 'chown', None)
1976
src = os.path.dirname(dst)
1982
chown(dst, s.st_uid, s.st_gid)
1983
except OSError as e:
1985
'Unable to copy ownership from "%s" to "%s". '
1986
'You may want to set it manually.', src, dst)
1987
trace.log_exception_quietly()
1990
def path_prefix_key(path):
1991
"""Generate a prefix-order path key for path.
1993
This can be used to sort paths in the same way that walkdirs does.
1995
return (dirname(path), path)
1998
def compare_paths_prefix_order(path_a, path_b):
1999
"""Compare path_a and path_b to generate the same order walkdirs uses."""
2000
key_a = path_prefix_key(path_a)
2001
key_b = path_prefix_key(path_b)
2002
return cmp(key_a, key_b)
2005
_cached_user_encoding = None
2008
def get_user_encoding():
2009
"""Find out what the preferred user encoding is.
2011
This is generally the encoding that is used for command line parameters
2012
and file contents. This may be different from the terminal encoding
2013
or the filesystem encoding.
2015
:return: A string defining the preferred user encoding
2017
global _cached_user_encoding
2018
if _cached_user_encoding is not None:
2019
return _cached_user_encoding
2021
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2022
# Use the existing locale settings and call nl_langinfo directly
2023
# rather than going through getpreferredencoding. This avoids
2024
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2025
# possibility of the setlocale call throwing an error.
2026
user_encoding = locale.nl_langinfo(locale.CODESET)
2028
# GZ 2011-12-19: On windows could call GetACP directly instead.
2029
user_encoding = locale.getpreferredencoding(False)
2032
user_encoding = codecs.lookup(user_encoding).name
2034
if user_encoding not in ("", "cp0"):
2035
sys.stderr.write('brz: warning:'
2036
' unknown encoding %s.'
2037
' Continuing with ascii encoding.\n'
2040
user_encoding = 'ascii'
2042
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2043
if user_encoding == 'ascii':
2044
if sys.platform == 'darwin':
2045
# OSX is special-cased in Python to have a UTF-8 filesystem
2046
# encoding and previously had LANG set here if not present.
2047
user_encoding = 'utf-8'
2048
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2049
# for some other posix platforms as well.
2051
_cached_user_encoding = user_encoding
2052
return user_encoding
2055
def get_diff_header_encoding():
2056
return get_terminal_encoding()
2059
def get_host_name():
2060
"""Return the current unicode host name.
2062
This is meant to be used in place of socket.gethostname() because that
2063
behaves inconsistently on different platforms.
2065
if sys.platform == "win32":
2066
return win32utils.get_host_name()
2070
return socket.gethostname()
2071
return socket.gethostname().decode(get_user_encoding())
2074
# We must not read/write any more than 64k at a time from/to a socket so we
2075
# don't risk "no buffer space available" errors on some platforms. Windows in
2076
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2078
MAX_SOCKET_CHUNK = 64 * 1024
2080
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2081
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2082
_eno = getattr(errno, _eno, None)
2083
if _eno is not None:
2084
_end_of_stream_errors.append(_eno)
2088
def read_bytes_from_socket(sock, report_activity=None,
2089
max_read_size=MAX_SOCKET_CHUNK):
2090
"""Read up to max_read_size of bytes from sock and notify of progress.
2092
Translates "Connection reset by peer" into file-like EOF (return an
2093
empty string rather than raise an error), and repeats the recv if
2094
interrupted by a signal.
2098
bytes = sock.recv(max_read_size)
2099
except socket.error as e:
2101
if eno in _end_of_stream_errors:
2102
# The connection was closed by the other side. Callers expect
2103
# an empty string to signal end-of-stream.
2105
elif eno == errno.EINTR:
2106
# Retry the interrupted recv.
2110
if report_activity is not None:
2111
report_activity(len(bytes), 'read')
2115
def recv_all(socket, count):
2116
"""Receive an exact number of bytes.
2118
Regular Socket.recv() may return less than the requested number of bytes,
2119
depending on what's in the OS buffer. MSG_WAITALL is not available
2120
on all platforms, but this should work everywhere. This will return
2121
less than the requested amount if the remote end closes.
2123
This isn't optimized and is intended mostly for use in testing.
2126
while len(b) < count:
2127
new = read_bytes_from_socket(socket, None, count - len(b))
2134
def send_all(sock, bytes, report_activity=None):
2135
"""Send all bytes on a socket.
2137
Breaks large blocks in smaller chunks to avoid buffering limitations on
2138
some platforms, and catches EINTR which may be thrown if the send is
2139
interrupted by a signal.
2141
This is preferred to socket.sendall(), because it avoids portability bugs
2142
and provides activity reporting.
2144
:param report_activity: Call this as bytes are read, see
2145
Transport._report_activity
2148
byte_count = len(bytes)
2149
view = memoryview(bytes)
2150
while sent_total < byte_count:
2152
sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
2153
except (socket.error, IOError) as e:
2154
if e.args[0] in _end_of_stream_errors:
2155
raise errors.ConnectionReset(
2156
"Error trying to write to socket", e)
2157
if e.args[0] != errno.EINTR:
2161
raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2164
if report_activity is not None:
2165
report_activity(sent, 'write')
2168
def connect_socket(address):
2169
# Slight variation of the socket.create_connection() function (provided by
2170
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2171
# provide it for previous python versions. Also, we don't use the timeout
2172
# parameter (provided by the python implementation) so we don't implement
2174
err = socket.error('getaddrinfo returns an empty list')
2175
host, port = address
2176
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2177
af, socktype, proto, canonname, sa = res
2180
sock = socket.socket(af, socktype, proto)
2184
except socket.error as err:
2185
# 'err' is now the most recent error
2186
if sock is not None:
2191
def dereference_path(path):
2192
"""Determine the real path to a file.
2194
All parent elements are dereferenced. But the file itself is not
2196
:param path: The original path. May be absolute or relative.
2197
:return: the real path *to* the file
2199
parent, base = os.path.split(path)
2200
# The pathjoin for '.' is a workaround for Python bug #1213894.
2201
# (initial path components aren't dereferenced)
2202
return pathjoin(realpath(pathjoin('.', parent)), base)
2205
def supports_mapi():
2206
"""Return True if we can use MAPI to launch a mail client."""
2207
return sys.platform == "win32"
2210
def resource_string(package, resource_name):
2211
"""Load a resource from a package and return it as a string.
2213
Note: Only packages that start with breezy are currently supported.
2215
This is designed to be a lightweight implementation of resource
2216
loading in a way which is API compatible with the same API from
2218
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2219
If and when pkg_resources becomes a standard library, this routine
2222
# Check package name is within breezy
2223
if package == "breezy":
2224
resource_relpath = resource_name
2225
elif package.startswith("breezy."):
2226
package = package[len("breezy."):].replace('.', os.sep)
2227
resource_relpath = pathjoin(package, resource_name)
2229
raise errors.BzrError('resource package %s not in breezy' % package)
2231
# Map the resource to a file and read its contents
2232
base = dirname(breezy.__file__)
2233
if getattr(sys, 'frozen', None): # bzr.exe
2234
base = abspath(pathjoin(base, '..', '..'))
2235
f = file(pathjoin(base, resource_relpath), "rU")
2241
def file_kind_from_stat_mode_thunk(mode):
2242
global file_kind_from_stat_mode
2243
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2245
from ._readdir_pyx import UTF8DirReader
2246
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2247
except ImportError as e:
2248
# This is one time where we won't warn that an extension failed to
2249
# load. The extension is never available on Windows anyway.
2250
from ._readdir_py import (
2251
_kind_from_mode as file_kind_from_stat_mode
2253
return file_kind_from_stat_mode(mode)
2254
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2256
def file_stat(f, _lstat=os.lstat):
2260
except OSError as e:
2261
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2262
raise errors.NoSuchFile(f)
2265
def file_kind(f, _lstat=os.lstat):
2266
stat_value = file_stat(f, _lstat)
2267
return file_kind_from_stat_mode(stat_value.st_mode)
2269
def until_no_eintr(f, *a, **kw):
2270
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2272
WARNING: you must be certain that it is safe to retry the call repeatedly
2273
if EINTR does occur. This is typically only true for low-level operations
2274
like os.read. If in any doubt, don't use this.
2276
Keep in mind that this is not a complete solution to EINTR. There is
2277
probably code in the Python standard library and other dependencies that
2278
may encounter EINTR if a signal arrives (and there is signal handler for
2279
that signal). So this function can reduce the impact for IO that breezy
2280
directly controls, but it is not a complete solution.
2282
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2286
except (IOError, OSError) as e:
2287
if e.errno == errno.EINTR:
2292
if sys.platform == "win32":
2295
return msvcrt.getch()
2300
fd = sys.stdin.fileno()
2301
settings = termios.tcgetattr(fd)
2304
ch = sys.stdin.read(1)
2306
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2309
if sys.platform.startswith('linux'):
2310
def _local_concurrency():
2312
return os.sysconf('SC_NPROCESSORS_ONLN')
2313
except (ValueError, OSError, AttributeError):
2315
elif sys.platform == 'darwin':
2316
def _local_concurrency():
2317
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2318
stdout=subprocess.PIPE).communicate()[0]
2319
elif "bsd" in sys.platform:
2320
def _local_concurrency():
2321
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2322
stdout=subprocess.PIPE).communicate()[0]
2323
elif sys.platform == 'sunos5':
2324
def _local_concurrency():
2325
return subprocess.Popen(['psrinfo', '-p',],
2326
stdout=subprocess.PIPE).communicate()[0]
2327
elif sys.platform == "win32":
2328
def _local_concurrency():
2329
# This appears to return the number of cores.
2330
return os.environ.get('NUMBER_OF_PROCESSORS')
2332
def _local_concurrency():
2337
_cached_local_concurrency = None
2339
def local_concurrency(use_cache=True):
2340
"""Return how many processes can be run concurrently.
2342
Rely on platform specific implementations and default to 1 (one) if
2343
anything goes wrong.
2345
global _cached_local_concurrency
2347
if _cached_local_concurrency is not None and use_cache:
2348
return _cached_local_concurrency
2350
concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2351
if concurrency is None:
2352
import multiprocessing
2354
concurrency = multiprocessing.cpu_count()
2355
except NotImplementedError:
2356
# multiprocessing.cpu_count() isn't implemented on all platforms
2358
concurrency = _local_concurrency()
2359
except (OSError, IOError):
2362
concurrency = int(concurrency)
2363
except (TypeError, ValueError):
2366
_cached_concurrency = concurrency
2370
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2371
"""A stream writer that doesn't decode str arguments."""
2373
def __init__(self, encode, stream, errors='strict'):
2374
codecs.StreamWriter.__init__(self, stream, errors)
2375
self.encode = encode
2377
def write(self, object):
2378
if isinstance(object, str):
2379
self.stream.write(object)
2381
data, _ = self.encode(object, self.errors)
2382
self.stream.write(data)
2384
if sys.platform == 'win32':
2385
def open_file(filename, mode='r', bufsize=-1):
2386
"""This function is used to override the ``open`` builtin.
2388
But it uses O_NOINHERIT flag so the file handle is not inherited by
2389
child processes. Deleting or renaming a closed file opened with this
2390
function is not blocking child processes.
2392
writing = 'w' in mode
2393
appending = 'a' in mode
2394
updating = '+' in mode
2395
binary = 'b' in mode
2398
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2399
# for flags for each modes.
2409
flags |= os.O_WRONLY
2410
flags |= os.O_CREAT | os.O_TRUNC
2415
flags |= os.O_WRONLY
2416
flags |= os.O_CREAT | os.O_APPEND
2421
flags |= os.O_RDONLY
2423
return os.fdopen(os.open(filename, flags), mode, bufsize)
2428
def available_backup_name(base, exists):
2429
"""Find a non-existing backup file name.
2431
This will *not* create anything, this only return a 'free' entry. This
2432
should be used for checking names in a directory below a locked
2433
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2434
Leap) and generally discouraged.
2436
:param base: The base name.
2438
:param exists: A callable returning True if the path parameter exists.
2441
name = "%s.~%d~" % (base, counter)
2444
name = "%s.~%d~" % (base, counter)
2448
def set_fd_cloexec(fd):
2449
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2450
support for this is not available.
2454
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2455
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2456
except (ImportError, AttributeError):
2457
# Either the fcntl module or specific constants are not present
2461
def find_executable_on_path(name):
2462
"""Finds an executable on the PATH.
2464
On Windows, this will try to append each extension in the PATHEXT
2465
environment variable to the name, if it cannot be found with the name
2468
:param name: The base name of the executable.
2469
:return: The path to the executable found or None.
2471
if sys.platform == 'win32':
2472
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2473
exts = [ext.lower() for ext in exts]
2474
base, ext = os.path.splitext(name)
2476
if ext.lower() not in exts:
2482
path = os.environ.get('PATH')
2483
if path is not None:
2484
path = path.split(os.pathsep)
2487
f = os.path.join(d, name) + ext
2488
if os.access(f, os.X_OK):
2490
if sys.platform == 'win32':
2491
app_path = win32utils.get_app_path(name)
2492
if app_path != name:
2497
def _posix_is_local_pid_dead(pid):
2498
"""True if pid doesn't correspond to live process on this machine"""
2500
# Special meaning of unix kill: just check if it's there.
2502
except OSError as e:
2503
if e.errno == errno.ESRCH:
2504
# On this machine, and really not found: as sure as we can be
2507
elif e.errno == errno.EPERM:
2508
# exists, though not ours
2511
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2512
# Don't really know.
2515
# Exists and our process: not dead.
2518
if sys.platform == "win32":
2519
is_local_pid_dead = win32utils.is_local_pid_dead
2521
is_local_pid_dead = _posix_is_local_pid_dead
2523
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2524
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2525
if getattr(errno, name, None) is not None]
2528
def fdatasync(fileno):
2529
"""Flush file contents to disk if possible.
2531
:param fileno: Integer OS file handle.
2532
:raises TransportNotPossible: If flushing to disk is not possible.
2534
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2538
except IOError as e:
2539
# See bug #1075108, on some platforms fdatasync exists, but can
2540
# raise ENOTSUP. However, we are calling fdatasync to be helpful
2541
# and reduce the chance of corruption-on-powerloss situations. It
2542
# is not a mandatory call, so it is ok to suppress failures.
2543
trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2544
if getattr(e, 'errno', None) not in _fdatasync_ignored:
2548
def ensure_empty_directory_exists(path, exception_class):
2549
"""Make sure a local directory exists and is empty.
2551
If it does not exist, it is created. If it exists and is not empty, an
2552
instance of exception_class is raised.
2556
except OSError as e:
2557
if e.errno != errno.EEXIST:
2559
if os.listdir(path) != []:
2560
raise exception_class(path)
2563
def is_environment_error(evalue):
2564
"""True if exception instance is due to a process environment issue
2566
This includes OSError and IOError, but also other errors that come from
2567
the operating system or core libraries but are not subclasses of those.
2569
if isinstance(evalue, (EnvironmentError, select.error)):
2571
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
breezy/osutils.py
