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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
26
27
from bzrlib.lazy_import import lazy_import
27
28
lazy_import(globals(), """
29
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,
35
# We need to import both shutil and rmtree as we export the later on posix
36
# and need the former on windows
38
from shutil import rmtree
41
# We need to import both tempfile and mkdtemp as we export the later on posix
42
# and need the former on windows
44
from tempfile import (
44
from tempfile import mkdtemp
49
47
from bzrlib import (
54
from bzrlib.i18n import gettext
57
57
from bzrlib.symbol_versioning import (
58
59
deprecated_function,
61
from bzrlib.trace import mutter
62
warn as warn_deprecated,
72
from bzrlib import symbol_versioning, _fs_enc
75
# Cross platform wall-clock time functionality with decent resolution.
76
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
77
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
78
# synchronized with ``time.time()``, this is only meant to be used to find
79
# delta times by subtracting from another call to this function.
80
timer_func = time.time
81
if sys.platform == 'win32':
82
timer_func = time.clock
64
84
# On win32, O_BINARY is used to indicate the file should
65
85
# be opened in binary mode, rather than text mode.
66
86
# On other platforms, O_BINARY doesn't exist, because
67
87
# they always open in binary mode, so it is okay to
68
# OR with 0 on those platforms
88
# OR with 0 on those platforms.
89
# O_NOINHERIT and O_TEXT exists only on win32 too.
69
90
O_BINARY = getattr(os, 'O_BINARY', 0)
91
O_TEXT = getattr(os, 'O_TEXT', 0)
92
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
95
def get_unicode_argv():
97
user_encoding = get_user_encoding()
98
return [a.decode(user_encoding) for a in sys.argv[1:]]
99
except UnicodeDecodeError:
100
raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
101
"application locale.").format(a, user_encoding))
72
104
def make_readonly(filename):
73
105
"""Make a filename read-only."""
74
mod = os.stat(filename).st_mode
76
os.chmod(filename, mod)
106
mod = os.lstat(filename).st_mode
107
if not stat.S_ISLNK(mod):
109
chmod_if_possible(filename, mod)
79
112
def make_writable(filename):
80
mod = os.stat(filename).st_mode
82
os.chmod(filename, mod)
113
mod = os.lstat(filename).st_mode
114
if not stat.S_ISLNK(mod):
116
chmod_if_possible(filename, mod)
119
def chmod_if_possible(filename, mode):
120
# Set file mode if that can be safely done.
121
# Sometimes even on unix the filesystem won't allow it - see
122
# https://bugs.launchpad.net/bzr/+bug/606537
124
# It is probably faster to just do the chmod, rather than
125
# doing a stat, and then trying to compare
126
os.chmod(filename, mode)
127
except (IOError, OSError),e:
128
# Permission/access denied seems to commonly happen on smbfs; there's
129
# probably no point warning about it.
130
# <https://bugs.launchpad.net/bzr/+bug/606537>
131
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
132
trace.mutter("ignore error on chmod of %r: %r" % (
138
def minimum_path_selection(paths):
139
"""Return the smallset subset of paths which are outside paths.
141
:param paths: A container (and hence not None) of paths.
142
:return: A set of paths sufficient to include everything in paths via
143
is_inside, drawn from the paths parameter.
149
return path.split('/')
150
sorted_paths = sorted(list(paths), key=sort_key)
152
search_paths = [sorted_paths[0]]
153
for path in sorted_paths[1:]:
154
if not is_inside(search_paths[-1], path):
155
# This path is unique, add it
156
search_paths.append(path)
158
return set(search_paths)
223
288
unlink_func(tmp_name)
225
290
rename_func(tmp_name, new)
291
if failure_exc is not None:
293
raise failure_exc[0], failure_exc[1], failure_exc[2]
228
298
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
229
299
# choke on a Unicode string containing a relative path if
230
300
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
232
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
233
302
def _posix_abspath(path):
234
303
# jam 20060426 rather than encoding to fsencoding
235
304
# copy posixpath.abspath, but use os.getcwdu instead
236
305
if not posixpath.isabs(path):
237
306
path = posixpath.join(getcwd(), path)
238
return posixpath.normpath(path)
307
return _posix_normpath(path)
241
310
def _posix_realpath(path):
242
311
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
314
def _posix_normpath(path):
315
path = posixpath.normpath(path)
316
# Bug 861008: posixpath.normpath() returns a path normalized according to
317
# the POSIX standard, which stipulates (for compatibility reasons) that two
318
# leading slashes must not be simplified to one, and only if there are 3 or
319
# more should they be simplified as one. So we treat the leading 2 slashes
320
# as a special case here by simply removing the first slash, as we consider
321
# that breaking POSIX compatibility for this obscure feature is acceptable.
322
# This is not a paranoid precaution, as we notably get paths like this when
323
# the repo is hosted at the root of the filesystem, i.e. in "/".
324
if path.startswith('//'):
329
def _posix_path_from_environ(key):
330
"""Get unicode path from `key` in environment or None if not present
332
Note that posix systems use arbitrary byte strings for filesystem objects,
333
so a path that raises BadFilenameEncoding here may still be accessible.
335
val = os.environ.get(key, None)
339
return val.decode(_fs_enc)
340
except UnicodeDecodeError:
341
# GZ 2011-12-12:Ideally want to include `key` in the exception message
342
raise errors.BadFilenameEncoding(val, _fs_enc)
345
def _posix_get_home_dir():
346
"""Get the home directory of the current user as a unicode path"""
347
path = posixpath.expanduser("~")
349
return path.decode(_fs_enc)
350
except UnicodeDecodeError:
351
raise errors.BadFilenameEncoding(path, _fs_enc)
354
def _posix_getuser_unicode():
355
"""Get username from environment or password database as unicode"""
356
name = getpass.getuser()
357
user_encoding = get_user_encoding()
359
return name.decode(user_encoding)
360
except UnicodeDecodeError:
361
raise errors.BzrError("Encoding of username %r is unsupported by %s "
362
"application locale." % (name, user_encoding))
245
365
def _win32_fixdrive(path):
246
366
"""Force drive letters to be consistent.
379
538
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
380
539
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
381
540
return shutil.rmtree(path, ignore_errors, onerror)
542
f = win32utils.get_unicode_argv # special function or None
545
path_from_environ = win32utils.get_environ_unicode
546
_get_home_dir = win32utils.get_home_location
547
getuser_unicode = win32utils.get_user_name
382
549
elif sys.platform == 'darwin':
383
550
getcwd = _mac_getcwd
386
def get_terminal_encoding():
553
def get_terminal_encoding(trace=False):
387
554
"""Find the best encoding for printing to the screen.
389
556
This attempts to check both sys.stdout and sys.stdin to see
390
557
what encoding they are in, and if that fails it falls back to
391
bzrlib.user_encoding.
558
osutils.get_user_encoding().
392
559
The problem is that on Windows, locale.getpreferredencoding()
393
560
is not the same encoding as that used by the console:
394
561
http://mail.python.org/pipermail/python-list/2003-May/162357.html
396
563
On my standard US Windows XP, the preferred encoding is
397
564
cp1252, but the console is cp437
566
:param trace: If True trace the selected encoding via mutter().
568
from bzrlib.trace import mutter
399
569
output_encoding = getattr(sys.stdout, 'encoding', None)
400
570
if not output_encoding:
401
571
input_encoding = getattr(sys.stdin, 'encoding', None)
402
572
if not input_encoding:
403
output_encoding = bzrlib.user_encoding
404
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
573
output_encoding = get_user_encoding()
575
mutter('encoding stdout as osutils.get_user_encoding() %r',
406
578
output_encoding = input_encoding
407
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
580
mutter('encoding stdout as sys.stdin encoding %r',
409
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
584
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
410
585
if output_encoding == 'cp0':
411
586
# invalid encoding (cp0 means 'no codepage' on Windows)
412
output_encoding = bzrlib.user_encoding
413
mutter('cp0 is invalid encoding.'
414
' encoding stdout as bzrlib.user_encoding %r', output_encoding)
587
output_encoding = get_user_encoding()
589
mutter('cp0 is invalid encoding.'
590
' encoding stdout as osutils.get_user_encoding() %r',
417
594
codecs.lookup(output_encoding)
526
674
for dirname in dir_list:
527
675
if is_inside(dirname, fname) or is_inside(fname, dirname):
680
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
681
report_activity=None, direction='read'):
682
"""Copy contents of one file to another.
684
The read_length can either be -1 to read to end-of-file (EOF) or
685
it can specify the maximum number of bytes to read.
687
The buff_size represents the maximum size for each read operation
688
performed on from_file.
690
:param report_activity: Call this as bytes are read, see
691
Transport._report_activity
692
:param direction: Will be passed to report_activity
694
:return: The number of bytes copied.
698
# read specified number of bytes
700
while read_length > 0:
701
num_bytes_to_read = min(read_length, buff_size)
703
block = from_file.read(num_bytes_to_read)
707
if report_activity is not None:
708
report_activity(len(block), direction)
711
actual_bytes_read = len(block)
712
read_length -= actual_bytes_read
713
length += actual_bytes_read
533
def pumpfile(fromfile, tofile):
534
"""Copy contents of one file to another."""
537
b = fromfile.read(BUFSIZE)
717
block = from_file.read(buff_size)
721
if report_activity is not None:
722
report_activity(len(block), direction)
728
def pump_string_file(bytes, file_handle, segment_size=None):
729
"""Write bytes to file_handle in many smaller writes.
731
:param bytes: The string to write.
732
:param file_handle: The file to write to.
734
# Write data in chunks rather than all at once, because very large
735
# writes fail on some platforms (e.g. Windows with SMB mounted
738
segment_size = 5242880 # 5MB
739
segments = range(len(bytes) / segment_size + 1)
740
write = file_handle.write
741
for segment_index in segments:
742
segment = buffer(bytes, segment_index * segment_size, segment_size)
543
746
def file_iterator(input_file, readsize=32768):
603
834
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
604
835
return offset.days * 86400 + offset.seconds
607
def format_date(t, offset=0, timezone='original', date_fmt=None,
837
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
838
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
841
def format_date(t, offset=0, timezone='original', date_fmt=None,
608
842
show_offset=True):
609
## TODO: Perhaps a global option to use either universal or local time?
610
## Or perhaps just let people set $TZ?
611
assert isinstance(t, float)
843
"""Return a formatted date string.
845
:param t: Seconds since the epoch.
846
:param offset: Timezone offset in seconds east of utc.
847
:param timezone: How to display the time: 'utc', 'original' for the
848
timezone specified by offset, or 'local' for the process's current
850
:param date_fmt: strftime format.
851
:param show_offset: Whether to append the timezone.
853
(date_fmt, tt, offset_str) = \
854
_format_date(t, offset, timezone, date_fmt, show_offset)
855
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
856
date_str = time.strftime(date_fmt, tt)
857
return date_str + offset_str
860
# Cache of formatted offset strings
864
def format_date_with_offset_in_original_timezone(t, offset=0,
865
_cache=_offset_cache):
866
"""Return a formatted date string in the original timezone.
868
This routine may be faster then format_date.
870
:param t: Seconds since the epoch.
871
:param offset: Timezone offset in seconds east of utc.
875
tt = time.gmtime(t + offset)
876
date_fmt = _default_format_by_weekday_num[tt[6]]
877
date_str = time.strftime(date_fmt, tt)
878
offset_str = _cache.get(offset, None)
879
if offset_str is None:
880
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
881
_cache[offset] = offset_str
882
return date_str + offset_str
885
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
887
"""Return an unicode date string formatted according to the current locale.
889
:param t: Seconds since the epoch.
890
:param offset: Timezone offset in seconds east of utc.
891
:param timezone: How to display the time: 'utc', 'original' for the
892
timezone specified by offset, or 'local' for the process's current
894
:param date_fmt: strftime format.
895
:param show_offset: Whether to append the timezone.
897
(date_fmt, tt, offset_str) = \
898
_format_date(t, offset, timezone, date_fmt, show_offset)
899
date_str = time.strftime(date_fmt, tt)
900
if not isinstance(date_str, unicode):
901
date_str = date_str.decode(get_user_encoding(), 'replace')
902
return date_str + offset_str
905
def _format_date(t, offset, timezone, date_fmt, show_offset):
613
906
if timezone == 'utc':
614
907
tt = time.gmtime(t)
743
raise errors.BzrError("sorry, %r not allowed in path" % f)
1030
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
744
1031
elif (f == '.') or (f == ''):
750
1038
def joinpath(p):
751
assert isinstance(p, (list, tuple))
753
1040
if (f == '..') or (f is None) or (f == ''):
754
raise errors.BzrError("sorry, %r not allowed in path" % f)
1041
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
755
1042
return pathjoin(*p)
758
@deprecated_function(zero_nine)
759
def appendpath(p1, p2):
763
return pathjoin(p1, p2)
1045
def parent_directories(filename):
1046
"""Return the list of parent directories, deepest first.
1048
For example, parent_directories("a/b/c") -> ["a/b", "a"].
1051
parts = splitpath(dirname(filename))
1053
parents.append(joinpath(parts))
1058
_extension_load_failures = []
1061
def failed_to_load_extension(exception):
1062
"""Handle failing to load a binary extension.
1064
This should be called from the ImportError block guarding the attempt to
1065
import the native extension. If this function returns, the pure-Python
1066
implementation should be loaded instead::
1069
>>> import bzrlib._fictional_extension_pyx
1070
>>> except ImportError, e:
1071
>>> bzrlib.osutils.failed_to_load_extension(e)
1072
>>> import bzrlib._fictional_extension_py
1074
# NB: This docstring is just an example, not a doctest, because doctest
1075
# currently can't cope with the use of lazy imports in this namespace --
1078
# This currently doesn't report the failure at the time it occurs, because
1079
# they tend to happen very early in startup when we can't check config
1080
# files etc, and also we want to report all failures but not spam the user
1082
exception_str = str(exception)
1083
if exception_str not in _extension_load_failures:
1084
trace.mutter("failed to load compiled extension: %s" % exception_str)
1085
_extension_load_failures.append(exception_str)
1088
def report_extension_load_failures():
1089
if not _extension_load_failures:
1091
if config.GlobalStack().get('ignore_missing_extensions'):
1093
# the warnings framework should by default show this only once
1094
from bzrlib.trace import warning
1096
"bzr: warning: some compiled extensions could not be loaded; "
1097
"see <https://answers.launchpad.net/bzr/+faq/703>")
1098
# we no longer show the specific missing extensions here, because it makes
1099
# the message too long and scary - see
1100
# https://bugs.launchpad.net/bzr/+bug/430529
1104
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1105
except ImportError, e:
1106
failed_to_load_extension(e)
1107
from bzrlib._chunks_to_lines_py import chunks_to_lines
766
1110
def split_lines(s):
767
1111
"""Split s into lines, but without removing the newline characters."""
1112
# Trivially convert a fulltext into a 'chunked' representation, and let
1113
# chunks_to_lines do the heavy lifting.
1114
if isinstance(s, str):
1115
# chunks_to_lines only supports 8-bit strings
1116
return chunks_to_lines([s])
1118
return _split_lines(s)
1121
def _split_lines(s):
1122
"""Split s into lines, but without removing the newline characters.
1124
This supports Unicode or plain string objects.
768
1126
lines = s.split('\n')
769
1127
result = [line + '\n' for line in lines[:-1]]
844
1249
os.path.commonprefix (python2.4) has a bad bug that it works just
845
1250
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
846
1251
avoids that problem.
1253
NOTE: `base` should not have a trailing slash otherwise you'll get
1254
PathNotChild exceptions regardless of `path`.
849
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
850
' exceed the platform minimum length (which is %d)' %
1257
if len(base) < MIN_ABS_PATHLENGTH:
1258
# must have space for e.g. a drive letter
1259
raise ValueError(gettext('%r is too short to calculate a relative path')
853
1262
rp = abspath(path)
857
while len(head) >= len(base):
1267
if len(head) <= len(base) and head != base:
1268
raise errors.PathNotChild(rp, base)
858
1269
if head == base:
860
head, tail = os.path.split(head)
1271
head, tail = split(head)
864
raise errors.PathNotChild(rp, base)
1276
return pathjoin(*reversed(s))
1281
def _cicp_canonical_relpath(base, path):
1282
"""Return the canonical path relative to base.
1284
Like relpath, but on case-insensitive-case-preserving file-systems, this
1285
will return the relpath as stored on the file-system rather than in the
1286
case specified in the input string, for all existing portions of the path.
1288
This will cause O(N) behaviour if called for every path in a tree; if you
1289
have a number of paths to convert, you should use canonical_relpaths().
1291
# TODO: it should be possible to optimize this for Windows by using the
1292
# win32 API FindFiles function to look for the specified name - but using
1293
# os.listdir() still gives us the correct, platform agnostic semantics in
1296
rel = relpath(base, path)
1297
# '.' will have been turned into ''
1301
abs_base = abspath(base)
1303
_listdir = os.listdir
1305
# use an explicit iterator so we can easily consume the rest on early exit.
1306
bit_iter = iter(rel.split('/'))
1307
for bit in bit_iter:
1310
next_entries = _listdir(current)
1311
except OSError: # enoent, eperm, etc
1312
# We can't find this in the filesystem, so just append the
1314
current = pathjoin(current, bit, *list(bit_iter))
1316
for look in next_entries:
1317
if lbit == look.lower():
1318
current = pathjoin(current, look)
1321
# got to the end, nothing matched, so we just return the
1322
# non-existing bits as they were specified (the filename may be
1323
# the target of a move, for example).
1324
current = pathjoin(current, bit, *list(bit_iter))
1326
return current[len(abs_base):].lstrip('/')
1328
# XXX - TODO - we need better detection/integration of case-insensitive
1329
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1330
# filesystems), for example, so could probably benefit from the same basic
1331
# support there. For now though, only Windows and OSX get that support, and
1332
# they get it for *all* file-systems!
1333
if sys.platform in ('win32', 'darwin'):
1334
canonical_relpath = _cicp_canonical_relpath
1336
canonical_relpath = relpath
1338
def canonical_relpaths(base, paths):
1339
"""Create an iterable to canonicalize a sequence of relative paths.
1341
The intent is for this implementation to use a cache, vastly speeding
1342
up multiple transformations in the same directory.
1344
# but for now, we haven't optimized...
1345
return [canonical_relpath(base, p) for p in paths]
1348
def decode_filename(filename):
1349
"""Decode the filename using the filesystem encoding
1351
If it is unicode, it is returned.
1352
Otherwise it is decoded from the the filesystem's encoding. If decoding
1353
fails, a errors.BadFilenameEncoding exception is raised.
1355
if type(filename) is unicode:
1358
return filename.decode(_fs_enc)
1359
except UnicodeDecodeError:
1360
raise errors.BadFilenameEncoding(filename, _fs_enc)
872
1363
def safe_unicode(unicode_or_utf8_string):
873
1364
"""Coerce unicode_or_utf8_string into unicode.
875
1366
If it is unicode, it is returned.
876
Otherwise it is decoded from utf-8. If a decoding error
877
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
878
as a BzrBadParameter exception.
1367
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1368
wrapped in a BzrBadParameterNotUnicode exception.
880
1370
if isinstance(unicode_or_utf8_string, unicode):
881
1371
return unicode_or_utf8_string
904
1394
return unicode_or_utf8_string.encode('utf-8')
907
def safe_revision_id(unicode_or_utf8_string):
1397
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1398
' Revision id generators should be creating utf8'
1402
def safe_revision_id(unicode_or_utf8_string, warn=True):
908
1403
"""Revision ids should now be utf8, but at one point they were unicode.
1405
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1407
:param warn: Functions that are sanitizing user data can set warn=False
1408
:return: None or a utf8 revision id.
1410
if (unicode_or_utf8_string is None
1411
or unicode_or_utf8_string.__class__ == str):
1412
return unicode_or_utf8_string
1414
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1416
return cache_utf8.encode(unicode_or_utf8_string)
1419
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1420
' generators should be creating utf8 file ids.')
1423
def safe_file_id(unicode_or_utf8_string, warn=True):
1424
"""File ids should now be utf8, but at one point they were unicode.
910
1426
This is the same as safe_utf8, except it uses the cached encode functions
911
1427
to save a little bit of performance.
1429
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1431
:param warn: Functions that are sanitizing user data can set warn=False
1432
:return: None or a utf8 file id.
913
if unicode_or_utf8_string is None:
915
if isinstance(unicode_or_utf8_string, str):
916
# TODO: jam 20070209 Eventually just remove this check.
918
utf8_str = cache_utf8.get_cached_utf8(unicode_or_utf8_string)
919
except UnicodeDecodeError:
920
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1434
if (unicode_or_utf8_string is None
1435
or unicode_or_utf8_string.__class__ == str):
1436
return unicode_or_utf8_string
1438
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
922
1440
return cache_utf8.encode(unicode_or_utf8_string)
925
# TODO: jam 20070217 We start by just re-using safe_revision_id, but ultimately
926
# we want to use a different dictionary cache, because trapping file ids
927
# and revision ids in the same dict seemed to have a noticable effect on
929
safe_file_id = safe_revision_id
932
1443
_platform_normalizes_filenames = False
933
1444
if sys.platform == 'darwin':
934
1445
_platform_normalizes_filenames = True
973
1484
normalized_filename = _inaccessible_normalized_filename
1487
def set_signal_handler(signum, handler, restart_syscall=True):
1488
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1489
on platforms that support that.
1491
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1492
automatically restart (by calling `signal.siginterrupt(signum,
1493
False)`). May be ignored if the feature is not available on this
1494
platform or Python version.
1498
siginterrupt = signal.siginterrupt
1500
# This python implementation doesn't provide signal support, hence no
1503
except AttributeError:
1504
# siginterrupt doesn't exist on this platform, or for this version
1506
siginterrupt = lambda signum, flag: None
1508
def sig_handler(*args):
1509
# Python resets the siginterrupt flag when a signal is
1510
# received. <http://bugs.python.org/issue8354>
1511
# As a workaround for some cases, set it back the way we want it.
1512
siginterrupt(signum, False)
1513
# Now run the handler function passed to set_signal_handler.
1516
sig_handler = handler
1517
old_handler = signal.signal(signum, sig_handler)
1519
siginterrupt(signum, False)
1523
default_terminal_width = 80
1524
"""The default terminal width for ttys.
1526
This is defined so that higher levels can share a common fallback value when
1527
terminal_width() returns None.
1530
# Keep some state so that terminal_width can detect if _terminal_size has
1531
# returned a different size since the process started. See docstring and
1532
# comments of terminal_width for details.
1533
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1534
_terminal_size_state = 'no_data'
1535
_first_terminal_size = None
976
1537
def terminal_width():
977
"""Return estimated terminal width."""
978
if sys.platform == 'win32':
979
return win32utils.get_console_size()[0]
1538
"""Return terminal width.
1540
None is returned if the width can't established precisely.
1543
- if BZR_COLUMNS is set, returns its value
1544
- if there is no controlling terminal, returns None
1545
- query the OS, if the queried size has changed since the last query,
1547
- if COLUMNS is set, returns its value,
1548
- if the OS has a value (even though it's never changed), return its value.
1550
From there, we need to query the OS to get the size of the controlling
1553
On Unices we query the OS by:
1554
- get termios.TIOCGWINSZ
1555
- if an error occurs or a negative value is obtained, returns None
1557
On Windows we query the OS by:
1558
- win32utils.get_console_size() decides,
1559
- returns None on error (provided default value)
1561
# Note to implementors: if changing the rules for determining the width,
1562
# make sure you've considered the behaviour in these cases:
1563
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1564
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1566
# - (add more interesting cases here, if you find any)
1567
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1568
# but we don't want to register a signal handler because it is impossible
1569
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1570
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1571
# time so we can notice if the reported size has changed, which should have
1574
# If BZR_COLUMNS is set, take it, user is always right
1575
# Except if they specified 0 in which case, impose no limit here
1577
width = int(os.environ['BZR_COLUMNS'])
1578
except (KeyError, ValueError):
1580
if width is not None:
1586
isatty = getattr(sys.stdout, 'isatty', None)
1587
if isatty is None or not isatty():
1588
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1592
width, height = os_size = _terminal_size(None, None)
1593
global _first_terminal_size, _terminal_size_state
1594
if _terminal_size_state == 'no_data':
1595
_first_terminal_size = os_size
1596
_terminal_size_state = 'unchanged'
1597
elif (_terminal_size_state == 'unchanged' and
1598
_first_terminal_size != os_size):
1599
_terminal_size_state = 'changed'
1601
# If the OS claims to know how wide the terminal is, and this value has
1602
# ever changed, use that.
1603
if _terminal_size_state == 'changed':
1604
if width is not None and width > 0:
1607
# If COLUMNS is set, use it.
1609
return int(os.environ['COLUMNS'])
1610
except (KeyError, ValueError):
1613
# Finally, use an unchanged size from the OS, if we have one.
1614
if _terminal_size_state == 'unchanged':
1615
if width is not None and width > 0:
1618
# The width could not be determined.
1622
def _win32_terminal_size(width, height):
1623
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1624
return width, height
1627
def _ioctl_terminal_size(width, height):
982
1629
import struct, fcntl, termios
983
1630
s = struct.pack('HHHH', 0, 0, 0, 0)
984
1631
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
985
width = struct.unpack('HHHH', x)[1]
1632
height, width = struct.unpack('HHHH', x)[0:2]
1633
except (IOError, AttributeError):
990
width = int(os.environ['COLUMNS'])
1635
return width, height
1637
_terminal_size = None
1638
"""Returns the terminal size as (width, height).
1640
:param width: Default value for width.
1641
:param height: Default value for height.
1643
This is defined specifically for each OS and query the size of the controlling
1644
terminal. If any error occurs, the provided default values should be returned.
1646
if sys.platform == 'win32':
1647
_terminal_size = _win32_terminal_size
1649
_terminal_size = _ioctl_terminal_size
999
1652
def supports_executable():
1046
1699
raise errors.IllegalPath(path)
1702
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1704
def _is_error_enotdir(e):
1705
"""Check if this exception represents ENOTDIR.
1707
Unfortunately, python is very inconsistent about the exception
1708
here. The cases are:
1709
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1710
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1711
which is the windows error code.
1712
3) Windows, Python2.5 uses errno == EINVAL and
1713
winerror == ERROR_DIRECTORY
1715
:param e: An Exception object (expected to be OSError with an errno
1716
attribute, but we should be able to cope with anything)
1717
:return: True if this represents an ENOTDIR error. False otherwise.
1719
en = getattr(e, 'errno', None)
1720
if (en == errno.ENOTDIR
1721
or (sys.platform == 'win32'
1722
and (en == _WIN32_ERROR_DIRECTORY
1723
or (en == errno.EINVAL
1724
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1049
1730
def walkdirs(top, prefix=""):
1050
1731
"""Yield data about all the directories in a tree.
1052
1733
This yields all the data about the contents of a directory at a time.
1053
1734
After each directory has been yielded, if the caller has mutated the list
1054
1735
to exclude some directories, they are then not descended into.
1056
1737
The data yielded is of the form:
1057
1738
((directory-relpath, directory-path-from-top),
1058
[(directory-relpath, basename, kind, lstat, path-from-top), ...]),
1739
[(relpath, basename, kind, lstat, path-from-top), ...]),
1059
1740
- directory-relpath is the relative path of the directory being returned
1060
1741
with respect to top. prefix is prepended to this.
1061
- directory-path-from-root is the path including top for this directory.
1742
- directory-path-from-root is the path including top for this directory.
1062
1743
It is suitable for use with os functions.
1063
1744
- relpath is the relative path within the subtree being walked.
1064
1745
- basename is the basename of the path
1120
1835
path-from-top might be unicode or utf8, but it is the correct path to
1121
1836
pass to os functions to affect the file in question. (such as os.lstat)
1123
fs_encoding = sys.getfilesystemencoding()
1124
if (sys.platform == 'win32' or
1125
fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1126
return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1128
return _walkdirs_fs_utf8(top, prefix=prefix)
1131
def _walkdirs_fs_utf8(top, prefix=""):
1132
"""See _walkdirs_utf8.
1134
This sub-function is called when we know the filesystem is already in utf8
1135
encoding. So we don't need to transcode filenames.
1138
_directory = _directory_kind
1139
_listdir = os.listdir
1140
_kind_from_mode = _formats.get
1838
global _selected_dir_reader
1839
if _selected_dir_reader is None:
1840
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1841
# Win98 doesn't have unicode apis like FindFirstFileW
1842
# TODO: We possibly could support Win98 by falling back to the
1843
# original FindFirstFile, and using TCHAR instead of WCHAR,
1844
# but that gets a bit tricky, and requires custom compiling
1847
from bzrlib._walkdirs_win32 import Win32ReadDir
1848
_selected_dir_reader = Win32ReadDir()
1851
elif _fs_enc in ('utf-8', 'ascii'):
1853
from bzrlib._readdir_pyx import UTF8DirReader
1854
_selected_dir_reader = UTF8DirReader()
1855
except ImportError, e:
1856
failed_to_load_extension(e)
1859
if _selected_dir_reader is None:
1860
# Fallback to the python version
1861
_selected_dir_reader = UnicodeDirReader()
1142
1863
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1143
1864
# But we don't actually uses 1-3 in pending, so set them to None
1144
pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1865
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1866
read_dir = _selected_dir_reader.read_dir
1867
_directory = _directory_kind
1146
relroot, _, _, _, top = pending.pop()
1148
relprefix = relroot + '/'
1151
top_slash = top + '/'
1154
append = dirblock.append
1155
for name in sorted(_listdir(top)):
1156
abspath = top_slash + name
1157
statvalue = _lstat(abspath)
1158
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1159
append((relprefix + name, name, kind, statvalue, abspath))
1869
relroot, _, _, _, top = pending[-1].pop()
1872
dirblock = sorted(read_dir(relroot, top))
1160
1873
yield (relroot, top), dirblock
1162
1874
# push the user specified dirs from dirblock
1163
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1166
def _walkdirs_unicode_to_utf8(top, prefix=""):
1167
"""See _walkdirs_utf8
1169
Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1171
This is currently the fallback code path when the filesystem encoding is
1172
not UTF-8. It may be better to implement an alternative so that we can
1173
safely handle paths that are not properly decodable in the current
1176
_utf8_encode = codecs.getencoder('utf8')
1178
_directory = _directory_kind
1179
_listdir = os.listdir
1180
_kind_from_mode = _formats.get
1182
pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1184
relroot, _, _, _, top = pending.pop()
1186
relprefix = relroot + '/'
1875
next = [d for d in reversed(dirblock) if d[2] == _directory]
1877
pending.append(next)
1880
class UnicodeDirReader(DirReader):
1881
"""A dir reader for non-utf8 file systems, which transcodes."""
1883
__slots__ = ['_utf8_encode']
1886
self._utf8_encode = codecs.getencoder('utf8')
1888
def top_prefix_to_starting_dir(self, top, prefix=""):
1889
"""See DirReader.top_prefix_to_starting_dir."""
1890
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1892
def read_dir(self, prefix, top):
1893
"""Read a single directory from a non-utf8 file system.
1895
top, and the abspath element in the output are unicode, all other paths
1896
are utf8. Local disk IO is done via unicode calls to listdir etc.
1898
This is currently the fallback code path when the filesystem encoding is
1899
not UTF-8. It may be better to implement an alternative so that we can
1900
safely handle paths that are not properly decodable in the current
1903
See DirReader.read_dir for details.
1905
_utf8_encode = self._utf8_encode
1907
_listdir = os.listdir
1908
_kind_from_mode = file_kind_from_stat_mode
1911
relprefix = prefix + '/'
1189
1914
top_slash = top + u'/'
1262
2013
_cached_user_encoding = None
1265
def get_user_encoding(use_cache=True):
2016
def get_user_encoding(use_cache=DEPRECATED_PARAMETER):
1266
2017
"""Find out what the preferred user encoding is.
1268
2019
This is generally the encoding that is used for command line parameters
1269
2020
and file contents. This may be different from the terminal encoding
1270
2021
or the filesystem encoding.
1272
:param use_cache: Enable cache for detected encoding.
1273
(This parameter is turned on by default,
1274
and required only for selftesting)
1276
2023
:return: A string defining the preferred user encoding
1278
2025
global _cached_user_encoding
1279
if _cached_user_encoding is not None and use_cache:
2026
if deprecated_passed(use_cache):
2027
warn_deprecated("use_cache should only have been used for tests",
2028
DeprecationWarning, stacklevel=2)
2029
if _cached_user_encoding is not None:
1280
2030
return _cached_user_encoding
1282
if sys.platform == 'darwin':
1283
# work around egregious python 2.4 bug
1284
sys.platform = 'posix'
1288
sys.platform = 'darwin'
2032
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2033
# Use the existing locale settings and call nl_langinfo directly
2034
# rather than going through getpreferredencoding. This avoids
2035
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2036
# possibility of the setlocale call throwing an error.
2037
user_encoding = locale.nl_langinfo(locale.CODESET)
2039
# GZ 2011-12-19: On windows could call GetACP directly instead.
2040
user_encoding = locale.getpreferredencoding(False)
1293
user_encoding = locale.getpreferredencoding()
1294
except locale.Error, e:
1295
sys.stderr.write('bzr: warning: %s\n'
1296
' Could not determine what text encoding to use.\n'
1297
' This error usually means your Python interpreter\n'
1298
' doesn\'t support the locale set by $LANG (%s)\n'
1299
" Continuing with ascii encoding.\n"
1300
% (e, os.environ.get('LANG')))
1301
user_encoding = 'ascii'
1303
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1304
# treat that as ASCII, and not support printing unicode characters to the
1306
if user_encoding in (None, 'cp0'):
1307
user_encoding = 'ascii'
1311
codecs.lookup(user_encoding)
2043
user_encoding = codecs.lookup(user_encoding).name
2045
if user_encoding not in ("", "cp0"):
1313
2046
sys.stderr.write('bzr: warning:'
1314
2047
' unknown encoding %s.'
1315
2048
' Continuing with ascii encoding.\n'
1316
2049
% user_encoding
1318
user_encoding = 'ascii'
1321
_cached_user_encoding = user_encoding
2051
user_encoding = 'ascii'
2053
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2054
if user_encoding == 'ascii':
2055
if sys.platform == 'darwin':
2056
# OSX is special-cased in Python to have a UTF-8 filesystem
2057
# encoding and previously had LANG set here if not present.
2058
user_encoding = 'utf-8'
2059
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2060
# for some other posix platforms as well.
2062
_cached_user_encoding = user_encoding
1323
2063
return user_encoding
1326
def recv_all(socket, bytes):
2066
def get_diff_header_encoding():
2067
return get_terminal_encoding()
2070
def get_host_name():
2071
"""Return the current unicode host name.
2073
This is meant to be used in place of socket.gethostname() because that
2074
behaves inconsistently on different platforms.
2076
if sys.platform == "win32":
2077
return win32utils.get_host_name()
2080
return socket.gethostname().decode(get_user_encoding())
2083
# We must not read/write any more than 64k at a time from/to a socket so we
2084
# don't risk "no buffer space available" errors on some platforms. Windows in
2085
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2087
MAX_SOCKET_CHUNK = 64 * 1024
2089
_end_of_stream_errors = [errno.ECONNRESET]
2090
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2091
_eno = getattr(errno, _eno, None)
2092
if _eno is not None:
2093
_end_of_stream_errors.append(_eno)
2097
def read_bytes_from_socket(sock, report_activity=None,
2098
max_read_size=MAX_SOCKET_CHUNK):
2099
"""Read up to max_read_size of bytes from sock and notify of progress.
2101
Translates "Connection reset by peer" into file-like EOF (return an
2102
empty string rather than raise an error), and repeats the recv if
2103
interrupted by a signal.
2107
bytes = sock.recv(max_read_size)
2108
except socket.error, e:
2110
if eno in _end_of_stream_errors:
2111
# The connection was closed by the other side. Callers expect
2112
# an empty string to signal end-of-stream.
2114
elif eno == errno.EINTR:
2115
# Retry the interrupted recv.
2119
if report_activity is not None:
2120
report_activity(len(bytes), 'read')
2124
def recv_all(socket, count):
1327
2125
"""Receive an exact number of bytes.
1329
2127
Regular Socket.recv() may return less than the requested number of bytes,
1330
dependning on what's in the OS buffer. MSG_WAITALL is not available
2128
depending on what's in the OS buffer. MSG_WAITALL is not available
1331
2129
on all platforms, but this should work everywhere. This will return
1332
2130
less than the requested amount if the remote end closes.
1334
2132
This isn't optimized and is intended mostly for use in testing.
1337
while len(b) < bytes:
1338
new = socket.recv(bytes - len(b))
2135
while len(b) < count:
2136
new = read_bytes_from_socket(socket, None, count - len(b))
2143
def send_all(sock, bytes, report_activity=None):
2144
"""Send all bytes on a socket.
2146
Breaks large blocks in smaller chunks to avoid buffering limitations on
2147
some platforms, and catches EINTR which may be thrown if the send is
2148
interrupted by a signal.
2150
This is preferred to socket.sendall(), because it avoids portability bugs
2151
and provides activity reporting.
2153
:param report_activity: Call this as bytes are read, see
2154
Transport._report_activity
2157
byte_count = len(bytes)
2158
while sent_total < byte_count:
2160
sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2161
except socket.error, e:
2162
if e.args[0] != errno.EINTR:
2166
report_activity(sent, 'write')
2169
def connect_socket(address):
2170
# Slight variation of the socket.create_connection() function (provided by
2171
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2172
# provide it for previous python versions. Also, we don't use the timeout
2173
# parameter (provided by the python implementation) so we don't implement
2175
err = socket.error('getaddrinfo returns an empty list')
2176
host, port = address
2177
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2178
af, socktype, proto, canonname, sa = res
2181
sock = socket.socket(af, socktype, proto)
2185
except socket.error, err:
2186
# 'err' is now the most recent error
2187
if sock is not None:
1344
2192
def dereference_path(path):
1345
2193
"""Determine the real path to a file.
1353
2201
# The pathjoin for '.' is a workaround for Python bug #1213894.
1354
2202
# (initial path components aren't dereferenced)
1355
2203
return pathjoin(realpath(pathjoin('.', parent)), base)
2206
def supports_mapi():
2207
"""Return True if we can use MAPI to launch a mail client."""
2208
return sys.platform == "win32"
2211
def resource_string(package, resource_name):
2212
"""Load a resource from a package and return it as a string.
2214
Note: Only packages that start with bzrlib are currently supported.
2216
This is designed to be a lightweight implementation of resource
2217
loading in a way which is API compatible with the same API from
2219
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2220
If and when pkg_resources becomes a standard library, this routine
2223
# Check package name is within bzrlib
2224
if package == "bzrlib":
2225
resource_relpath = resource_name
2226
elif package.startswith("bzrlib."):
2227
package = package[len("bzrlib."):].replace('.', os.sep)
2228
resource_relpath = pathjoin(package, resource_name)
2230
raise errors.BzrError('resource package %s not in bzrlib' % package)
2232
# Map the resource to a file and read its contents
2233
base = dirname(bzrlib.__file__)
2234
if getattr(sys, 'frozen', None): # bzr.exe
2235
base = abspath(pathjoin(base, '..', '..'))
2236
f = file(pathjoin(base, resource_relpath), "rU")
2242
def file_kind_from_stat_mode_thunk(mode):
2243
global file_kind_from_stat_mode
2244
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2246
from bzrlib._readdir_pyx import UTF8DirReader
2247
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2248
except ImportError, e:
2249
# This is one time where we won't warn that an extension failed to
2250
# load. The extension is never available on Windows anyway.
2251
from bzrlib._readdir_py import (
2252
_kind_from_mode as file_kind_from_stat_mode
2254
return file_kind_from_stat_mode(mode)
2255
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2257
def file_stat(f, _lstat=os.lstat):
2262
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2263
raise errors.NoSuchFile(f)
2266
def file_kind(f, _lstat=os.lstat):
2267
stat_value = file_stat(f, _lstat)
2268
return file_kind_from_stat_mode(stat_value.st_mode)
2270
def until_no_eintr(f, *a, **kw):
2271
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2273
WARNING: you must be certain that it is safe to retry the call repeatedly
2274
if EINTR does occur. This is typically only true for low-level operations
2275
like os.read. If in any doubt, don't use this.
2277
Keep in mind that this is not a complete solution to EINTR. There is
2278
probably code in the Python standard library and other dependencies that
2279
may encounter EINTR if a signal arrives (and there is signal handler for
2280
that signal). So this function can reduce the impact for IO that bzrlib
2281
directly controls, but it is not a complete solution.
2283
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2287
except (IOError, OSError), e:
2288
if e.errno == errno.EINTR:
2293
@deprecated_function(deprecated_in((2, 2, 0)))
2294
def re_compile_checked(re_string, flags=0, where=""):
2295
"""Return a compiled re, or raise a sensible error.
2297
This should only be used when compiling user-supplied REs.
2299
:param re_string: Text form of regular expression.
2300
:param flags: eg re.IGNORECASE
2301
:param where: Message explaining to the user the context where
2302
it occurred, eg 'log search filter'.
2304
# from https://bugs.launchpad.net/bzr/+bug/251352
2306
re_obj = re.compile(re_string, flags)
2309
except errors.InvalidPattern, e:
2311
where = ' in ' + where
2312
# despite the name 'error' is a type
2313
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2317
if sys.platform == "win32":
2320
return msvcrt.getch()
2325
fd = sys.stdin.fileno()
2326
settings = termios.tcgetattr(fd)
2329
ch = sys.stdin.read(1)
2331
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2334
if sys.platform.startswith('linux'):
2335
def _local_concurrency():
2337
return os.sysconf('SC_NPROCESSORS_ONLN')
2338
except (ValueError, OSError, AttributeError):
2340
elif sys.platform == 'darwin':
2341
def _local_concurrency():
2342
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2343
stdout=subprocess.PIPE).communicate()[0]
2344
elif "bsd" in sys.platform:
2345
def _local_concurrency():
2346
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2347
stdout=subprocess.PIPE).communicate()[0]
2348
elif sys.platform == 'sunos5':
2349
def _local_concurrency():
2350
return subprocess.Popen(['psrinfo', '-p',],
2351
stdout=subprocess.PIPE).communicate()[0]
2352
elif sys.platform == "win32":
2353
def _local_concurrency():
2354
# This appears to return the number of cores.
2355
return os.environ.get('NUMBER_OF_PROCESSORS')
2357
def _local_concurrency():
2362
_cached_local_concurrency = None
2364
def local_concurrency(use_cache=True):
2365
"""Return how many processes can be run concurrently.
2367
Rely on platform specific implementations and default to 1 (one) if
2368
anything goes wrong.
2370
global _cached_local_concurrency
2372
if _cached_local_concurrency is not None and use_cache:
2373
return _cached_local_concurrency
2375
concurrency = os.environ.get('BZR_CONCURRENCY', None)
2376
if concurrency is None:
2378
import multiprocessing
2379
concurrency = multiprocessing.cpu_count()
2380
except (ImportError, NotImplementedError):
2381
# multiprocessing is only available on Python >= 2.6
2382
# and multiprocessing.cpu_count() isn't implemented on all
2385
concurrency = _local_concurrency()
2386
except (OSError, IOError):
2389
concurrency = int(concurrency)
2390
except (TypeError, ValueError):
2393
_cached_concurrency = concurrency
2397
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2398
"""A stream writer that doesn't decode str arguments."""
2400
def __init__(self, encode, stream, errors='strict'):
2401
codecs.StreamWriter.__init__(self, stream, errors)
2402
self.encode = encode
2404
def write(self, object):
2405
if type(object) is str:
2406
self.stream.write(object)
2408
data, _ = self.encode(object, self.errors)
2409
self.stream.write(data)
2411
if sys.platform == 'win32':
2412
def open_file(filename, mode='r', bufsize=-1):
2413
"""This function is used to override the ``open`` builtin.
2415
But it uses O_NOINHERIT flag so the file handle is not inherited by
2416
child processes. Deleting or renaming a closed file opened with this
2417
function is not blocking child processes.
2419
writing = 'w' in mode
2420
appending = 'a' in mode
2421
updating = '+' in mode
2422
binary = 'b' in mode
2425
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2426
# for flags for each modes.
2436
flags |= os.O_WRONLY
2437
flags |= os.O_CREAT | os.O_TRUNC
2442
flags |= os.O_WRONLY
2443
flags |= os.O_CREAT | os.O_APPEND
2448
flags |= os.O_RDONLY
2450
return os.fdopen(os.open(filename, flags), mode, bufsize)
2455
def available_backup_name(base, exists):
2456
"""Find a non-existing backup file name.
2458
This will *not* create anything, this only return a 'free' entry. This
2459
should be used for checking names in a directory below a locked
2460
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2461
Leap) and generally discouraged.
2463
:param base: The base name.
2465
:param exists: A callable returning True if the path parameter exists.
2468
name = "%s.~%d~" % (base, counter)
2471
name = "%s.~%d~" % (base, counter)
2475
def set_fd_cloexec(fd):
2476
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2477
support for this is not available.
2481
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2482
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2483
except (ImportError, AttributeError):
2484
# Either the fcntl module or specific constants are not present
2488
def find_executable_on_path(name):
2489
"""Finds an executable on the PATH.
2491
On Windows, this will try to append each extension in the PATHEXT
2492
environment variable to the name, if it cannot be found with the name
2495
:param name: The base name of the executable.
2496
:return: The path to the executable found or None.
2498
if sys.platform == 'win32':
2499
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2500
exts = [ext.lower() for ext in exts]
2501
base, ext = os.path.splitext(name)
2503
if ext.lower() not in exts:
2509
path = os.environ.get('PATH')
2510
if path is not None:
2511
path = path.split(os.pathsep)
2514
f = os.path.join(d, name) + ext
2515
if os.access(f, os.X_OK):
2517
if sys.platform == 'win32':
2518
app_path = win32utils.get_app_path(name)
2519
if app_path != name:
2524
def _posix_is_local_pid_dead(pid):
2525
"""True if pid doesn't correspond to live process on this machine"""
2527
# Special meaning of unix kill: just check if it's there.
2530
if e.errno == errno.ESRCH:
2531
# On this machine, and really not found: as sure as we can be
2534
elif e.errno == errno.EPERM:
2535
# exists, though not ours
2538
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2539
# Don't really know.
2542
# Exists and our process: not dead.
2545
if sys.platform == "win32":
2546
is_local_pid_dead = win32utils.is_local_pid_dead
2548
is_local_pid_dead = _posix_is_local_pid_dead
2551
def fdatasync(fileno):
2552
"""Flush file contents to disk if possible.
2554
:param fileno: Integer OS file handle.
2555
:raises TransportNotPossible: If flushing to disk is not possible.
2557
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2562
def ensure_empty_directory_exists(path, exception_class):
2563
"""Make sure a local directory exists and is empty.
2565
If it does not exist, it is created. If it exists and is not empty, an
2566
instance of exception_class is raised.
2571
if e.errno != errno.EEXIST:
2573
if os.listdir(path) != []:
2574
raise exception_class(path)
2577
def is_environment_error(evalue):
2578
"""True if exception instance is due to a process environment issue
2580
This includes OSError and IOError, but also other errors that come from
2581
the operating system or core libraries but are not subclasses of those.
2583
if isinstance(evalue, (EnvironmentError, select.error)):
2585
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
bzrlib/osutils.py
