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
17
from __future__ import absolute_import
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(), """
27
from .lazy_import import lazy_import
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 mkdtemp
44
from tempfile import (
52
from breezy.i18n import gettext
73
# Cross platform wall-clock time functionality with decent resolution.
74
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
75
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
76
# synchronized with ``time.time()``, this is only meant to be used to find
77
# delta times by subtracting from another call to this function.
78
timer_func = time.time
79
if sys.platform == 'win32':
80
timer_func = time.clock
57
from bzrlib import symbol_versioning
58
from bzrlib.symbol_versioning import (
62
from bzrlib.trace import mutter
82
65
# On win32, O_BINARY is used to indicate the file should
83
66
# be opened in binary mode, rather than text mode.
84
67
# On other platforms, O_BINARY doesn't exist, because
85
68
# they always open in binary mode, so it is okay to
86
# OR with 0 on those platforms.
87
# O_NOINHERIT and O_TEXT exists only on win32 too.
69
# OR with 0 on those platforms
88
70
O_BINARY = getattr(os, 'O_BINARY', 0)
89
O_TEXT = getattr(os, 'O_TEXT', 0)
90
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
93
class UnsupportedTimezoneFormat(errors.BzrError):
95
_fmt = ('Unsupported timezone format "%(timezone)s", '
96
'options are "utc", "original", "local".')
98
def __init__(self, timezone):
99
self.timezone = timezone
102
def get_unicode_argv():
106
user_encoding = get_user_encoding()
107
return [a.decode(user_encoding) for a in sys.argv[1:]]
108
except UnicodeDecodeError:
109
raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
110
"application locale.").format(a, user_encoding))
113
73
def make_readonly(filename):
114
74
"""Make a filename read-only."""
115
mod = os.lstat(filename).st_mode
116
if not stat.S_ISLNK(mod):
118
chmod_if_possible(filename, mod)
75
mod = os.stat(filename).st_mode
77
os.chmod(filename, mod)
121
80
def make_writable(filename):
122
mod = os.lstat(filename).st_mode
123
if not stat.S_ISLNK(mod):
125
chmod_if_possible(filename, mod)
128
def chmod_if_possible(filename, mode):
129
# Set file mode if that can be safely done.
130
# Sometimes even on unix the filesystem won't allow it - see
131
# https://bugs.launchpad.net/bzr/+bug/606537
133
# It is probably faster to just do the chmod, rather than
134
# doing a stat, and then trying to compare
135
os.chmod(filename, mode)
136
except (IOError, OSError) as e:
137
# Permission/access denied seems to commonly happen on smbfs; there's
138
# probably no point warning about it.
139
# <https://bugs.launchpad.net/bzr/+bug/606537>
140
if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
141
trace.mutter("ignore error on chmod of %r: %r" % (
147
def minimum_path_selection(paths):
148
"""Return the smallset subset of paths which are outside paths.
150
:param paths: A container (and hence not None) of paths.
151
:return: A set of paths sufficient to include everything in paths via
152
is_inside, drawn from the paths parameter.
158
return path.split('/')
159
sorted_paths = sorted(list(paths), key=sort_key)
161
search_paths = [sorted_paths[0]]
162
for path in sorted_paths[1:]:
163
if not is_inside(search_paths[-1], path):
164
# This path is unique, add it
165
search_paths.append(path)
167
return set(search_paths)
81
mod = os.stat(filename).st_mode
83
os.chmod(filename, mod)
302
233
# choke on a Unicode string containing a relative path if
303
234
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
236
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
305
237
def _posix_abspath(path):
306
238
# jam 20060426 rather than encoding to fsencoding
307
239
# copy posixpath.abspath, but use os.getcwdu instead
308
240
if not posixpath.isabs(path):
309
241
path = posixpath.join(getcwd(), path)
310
return _posix_normpath(path)
242
return posixpath.normpath(path)
313
245
def _posix_realpath(path):
314
246
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
317
def _posix_normpath(path):
318
path = posixpath.normpath(path)
319
# Bug 861008: posixpath.normpath() returns a path normalized according to
320
# the POSIX standard, which stipulates (for compatibility reasons) that two
321
# leading slashes must not be simplified to one, and only if there are 3 or
322
# more should they be simplified as one. So we treat the leading 2 slashes
323
# as a special case here by simply removing the first slash, as we consider
324
# that breaking POSIX compatibility for this obscure feature is acceptable.
325
# This is not a paranoid precaution, as we notably get paths like this when
326
# the repo is hosted at the root of the filesystem, i.e. in "/".
327
if path.startswith('//'):
332
def _posix_path_from_environ(key):
333
"""Get unicode path from `key` in environment or None if not present
335
Note that posix systems use arbitrary byte strings for filesystem objects,
336
so a path that raises BadFilenameEncoding here may still be accessible.
338
val = os.environ.get(key, None)
339
if PY3 or val is None:
342
return val.decode(_fs_enc)
343
except UnicodeDecodeError:
344
# GZ 2011-12-12:Ideally want to include `key` in the exception message
345
raise errors.BadFilenameEncoding(val, _fs_enc)
348
def _posix_get_home_dir():
349
"""Get the home directory of the current user as a unicode path"""
350
path = posixpath.expanduser("~")
352
return path.decode(_fs_enc)
353
except AttributeError:
355
except UnicodeDecodeError:
356
raise errors.BadFilenameEncoding(path, _fs_enc)
359
def _posix_getuser_unicode():
360
"""Get username from environment or password database as unicode"""
361
name = getpass.getuser()
364
user_encoding = get_user_encoding()
366
return name.decode(user_encoding)
367
except UnicodeDecodeError:
368
raise errors.BzrError("Encoding of username %r is unsupported by %s "
369
"application locale." % (name, user_encoding))
372
249
def _win32_fixdrive(path):
373
250
"""Force drive letters to be consistent.
378
255
running python.exe under cmd.exe return capital C:\\
379
256
running win32 python inside a cygwin shell returns lowercase c:\\
381
drive, path = ntpath.splitdrive(path)
258
drive, path = _nt_splitdrive(path)
382
259
return drive.upper() + path
385
262
def _win32_abspath(path):
386
# Real ntpath.abspath doesn't have a problem with a unicode cwd
387
return _win32_fixdrive(ntpath.abspath(path).replace('\\', '/'))
263
# Real _nt_abspath doesn't have a problem with a unicode cwd
264
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
267
def _win98_abspath(path):
268
"""Return the absolute version of a path.
269
Windows 98 safe implementation (python reimplementation
270
of Win32 API function GetFullPathNameW)
275
# \\HOST\path => //HOST/path
276
# //HOST/path => //HOST/path
277
# path => C:/cwd/path
280
# check for absolute path
281
drive = _nt_splitdrive(path)[0]
282
if drive == '' and path[:2] not in('//','\\\\'):
284
# we cannot simply os.path.join cwd and path
285
# because os.path.join('C:','/path') produce '/path'
286
# and this is incorrect
287
if path[:1] in ('/','\\'):
288
cwd = _nt_splitdrive(cwd)[0]
290
path = cwd + '\\' + path
291
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
293
if win32utils.winver == 'Windows 98':
294
_win32_abspath = _win98_abspath
390
297
def _win32_realpath(path):
391
# Real ntpath.realpath doesn't have a problem with a unicode cwd
392
return _win32_fixdrive(ntpath.realpath(path).replace('\\', '/'))
298
# Real _nt_realpath doesn't have a problem with a unicode cwd
299
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
395
302
def _win32_pathjoin(*args):
396
return ntpath.join(*args).replace('\\', '/')
303
return _nt_join(*args).replace('\\', '/')
399
306
def _win32_normpath(path):
400
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
307
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
403
310
def _win32_getcwd():
404
return _win32_fixdrive(_getcwd().replace('\\', '/'))
311
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
407
314
def _win32_mkdtemp(*args, **kwargs):
522
383
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
523
384
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
524
385
return shutil.rmtree(path, ignore_errors, onerror)
526
f = win32utils.get_unicode_argv # special function or None
529
path_from_environ = win32utils.get_environ_unicode
530
_get_home_dir = win32utils.get_home_location
531
getuser_unicode = win32utils.get_user_name
533
386
elif sys.platform == 'darwin':
534
387
getcwd = _mac_getcwd
537
def get_terminal_encoding(trace=False):
390
def get_terminal_encoding():
538
391
"""Find the best encoding for printing to the screen.
540
393
This attempts to check both sys.stdout and sys.stdin to see
541
394
what encoding they are in, and if that fails it falls back to
542
osutils.get_user_encoding().
395
bzrlib.user_encoding.
543
396
The problem is that on Windows, locale.getpreferredencoding()
544
397
is not the same encoding as that used by the console:
545
398
http://mail.python.org/pipermail/python-list/2003-May/162357.html
547
400
On my standard US Windows XP, the preferred encoding is
548
401
cp1252, but the console is cp437
550
:param trace: If True trace the selected encoding via mutter().
552
from .trace import mutter
553
403
output_encoding = getattr(sys.stdout, 'encoding', None)
554
404
if not output_encoding:
555
405
input_encoding = getattr(sys.stdin, 'encoding', None)
556
406
if not input_encoding:
557
output_encoding = get_user_encoding()
559
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)
562
410
output_encoding = input_encoding
564
mutter('encoding stdout as sys.stdin encoding %r',
411
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
568
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
413
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
569
414
if output_encoding == 'cp0':
570
415
# invalid encoding (cp0 means 'no codepage' on Windows)
571
output_encoding = get_user_encoding()
573
mutter('cp0 is invalid encoding.'
574
' 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)
578
421
codecs.lookup(output_encoding)
579
422
except LookupError:
580
sys.stderr.write('brz: warning:'
423
sys.stderr.write('bzr: warning:'
581
424
' unknown terminal encoding %s.\n'
582
425
' Using encoding %s instead.\n'
583
% (output_encoding, get_user_encoding())
426
% (output_encoding, bzrlib.user_encoding)
585
output_encoding = get_user_encoding()
428
output_encoding = bzrlib.user_encoding
587
430
return output_encoding
830
605
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
831
606
return offset.days * 86400 + offset.seconds
833
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
834
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
837
def format_date(t, offset=0, timezone='original', date_fmt=None,
609
def format_date(t, offset=0, timezone='original', date_fmt=None,
838
610
show_offset=True):
839
"""Return a formatted date string.
841
:param t: Seconds since the epoch.
842
:param offset: Timezone offset in seconds east of utc.
843
:param timezone: How to display the time: 'utc', 'original' for the
844
timezone specified by offset, or 'local' for the process's current
846
:param date_fmt: strftime format.
847
:param show_offset: Whether to append the timezone.
849
(date_fmt, tt, offset_str) = \
850
_format_date(t, offset, timezone, date_fmt, show_offset)
851
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
852
date_str = time.strftime(date_fmt, tt)
853
return date_str + offset_str
856
# Cache of formatted offset strings
860
def format_date_with_offset_in_original_timezone(t, offset=0,
861
_cache=_offset_cache):
862
"""Return a formatted date string in the original timezone.
864
This routine may be faster then format_date.
866
:param t: Seconds since the epoch.
867
:param offset: Timezone offset in seconds east of utc.
871
tt = time.gmtime(t + offset)
872
date_fmt = _default_format_by_weekday_num[tt[6]]
873
date_str = time.strftime(date_fmt, tt)
874
offset_str = _cache.get(offset, None)
875
if offset_str is None:
876
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
877
_cache[offset] = offset_str
878
return date_str + offset_str
881
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
883
"""Return an unicode date string formatted according to the current locale.
885
:param t: Seconds since the epoch.
886
:param offset: Timezone offset in seconds east of utc.
887
:param timezone: How to display the time: 'utc', 'original' for the
888
timezone specified by offset, or 'local' for the process's current
890
:param date_fmt: strftime format.
891
:param show_offset: Whether to append the timezone.
893
(date_fmt, tt, offset_str) = \
894
_format_date(t, offset, timezone, date_fmt, show_offset)
895
date_str = time.strftime(date_fmt, tt)
896
if not isinstance(date_str, text_type):
897
date_str = date_str.decode(get_user_encoding(), 'replace')
898
return date_str + offset_str
901
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)
902
615
if timezone == 'utc':
903
616
tt = time.gmtime(t)
1029
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
745
raise errors.BzrError("sorry, %r not allowed in path" % f)
1030
746
elif (f == '.') or (f == ''):
1037
752
def joinpath(p):
753
assert isinstance(p, (list, tuple))
1039
755
if (f == '..') or (f is None) or (f == ''):
1040
raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
756
raise errors.BzrError("sorry, %r not allowed in path" % f)
1041
757
return pathjoin(*p)
1044
def parent_directories(filename):
1045
"""Return the list of parent directories, deepest first.
1047
For example, parent_directories("a/b/c") -> ["a/b", "a"].
1050
parts = splitpath(dirname(filename))
1052
parents.append(joinpath(parts))
1057
_extension_load_failures = []
1060
def failed_to_load_extension(exception):
1061
"""Handle failing to load a binary extension.
1063
This should be called from the ImportError block guarding the attempt to
1064
import the native extension. If this function returns, the pure-Python
1065
implementation should be loaded instead::
1068
>>> import breezy._fictional_extension_pyx
1069
>>> except ImportError, e:
1070
>>> breezy.osutils.failed_to_load_extension(e)
1071
>>> import breezy._fictional_extension_py
1073
# NB: This docstring is just an example, not a doctest, because doctest
1074
# currently can't cope with the use of lazy imports in this namespace --
1077
# This currently doesn't report the failure at the time it occurs, because
1078
# they tend to happen very early in startup when we can't check config
1079
# files etc, and also we want to report all failures but not spam the user
1081
exception_str = str(exception)
1082
if exception_str not in _extension_load_failures:
1083
trace.mutter("failed to load compiled extension: %s" % exception_str)
1084
_extension_load_failures.append(exception_str)
1087
def report_extension_load_failures():
1088
if not _extension_load_failures:
1090
if config.GlobalConfig().suppress_warning('missing_extensions'):
1092
# the warnings framework should by default show this only once
1093
from .trace import warning
1095
"brz: warning: some compiled extensions could not be loaded; "
1096
"see ``brz help missing-extensions``")
1097
# we no longer show the specific missing extensions here, because it makes
1098
# the message too long and scary - see
1099
# https://bugs.launchpad.net/bzr/+bug/430529
1103
from ._chunks_to_lines_pyx import chunks_to_lines
1104
except ImportError as e:
1105
failed_to_load_extension(e)
1106
from ._chunks_to_lines_py import chunks_to_lines
760
@deprecated_function(zero_nine)
761
def appendpath(p1, p2):
765
return pathjoin(p1, p2)
1109
768
def split_lines(s):
1110
769
"""Split s into lines, but without removing the newline characters."""
1111
# Trivially convert a fulltext into a 'chunked' representation, and let
1112
# chunks_to_lines do the heavy lifting.
1113
if isinstance(s, str):
1114
# chunks_to_lines only supports 8-bit strings
1115
return chunks_to_lines([s])
1117
return _split_lines(s)
1120
def _split_lines(s):
1121
"""Split s into lines, but without removing the newline characters.
1123
This supports Unicode or plain string objects.
1125
nl = b'\n' if isinstance(s, bytes) else u'\n'
1127
result = [line + nl for line in lines[:-1]]
770
lines = s.split('\n')
771
result = [line + '\n' for line in lines[:-1]]
1129
773
result.append(lines[-1])
1249
846
os.path.commonprefix (python2.4) has a bad bug that it works just
1250
847
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1251
848
avoids that problem.
1253
NOTE: `base` should not have a trailing slash otherwise you'll get
1254
PathNotChild exceptions regardless of `path`.
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')
851
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
852
' exceed the platform minimum length (which is %d)' %
1262
855
rp = abspath(path)
1267
if len(head) <= len(base) and head != base:
1268
raise errors.PathNotChild(rp, base)
859
while len(head) >= len(base):
1269
860
if head == base:
1271
head, tail = split(head)
862
head, tail = os.path.split(head)
866
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 isinstance(filename, text_type):
1358
return filename.decode(_fs_enc)
1359
except UnicodeDecodeError:
1360
raise errors.BadFilenameEncoding(filename, _fs_enc)
1363
874
def safe_unicode(unicode_or_utf8_string):
1364
875
"""Coerce unicode_or_utf8_string into unicode.
1366
877
If it is unicode, it is returned.
1367
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1368
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.
1370
if isinstance(unicode_or_utf8_string, text_type):
882
if isinstance(unicode_or_utf8_string, unicode):
1371
883
return unicode_or_utf8_string
1373
885
return unicode_or_utf8_string.decode('utf8')
1474
996
normalized_filename = _inaccessible_normalized_filename
1477
def set_signal_handler(signum, handler, restart_syscall=True):
1478
"""A wrapper for signal.signal that also calls siginterrupt(signum, False)
1479
on platforms that support that.
1481
:param restart_syscall: if set, allow syscalls interrupted by a signal to
1482
automatically restart (by calling `signal.siginterrupt(signum,
1483
False)`). May be ignored if the feature is not available on this
1484
platform or Python version.
1488
siginterrupt = signal.siginterrupt
1490
# This python implementation doesn't provide signal support, hence no
1493
except AttributeError:
1494
# siginterrupt doesn't exist on this platform, or for this version
1496
siginterrupt = lambda signum, flag: None
1498
def sig_handler(*args):
1499
# Python resets the siginterrupt flag when a signal is
1500
# received. <http://bugs.python.org/issue8354>
1501
# As a workaround for some cases, set it back the way we want it.
1502
siginterrupt(signum, False)
1503
# Now run the handler function passed to set_signal_handler.
1506
sig_handler = handler
1507
old_handler = signal.signal(signum, sig_handler)
1509
siginterrupt(signum, False)
1513
default_terminal_width = 80
1514
"""The default terminal width for ttys.
1516
This is defined so that higher levels can share a common fallback value when
1517
terminal_width() returns None.
1520
# Keep some state so that terminal_width can detect if _terminal_size has
1521
# returned a different size since the process started. See docstring and
1522
# comments of terminal_width for details.
1523
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1524
_terminal_size_state = 'no_data'
1525
_first_terminal_size = None
1527
999
def terminal_width():
1528
"""Return terminal width.
1530
None is returned if the width can't established precisely.
1533
- if BRZ_COLUMNS is set, returns its value
1534
- if there is no controlling terminal, returns None
1535
- query the OS, if the queried size has changed since the last query,
1537
- if COLUMNS is set, returns its value,
1538
- if the OS has a value (even though it's never changed), return its value.
1540
From there, we need to query the OS to get the size of the controlling
1543
On Unices we query the OS by:
1544
- get termios.TIOCGWINSZ
1545
- if an error occurs or a negative value is obtained, returns None
1547
On Windows we query the OS by:
1548
- win32utils.get_console_size() decides,
1549
- returns None on error (provided default value)
1551
# Note to implementors: if changing the rules for determining the width,
1552
# make sure you've considered the behaviour in these cases:
1553
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1554
# - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1556
# - (add more interesting cases here, if you find any)
1557
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1558
# but we don't want to register a signal handler because it is impossible
1559
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1560
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1561
# time so we can notice if the reported size has changed, which should have
1564
# If BRZ_COLUMNS is set, take it, user is always right
1565
# Except if they specified 0 in which case, impose no limit here
1567
width = int(os.environ['BRZ_COLUMNS'])
1568
except (KeyError, ValueError):
1570
if width is not None:
1576
isatty = getattr(sys.stdout, 'isatty', None)
1577
if isatty is None or not isatty():
1578
# Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1582
width, height = os_size = _terminal_size(None, None)
1583
global _first_terminal_size, _terminal_size_state
1584
if _terminal_size_state == 'no_data':
1585
_first_terminal_size = os_size
1586
_terminal_size_state = 'unchanged'
1587
elif (_terminal_size_state == 'unchanged' and
1588
_first_terminal_size != os_size):
1589
_terminal_size_state = 'changed'
1591
# If the OS claims to know how wide the terminal is, and this value has
1592
# ever changed, use that.
1593
if _terminal_size_state == 'changed':
1594
if width is not None and width > 0:
1597
# If COLUMNS is set, use it.
1599
return int(os.environ['COLUMNS'])
1600
except (KeyError, ValueError):
1603
# Finally, use an unchanged size from the OS, if we have one.
1604
if _terminal_size_state == 'unchanged':
1605
if width is not None and width > 0:
1608
# The width could not be determined.
1612
def _win32_terminal_size(width, height):
1613
width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
1614
return width, height
1617
def _ioctl_terminal_size(width, height):
1000
"""Return estimated terminal width."""
1001
if sys.platform == 'win32':
1002
return win32utils.get_console_size()[0]
1619
1005
import struct, fcntl, termios
1620
1006
s = struct.pack('HHHH', 0, 0, 0, 0)
1621
1007
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1622
height, width = struct.unpack('HHHH', x)[0:2]
1623
except (IOError, AttributeError):
1008
width = struct.unpack('HHHH', x)[1]
1625
return width, height
1627
_terminal_size = None
1628
"""Returns the terminal size as (width, height).
1630
:param width: Default value for width.
1631
:param height: Default value for height.
1633
This is defined specifically for each OS and query the size of the controlling
1634
terminal. If any error occurs, the provided default values should be returned.
1636
if sys.platform == 'win32':
1637
_terminal_size = _win32_terminal_size
1639
_terminal_size = _ioctl_terminal_size
1013
width = int(os.environ['COLUMNS'])
1642
1022
def supports_executable():
1689
1069
raise errors.IllegalPath(path)
1692
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1694
def _is_error_enotdir(e):
1695
"""Check if this exception represents ENOTDIR.
1697
Unfortunately, python is very inconsistent about the exception
1698
here. The cases are:
1699
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1700
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1701
which is the windows error code.
1702
3) Windows, Python2.5 uses errno == EINVAL and
1703
winerror == ERROR_DIRECTORY
1705
:param e: An Exception object (expected to be OSError with an errno
1706
attribute, but we should be able to cope with anything)
1707
:return: True if this represents an ENOTDIR error. False otherwise.
1709
en = getattr(e, 'errno', None)
1710
if (en == errno.ENOTDIR
1711
or (sys.platform == 'win32'
1712
and (en == _WIN32_ERROR_DIRECTORY
1713
or (en == errno.EINVAL
1714
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1720
1072
def walkdirs(top, prefix=""):
1721
1073
"""Yield data about all the directories in a tree.
1723
1075
This yields all the data about the contents of a directory at a time.
1724
1076
After each directory has been yielded, if the caller has mutated the list
1725
1077
to exclude some directories, they are then not descended into.
1727
1079
The data yielded is of the form:
1728
1080
((directory-relpath, directory-path-from-top),
1729
[(relpath, basename, kind, lstat, path-from-top), ...]),
1081
[(directory-relpath, basename, kind, lstat, path-from-top), ...]),
1730
1082
- directory-relpath is the relative path of the directory being returned
1731
1083
with respect to top. prefix is prepended to this.
1732
- 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.
1733
1085
It is suitable for use with os functions.
1734
1086
- relpath is the relative path within the subtree being walked.
1735
1087
- basename is the basename of the path
1825
1143
path-from-top might be unicode or utf8, but it is the correct path to
1826
1144
pass to os functions to affect the file in question. (such as os.lstat)
1828
global _selected_dir_reader
1829
if _selected_dir_reader is None:
1830
if sys.platform == "win32":
1832
from ._walkdirs_win32 import Win32ReadDir
1833
_selected_dir_reader = Win32ReadDir()
1836
elif _fs_enc in ('utf-8', 'ascii'):
1838
from ._readdir_pyx import UTF8DirReader
1839
_selected_dir_reader = UTF8DirReader()
1840
except ImportError as e:
1841
failed_to_load_extension(e)
1844
if _selected_dir_reader is None:
1845
# Fallback to the python version
1846
_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
1848
1165
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1849
1166
# But we don't actually uses 1-3 in pending, so set them to None
1850
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1851
read_dir = _selected_dir_reader.read_dir
1852
_directory = _directory_kind
1167
pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1854
relroot, _, _, _, top = pending[-1].pop()
1857
dirblock = sorted(read_dir(relroot, top))
1858
yield (relroot, top), dirblock
1859
# push the user specified dirs from dirblock
1860
next = [d for d in reversed(dirblock) if d[2] == _directory]
1862
pending.append(next)
1865
class UnicodeDirReader(DirReader):
1866
"""A dir reader for non-utf8 file systems, which transcodes."""
1868
__slots__ = ['_utf8_encode']
1871
self._utf8_encode = codecs.getencoder('utf8')
1873
def top_prefix_to_starting_dir(self, top, prefix=""):
1874
"""See DirReader.top_prefix_to_starting_dir."""
1875
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1877
def read_dir(self, prefix, top):
1878
"""Read a single directory from a non-utf8 file system.
1880
top, and the abspath element in the output are unicode, all other paths
1881
are utf8. Local disk IO is done via unicode calls to listdir etc.
1883
This is currently the fallback code path when the filesystem encoding is
1884
not UTF-8. It may be better to implement an alternative so that we can
1885
safely handle paths that are not properly decodable in the current
1888
See DirReader.read_dir for details.
1890
_utf8_encode = self._utf8_encode
1892
_listdir = os.listdir
1893
_kind_from_mode = file_kind_from_stat_mode
1896
relprefix = prefix + b'/'
1169
relroot, _, _, _, top = pending.pop()
1171
relprefix = relroot + '/'
1899
1174
top_slash = top + '/'
1902
1177
append = dirblock.append
1903
1178
for name in sorted(_listdir(top)):
1905
name_utf8 = _utf8_encode(name)[0]
1906
except UnicodeDecodeError:
1907
raise errors.BadFilenameEncoding(
1908
_utf8_encode(relprefix)[0] + name, _fs_enc)
1909
abspath = top_slash + name
1910
statvalue = _lstat(abspath)
1911
kind = _kind_from_mode(statvalue.st_mode)
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)):
1217
name_utf8 = _utf8_encode(name)[0]
1218
abspath = top_slash + name
1219
statvalue = _lstat(abspath)
1220
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1912
1221
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
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)
1916
1228
def copy_tree(from_path, to_path, handlers={}):
1917
1229
"""Copy all of the entries in from_path into to_path.
1919
:param from_path: The base directory to copy.
1231
:param from_path: The base directory to copy.
1920
1232
:param to_path: The target directory. If it does not exist, it will
1922
1234
:param handlers: A dictionary of functions, which takes a source and
1998
1285
_cached_user_encoding = None
2001
def get_user_encoding():
1288
def get_user_encoding(use_cache=True):
2002
1289
"""Find out what the preferred user encoding is.
2004
1291
This is generally the encoding that is used for command line parameters
2005
1292
and file contents. This may be different from the terminal encoding
2006
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)
2008
1299
:return: A string defining the preferred user encoding
2010
1301
global _cached_user_encoding
2011
if _cached_user_encoding is not None:
1302
if _cached_user_encoding is not None and use_cache:
2012
1303
return _cached_user_encoding
2014
if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2015
# Use the existing locale settings and call nl_langinfo directly
2016
# rather than going through getpreferredencoding. This avoids
2017
# <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2018
# possibility of the setlocale call throwing an error.
2019
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'
2021
# GZ 2011-12-19: On windows could call GetACP directly instead.
2022
user_encoding = locale.getpreferredencoding(False)
2025
user_encoding = codecs.lookup(user_encoding).name
2027
if user_encoding not in ("", "cp0"):
2028
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:'
2029
1337
' unknown encoding %s.'
2030
1338
' Continuing with ascii encoding.\n'
2031
1339
% user_encoding
2033
user_encoding = 'ascii'
2035
# Get 'ascii' when setlocale has not been called or LANG=C or unset.
2036
if user_encoding == 'ascii':
2037
if sys.platform == 'darwin':
2038
# OSX is special-cased in Python to have a UTF-8 filesystem
2039
# encoding and previously had LANG set here if not present.
2040
user_encoding = 'utf-8'
2041
# GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2042
# for some other posix platforms as well.
2044
_cached_user_encoding = user_encoding
1341
user_encoding = 'ascii'
1344
_cached_user_encoding = user_encoding
2045
1346
return user_encoding
2048
def get_diff_header_encoding():
2049
return get_terminal_encoding()
2052
def get_host_name():
2053
"""Return the current unicode host name.
2055
This is meant to be used in place of socket.gethostname() because that
2056
behaves inconsistently on different platforms.
2058
if sys.platform == "win32":
2059
return win32utils.get_host_name()
2063
return socket.gethostname()
2064
return socket.gethostname().decode(get_user_encoding())
2067
# We must not read/write any more than 64k at a time from/to a socket so we
2068
# don't risk "no buffer space available" errors on some platforms. Windows in
2069
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
2071
MAX_SOCKET_CHUNK = 64 * 1024
2073
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2074
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2075
_eno = getattr(errno, _eno, None)
2076
if _eno is not None:
2077
_end_of_stream_errors.append(_eno)
2081
def read_bytes_from_socket(sock, report_activity=None,
2082
max_read_size=MAX_SOCKET_CHUNK):
2083
"""Read up to max_read_size of bytes from sock and notify of progress.
2085
Translates "Connection reset by peer" into file-like EOF (return an
2086
empty string rather than raise an error), and repeats the recv if
2087
interrupted by a signal.
2091
data = sock.recv(max_read_size)
2092
except socket.error as e:
2094
if eno in _end_of_stream_errors:
2095
# The connection was closed by the other side. Callers expect
2096
# an empty string to signal end-of-stream.
2098
elif eno == errno.EINTR:
2099
# Retry the interrupted recv.
2103
if report_activity is not None:
2104
report_activity(len(data), 'read')
2108
def recv_all(socket, count):
1349
def recv_all(socket, bytes):
2109
1350
"""Receive an exact number of bytes.
2111
1352
Regular Socket.recv() may return less than the requested number of bytes,
2112
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
2113
1354
on all platforms, but this should work everywhere. This will return
2114
1355
less than the requested amount if the remote end closes.
2116
1357
This isn't optimized and is intended mostly for use in testing.
2119
while len(b) < count:
2120
new = read_bytes_from_socket(socket, None, count - len(b))
1360
while len(b) < bytes:
1361
new = socket.recv(bytes - len(b))
2127
def send_all(sock, bytes, report_activity=None):
2128
"""Send all bytes on a socket.
2130
Breaks large blocks in smaller chunks to avoid buffering limitations on
2131
some platforms, and catches EINTR which may be thrown if the send is
2132
interrupted by a signal.
2134
This is preferred to socket.sendall(), because it avoids portability bugs
2135
and provides activity reporting.
2137
:param report_activity: Call this as bytes are read, see
2138
Transport._report_activity
2141
byte_count = len(bytes)
2142
view = memoryview(bytes)
2143
while sent_total < byte_count:
2145
sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
2146
except (socket.error, IOError) as e:
2147
if e.args[0] in _end_of_stream_errors:
2148
raise errors.ConnectionReset(
2149
"Error trying to write to socket", e)
2150
if e.args[0] != errno.EINTR:
2154
raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2157
if report_activity is not None:
2158
report_activity(sent, 'write')
2161
def connect_socket(address):
2162
# Slight variation of the socket.create_connection() function (provided by
2163
# python-2.6) that can fail if getaddrinfo returns an empty list. We also
2164
# provide it for previous python versions. Also, we don't use the timeout
2165
# parameter (provided by the python implementation) so we don't implement
2167
err = socket.error('getaddrinfo returns an empty list')
2168
host, port = address
2169
for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2170
af, socktype, proto, canonname, sa = res
2173
sock = socket.socket(af, socktype, proto)
2177
except socket.error as e:
2179
# 'err' is now the most recent error
2180
if sock is not None:
2185
1367
def dereference_path(path):
2186
1368
"""Determine the real path to a file.
2194
1376
# The pathjoin for '.' is a workaround for Python bug #1213894.
2195
1377
# (initial path components aren't dereferenced)
2196
1378
return pathjoin(realpath(pathjoin('.', parent)), base)
2199
def supports_mapi():
2200
"""Return True if we can use MAPI to launch a mail client."""
2201
return sys.platform == "win32"
2204
def resource_string(package, resource_name):
2205
"""Load a resource from a package and return it as a string.
2207
Note: Only packages that start with breezy are currently supported.
2209
This is designed to be a lightweight implementation of resource
2210
loading in a way which is API compatible with the same API from
2212
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
2213
If and when pkg_resources becomes a standard library, this routine
2216
# Check package name is within breezy
2217
if package == "breezy":
2218
resource_relpath = resource_name
2219
elif package.startswith("breezy."):
2220
package = package[len("breezy."):].replace('.', os.sep)
2221
resource_relpath = pathjoin(package, resource_name)
2223
raise errors.BzrError('resource package %s not in breezy' % package)
2225
# Map the resource to a file and read its contents
2226
base = dirname(breezy.__file__)
2227
if getattr(sys, 'frozen', None): # bzr.exe
2228
base = abspath(pathjoin(base, '..', '..'))
2229
with open(pathjoin(base, resource_relpath), "rU") as f:
2232
def file_kind_from_stat_mode_thunk(mode):
2233
global file_kind_from_stat_mode
2234
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2236
from ._readdir_pyx import UTF8DirReader
2237
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2238
except ImportError as e:
2239
# This is one time where we won't warn that an extension failed to
2240
# load. The extension is never available on Windows anyway.
2241
from ._readdir_py import (
2242
_kind_from_mode as file_kind_from_stat_mode
2244
return file_kind_from_stat_mode(mode)
2245
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2247
def file_stat(f, _lstat=os.lstat):
2251
except OSError as e:
2252
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2253
raise errors.NoSuchFile(f)
2256
def file_kind(f, _lstat=os.lstat):
2257
stat_value = file_stat(f, _lstat)
2258
return file_kind_from_stat_mode(stat_value.st_mode)
2260
def until_no_eintr(f, *a, **kw):
2261
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2263
WARNING: you must be certain that it is safe to retry the call repeatedly
2264
if EINTR does occur. This is typically only true for low-level operations
2265
like os.read. If in any doubt, don't use this.
2267
Keep in mind that this is not a complete solution to EINTR. There is
2268
probably code in the Python standard library and other dependencies that
2269
may encounter EINTR if a signal arrives (and there is signal handler for
2270
that signal). So this function can reduce the impact for IO that breezy
2271
directly controls, but it is not a complete solution.
2273
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
2277
except (IOError, OSError) as e:
2278
if e.errno == errno.EINTR:
2283
if sys.platform == "win32":
2286
return msvcrt.getch()
2291
fd = sys.stdin.fileno()
2292
settings = termios.tcgetattr(fd)
2295
ch = sys.stdin.read(1)
2297
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2300
if sys.platform.startswith('linux'):
2301
def _local_concurrency():
2303
return os.sysconf('SC_NPROCESSORS_ONLN')
2304
except (ValueError, OSError, AttributeError):
2306
elif sys.platform == 'darwin':
2307
def _local_concurrency():
2308
return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2309
stdout=subprocess.PIPE).communicate()[0]
2310
elif "bsd" in sys.platform:
2311
def _local_concurrency():
2312
return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2313
stdout=subprocess.PIPE).communicate()[0]
2314
elif sys.platform == 'sunos5':
2315
def _local_concurrency():
2316
return subprocess.Popen(['psrinfo', '-p',],
2317
stdout=subprocess.PIPE).communicate()[0]
2318
elif sys.platform == "win32":
2319
def _local_concurrency():
2320
# This appears to return the number of cores.
2321
return os.environ.get('NUMBER_OF_PROCESSORS')
2323
def _local_concurrency():
2328
_cached_local_concurrency = None
2330
def local_concurrency(use_cache=True):
2331
"""Return how many processes can be run concurrently.
2333
Rely on platform specific implementations and default to 1 (one) if
2334
anything goes wrong.
2336
global _cached_local_concurrency
2338
if _cached_local_concurrency is not None and use_cache:
2339
return _cached_local_concurrency
2341
concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2342
if concurrency is None:
2343
import multiprocessing
2345
concurrency = multiprocessing.cpu_count()
2346
except NotImplementedError:
2347
# multiprocessing.cpu_count() isn't implemented on all platforms
2349
concurrency = _local_concurrency()
2350
except (OSError, IOError):
2353
concurrency = int(concurrency)
2354
except (TypeError, ValueError):
2357
_cached_concurrency = concurrency
2361
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
2362
"""A stream writer that doesn't decode str arguments."""
2364
def __init__(self, encode, stream, errors='strict'):
2365
codecs.StreamWriter.__init__(self, stream, errors)
2366
self.encode = encode
2368
def write(self, object):
2369
if isinstance(object, str):
2370
self.stream.write(object)
2372
data, _ = self.encode(object, self.errors)
2373
self.stream.write(data)
2375
if sys.platform == 'win32':
2376
def open_file(filename, mode='r', bufsize=-1):
2377
"""This function is used to override the ``open`` builtin.
2379
But it uses O_NOINHERIT flag so the file handle is not inherited by
2380
child processes. Deleting or renaming a closed file opened with this
2381
function is not blocking child processes.
2383
writing = 'w' in mode
2384
appending = 'a' in mode
2385
updating = '+' in mode
2386
binary = 'b' in mode
2389
# see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
2390
# for flags for each modes.
2400
flags |= os.O_WRONLY
2401
flags |= os.O_CREAT | os.O_TRUNC
2406
flags |= os.O_WRONLY
2407
flags |= os.O_CREAT | os.O_APPEND
2412
flags |= os.O_RDONLY
2414
return os.fdopen(os.open(filename, flags), mode, bufsize)
2419
def available_backup_name(base, exists):
2420
"""Find a non-existing backup file name.
2422
This will *not* create anything, this only return a 'free' entry. This
2423
should be used for checking names in a directory below a locked
2424
tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2425
Leap) and generally discouraged.
2427
:param base: The base name.
2429
:param exists: A callable returning True if the path parameter exists.
2432
name = "%s.~%d~" % (base, counter)
2435
name = "%s.~%d~" % (base, counter)
2439
def set_fd_cloexec(fd):
2440
"""Set a Unix file descriptor's FD_CLOEXEC flag. Do nothing if platform
2441
support for this is not available.
2445
old = fcntl.fcntl(fd, fcntl.F_GETFD)
2446
fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2447
except (ImportError, AttributeError):
2448
# Either the fcntl module or specific constants are not present
2452
def find_executable_on_path(name):
2453
"""Finds an executable on the PATH.
2455
On Windows, this will try to append each extension in the PATHEXT
2456
environment variable to the name, if it cannot be found with the name
2459
:param name: The base name of the executable.
2460
:return: The path to the executable found or None.
2462
if sys.platform == 'win32':
2463
exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2464
exts = [ext.lower() for ext in exts]
2465
base, ext = os.path.splitext(name)
2467
if ext.lower() not in exts:
2473
path = os.environ.get('PATH')
2474
if path is not None:
2475
path = path.split(os.pathsep)
2478
f = os.path.join(d, name) + ext
2479
if os.access(f, os.X_OK):
2481
if sys.platform == 'win32':
2482
app_path = win32utils.get_app_path(name)
2483
if app_path != name:
2488
def _posix_is_local_pid_dead(pid):
2489
"""True if pid doesn't correspond to live process on this machine"""
2491
# Special meaning of unix kill: just check if it's there.
2493
except OSError as e:
2494
if e.errno == errno.ESRCH:
2495
# On this machine, and really not found: as sure as we can be
2498
elif e.errno == errno.EPERM:
2499
# exists, though not ours
2502
mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2503
# Don't really know.
2506
# Exists and our process: not dead.
2509
if sys.platform == "win32":
2510
is_local_pid_dead = win32utils.is_local_pid_dead
2512
is_local_pid_dead = _posix_is_local_pid_dead
2514
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2515
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2516
if getattr(errno, name, None) is not None]
2519
def fdatasync(fileno):
2520
"""Flush file contents to disk if possible.
2522
:param fileno: Integer OS file handle.
2523
:raises TransportNotPossible: If flushing to disk is not possible.
2525
fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2529
except IOError as e:
2530
# See bug #1075108, on some platforms fdatasync exists, but can
2531
# raise ENOTSUP. However, we are calling fdatasync to be helpful
2532
# and reduce the chance of corruption-on-powerloss situations. It
2533
# is not a mandatory call, so it is ok to suppress failures.
2534
trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2535
if getattr(e, 'errno', None) not in _fdatasync_ignored:
2539
def ensure_empty_directory_exists(path, exception_class):
2540
"""Make sure a local directory exists and is empty.
2542
If it does not exist, it is created. If it exists and is not empty, an
2543
instance of exception_class is raised.
2547
except OSError as e:
2548
if e.errno != errno.EEXIST:
2550
if os.listdir(path) != []:
2551
raise exception_class(path)
2554
def is_environment_error(evalue):
2555
"""True if exception instance is due to a process environment issue
2557
This includes OSError and IOError, but also other errors that come from
2558
the operating system or core libraries but are not subclasses of those.
2560
if isinstance(evalue, (EnvironmentError, select.error)):
2562
if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
added
removed
bzrlib/osutils.py
