13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
25
from .lazy_import import lazy_import
26
lazy_import(globals(), """
27
29
from datetime import datetime
31
from ntpath import (abspath as _nt_abspath,
33
normpath as _nt_normpath,
34
realpath as _nt_realpath,
35
splitdrive as _nt_splitdrive,
33
# We need to import both shutil and rmtree as we export the later on posix
34
# and need the former on windows
36
from shutil import rmtree
39
# We need to import both tempfile and mkdtemp as we export the later on posix
40
# and need the former on windows
42
from tempfile import mkdtemp
44
from tempfile import (
50
from breezy.i18n import gettext
57
from bzrlib import symbol_versioning
58
from bzrlib.symbol_versioning import (
62
from bzrlib.trace import mutter
66
65
# On win32, O_BINARY is used to indicate the file should
67
66
# be opened in binary mode, rather than text mode.
68
67
# On other platforms, O_BINARY doesn't exist, because
69
68
# they always open in binary mode, so it is okay to
70
# OR with 0 on those platforms.
71
# O_NOINHERIT and O_TEXT exists only on win32 too.
69
# OR with 0 on those platforms
72
70
O_BINARY = getattr(os, 'O_BINARY', 0)
73
O_TEXT = getattr(os, 'O_TEXT', 0)
74
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
77
class UnsupportedTimezoneFormat(errors.BzrError):
79
_fmt = ('Unsupported timezone format "%(timezone)s", '
80
'options are "utc", "original", "local".')
82
def __init__(self, timezone):
83
self.timezone = timezone
86
73
def make_readonly(filename):
87
74
"""Make a filename read-only."""
88
mod = os.lstat(filename).st_mode
89
if not stat.S_ISLNK(mod):
91
chmod_if_possible(filename, mod)
75
mod = os.stat(filename).st_mode
77
os.chmod(filename, mod)
94
80
def make_writable(filename):
95
mod = os.lstat(filename).st_mode
96
if not stat.S_ISLNK(mod):
98
chmod_if_possible(filename, mod)
101
def chmod_if_possible(filename, mode):
102
# Set file mode if that can be safely done.
103
# Sometimes even on unix the filesystem won't allow it - see
104
# https://bugs.launchpad.net/bzr/+bug/606537
106
# It is probably faster to just do the chmod, rather than
107
# doing a stat, and then trying to compare
108
os.chmod(filename, mode)
109
except (IOError, OSError) as e:
110
# Permission/access denied seems to commonly happen on smbfs; there's
111
# probably no point warning about it.
112
# <https://bugs.launchpad.net/bzr/+bug/606537>
113
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
114
trace.mutter("ignore error on chmod of %r: %r" % (
120
def minimum_path_selection(paths):
121
"""Return the smallset subset of paths which are outside paths.
123
:param paths: A container (and hence not None) of paths.
124
:return: A set of paths sufficient to include everything in paths via
125
is_inside, drawn from the paths parameter.
131
if isinstance(path, bytes):
132
return path.split(b'/')
134
return path.split('/')
135
sorted_paths = sorted(list(paths), key=sort_key)
137
search_paths = [sorted_paths[0]]
138
for path in sorted_paths[1:]:
139
if not is_inside(search_paths[-1], path):
140
# This path is unique, add it
141
search_paths.append(path)
143
return set(search_paths)
81
mod = os.stat(filename).st_mode
83
os.chmod(filename, mod)
473
383
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
474
384
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
475
385
return shutil.rmtree(path, ignore_errors, onerror)
477
_get_home_dir = win32utils.get_home_location
478
getuser_unicode = win32utils.get_user_name
480
386
elif sys.platform == 'darwin':
481
387
getcwd = _mac_getcwd
484
def get_terminal_encoding(trace=False):
390
def get_terminal_encoding():
485
391
"""Find the best encoding for printing to the screen.
487
393
This attempts to check both sys.stdout and sys.stdin to see
488
394
what encoding they are in, and if that fails it falls back to
489
osutils.get_user_encoding().
395
bzrlib.user_encoding.
490
396
The problem is that on Windows, locale.getpreferredencoding()
491
397
is not the same encoding as that used by the console:
492
398
http://mail.python.org/pipermail/python-list/2003-May/162357.html
494
400
On my standard US Windows XP, the preferred encoding is
495
401
cp1252, but the console is cp437
497
:param trace: If True trace the selected encoding via mutter().
499
from .trace import mutter
500
403
output_encoding = getattr(sys.stdout, 'encoding', None)
501
404
if not output_encoding:
502
405
input_encoding = getattr(sys.stdin, 'encoding', None)
503
406
if not input_encoding:
504
output_encoding = get_user_encoding()
506
mutter('encoding stdout as osutils.get_user_encoding() %r',
407
output_encoding = bzrlib.user_encoding
408
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
509
410
output_encoding = input_encoding
511
mutter('encoding stdout as sys.stdin encoding %r',
411
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
515
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
413
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
516
414
if output_encoding == 'cp0':
517
415
# invalid encoding (cp0 means 'no codepage' on Windows)
518
output_encoding = get_user_encoding()
520
mutter('cp0 is invalid encoding.'
521
' encoding stdout as osutils.get_user_encoding() %r',
416
output_encoding = bzrlib.user_encoding
417
mutter('cp0 is invalid encoding.'
418
' encoding stdout as bzrlib.user_encoding %r', output_encoding)
525
421
codecs.lookup(output_encoding)
526
422
except LookupError:
527
sys.stderr.write('brz: warning:'
423
sys.stderr.write('bzr: warning:'
528
424
' unknown terminal encoding %s.\n'
529
425
' Using encoding %s instead.\n'
530
% (output_encoding, get_user_encoding())
532
output_encoding = get_user_encoding()
426
% (output_encoding, bzrlib.user_encoding)
428
output_encoding = bzrlib.user_encoding
534
430
return output_encoding
779
605
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
780
606
return offset.days * 86400 + offset.seconds
783
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
784
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
787
def format_date(t, offset=0, timezone='original', date_fmt=None,
609
def format_date(t, offset=0, timezone='original', date_fmt=None,
788
610
show_offset=True):
789
"""Return a formatted date string.
791
:param t: Seconds since the epoch.
792
:param offset: Timezone offset in seconds east of utc.
793
:param timezone: How to display the time: 'utc', 'original' for the
794
timezone specified by offset, or 'local' for the process's current
796
:param date_fmt: strftime format.
797
:param show_offset: Whether to append the timezone.
799
(date_fmt, tt, offset_str) = \
800
_format_date(t, offset, timezone, date_fmt, show_offset)
801
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
802
date_str = time.strftime(date_fmt, tt)
803
return date_str + offset_str
806
# Cache of formatted offset strings
810
def format_date_with_offset_in_original_timezone(t, offset=0,
811
_cache=_offset_cache):
812
"""Return a formatted date string in the original timezone.
814
This routine may be faster then format_date.
816
:param t: Seconds since the epoch.
817
:param offset: Timezone offset in seconds east of utc.
821
tt = time.gmtime(t + offset)
822
date_fmt = _default_format_by_weekday_num[tt[6]]
823
date_str = time.strftime(date_fmt, tt)
824
offset_str = _cache.get(offset, None)
825
if offset_str is None:
826
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
827
_cache[offset] = offset_str
828
return date_str + offset_str
831
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
833
"""Return an unicode date string formatted according to the current locale.
835
:param t: Seconds since the epoch.
836
:param offset: Timezone offset in seconds east of utc.
837
:param timezone: How to display the time: 'utc', 'original' for the
838
timezone specified by offset, or 'local' for the process's current
840
:param date_fmt: strftime format.
841
:param show_offset: Whether to append the timezone.
843
(date_fmt, tt, offset_str) = \
844
_format_date(t, offset, timezone, date_fmt, show_offset)
845
date_str = time.strftime(date_fmt, tt)
846
if not isinstance(date_str, str):
847
date_str = date_str.decode(get_user_encoding(), 'replace')
848
return date_str + offset_str
851
def _format_date(t, offset, timezone, date_fmt, show_offset):
611
## TODO: Perhaps a global option to use either universal or local time?
612
## Or perhaps just let people set $TZ?
613
assert isinstance(t, float)
852
615
if timezone == 'utc':
853
616
tt = time.gmtime(t)
952
718
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
955
719
def rand_chars(num):
956
720
"""Return a random string of num alphanumeric characters
958
The result only contains lowercase chars because it may be used on
722
The result only contains lowercase chars because it may be used on
959
723
case-insensitive filesystems.
962
726
for raw_byte in rand_bytes(num):
963
s += ALNUM[raw_byte % 36]
727
s += ALNUM[ord(raw_byte) % 36]
967
# TODO: We could later have path objects that remember their list
968
# decomposition (might be too tricksy though.)
731
## TODO: We could later have path objects that remember their list
732
## decomposition (might be too tricksy though.)
970
734
def splitpath(p):
971
735
"""Turn string into list of parts."""
972
use_bytes = isinstance(p, bytes)
973
if os.path.sep == '\\':
974
# split on either delimiter because people might use either on
977
ps = re.split(b'[\\\\/]', p)
979
ps = re.split(r'[\\/]', p)
736
assert isinstance(p, basestring)
988
current_empty_dir = (b'.', b'')
991
current_empty_dir = ('.', '')
738
# split on either delimiter because people might use either on
740
ps = re.split(r'[\\/]', p)
996
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
997
elif f in current_empty_dir:
745
raise errors.BzrError("sorry, %r not allowed in path" % f)
746
elif (f == '.') or (f == ''):
1004
752
def joinpath(p):
753
assert isinstance(p, (list, tuple))
1006
755
if (f == '..') or (f is None) or (f == ''):
1007
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
756
raise errors.BzrError("sorry, %r not allowed in path" % f)
1008
757
return pathjoin(*p)
1011
def parent_directories(filename):
1012
"""Return the list of parent directories, deepest first.
1014
For example, parent_directories("a/b/c") -> ["a/b", "a"].
1017
parts = splitpath(dirname(filename))
1019
parents.append(joinpath(parts))
1024
_extension_load_failures = []
1027
def failed_to_load_extension(exception):
1028
"""Handle failing to load a binary extension.
1030
This should be called from the ImportError block guarding the attempt to
1031
import the native extension. If this function returns, the pure-Python
1032
implementation should be loaded instead::
1035
>>> import breezy._fictional_extension_pyx
1036
>>> except ImportError, e:
1037
>>> breezy.osutils.failed_to_load_extension(e)
1038
>>> import breezy._fictional_extension_py
1040
# NB: This docstring is just an example, not a doctest, because doctest
1041
# currently can't cope with the use of lazy imports in this namespace --
1044
# This currently doesn't report the failure at the time it occurs, because
1045
# they tend to happen very early in startup when we can't check config
1046
# files etc, and also we want to report all failures but not spam the user
1048
exception_str = str(exception)
1049
if exception_str not in _extension_load_failures:
1050
trace.mutter("failed to load compiled extension: %s" % exception_str)
1051
_extension_load_failures.append(exception_str)
1054
def report_extension_load_failures():
1055
if not _extension_load_failures:
1057
if config.GlobalConfig().suppress_warning('missing_extensions'):
1059
# the warnings framework should by default show this only once
1060
from .trace import warning
1062
"brz: warning: some compiled extensions could not be loaded; "
1063
"see ``brz help missing-extensions``")
1064
# we no longer show the specific missing extensions here, because it makes
1065
# the message too long and scary - see
1066
# https://bugs.launchpad.net/bzr/+bug/430529
1070
from ._chunks_to_lines_pyx import chunks_to_lines
1071
except ImportError as e:
1072
failed_to_load_extension(e)
1073
from ._chunks_to_lines_py import chunks_to_lines
760
@deprecated_function(zero_nine)
761
def appendpath(p1, p2):
765
return pathjoin(p1, p2)
1076
768
def split_lines(s):
1077
769
"""Split s into lines, but without removing the newline characters."""
1078
# Trivially convert a fulltext into a 'chunked' representation, and let
1079
# chunks_to_lines do the heavy lifting.
1080
if isinstance(s, bytes):
1081
# chunks_to_lines only supports 8-bit strings
1082
return chunks_to_lines([s])
1084
return _split_lines(s)
1087
def _split_lines(s):
1088
"""Split s into lines, but without removing the newline characters.
1090
This supports Unicode or plain string objects.
1092
nl = b'\n' if isinstance(s, bytes) else u'\n'
1094
result = [line + nl for line in lines[:-1]]
770
lines = s.split('\n')
771
result = [line + '\n' for line in lines[:-1]]
1096
773
result.append(lines[-1])
1216
846
os.path.commonprefix (python2.4) has a bad bug that it works just
1217
847
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1218
848
avoids that problem.
1220
NOTE: `base` should not have a trailing slash otherwise you'll get
1221
PathNotChild exceptions regardless of `path`.
1224
if len(base) < MIN_ABS_PATHLENGTH:
1225
# must have space for e.g. a drive letter
1226
raise ValueError(gettext('%r is too short to calculate a relative path')
851
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
852
' exceed the platform minimum length (which is %d)' %
1229
855
rp = abspath(path)
1234
if len(head) <= len(base) and head != base:
1235
raise errors.PathNotChild(rp, base)
859
while len(head) >= len(base):
1236
860
if head == base:
1238
head, tail = split(head)
862
head, tail = os.path.split(head)
866
raise errors.PathNotChild(rp, base)
1243
return pathjoin(*reversed(s))
1248
def _cicp_canonical_relpath(base, path):
1249
"""Return the canonical path relative to base.
1251
Like relpath, but on case-insensitive-case-preserving file-systems, this
1252
will return the relpath as stored on the file-system rather than in the
1253
case specified in the input string, for all existing portions of the path.
1255
This will cause O(N) behaviour if called for every path in a tree; if you
1256
have a number of paths to convert, you should use canonical_relpaths().
1258
# TODO: it should be possible to optimize this for Windows by using the
1259
# win32 API FindFiles function to look for the specified name - but using
1260
# os.listdir() still gives us the correct, platform agnostic semantics in
1263
rel = relpath(base, path)
1264
# '.' will have been turned into ''
1268
abs_base = abspath(base)
1271
# use an explicit iterator so we can easily consume the rest on early exit.
1272
bit_iter = iter(rel.split('/'))
1273
for bit in bit_iter:
1276
next_entries = scandir(current)
1277
except OSError: # enoent, eperm, etc
1278
# We can't find this in the filesystem, so just append the
1280
current = pathjoin(current, bit, *list(bit_iter))
1282
for entry in next_entries:
1283
if lbit == entry.name.lower():
1284
current = entry.path
1287
# got to the end, nothing matched, so we just return the
1288
# non-existing bits as they were specified (the filename may be
1289
# the target of a move, for example).
1290
current = pathjoin(current, bit, *list(bit_iter))
1292
return current[len(abs_base):].lstrip('/')
1295
# XXX - TODO - we need better detection/integration of case-insensitive
1296
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1297
# filesystems), for example, so could probably benefit from the same basic
1298
# support there. For now though, only Windows and OSX get that support, and
1299
# they get it for *all* file-systems!
1300
if sys.platform in ('win32', 'darwin'):
1301
canonical_relpath = _cicp_canonical_relpath
1303
canonical_relpath = relpath
1306
def canonical_relpaths(base, paths):
1307
"""Create an iterable to canonicalize a sequence of relative paths.
1309
The intent is for this implementation to use a cache, vastly speeding
1310
up multiple transformations in the same directory.
1312
# but for now, we haven't optimized...
1313
return [canonical_relpath(base, p) for p in paths]
1316
def decode_filename(filename):
1317
"""Decode the filename using the filesystem encoding
1319
If it is unicode, it is returned.
1320
Otherwise it is decoded from the the filesystem's encoding. If decoding
1321
fails, a errors.BadFilenameEncoding exception is raised.
1323
if isinstance(filename, str):
1326
return filename.decode(_fs_enc)
1327
except UnicodeDecodeError:
1328
raise errors.BadFilenameEncoding(filename, _fs_enc)
1331
874
def safe_unicode(unicode_or_utf8_string):
1332
875
"""Coerce unicode_or_utf8_string into unicode.
1334
877
If it is unicode, it is returned.
1335
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1336
wrapped in a BzrBadParameterNotUnicode exception.
878
Otherwise it is decoded from utf-8. If a decoding error
879
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
880
as a BzrBadParameter exception.
1338
if isinstance(unicode_or_utf8_string, str):
882
if isinstance(unicode_or_utf8_string, unicode):
1339
883
return unicode_or_utf8_string
1341
885
return unicode_or_utf8_string.decode('utf8')
1410
996
normalized_filename = _inaccessible_normalized_filename
1413
def set_signal_handler(signum, handler, restart_syscall=True):
1414
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1415
on platforms that support that.
1417
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1418
automatically restart (by calling `signal.siginterrupt(signum,
1419
False)`). May be ignored if the feature is not available on this
1420
platform or Python version.
1424
siginterrupt = signal.siginterrupt
1426
# This python implementation doesn't provide signal support, hence no
1429
except AttributeError:
1430
# siginterrupt doesn't exist on this platform, or for this version
1432
def siginterrupt(signum, flag): return None
1434
def sig_handler(*args):
1435
# Python resets the siginterrupt flag when a signal is
1436
# received. <http://bugs.python.org/issue8354>
1437
# As a workaround for some cases, set it back the way we want it.
1438
siginterrupt(signum, False)
1439
# Now run the handler function passed to set_signal_handler.
1442
sig_handler = handler
1443
old_handler = signal.signal(signum, sig_handler)
1445
siginterrupt(signum, False)
1449
default_terminal_width = 80
1450
"""The default terminal width for ttys.
1452
This is defined so that higher levels can share a common fallback value when
1453
terminal_width() returns None.
1456
# Keep some state so that terminal_width can detect if _terminal_size has
1457
# returned a different size since the process started. See docstring and
1458
# comments of terminal_width for details.
1459
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1460
_terminal_size_state = 'no_data'
1461
_first_terminal_size = None
1464
999
def terminal_width():
1465
"""Return terminal width.
1467
None is returned if the width can't established precisely.
1470
- if BRZ_COLUMNS is set, returns its value
1471
- if there is no controlling terminal, returns None
1472
- query the OS, if the queried size has changed since the last query,
1474
- if COLUMNS is set, returns its value,
1475
- if the OS has a value (even though it's never changed), return its value.
1477
From there, we need to query the OS to get the size of the controlling
1480
On Unices we query the OS by:
1481
- get termios.TIOCGWINSZ
1482
- if an error occurs or a negative value is obtained, returns None
1484
On Windows we query the OS by:
1485
- win32utils.get_console_size() decides,
1486
- returns None on error (provided default value)
1488
# Note to implementors: if changing the rules for determining the width,
1489
# make sure you've considered the behaviour in these cases:
1490
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1491
# - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1493
# - (add more interesting cases here, if you find any)
1494
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1495
# but we don't want to register a signal handler because it is impossible
1496
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1497
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1498
# time so we can notice if the reported size has changed, which should have
1501
# If BRZ_COLUMNS is set, take it, user is always right
1502
# Except if they specified 0 in which case, impose no limit here
1504
width = int(os.environ['BRZ_COLUMNS'])
1505
except (KeyError, ValueError):
1507
if width is not None:
1513
isatty = getattr(sys.stdout, 'isatty', None)
1514
if isatty is None or not isatty():
1515
# Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1519
width, height = os_size = _terminal_size(None, None)
1520
global _first_terminal_size, _terminal_size_state
1521
if _terminal_size_state == 'no_data':
1522
_first_terminal_size = os_size
1523
_terminal_size_state = 'unchanged'
1524
elif (_terminal_size_state == 'unchanged' and
1525
_first_terminal_size != os_size):
1526
_terminal_size_state = 'changed'
1528
# If the OS claims to know how wide the terminal is, and this value has
1529
# ever changed, use that.
1530
if _terminal_size_state == 'changed':
1531
if width is not None and width > 0:
1534
# If COLUMNS is set, use it.
1536
return int(os.environ['COLUMNS'])
1537
except (KeyError, ValueError):
1540
# Finally, use an unchanged size from the OS, if we have one.
1541
if _terminal_size_state == 'unchanged':
1542
if width is not None and width > 0:
1545
# The width could not be determined.
1549
def _win32_terminal_size(width, height):
1550
width, height = win32utils.get_console_size(
1551
defaultx=width, defaulty=height)
1552
return width, height
1555
def _ioctl_terminal_size(width, height):
1000
"""Return estimated terminal width."""
1001
if sys.platform == 'win32':
1002
return win32utils.get_console_size()[0]
1005
import struct, fcntl, termios
1560
1006
s = struct.pack('HHHH', 0, 0, 0, 0)
1561
1007
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1562
height, width = struct.unpack('HHHH', x)[0:2]
1563
except (IOError, AttributeError):
1008
width = struct.unpack('HHHH', x)[1]
1565
return width, height
1568
_terminal_size = None
1569
"""Returns the terminal size as (width, height).
1571
:param width: Default value for width.
1572
:param height: Default value for height.
1574
This is defined specifically for each OS and query the size of the controlling
1575
terminal. If any error occurs, the provided default values should be returned.
1577
if sys.platform == 'win32':
1578
_terminal_size = _win32_terminal_size
1580
_terminal_size = _ioctl_terminal_size
1583
def supports_executable(path):
1584
"""Return if filesystem at path supports executable bit.
1586
:param path: Path for which to check the file system
1587
:return: boolean indicating whether executable bit can be stored/relied upon
1589
if sys.platform == 'win32':
1592
fs_type = get_fs_type(path)
1593
except errors.DependencyNotPresent as e:
1594
trace.mutter('Unable to get fs type for %r: %s', path, e)
1596
if fs_type in ('vfat', 'ntfs'):
1597
# filesystems known to not support executable bit
1602
def supports_symlinks(path):
1603
"""Return if the filesystem at path supports the creation of symbolic links.
1606
if not has_symlinks():
1609
fs_type = get_fs_type(path)
1610
except errors.DependencyNotPresent as e:
1611
trace.mutter('Unable to get fs type for %r: %s', path, e)
1613
if fs_type in ('vfat', 'ntfs'):
1614
# filesystems known to not support symlinks
1013
width = int(os.environ['COLUMNS'])
1022
def supports_executable():
1023
return sys.platform != "win32"
1619
1026
def supports_posix_readonly():
1660
1069
raise errors.IllegalPath(path)
1663
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1667
scandir = os.scandir
1668
except AttributeError: # Python < 3
1669
lazy_import(globals(), """\
1670
from scandir import scandir
1674
def _is_error_enotdir(e):
1675
"""Check if this exception represents ENOTDIR.
1677
Unfortunately, python is very inconsistent about the exception
1678
here. The cases are:
1679
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1680
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1681
which is the windows error code.
1682
3) Windows, Python2.5 uses errno == EINVAL and
1683
winerror == ERROR_DIRECTORY
1685
:param e: An Exception object (expected to be OSError with an errno
1686
attribute, but we should be able to cope with anything)
1687
:return: True if this represents an ENOTDIR error. False otherwise.
1689
en = getattr(e, 'errno', None)
1690
if (en == errno.ENOTDIR or
1691
(sys.platform == 'win32' and
1692
(en == _WIN32_ERROR_DIRECTORY or
1694
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1700
1072
def walkdirs(top, prefix=""):
1701
1073
"""Yield data about all the directories in a tree.
1703
1075
This yields all the data about the contents of a directory at a time.
1704
1076
After each directory has been yielded, if the caller has mutated the list
1705
1077
to exclude some directories, they are then not descended into.
1707
1079
The data yielded is of the form:
1708
1080
((directory-relpath, directory-path-from-top),
1709
[(relpath, basename, kind, lstat, path-from-top), ...]),
1081
[(directory-relpath, basename, kind, lstat, path-from-top), ...]),
1710
1082
- directory-relpath is the relative path of the directory being returned
1711
1083
with respect to top. prefix is prepended to this.
1712
- directory-path-from-root is the path including top for this directory.
1084
- directory-path-from-root is the path including top for this directory.
1713
1085
It is suitable for use with os functions.
1714
1086
- relpath is the relative path within the subtree being walked.
1715
1087
- basename is the basename of the path
1802
1143
path-from-top might be unicode or utf8, but it is the correct path to
1803
1144
pass to os functions to affect the file in question. (such as os.lstat)
1805
global _selected_dir_reader
1806
if _selected_dir_reader is None:
1807
if sys.platform == "win32":
1809
from ._walkdirs_win32 import Win32ReadDir
1810
_selected_dir_reader = Win32ReadDir()
1813
elif _fs_enc in ('utf-8', 'ascii'):
1815
from ._readdir_pyx import UTF8DirReader
1816
_selected_dir_reader = UTF8DirReader()
1817
except ImportError as e:
1818
failed_to_load_extension(e)
1821
if _selected_dir_reader is None:
1822
# Fallback to the python version
1823
_selected_dir_reader = UnicodeDirReader()
1146
fs_encoding = sys.getfilesystemencoding()
1147
if (sys.platform == 'win32' or
1148
fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1149
return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1151
return _walkdirs_fs_utf8(top, prefix=prefix)
1154
def _walkdirs_fs_utf8(top, prefix=""):
1155
"""See _walkdirs_utf8.
1157
This sub-function is called when we know the filesystem is already in utf8
1158
encoding. So we don't need to transcode filenames.
1161
_directory = _directory_kind
1162
_listdir = os.listdir
1163
_kind_from_mode = _formats.get
1825
1165
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1826
1166
# But we don't actually uses 1-3 in pending, so set them to None
1827
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1828
read_dir = _selected_dir_reader.read_dir
1829
_directory = _directory_kind
1167
pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1831
relroot, _, _, _, top = pending[-1].pop()
1834
dirblock = sorted(read_dir(relroot, top))
1835
yield (relroot, top), dirblock
1836
# push the user specified dirs from dirblock
1837
next = [d for d in reversed(dirblock) if d[2] == _directory]
1839
pending.append(next)
1842
class UnicodeDirReader(DirReader):
1843
"""A dir reader for non-utf8 file systems, which transcodes."""
1845
__slots__ = ['_utf8_encode']
1848
self._utf8_encode = codecs.getencoder('utf8')
1850
def top_prefix_to_starting_dir(self, top, prefix=""):
1851
"""See DirReader.top_prefix_to_starting_dir."""
1852
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1854
def read_dir(self, prefix, top):
1855
"""Read a single directory from a non-utf8 file system.
1857
top, and the abspath element in the output are unicode, all other paths
1858
are utf8. Local disk IO is done via unicode calls to listdir etc.
1860
This is currently the fallback code path when the filesystem encoding is
1861
not UTF-8. It may be better to implement an alternative so that we can
1862
safely handle paths that are not properly decodable in the current
1865
See DirReader.read_dir for details.
1867
_utf8_encode = self._utf8_encode
1869
def _fs_decode(s): return s.decode(_fs_enc)
1871
def _fs_encode(s): return s.encode(_fs_enc)
1874
relprefix = prefix + b'/'
1169
relroot, _, _, _, top = pending.pop()
1171
relprefix = relroot + '/'
1877
1174
top_slash = top + '/'
1880
1177
append = dirblock.append
1881
for entry in scandir(safe_utf8(top)):
1883
name = _fs_decode(entry.name)
1884
except UnicodeDecodeError:
1885
raise errors.BadFilenameEncoding(
1886
relprefix + entry.name, _fs_enc)
1178
for name in sorted(_listdir(top)):
1887
1179
abspath = top_slash + name
1180
statvalue = _lstat(abspath)
1181
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1182
append((relprefix + name, name, kind, statvalue, abspath))
1183
yield (relroot, top), dirblock
1185
# push the user specified dirs from dirblock
1186
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1189
def _walkdirs_unicode_to_utf8(top, prefix=""):
1190
"""See _walkdirs_utf8
1192
Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1194
This is currently the fallback code path when the filesystem encoding is
1195
not UTF-8. It may be better to implement an alternative so that we can
1196
safely handle paths that are not properly decodable in the current
1199
_utf8_encode = codecs.getencoder('utf8')
1201
_directory = _directory_kind
1202
_listdir = os.listdir
1203
_kind_from_mode = _formats.get
1205
pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1207
relroot, _, _, _, top = pending.pop()
1209
relprefix = relroot + '/'
1212
top_slash = top + u'/'
1215
append = dirblock.append
1216
for name in sorted(_listdir(top)):
1888
1217
name_utf8 = _utf8_encode(name)[0]
1889
statvalue = entry.stat(follow_symlinks=False)
1890
kind = file_kind_from_stat_mode(statvalue.st_mode)
1218
abspath = top_slash + name
1219
statvalue = _lstat(abspath)
1220
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1891
1221
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1892
return sorted(dirblock)
1222
yield (relroot, top), dirblock
1224
# push the user specified dirs from dirblock
1225
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1895
1228
def copy_tree(from_path, to_path, handlers={}):
1896
1229
"""Copy all of the entries in from_path into to_path.
1898
:param from_path: The base directory to copy.
1231
:param from_path: The base directory to copy.
1899
1232
:param to_path: The target directory. If it does not exist, it will
1901
1234
:param handlers: A dictionary of functions, which takes a source and
1934
1267
real_handlers[kind](abspath, relpath)
1937
def copy_ownership_from_path(dst, src=None):
1938
"""Copy usr/grp ownership from src file/dir to dst file/dir.
1940
If src is None, the containing directory is used as source. If chown
1941
fails, the error is ignored and a warning is printed.
1943
chown = getattr(os, 'chown', None)
1948
src = os.path.dirname(dst)
1954
chown(dst, s.st_uid, s.st_gid)
1957
'Unable to copy ownership from "%s" to "%s". '
1958
'You may want to set it manually.', src, dst)
1959
trace.log_exception_quietly()
1962
1270
def path_prefix_key(path):
1963
1271
"""Generate a prefix-order path key for path.
1965
1273
This can be used to sort paths in the same way that walkdirs does.
1967
return (dirname(path), path)
1275
return (dirname(path) , path)
1970
1278
def compare_paths_prefix_order(path_a, path_b):
1971
1279
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1972
1280
key_a = path_prefix_key(path_a)
1973
1281
key_b = path_prefix_key(path_b)
1974
return (key_a > key_b) - (key_a < key_b)
1282
return cmp(key_a, key_b)
1977
1285
_cached_user_encoding = None
1980
def get_user_encoding():
1288
def get_user_encoding(use_cache=True):
1981
1289
"""Find out what the preferred user encoding is.
1983
1291
This is generally the encoding that is used for command line parameters
1984
1292
and file contents. This may be different from the terminal encoding
1985
1293
or the filesystem encoding.
1295
:param use_cache: Enable cache for detected encoding.
1296
(This parameter is turned on by default,
1297
and required only for selftesting)
1987
1299
:return: A string defining the preferred user encoding
1989
1301
global _cached_user_encoding
1990
if _cached_user_encoding is not None:
1302
if _cached_user_encoding is not None and use_cache:
1991
1303
return _cached_user_encoding
1993
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
1994
# Use the existing locale settings and call nl_langinfo directly
1995
# rather than going through getpreferredencoding. This avoids
1996
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
1997
# possibility of the setlocale call throwing an error.
1998
user_encoding = locale.nl_langinfo(locale.CODESET)
1305
if sys.platform == 'darwin':
1306
# work around egregious python 2.4 bug
1307
sys.platform = 'posix'
1311
sys.platform = 'darwin'
2000
# GZ 2011-12-19: On windows could call GetACP directly instead.
2001
user_encoding = locale.getpreferredencoding(False)
2004
user_encoding = codecs.lookup(user_encoding).name
2006
if user_encoding not in ("", "cp0"):
2007
sys.stderr.write('brz: warning:'
1316
user_encoding = locale.getpreferredencoding()
1317
except locale.Error, e:
1318
sys.stderr.write('bzr: warning: %s\n'
1319
' Could not determine what text encoding to use.\n'
1320
' This error usually means your Python interpreter\n'
1321
' doesn\'t support the locale set by $LANG (%s)\n'
1322
" Continuing with ascii encoding.\n"
1323
% (e, os.environ.get('LANG')))
1324
user_encoding = 'ascii'
1326
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1327
# treat that as ASCII, and not support printing unicode characters to the
1329
if user_encoding in (None, 'cp0'):
1330
user_encoding = 'ascii'
1334
codecs.lookup(user_encoding)
1336
sys.stderr.write('bzr: warning:'
2008
1337
' unknown encoding %s.'
2009
1338
' Continuing with ascii encoding.\n'
2010
1339
% user_encoding
2012
user_encoding = 'ascii'
2014
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2015
if user_encoding == 'ascii':
2016
if sys.platform == 'darwin':
2017
# OSX is special-cased in Python to have a UTF-8 filesystem
2018
# encoding and previously had LANG set here if not present.
2019
user_encoding = 'utf-8'
2020
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2021
# for some other posix platforms as well.
2023
_cached_user_encoding = user_encoding
1341
user_encoding = 'ascii'
1344
_cached_user_encoding = user_encoding
2024
1346
return user_encoding
2027
def get_diff_header_encoding():
2028
return get_terminal_encoding()
2031
def get_host_name():
2032
"""Return the current unicode host name.
2034
This is meant to be used in place of socket.gethostname() because that
2035
behaves inconsistently on different platforms.
2037
if sys.platform == "win32":
2038
return win32utils.get_host_name()
2041
return socket.gethostname()
2044
# We must not read/write any more than 64k at a time from/to a socket so we
2045
# don't risk "no buffer space available" errors on some platforms. Windows in
2046
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2048
MAX_SOCKET_CHUNK = 64 * 1024
2050
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2051
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2052
_eno = getattr(errno, _eno, None)
2053
if _eno is not None:
2054
_end_of_stream_errors.append(_eno)
2058
def read_bytes_from_socket(sock, report_activity=None,
2059
max_read_size=MAX_SOCKET_CHUNK):
2060
"""Read up to max_read_size of bytes from sock and notify of progress.
2062
Translates "Connection reset by peer" into file-like EOF (return an
2063
empty string rather than raise an error), and repeats the recv if
2064
interrupted by a signal.
2068
data = sock.recv(max_read_size)
2069
except socket.error as e:
2071
if eno in _end_of_stream_errors:
2072
# The connection was closed by the other side. Callers expect
2073
# an empty string to signal end-of-stream.
2075
elif eno == errno.EINTR:
2076
# Retry the interrupted recv.
2080
if report_activity is not None:
2081
report_activity(len(data), 'read')
2085
def recv_all(socket, count):
1349
def recv_all(socket, bytes):
2086
1350
"""Receive an exact number of bytes.
2088
1352
Regular Socket.recv() may return less than the requested number of bytes,
2089
depending on what's in the OS buffer. MSG_WAITALL is not available
1353
dependning on what's in the OS buffer. MSG_WAITALL is not available
2090
1354
on all platforms, but this should work everywhere. This will return
2091
1355
less than the requested amount if the remote end closes.
2093
1357
This isn't optimized and is intended mostly for use in testing.
2096
while len(b) < count:
2097
new = read_bytes_from_socket(socket, None, count - len(b))
1360
while len(b) < bytes:
1361
new = socket.recv(bytes - len(b))
2104
def send_all(sock, bytes, report_activity=None):
2105
"""Send all bytes on a socket.
2107
Breaks large blocks in smaller chunks to avoid buffering limitations on
2108
some platforms, and catches EINTR which may be thrown if the send is
2109
interrupted by a signal.
2111
This is preferred to socket.sendall(), because it avoids portability bugs
2112
and provides activity reporting.
2114
:param report_activity: Call this as bytes are read, see
2115
Transport._report_activity
2118
byte_count = len(bytes)
2119
view = memoryview(bytes)
2120
while sent_total < byte_count:
2122
sent = sock.send(view[sent_total:sent_total + MAX_SOCKET_CHUNK])
2123
except (socket.error, IOError) as e:
2124
if e.args[0] in _end_of_stream_errors:
2125
raise errors.ConnectionReset(
2126
"Error trying to write to socket", e)
2127
if e.args[0] != errno.EINTR:
2131
raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2134
if report_activity is not None:
2135
report_activity(sent, 'write')
2138
def connect_socket(address):
2139
# Slight variation of the socket.create_connection() function (provided by
2140
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2141
# provide it for previous python versions. Also, we don't use the timeout
2142
# parameter (provided by the python implementation) so we don't implement
2144
err = socket.error('getaddrinfo returns an empty list')
2145
host, port = address
2146
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2147
af, socktype, proto, canonname, sa = res
2150
sock = socket.socket(af, socktype, proto)
2154
except socket.error as e:
2156
# 'err' is now the most recent error
2157
if sock is not None:
2162
1367
def dereference_path(path):
2163
1368
"""Determine the real path to a file.
2171
1376
# The pathjoin for '.' is a workaround for Python bug #1213894.
2172
1377
# (initial path components aren't dereferenced)
2173
1378
return pathjoin(realpath(pathjoin('.', parent)), base)
2176
def supports_mapi():
2177
"""Return True if we can use MAPI to launch a mail client."""
2178
return sys.platform == "win32"
2181
def resource_string(package, resource_name):
2182
"""Load a resource from a package and return it as a string.
2184
Note: Only packages that start with breezy are currently supported.
2186
This is designed to be a lightweight implementation of resource
2187
loading in a way which is API compatible with the same API from
2189
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2190
If and when pkg_resources becomes a standard library, this routine
2193
# Check package name is within breezy
2194
if package == "breezy":
2195
resource_relpath = resource_name
2196
elif package.startswith("breezy."):
2197
package = package[len("breezy."):].replace('.', os.sep)
2198
resource_relpath = pathjoin(package, resource_name)
2200
raise errors.BzrError('resource package %s not in breezy' % package)
2202
# Map the resource to a file and read its contents
2203
base = dirname(breezy.__file__)
2204
if getattr(sys, 'frozen', None): # bzr.exe
2205
base = abspath(pathjoin(base, '..', '..'))
2206
with open(pathjoin(base, resource_relpath), "rt") as f:
2210
def file_kind_from_stat_mode_thunk(mode):
2211
global file_kind_from_stat_mode
2212
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2214
from ._readdir_pyx import UTF8DirReader
2215
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2217
# This is one time where we won't warn that an extension failed to
2218
# load. The extension is never available on Windows anyway.
2219
from ._readdir_py import (
2220
_kind_from_mode as file_kind_from_stat_mode
2222
return file_kind_from_stat_mode(mode)
2225
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2228
def file_stat(f, _lstat=os.lstat):
2232
except OSError as e:
2233
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2234
raise errors.NoSuchFile(f)
2238
def file_kind(f, _lstat=os.lstat):
2239
stat_value = file_stat(f, _lstat)
2240
return file_kind_from_stat_mode(stat_value.st_mode)
2243
def until_no_eintr(f, *a, **kw):
2244
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2246
WARNING: you must be certain that it is safe to retry the call repeatedly
2247
if EINTR does occur. This is typically only true for low-level operations
2248
like os.read. If in any doubt, don't use this.
2250
Keep in mind that this is not a complete solution to EINTR. There is
2251
probably code in the Python standard library and other dependencies that
2252
may encounter EINTR if a signal arrives (and there is signal handler for
2253
that signal). So this function can reduce the impact for IO that breezy
2254
directly controls, but it is not a complete solution.
2256
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2260
except (IOError, OSError) as e:
2261
if e.errno == errno.EINTR:
2266
if sys.platform == "win32":
2269
return msvcrt.getch()
2274
fd = sys.stdin.fileno()
2275
settings = termios.tcgetattr(fd)
2278
ch = sys.stdin.read(1)
2280
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2283
if sys.platform.startswith('linux'):
2284
def _local_concurrency():
2286
return os.sysconf('SC_NPROCESSORS_ONLN')
2287
except (ValueError, OSError, AttributeError):
2289
elif sys.platform == 'darwin':
2290
def _local_concurrency():
2291
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2292
stdout=subprocess.PIPE).communicate()[0]
2293
elif "bsd" in sys.platform:
2294
def _local_concurrency():
2295
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2296
stdout=subprocess.PIPE).communicate()[0]
2297
elif sys.platform == 'sunos5':
2298
def _local_concurrency():
2299
return subprocess.Popen(['psrinfo', '-p', ],
2300
stdout=subprocess.PIPE).communicate()[0]
2301
elif sys.platform == "win32":
2302
def _local_concurrency():
2303
# This appears to return the number of cores.
2304
return os.environ.get('NUMBER_OF_PROCESSORS')
2306
def _local_concurrency():
2311
_cached_local_concurrency = None
2314
def local_concurrency(use_cache=True):
2315
"""Return how many processes can be run concurrently.
2317
Rely on platform specific implementations and default to 1 (one) if
2318
anything goes wrong.
2320
global _cached_local_concurrency
2322
if _cached_local_concurrency is not None and use_cache:
2323
return _cached_local_concurrency
2325
concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2326
if concurrency is None:
2327
import multiprocessing
2329
concurrency = multiprocessing.cpu_count()
2330
except NotImplementedError:
2331
# multiprocessing.cpu_count() isn't implemented on all platforms
2333
concurrency = _local_concurrency()
2334
except (OSError, IOError):
2337
concurrency = int(concurrency)
2338
except (TypeError, ValueError):
2341
_cached_local_concurrency = concurrency
2345
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2346
"""A stream writer that doesn't decode str arguments."""
2348
def __init__(self, encode, stream, errors='strict'):
2349
codecs.StreamWriter.__init__(self, stream, errors)
2350
self.encode = encode
2352
def write(self, object):
2353
if isinstance(object, str):
2354
self.stream.write(object)
2356
data, _ = self.encode(object, self.errors)
2357
self.stream.write(data)
2360
if sys.platform == 'win32':
2361
def open_file(filename, mode='r', bufsize=-1):
2362
"""This function is used to override the ``open`` builtin.
2364
But it uses O_NOINHERIT flag so the file handle is not inherited by
2365
child processes. Deleting or renaming a closed file opened with this
2366
function is not blocking child processes.
2368
writing = 'w' in mode
2369
appending = 'a' in mode
2370
updating = '+' in mode
2371
binary = 'b' in mode
2374
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2375
# for flags for each modes.
2385
flags |= os.O_WRONLY
2386
flags |= os.O_CREAT | os.O_TRUNC
2391
flags |= os.O_WRONLY
2392
flags |= os.O_CREAT | os.O_APPEND
2397
flags |= os.O_RDONLY
2399
return os.fdopen(os.open(filename, flags), mode, bufsize)
2404
def available_backup_name(base, exists):
2405
"""Find a non-existing backup file name.
2407
This will *not* create anything, this only return a 'free' entry. This
2408
should be used for checking names in a directory below a locked
2409
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2410
Leap) and generally discouraged.
2412
:param base: The base name.
2414
:param exists: A callable returning True if the path parameter exists.
2417
name = "%s.~%d~" % (base, counter)
2420
name = "%s.~%d~" % (base, counter)
2424
def set_fd_cloexec(fd):
2425
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2426
support for this is not available.
2430
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2431
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2432
except (ImportError, AttributeError):
2433
# Either the fcntl module or specific constants are not present
2437
def find_executable_on_path(name):
2438
"""Finds an executable on the PATH.
2440
On Windows, this will try to append each extension in the PATHEXT
2441
environment variable to the name, if it cannot be found with the name
2444
:param name: The base name of the executable.
2445
:return: The path to the executable found or None.
2447
if sys.platform == 'win32':
2448
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2449
exts = [ext.lower() for ext in exts]
2450
base, ext = os.path.splitext(name)
2452
if ext.lower() not in exts:
2458
path = os.environ.get('PATH')
2459
if path is not None:
2460
path = path.split(os.pathsep)
2463
f = os.path.join(d, name) + ext
2464
if os.access(f, os.X_OK):
2466
if sys.platform == 'win32':
2467
app_path = win32utils.get_app_path(name)
2468
if app_path != name:
2473
def _posix_is_local_pid_dead(pid):
2474
"""True if pid doesn't correspond to live process on this machine"""
2476
# Special meaning of unix kill: just check if it's there.
2478
except OSError as e:
2479
if e.errno == errno.ESRCH:
2480
# On this machine, and really not found: as sure as we can be
2483
elif e.errno == errno.EPERM:
2484
# exists, though not ours
2487
trace.mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2488
# Don't really know.
2491
# Exists and our process: not dead.
2495
if sys.platform == "win32":
2496
is_local_pid_dead = win32utils.is_local_pid_dead
2498
is_local_pid_dead = _posix_is_local_pid_dead
2500
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2501
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2502
if getattr(errno, name, None) is not None]
2505
def fdatasync(fileno):
2506
"""Flush file contents to disk if possible.
2508
:param fileno: Integer OS file handle.
2509
:raises TransportNotPossible: If flushing to disk is not possible.
2511
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2515
except IOError as e:
2516
# See bug #1075108, on some platforms fdatasync exists, but can
2517
# raise ENOTSUP. However, we are calling fdatasync to be helpful
2518
# and reduce the chance of corruption-on-powerloss situations. It
2519
# is not a mandatory call, so it is ok to suppress failures.
2520
trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2521
if getattr(e, 'errno', None) not in _fdatasync_ignored:
2525
def ensure_empty_directory_exists(path, exception_class):
2526
"""Make sure a local directory exists and is empty.
2528
If it does not exist, it is created. If it exists and is not empty, an
2529
instance of exception_class is raised.
2533
except OSError as e:
2534
if e.errno != errno.EEXIST:
2536
if os.listdir(path) != []:
2537
raise exception_class(path)
2540
def read_mtab(path):
2541
"""Read an fstab-style file and extract mountpoint+filesystem information.
2543
:param path: Path to read from
2544
:yield: Tuples with mountpoints (as bytestrings) and filesystem names
2546
with open(path, 'rb') as f:
2548
if line.startswith(b'#'):
2553
yield cols[1], cols[2].decode('ascii', 'replace')
2556
MTAB_PATH = '/etc/mtab'
2558
class FilesystemFinder(object):
2559
"""Find the filesystem for a particular path."""
2561
def __init__(self, mountpoints):
2564
self._mountpoints = sorted(mountpoints, key=key, reverse=True)
2568
"""Create a FilesystemFinder from an mtab-style file.
2570
Note that this will silenty ignore mtab if it doesn't exist or can not
2573
# TODO(jelmer): Use inotify to be notified when /etc/mtab changes and
2574
# we need to re-read it.
2576
return cls(read_mtab(MTAB_PATH))
2577
except EnvironmentError as e:
2578
trace.mutter('Unable to read mtab: %s', e)
2581
def find(self, path):
2582
"""Find the filesystem used by a particular path.
2584
:param path: Path to find (bytestring or text type)
2585
:return: Filesystem name (as text type) or None, if the filesystem is
2588
for mountpoint, filesystem in self._mountpoints:
2589
if is_inside(mountpoint, path):
2594
_FILESYSTEM_FINDER = None
2597
def get_fs_type(path):
2598
"""Return the filesystem type for the partition a path is in.
2600
:param path: Path to search filesystem type for
2601
:return: A FS type, as string. E.g. "ext2"
2603
global _FILESYSTEM_FINDER
2604
if _FILESYSTEM_FINDER is None:
2605
_FILESYSTEM_FINDER = FilesystemFinder.from_mtab()
2607
if not isinstance(path, bytes):
2608
path = path.encode(_fs_enc)
2610
return _FILESYSTEM_FINDER.find(path)
2613
perf_counter = time.perf_counter
added
removed
bzrlib/osutils.py
