/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
 
import errno
20
17
import os
21
18
import re
22
19
import stat
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
23
21
import sys
24
22
import time
25
23
import codecs
26
24
 
27
 
from .lazy_import import lazy_import
 
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
30
 
from datetime import timedelta
31
 
import getpass
32
 
import locale
33
 
import ntpath
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
34
35
import posixpath
35
 
import select
36
 
# We need to import both shutil and rmtree as we export the later on posix
37
 
# and need the former on windows
38
36
import shutil
39
 
from shutil import rmtree
 
37
from shutil import (
 
38
    rmtree,
 
39
    )
40
40
import socket
41
41
import subprocess
42
 
# We need to import both tempfile and mkdtemp as we export the later on posix
43
 
# and need the former on windows
44
42
import tempfile
45
 
from tempfile import mkdtemp
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
46
46
import unicodedata
47
47
 
48
 
from breezy import (
49
 
    config,
 
48
from bzrlib import (
 
49
    cache_utf8,
50
50
    errors,
51
51
    trace,
52
52
    win32utils,
53
53
    )
54
 
from breezy.i18n import gettext
55
54
""")
56
55
 
57
 
from .sixish import (
58
 
    PY3,
59
 
    text_type,
60
 
    )
61
 
 
62
 
from hashlib import (
63
 
    md5,
64
 
    sha1 as sha,
65
 
    )
66
 
 
67
 
 
68
 
import breezy
69
 
from . import _fs_enc
 
56
from bzrlib.symbol_versioning import (
 
57
    deprecated_function,
 
58
    deprecated_in,
 
59
    )
 
60
 
 
61
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
62
# of 2.5
 
63
if sys.version_info < (2, 5):
 
64
    import md5 as _mod_md5
 
65
    md5 = _mod_md5.new
 
66
    import sha as _mod_sha
 
67
    sha = _mod_sha.new
 
68
else:
 
69
    from hashlib import (
 
70
        md5,
 
71
        sha1 as sha,
 
72
        )
 
73
 
 
74
 
 
75
import bzrlib
 
76
from bzrlib import symbol_versioning
70
77
 
71
78
 
72
79
# Cross platform wall-clock time functionality with decent resolution.
90
97
 
91
98
 
92
99
def get_unicode_argv():
93
 
    if PY3:
94
 
        return sys.argv[1:]
95
100
    try:
96
101
        user_encoding = get_user_encoding()
97
102
        return [a.decode(user_encoding) for a in sys.argv[1:]]
98
103
    except UnicodeDecodeError:
99
 
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
100
 
            "application locale.").format(a, user_encoding))
 
104
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
105
                                                            "encoding." % a))
101
106
 
102
107
 
103
108
def make_readonly(filename):
104
109
    """Make a filename read-only."""
105
110
    mod = os.lstat(filename).st_mode
106
111
    if not stat.S_ISLNK(mod):
107
 
        mod = mod & 0o777555
108
 
        chmod_if_possible(filename, mod)
 
112
        mod = mod & 0777555
 
113
        os.chmod(filename, mod)
109
114
 
110
115
 
111
116
def make_writable(filename):
112
117
    mod = os.lstat(filename).st_mode
113
118
    if not stat.S_ISLNK(mod):
114
 
        mod = mod | 0o200
115
 
        chmod_if_possible(filename, mod)
116
 
 
117
 
 
118
 
def chmod_if_possible(filename, mode):
119
 
    # Set file mode if that can be safely done.
120
 
    # Sometimes even on unix the filesystem won't allow it - see
121
 
    # https://bugs.launchpad.net/bzr/+bug/606537
122
 
    try:
123
 
        # It is probably faster to just do the chmod, rather than
124
 
        # doing a stat, and then trying to compare
125
 
        os.chmod(filename, mode)
126
 
    except (IOError, OSError) as e:
127
 
        # Permission/access denied seems to commonly happen on smbfs; there's
128
 
        # probably no point warning about it.
129
 
        # <https://bugs.launchpad.net/bzr/+bug/606537>
130
 
        if getattr(e, 'errno') in (errno.EPERM, errno.EACCES):
131
 
            trace.mutter("ignore error on chmod of %r: %r" % (
132
 
                filename, e))
133
 
            return
134
 
        raise
 
119
        mod = mod | 0200
 
120
        os.chmod(filename, mod)
135
121
 
136
122
 
137
123
def minimum_path_selection(paths):
212
198
            stat = getattr(os, 'lstat', os.stat)
213
199
            stat(f)
214
200
            return True
215
 
        except OSError as e:
 
201
        except OSError, e:
216
202
            if e.errno == errno.ENOENT:
217
203
                return False;
218
204
            else:
219
 
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
 
205
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
220
206
 
221
207
 
222
208
def fancy_rename(old, new, rename_func, unlink_func):
246
232
    file_existed = False
247
233
    try:
248
234
        rename_func(new, tmp_name)
249
 
    except (errors.NoSuchFile,) as e:
 
235
    except (errors.NoSuchFile,), e:
250
236
        pass
251
 
    except IOError as e:
 
237
    except IOError, e:
252
238
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
253
239
        # function raises an IOError with errno is None when a rename fails.
254
240
        # This then gets caught here.
255
241
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
256
242
            raise
257
 
    except Exception as e:
 
243
    except Exception, e:
258
244
        if (getattr(e, 'errno', None) is None
259
245
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
260
246
            raise
261
247
    else:
262
248
        file_existed = True
263
249
 
 
250
    failure_exc = None
264
251
    success = False
265
252
    try:
266
 
        # This may throw an exception, in which case success will
267
 
        # not be set.
268
 
        rename_func(old, new)
269
 
        success = True
270
 
    except (IOError, OSError) as e:
271
 
        # source and target may be aliases of each other (e.g. on a
272
 
        # case-insensitive filesystem), so we may have accidentally renamed
273
 
        # source by when we tried to rename target
274
 
        if (file_existed and e.errno in (None, errno.ENOENT)
275
 
            and old.lower() == new.lower()):
276
 
            # source and target are the same file on a case-insensitive
277
 
            # filesystem, so we don't generate an exception
278
 
            pass
279
 
        else:
280
 
            raise
 
253
        try:
 
254
            # This may throw an exception, in which case success will
 
255
            # not be set.
 
256
            rename_func(old, new)
 
257
            success = True
 
258
        except (IOError, OSError), e:
 
259
            # source and target may be aliases of each other (e.g. on a
 
260
            # case-insensitive filesystem), so we may have accidentally renamed
 
261
            # source by when we tried to rename target
 
262
            failure_exc = sys.exc_info()
 
263
            if (file_existed and e.errno in (None, errno.ENOENT)
 
264
                and old.lower() == new.lower()):
 
265
                # source and target are the same file on a case-insensitive
 
266
                # filesystem, so we don't generate an exception
 
267
                failure_exc = None
281
268
    finally:
282
269
        if file_existed:
283
270
            # If the file used to exist, rename it back into place
286
273
                unlink_func(tmp_name)
287
274
            else:
288
275
                rename_func(tmp_name, new)
 
276
    if failure_exc is not None:
 
277
        raise failure_exc[0], failure_exc[1], failure_exc[2]
289
278
 
290
279
 
291
280
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
292
281
# choke on a Unicode string containing a relative path if
293
282
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
294
283
# string.
 
284
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
295
285
def _posix_abspath(path):
296
286
    # jam 20060426 rather than encoding to fsencoding
297
287
    # copy posixpath.abspath, but use os.getcwdu instead
298
288
    if not posixpath.isabs(path):
299
289
        path = posixpath.join(getcwd(), path)
300
 
    return _posix_normpath(path)
 
290
    return posixpath.normpath(path)
301
291
 
302
292
 
303
293
def _posix_realpath(path):
304
294
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
305
295
 
306
296
 
307
 
def _posix_normpath(path):
308
 
    path = posixpath.normpath(path)
309
 
    # Bug 861008: posixpath.normpath() returns a path normalized according to
310
 
    # the POSIX standard, which stipulates (for compatibility reasons) that two
311
 
    # leading slashes must not be simplified to one, and only if there are 3 or
312
 
    # more should they be simplified as one. So we treat the leading 2 slashes
313
 
    # as a special case here by simply removing the first slash, as we consider
314
 
    # that breaking POSIX compatibility for this obscure feature is acceptable.
315
 
    # This is not a paranoid precaution, as we notably get paths like this when
316
 
    # the repo is hosted at the root of the filesystem, i.e. in "/".    
317
 
    if path.startswith('//'):
318
 
        path = path[1:]
319
 
    return path
320
 
 
321
 
 
322
 
def _posix_path_from_environ(key):
323
 
    """Get unicode path from `key` in environment or None if not present
324
 
 
325
 
    Note that posix systems use arbitrary byte strings for filesystem objects,
326
 
    so a path that raises BadFilenameEncoding here may still be accessible.
327
 
    """
328
 
    val = os.environ.get(key, None)
329
 
    if PY3 or val is None:
330
 
        return val
331
 
    try:
332
 
        return val.decode(_fs_enc)
333
 
    except UnicodeDecodeError:
334
 
        # GZ 2011-12-12:Ideally want to include `key` in the exception message
335
 
        raise errors.BadFilenameEncoding(val, _fs_enc)
336
 
 
337
 
 
338
 
def _posix_get_home_dir():
339
 
    """Get the home directory of the current user as a unicode path"""
340
 
    path = posixpath.expanduser("~")
341
 
    try:
342
 
        return path.decode(_fs_enc)
343
 
    except AttributeError:
344
 
        return path
345
 
    except UnicodeDecodeError:
346
 
        raise errors.BadFilenameEncoding(path, _fs_enc)
347
 
 
348
 
 
349
 
def _posix_getuser_unicode():
350
 
    """Get username from environment or password database as unicode"""
351
 
    name = getpass.getuser()
352
 
    if PY3:
353
 
        return name
354
 
    user_encoding = get_user_encoding()
355
 
    try:
356
 
        return name.decode(user_encoding)
357
 
    except UnicodeDecodeError:
358
 
        raise errors.BzrError("Encoding of username %r is unsupported by %s "
359
 
            "application locale." % (name, user_encoding))
360
 
 
361
 
 
362
297
def _win32_fixdrive(path):
363
298
    """Force drive letters to be consistent.
364
299
 
368
303
    running python.exe under cmd.exe return capital C:\\
369
304
    running win32 python inside a cygwin shell returns lowercase c:\\
370
305
    """
371
 
    drive, path = ntpath.splitdrive(path)
 
306
    drive, path = _nt_splitdrive(path)
372
307
    return drive.upper() + path
373
308
 
374
309
 
375
310
def _win32_abspath(path):
376
 
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
377
 
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
 
311
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
312
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
313
 
 
314
 
 
315
def _win98_abspath(path):
 
316
    """Return the absolute version of a path.
 
317
    Windows 98 safe implementation (python reimplementation
 
318
    of Win32 API function GetFullPathNameW)
 
319
    """
 
320
    # Corner cases:
 
321
    #   C:\path     => C:/path
 
322
    #   C:/path     => C:/path
 
323
    #   \\HOST\path => //HOST/path
 
324
    #   //HOST/path => //HOST/path
 
325
    #   path        => C:/cwd/path
 
326
    #   /path       => C:/path
 
327
    path = unicode(path)
 
328
    # check for absolute path
 
329
    drive = _nt_splitdrive(path)[0]
 
330
    if drive == '' and path[:2] not in('//','\\\\'):
 
331
        cwd = os.getcwdu()
 
332
        # we cannot simply os.path.join cwd and path
 
333
        # because os.path.join('C:','/path') produce '/path'
 
334
        # and this is incorrect
 
335
        if path[:1] in ('/','\\'):
 
336
            cwd = _nt_splitdrive(cwd)[0]
 
337
            path = path[1:]
 
338
        path = cwd + '\\' + path
 
339
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
378
340
 
379
341
 
380
342
def _win32_realpath(path):
381
 
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
382
 
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
 
343
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
344
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
383
345
 
384
346
 
385
347
def _win32_pathjoin(*args):
386
 
    return ntpath.join(*args).replace('\\', '/')
 
348
    return _nt_join(*args).replace('\\', '/')
387
349
 
388
350
 
389
351
def _win32_normpath(path):
390
 
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
 
352
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
391
353
 
392
354
 
393
355
def _win32_getcwd():
394
 
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
 
356
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
395
357
 
396
358
 
397
359
def _win32_mkdtemp(*args, **kwargs):
398
360
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
399
361
 
400
362
 
 
363
def _add_rename_error_details(e, old, new):
 
364
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
 
365
        % (old, new, e.strerror))
 
366
    new_e.filename = old
 
367
    new_e.to_filename = new
 
368
    return new_e
 
369
 
 
370
 
401
371
def _win32_rename(old, new):
402
372
    """We expect to be able to atomically replace 'new' with old.
403
373
 
405
375
    and then deleted.
406
376
    """
407
377
    try:
408
 
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
409
 
    except OSError as e:
 
378
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
379
    except OSError, e:
410
380
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
411
381
            # If we try to rename a non-existant file onto cwd, we get
412
382
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
416
386
        raise
417
387
 
418
388
 
 
389
def _wrapped_rename(old, new):
 
390
    """Rename a file or directory"""
 
391
    try:
 
392
        os.rename(old, new)
 
393
    except (IOError, OSError), e:
 
394
        # this is eventually called by all rename-like functions, so should 
 
395
        # catch all of them
 
396
        raise _add_rename_error_details(e, old, new)
 
397
 
 
398
 
419
399
def _mac_getcwd():
420
 
    return unicodedata.normalize('NFC', _getcwd())
421
 
 
422
 
 
423
 
def _rename_wrap_exception(rename_func):
424
 
    """Adds extra information to any exceptions that come from rename().
425
 
 
426
 
    The exception has an updated message and 'old_filename' and 'new_filename'
427
 
    attributes.
428
 
    """
429
 
 
430
 
    def _rename_wrapper(old, new):
431
 
        try:
432
 
            rename_func(old, new)
433
 
        except OSError as e:
434
 
            detailed_error = OSError(e.errno, e.strerror +
435
 
                                " [occurred when renaming '%s' to '%s']" %
436
 
                                (old, new))
437
 
            detailed_error.old_filename = old
438
 
            detailed_error.new_filename = new
439
 
            raise detailed_error
440
 
 
441
 
    return _rename_wrapper
442
 
 
443
 
 
444
 
if sys.version_info > (3,):
445
 
    _getcwd = os.getcwd
446
 
else:
447
 
    _getcwd = os.getcwdu
448
 
 
449
 
 
450
 
# Default rename wraps os.rename()
451
 
rename = _rename_wrap_exception(os.rename)
 
400
    return unicodedata.normalize('NFC', os.getcwdu())
 
401
 
452
402
 
453
403
# Default is to just use the python builtins, but these can be rebound on
454
404
# particular platforms.
455
405
abspath = _posix_abspath
456
406
realpath = _posix_realpath
457
407
pathjoin = os.path.join
458
 
normpath = _posix_normpath
459
 
path_from_environ = _posix_path_from_environ
460
 
_get_home_dir = _posix_get_home_dir
461
 
getuser_unicode = _posix_getuser_unicode
462
 
getcwd = _getcwd
 
408
normpath = os.path.normpath
 
409
rename = _wrapped_rename # overridden below on win32
 
410
getcwd = os.getcwdu
463
411
dirname = os.path.dirname
464
412
basename = os.path.basename
465
413
split = os.path.split
466
414
splitext = os.path.splitext
467
 
# These were already lazily imported into local scope
 
415
# These were already imported into local scope
468
416
# mkdtemp = tempfile.mkdtemp
469
417
# rmtree = shutil.rmtree
470
 
lstat = os.lstat
471
 
fstat = os.fstat
472
 
 
473
 
def wrap_stat(st):
474
 
    return st
475
 
 
476
418
 
477
419
MIN_ABS_PATHLENGTH = 1
478
420
 
479
421
 
480
422
if sys.platform == 'win32':
481
 
    abspath = _win32_abspath
 
423
    if win32utils.winver == 'Windows 98':
 
424
        abspath = _win98_abspath
 
425
    else:
 
426
        abspath = _win32_abspath
482
427
    realpath = _win32_realpath
483
428
    pathjoin = _win32_pathjoin
484
429
    normpath = _win32_normpath
485
430
    getcwd = _win32_getcwd
486
431
    mkdtemp = _win32_mkdtemp
487
 
    rename = _rename_wrap_exception(_win32_rename)
488
 
    try:
489
 
        from . import _walkdirs_win32
490
 
    except ImportError:
491
 
        pass
492
 
    else:
493
 
        lstat = _walkdirs_win32.lstat
494
 
        fstat = _walkdirs_win32.fstat
495
 
        wrap_stat = _walkdirs_win32.wrap_stat
 
432
    rename = _win32_rename
496
433
 
497
434
    MIN_ABS_PATHLENGTH = 3
498
435
 
516
453
    f = win32utils.get_unicode_argv     # special function or None
517
454
    if f is not None:
518
455
        get_unicode_argv = f
519
 
    path_from_environ = win32utils.get_environ_unicode
520
 
    _get_home_dir = win32utils.get_home_location
521
 
    getuser_unicode = win32utils.get_user_name
522
456
 
523
457
elif sys.platform == 'darwin':
524
458
    getcwd = _mac_getcwd
525
459
 
526
460
 
527
 
def get_terminal_encoding(trace=False):
 
461
def get_terminal_encoding():
528
462
    """Find the best encoding for printing to the screen.
529
463
 
530
464
    This attempts to check both sys.stdout and sys.stdin to see
536
470
 
537
471
    On my standard US Windows XP, the preferred encoding is
538
472
    cp1252, but the console is cp437
539
 
 
540
 
    :param trace: If True trace the selected encoding via mutter().
541
473
    """
542
 
    from .trace import mutter
 
474
    from bzrlib.trace import mutter
543
475
    output_encoding = getattr(sys.stdout, 'encoding', None)
544
476
    if not output_encoding:
545
477
        input_encoding = getattr(sys.stdin, 'encoding', None)
546
478
        if not input_encoding:
547
479
            output_encoding = get_user_encoding()
548
 
            if trace:
549
 
                mutter('encoding stdout as osutils.get_user_encoding() %r',
 
480
            mutter('encoding stdout as osutils.get_user_encoding() %r',
550
481
                   output_encoding)
551
482
        else:
552
483
            output_encoding = input_encoding
553
 
            if trace:
554
 
                mutter('encoding stdout as sys.stdin encoding %r',
555
 
                    output_encoding)
 
484
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
556
485
    else:
557
 
        if trace:
558
 
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
486
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
559
487
    if output_encoding == 'cp0':
560
488
        # invalid encoding (cp0 means 'no codepage' on Windows)
561
489
        output_encoding = get_user_encoding()
562
 
        if trace:
563
 
            mutter('cp0 is invalid encoding.'
 
490
        mutter('cp0 is invalid encoding.'
564
491
               ' encoding stdout as osutils.get_user_encoding() %r',
565
492
               output_encoding)
566
493
    # check encoding
567
494
    try:
568
495
        codecs.lookup(output_encoding)
569
496
    except LookupError:
570
 
        sys.stderr.write('brz: warning:'
 
497
        sys.stderr.write('bzr: warning:'
571
498
                         ' unknown terminal encoding %s.\n'
572
499
                         '  Using encoding %s instead.\n'
573
500
                         % (output_encoding, get_user_encoding())
592
519
def isdir(f):
593
520
    """True if f is an accessible directory."""
594
521
    try:
595
 
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
 
522
        return S_ISDIR(os.lstat(f)[ST_MODE])
596
523
    except OSError:
597
524
        return False
598
525
 
600
527
def isfile(f):
601
528
    """True if f is a regular file."""
602
529
    try:
603
 
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
 
530
        return S_ISREG(os.lstat(f)[ST_MODE])
604
531
    except OSError:
605
532
        return False
606
533
 
607
534
def islink(f):
608
535
    """True if f is a symlink."""
609
536
    try:
610
 
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
 
537
        return S_ISLNK(os.lstat(f)[ST_MODE])
611
538
    except OSError:
612
539
        return False
613
540
 
710
637
    # drives).
711
638
    if not segment_size:
712
639
        segment_size = 5242880 # 5MB
713
 
    offsets = range(0, len(bytes), segment_size)
714
 
    view = memoryview(bytes)
 
640
    segments = range(len(bytes) / segment_size + 1)
715
641
    write = file_handle.write
716
 
    for offset in offsets:
717
 
        write(view[offset:offset+segment_size])
 
642
    for segment_index in segments:
 
643
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
644
        write(segment)
718
645
 
719
646
 
720
647
def file_iterator(input_file, readsize=32768):
775
702
def sha_strings(strings, _factory=sha):
776
703
    """Return the sha-1 of concatenation of strings"""
777
704
    s = _factory()
778
 
    for string in strings:
779
 
        s.update(string)
 
705
    map(s.update, strings)
780
706
    return s.hexdigest()
781
707
 
782
708
 
802
728
            return True
803
729
 
804
730
 
805
 
def gmtime(seconds=None):
806
 
    """Convert seconds since the Epoch to a time tuple expressing UTC (a.k.a.
807
 
    GMT). When 'seconds' is not passed in, convert the current time instead.
808
 
    Handy replacement for time.gmtime() buggy on Windows and 32-bit platforms.
809
 
    """
810
 
    if seconds is None:
811
 
        seconds = time.time()
812
 
    return (datetime(1970, 1, 1) + timedelta(seconds=seconds)).timetuple()
813
 
 
814
 
 
815
731
def local_time_offset(t=None):
816
732
    """Return offset of local zone from GMT, either at present or at time t."""
817
733
    if t is None:
857
773
    """
858
774
    if offset is None:
859
775
        offset = 0
860
 
    tt = gmtime(t + offset)
 
776
    tt = time.gmtime(t + offset)
861
777
    date_fmt = _default_format_by_weekday_num[tt[6]]
862
778
    date_str = time.strftime(date_fmt, tt)
863
779
    offset_str = _cache.get(offset, None)
882
798
    (date_fmt, tt, offset_str) = \
883
799
               _format_date(t, offset, timezone, date_fmt, show_offset)
884
800
    date_str = time.strftime(date_fmt, tt)
885
 
    if not isinstance(date_str, text_type):
 
801
    if not isinstance(date_str, unicode):
886
802
        date_str = date_str.decode(get_user_encoding(), 'replace')
887
803
    return date_str + offset_str
888
804
 
889
805
 
890
806
def _format_date(t, offset, timezone, date_fmt, show_offset):
891
807
    if timezone == 'utc':
892
 
        tt = gmtime(t)
 
808
        tt = time.gmtime(t)
893
809
        offset = 0
894
810
    elif timezone == 'original':
895
811
        if offset is None:
896
812
            offset = 0
897
 
        tt = gmtime(t + offset)
 
813
        tt = time.gmtime(t + offset)
898
814
    elif timezone == 'local':
899
815
        tt = time.localtime(t)
900
816
        offset = local_time_offset(t)
910
826
 
911
827
 
912
828
def compact_date(when):
913
 
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
 
829
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
914
830
 
915
831
 
916
832
def format_delta(delta):
964
880
 
965
881
def filesize(f):
966
882
    """Return size of given open file."""
967
 
    return os.fstat(f.fileno())[stat.ST_SIZE]
968
 
 
969
 
 
970
 
# Alias os.urandom to support platforms (which?) without /dev/urandom and 
971
 
# override if it doesn't work. Avoid checking on windows where there is
972
 
# significant initialisation cost that can be avoided for some bzr calls.
973
 
 
974
 
rand_bytes = os.urandom
975
 
 
976
 
if rand_bytes.__module__ != "nt":
 
883
    return os.fstat(f.fileno())[ST_SIZE]
 
884
 
 
885
 
 
886
# Define rand_bytes based on platform.
 
887
try:
 
888
    # Python 2.4 and later have os.urandom,
 
889
    # but it doesn't work on some arches
 
890
    os.urandom(1)
 
891
    rand_bytes = os.urandom
 
892
except (NotImplementedError, AttributeError):
 
893
    # If python doesn't have os.urandom, or it doesn't work,
 
894
    # then try to first pull random data from /dev/urandom
977
895
    try:
978
 
        rand_bytes(1)
979
 
    except NotImplementedError:
 
896
        rand_bytes = file('/dev/urandom', 'rb').read
 
897
    # Otherwise, use this hack as a last resort
 
898
    except (IOError, OSError):
980
899
        # not well seeded, but better than nothing
981
900
        def rand_bytes(n):
982
901
            import random
996
915
    """
997
916
    s = ''
998
917
    for raw_byte in rand_bytes(num):
999
 
        if not PY3:
1000
 
            s += ALNUM[ord(raw_byte) % 36]
1001
 
        else:
1002
 
            s += ALNUM[raw_byte % 36]
 
918
        s += ALNUM[ord(raw_byte) % 36]
1003
919
    return s
1004
920
 
1005
921
 
1015
931
    rps = []
1016
932
    for f in ps:
1017
933
        if f == '..':
1018
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
934
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1019
935
        elif (f == '.') or (f == ''):
1020
936
            pass
1021
937
        else:
1026
942
def joinpath(p):
1027
943
    for f in p:
1028
944
        if (f == '..') or (f is None) or (f == ''):
1029
 
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
 
945
            raise errors.BzrError("sorry, %r not allowed in path" % f)
1030
946
    return pathjoin(*p)
1031
947
 
1032
948
 
1033
949
def parent_directories(filename):
1034
950
    """Return the list of parent directories, deepest first.
1035
 
 
 
951
    
1036
952
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
1037
953
    """
1038
954
    parents = []
1054
970
    implementation should be loaded instead::
1055
971
 
1056
972
    >>> try:
1057
 
    >>>     import breezy._fictional_extension_pyx
 
973
    >>>     import bzrlib._fictional_extension_pyx
1058
974
    >>> except ImportError, e:
1059
 
    >>>     breezy.osutils.failed_to_load_extension(e)
1060
 
    >>>     import breezy._fictional_extension_py
 
975
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
976
    >>>     import bzrlib._fictional_extension_py
1061
977
    """
1062
978
    # NB: This docstring is just an example, not a doctest, because doctest
1063
979
    # currently can't cope with the use of lazy imports in this namespace --
1064
980
    # mbp 20090729
1065
 
 
 
981
    
1066
982
    # This currently doesn't report the failure at the time it occurs, because
1067
983
    # they tend to happen very early in startup when we can't check config
1068
984
    # files etc, and also we want to report all failures but not spam the user
1069
985
    # with 10 warnings.
 
986
    from bzrlib import trace
1070
987
    exception_str = str(exception)
1071
988
    if exception_str not in _extension_load_failures:
1072
989
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1076
993
def report_extension_load_failures():
1077
994
    if not _extension_load_failures:
1078
995
        return
1079
 
    if config.GlobalStack().get('ignore_missing_extensions'):
 
996
    from bzrlib.config import GlobalConfig
 
997
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
1080
998
        return
1081
999
    # the warnings framework should by default show this only once
1082
 
    from .trace import warning
 
1000
    from bzrlib.trace import warning
1083
1001
    warning(
1084
 
        "brz: warning: some compiled extensions could not be loaded; "
 
1002
        "bzr: warning: some compiled extensions could not be loaded; "
1085
1003
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1086
1004
    # we no longer show the specific missing extensions here, because it makes
1087
1005
    # the message too long and scary - see
1089
1007
 
1090
1008
 
1091
1009
try:
1092
 
    from ._chunks_to_lines_pyx import chunks_to_lines
1093
 
except ImportError as e:
 
1010
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
1011
except ImportError, e:
1094
1012
    failed_to_load_extension(e)
1095
 
    from ._chunks_to_lines_py import chunks_to_lines
 
1013
    from bzrlib._chunks_to_lines_py import chunks_to_lines
1096
1014
 
1097
1015
 
1098
1016
def split_lines(s):
1111
1029
 
1112
1030
    This supports Unicode or plain string objects.
1113
1031
    """
1114
 
    nl = b'\n' if isinstance(s, bytes) else u'\n'
1115
 
    lines = s.split(nl)
1116
 
    result = [line + nl for line in lines[:-1]]
 
1032
    lines = s.split('\n')
 
1033
    result = [line + '\n' for line in lines[:-1]]
1117
1034
    if lines[-1]:
1118
1035
        result.append(lines[-1])
1119
1036
    return result
1130
1047
        return
1131
1048
    try:
1132
1049
        os.link(src, dest)
1133
 
    except (OSError, IOError) as e:
 
1050
    except (OSError, IOError), e:
1134
1051
        if e.errno != errno.EXDEV:
1135
1052
            raise
1136
1053
        shutil.copyfile(src, dest)
1137
1054
 
1138
1055
 
1139
1056
def delete_any(path):
1140
 
    """Delete a file, symlink or directory.
1141
 
 
 
1057
    """Delete a file, symlink or directory.  
 
1058
    
1142
1059
    Will delete even if readonly.
1143
1060
    """
1144
1061
    try:
1145
1062
       _delete_file_or_dir(path)
1146
 
    except (OSError, IOError) as e:
 
1063
    except (OSError, IOError), e:
1147
1064
        if e.errno in (errno.EPERM, errno.EACCES):
1148
1065
            # make writable and try again
1149
1066
            try:
1245
1162
 
1246
1163
    if len(base) < MIN_ABS_PATHLENGTH:
1247
1164
        # must have space for e.g. a drive letter
1248
 
        raise ValueError(gettext('%r is too short to calculate a relative path')
 
1165
        raise ValueError('%r is too short to calculate a relative path'
1249
1166
            % (base,))
1250
1167
 
1251
1168
    rp = abspath(path)
1333
1250
    # but for now, we haven't optimized...
1334
1251
    return [canonical_relpath(base, p) for p in paths]
1335
1252
 
1336
 
 
1337
 
def decode_filename(filename):
1338
 
    """Decode the filename using the filesystem encoding
1339
 
 
1340
 
    If it is unicode, it is returned.
1341
 
    Otherwise it is decoded from the the filesystem's encoding. If decoding
1342
 
    fails, a errors.BadFilenameEncoding exception is raised.
1343
 
    """
1344
 
    if isinstance(filename, text_type):
1345
 
        return filename
1346
 
    try:
1347
 
        return filename.decode(_fs_enc)
1348
 
    except UnicodeDecodeError:
1349
 
        raise errors.BadFilenameEncoding(filename, _fs_enc)
1350
 
 
1351
 
 
1352
1253
def safe_unicode(unicode_or_utf8_string):
1353
1254
    """Coerce unicode_or_utf8_string into unicode.
1354
1255
 
1356
1257
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1357
1258
    wrapped in a BzrBadParameterNotUnicode exception.
1358
1259
    """
1359
 
    if isinstance(unicode_or_utf8_string, text_type):
 
1260
    if isinstance(unicode_or_utf8_string, unicode):
1360
1261
        return unicode_or_utf8_string
1361
1262
    try:
1362
1263
        return unicode_or_utf8_string.decode('utf8')
1383
1284
    return unicode_or_utf8_string.encode('utf-8')
1384
1285
 
1385
1286
 
1386
 
def safe_revision_id(unicode_or_utf8_string):
 
1287
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1288
                        ' Revision id generators should be creating utf8'
 
1289
                        ' revision ids.')
 
1290
 
 
1291
 
 
1292
def safe_revision_id(unicode_or_utf8_string, warn=True):
1387
1293
    """Revision ids should now be utf8, but at one point they were unicode.
1388
1294
 
1389
1295
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1390
1296
        utf8 or None).
 
1297
    :param warn: Functions that are sanitizing user data can set warn=False
1391
1298
    :return: None or a utf8 revision id.
1392
1299
    """
1393
1300
    if (unicode_or_utf8_string is None
1394
1301
        or unicode_or_utf8_string.__class__ == str):
1395
1302
        return unicode_or_utf8_string
1396
 
    raise TypeError('Unicode revision ids are no longer supported. '
1397
 
                    'Revision id generators should be creating utf8 revision '
1398
 
                    'ids.')
1399
 
 
1400
 
 
1401
 
def safe_file_id(unicode_or_utf8_string):
 
1303
    if warn:
 
1304
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1305
                               stacklevel=2)
 
1306
    return cache_utf8.encode(unicode_or_utf8_string)
 
1307
 
 
1308
 
 
1309
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1310
                    ' generators should be creating utf8 file ids.')
 
1311
 
 
1312
 
 
1313
def safe_file_id(unicode_or_utf8_string, warn=True):
1402
1314
    """File ids should now be utf8, but at one point they were unicode.
1403
1315
 
1404
1316
    This is the same as safe_utf8, except it uses the cached encode functions
1406
1318
 
1407
1319
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1408
1320
        utf8 or None).
 
1321
    :param warn: Functions that are sanitizing user data can set warn=False
1409
1322
    :return: None or a utf8 file id.
1410
1323
    """
1411
1324
    if (unicode_or_utf8_string is None
1412
1325
        or unicode_or_utf8_string.__class__ == str):
1413
1326
        return unicode_or_utf8_string
1414
 
    raise TypeError('Unicode file ids are no longer supported. '
1415
 
                    'File id generators should be creating utf8 file ids.')
 
1327
    if warn:
 
1328
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1329
                               stacklevel=2)
 
1330
    return cache_utf8.encode(unicode_or_utf8_string)
1416
1331
 
1417
1332
 
1418
1333
_platform_normalizes_filenames = False
1423
1338
def normalizes_filenames():
1424
1339
    """Return True if this platform normalizes unicode filenames.
1425
1340
 
1426
 
    Only Mac OSX.
 
1341
    Mac OSX does, Windows/Linux do not.
1427
1342
    """
1428
1343
    return _platform_normalizes_filenames
1429
1344
 
1434
1349
    On platforms where the system normalizes filenames (Mac OSX),
1435
1350
    you can access a file by any path which will normalize correctly.
1436
1351
    On platforms where the system does not normalize filenames
1437
 
    (everything else), you have to access a file by its exact path.
 
1352
    (Windows, Linux), you have to access a file by its exact path.
1438
1353
 
1439
1354
    Internally, bzr only supports NFC normalization, since that is
1440
1355
    the standard for XML documents.
1502
1417
terminal_width() returns None.
1503
1418
"""
1504
1419
 
1505
 
# Keep some state so that terminal_width can detect if _terminal_size has
1506
 
# returned a different size since the process started.  See docstring and
1507
 
# comments of terminal_width for details.
1508
 
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1509
 
_terminal_size_state = 'no_data'
1510
 
_first_terminal_size = None
1511
1420
 
1512
1421
def terminal_width():
1513
1422
    """Return terminal width.
1515
1424
    None is returned if the width can't established precisely.
1516
1425
 
1517
1426
    The rules are:
1518
 
    - if BRZ_COLUMNS is set, returns its value
 
1427
    - if BZR_COLUMNS is set, returns its value
1519
1428
    - if there is no controlling terminal, returns None
1520
 
    - query the OS, if the queried size has changed since the last query,
1521
 
      return its value,
1522
1429
    - if COLUMNS is set, returns its value,
1523
 
    - if the OS has a value (even though it's never changed), return its value.
1524
1430
 
1525
1431
    From there, we need to query the OS to get the size of the controlling
1526
1432
    terminal.
1527
1433
 
1528
 
    On Unices we query the OS by:
 
1434
    Unices:
1529
1435
    - get termios.TIOCGWINSZ
1530
1436
    - if an error occurs or a negative value is obtained, returns None
1531
1437
 
1532
 
    On Windows we query the OS by:
 
1438
    Windows:
 
1439
    
1533
1440
    - win32utils.get_console_size() decides,
1534
1441
    - returns None on error (provided default value)
1535
1442
    """
1536
 
    # Note to implementors: if changing the rules for determining the width,
1537
 
    # make sure you've considered the behaviour in these cases:
1538
 
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1539
 
    #  - brz log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1540
 
    #    0,0.
1541
 
    #  - (add more interesting cases here, if you find any)
1542
 
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1543
 
    # but we don't want to register a signal handler because it is impossible
1544
 
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
1545
 
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
1546
 
    # time so we can notice if the reported size has changed, which should have
1547
 
    # a similar effect.
1548
1443
 
1549
 
    # If BRZ_COLUMNS is set, take it, user is always right
1550
 
    # Except if they specified 0 in which case, impose no limit here
 
1444
    # If BZR_COLUMNS is set, take it, user is always right
1551
1445
    try:
1552
 
        width = int(os.environ['BRZ_COLUMNS'])
 
1446
        return int(os.environ['BZR_COLUMNS'])
1553
1447
    except (KeyError, ValueError):
1554
 
        width = None
1555
 
    if width is not None:
1556
 
        if width > 0:
1557
 
            return width
1558
 
        else:
1559
 
            return None
 
1448
        pass
1560
1449
 
1561
1450
    isatty = getattr(sys.stdout, 'isatty', None)
1562
 
    if isatty is None or not isatty():
1563
 
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
 
1451
    if  isatty is None or not isatty():
 
1452
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1564
1453
        return None
1565
1454
 
1566
 
    # Query the OS
1567
 
    width, height = os_size = _terminal_size(None, None)
1568
 
    global _first_terminal_size, _terminal_size_state
1569
 
    if _terminal_size_state == 'no_data':
1570
 
        _first_terminal_size = os_size
1571
 
        _terminal_size_state = 'unchanged'
1572
 
    elif (_terminal_size_state == 'unchanged' and
1573
 
          _first_terminal_size != os_size):
1574
 
        _terminal_size_state = 'changed'
1575
 
 
1576
 
    # If the OS claims to know how wide the terminal is, and this value has
1577
 
    # ever changed, use that.
1578
 
    if _terminal_size_state == 'changed':
1579
 
        if width is not None and width > 0:
1580
 
            return width
1581
 
 
1582
 
    # If COLUMNS is set, use it.
 
1455
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1456
    # given terminal, the application can decide to set COLUMNS to a lower
 
1457
    # value (splitted screen) or a bigger value (scroll bars))
1583
1458
    try:
1584
1459
        return int(os.environ['COLUMNS'])
1585
1460
    except (KeyError, ValueError):
1586
1461
        pass
1587
1462
 
1588
 
    # Finally, use an unchanged size from the OS, if we have one.
1589
 
    if _terminal_size_state == 'unchanged':
1590
 
        if width is not None and width > 0:
1591
 
            return width
 
1463
    width, height = _terminal_size(None, None)
 
1464
    if width <= 0:
 
1465
        # Consider invalid values as meaning no width
 
1466
        return None
1592
1467
 
1593
 
    # The width could not be determined.
1594
 
    return None
 
1468
    return width
1595
1469
 
1596
1470
 
1597
1471
def _win32_terminal_size(width, height):
1624
1498
    _terminal_size = _ioctl_terminal_size
1625
1499
 
1626
1500
 
 
1501
def _terminal_size_changed(signum, frame):
 
1502
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1503
    width, height = _terminal_size(None, None)
 
1504
    if width is not None:
 
1505
        os.environ['COLUMNS'] = str(width)
 
1506
 
 
1507
 
 
1508
_registered_sigwinch = False
 
1509
def watch_sigwinch():
 
1510
    """Register for SIGWINCH, once and only once.
 
1511
 
 
1512
    Do nothing if the signal module is not available.
 
1513
    """
 
1514
    global _registered_sigwinch
 
1515
    if not _registered_sigwinch:
 
1516
        try:
 
1517
            import signal
 
1518
            if getattr(signal, "SIGWINCH", None) is not None:
 
1519
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1520
        except ImportError:
 
1521
            # python doesn't provide signal support, nothing we can do about it
 
1522
            pass
 
1523
        _registered_sigwinch = True
 
1524
 
 
1525
 
1627
1526
def supports_executable():
1628
1527
    return sys.platform != "win32"
1629
1528
 
1654
1553
        if orig_val is not None:
1655
1554
            del os.environ[env_variable]
1656
1555
    else:
1657
 
        if not PY3 and isinstance(value, text_type):
 
1556
        if isinstance(value, unicode):
1658
1557
            value = value.encode(get_user_encoding())
1659
1558
        os.environ[env_variable] = value
1660
1559
    return orig_val
1752
1651
        dirblock = []
1753
1652
        append = dirblock.append
1754
1653
        try:
1755
 
            names = sorted(map(decode_filename, _listdir(top)))
1756
 
        except OSError as e:
 
1654
            names = sorted(_listdir(top))
 
1655
        except OSError, e:
1757
1656
            if not _is_error_enotdir(e):
1758
1657
                raise
1759
1658
        else:
1812
1711
    """
1813
1712
    global _selected_dir_reader
1814
1713
    if _selected_dir_reader is None:
1815
 
        if sys.platform == "win32":
 
1714
        fs_encoding = _fs_enc.upper()
 
1715
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1716
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1717
            # TODO: We possibly could support Win98 by falling back to the
 
1718
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1719
            #       but that gets a bit tricky, and requires custom compiling
 
1720
            #       for win98 anyway.
1816
1721
            try:
1817
 
                from ._walkdirs_win32 import Win32ReadDir
 
1722
                from bzrlib._walkdirs_win32 import Win32ReadDir
1818
1723
                _selected_dir_reader = Win32ReadDir()
1819
1724
            except ImportError:
1820
1725
                pass
1821
 
        elif _fs_enc in ('utf-8', 'ascii'):
 
1726
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1727
            # ANSI_X3.4-1968 is a form of ASCII
1822
1728
            try:
1823
 
                from ._readdir_pyx import UTF8DirReader
 
1729
                from bzrlib._readdir_pyx import UTF8DirReader
1824
1730
                _selected_dir_reader = UTF8DirReader()
1825
 
            except ImportError as e:
 
1731
            except ImportError, e:
1826
1732
                failed_to_load_extension(e)
1827
1733
                pass
1828
1734
 
1958
1864
    try:
1959
1865
        s = os.stat(src)
1960
1866
        chown(dst, s.st_uid, s.st_gid)
1961
 
    except OSError as e:
1962
 
        trace.warning(
1963
 
            'Unable to copy ownership from "%s" to "%s". '
1964
 
            'You may want to set it manually.', src, dst)
1965
 
        trace.log_exception_quietly()
 
1867
    except OSError, e:
 
1868
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
1966
1869
 
1967
1870
 
1968
1871
def path_prefix_key(path):
1983
1886
_cached_user_encoding = None
1984
1887
 
1985
1888
 
1986
 
def get_user_encoding():
 
1889
def get_user_encoding(use_cache=True):
1987
1890
    """Find out what the preferred user encoding is.
1988
1891
 
1989
1892
    This is generally the encoding that is used for command line parameters
1990
1893
    and file contents. This may be different from the terminal encoding
1991
1894
    or the filesystem encoding.
1992
1895
 
 
1896
    :param  use_cache:  Enable cache for detected encoding.
 
1897
                        (This parameter is turned on by default,
 
1898
                        and required only for selftesting)
 
1899
 
1993
1900
    :return: A string defining the preferred user encoding
1994
1901
    """
1995
1902
    global _cached_user_encoding
1996
 
    if _cached_user_encoding is not None:
 
1903
    if _cached_user_encoding is not None and use_cache:
1997
1904
        return _cached_user_encoding
1998
1905
 
1999
 
    if os.name == 'posix' and getattr(locale, 'CODESET', None) is not None:
2000
 
        # Use the existing locale settings and call nl_langinfo directly
2001
 
        # rather than going through getpreferredencoding. This avoids
2002
 
        # <http://bugs.python.org/issue6202> on OSX Python 2.6 and the
2003
 
        # possibility of the setlocale call throwing an error.
2004
 
        user_encoding = locale.nl_langinfo(locale.CODESET)
 
1906
    if sys.platform == 'darwin':
 
1907
        # python locale.getpreferredencoding() always return
 
1908
        # 'mac-roman' on darwin. That's a lie.
 
1909
        sys.platform = 'posix'
 
1910
        try:
 
1911
            if os.environ.get('LANG', None) is None:
 
1912
                # If LANG is not set, we end up with 'ascii', which is bad
 
1913
                # ('mac-roman' is more than ascii), so we set a default which
 
1914
                # will give us UTF-8 (which appears to work in all cases on
 
1915
                # OSX). Users are still free to override LANG of course, as
 
1916
                # long as it give us something meaningful. This work-around
 
1917
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1918
                # work with them too -- vila 20080908
 
1919
                os.environ['LANG'] = 'en_US.UTF-8'
 
1920
            import locale
 
1921
        finally:
 
1922
            sys.platform = 'darwin'
2005
1923
    else:
2006
 
        # GZ 2011-12-19: On windows could call GetACP directly instead.
2007
 
        user_encoding = locale.getpreferredencoding(False)
 
1924
        import locale
2008
1925
 
2009
1926
    try:
2010
 
        user_encoding = codecs.lookup(user_encoding).name
2011
 
    except LookupError:
2012
 
        if user_encoding not in ("", "cp0"):
2013
 
            sys.stderr.write('brz: warning:'
 
1927
        user_encoding = locale.getpreferredencoding()
 
1928
    except locale.Error, e:
 
1929
        sys.stderr.write('bzr: warning: %s\n'
 
1930
                         '  Could not determine what text encoding to use.\n'
 
1931
                         '  This error usually means your Python interpreter\n'
 
1932
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1933
                         "  Continuing with ascii encoding.\n"
 
1934
                         % (e, os.environ.get('LANG')))
 
1935
        user_encoding = 'ascii'
 
1936
 
 
1937
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1938
    # treat that as ASCII, and not support printing unicode characters to the
 
1939
    # console.
 
1940
    #
 
1941
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1942
    if user_encoding in (None, 'cp0', ''):
 
1943
        user_encoding = 'ascii'
 
1944
    else:
 
1945
        # check encoding
 
1946
        try:
 
1947
            codecs.lookup(user_encoding)
 
1948
        except LookupError:
 
1949
            sys.stderr.write('bzr: warning:'
2014
1950
                             ' unknown encoding %s.'
2015
1951
                             ' Continuing with ascii encoding.\n'
2016
1952
                             % user_encoding
2017
1953
                            )
2018
 
        user_encoding = 'ascii'
2019
 
    else:
2020
 
        # Get 'ascii' when setlocale has not been called or LANG=C or unset.
2021
 
        if user_encoding == 'ascii':
2022
 
            if sys.platform == 'darwin':
2023
 
                # OSX is special-cased in Python to have a UTF-8 filesystem
2024
 
                # encoding and previously had LANG set here if not present.
2025
 
                user_encoding = 'utf-8'
2026
 
            # GZ 2011-12-19: Maybe UTF-8 should be the default in this case
2027
 
            #                for some other posix platforms as well.
2028
 
 
2029
 
    _cached_user_encoding = user_encoding
 
1954
            user_encoding = 'ascii'
 
1955
 
 
1956
    if use_cache:
 
1957
        _cached_user_encoding = user_encoding
 
1958
 
2030
1959
    return user_encoding
2031
1960
 
2032
1961
 
2033
 
def get_diff_header_encoding():
2034
 
    return get_terminal_encoding()
2035
 
 
2036
 
 
2037
1962
def get_host_name():
2038
1963
    """Return the current unicode host name.
2039
1964
 
2041
1966
    behaves inconsistently on different platforms.
2042
1967
    """
2043
1968
    if sys.platform == "win32":
 
1969
        import win32utils
2044
1970
        return win32utils.get_host_name()
2045
1971
    else:
2046
1972
        import socket
2047
 
        if PY3:
2048
 
            return socket.gethostname()
2049
1973
        return socket.gethostname().decode(get_user_encoding())
2050
1974
 
2051
1975
 
2055
1979
# data at once.
2056
1980
MAX_SOCKET_CHUNK = 64 * 1024
2057
1981
 
2058
 
_end_of_stream_errors = [errno.ECONNRESET, errno.EPIPE, errno.EINVAL]
2059
 
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
2060
 
    _eno = getattr(errno, _eno, None)
2061
 
    if _eno is not None:
2062
 
        _end_of_stream_errors.append(_eno)
2063
 
del _eno
2064
 
 
2065
 
 
2066
1982
def read_bytes_from_socket(sock, report_activity=None,
2067
1983
        max_read_size=MAX_SOCKET_CHUNK):
2068
1984
    """Read up to max_read_size of bytes from sock and notify of progress.
2071
1987
    empty string rather than raise an error), and repeats the recv if
2072
1988
    interrupted by a signal.
2073
1989
    """
2074
 
    while True:
 
1990
    while 1:
2075
1991
        try:
2076
1992
            bytes = sock.recv(max_read_size)
2077
 
        except socket.error as e:
 
1993
        except socket.error, e:
2078
1994
            eno = e.args[0]
2079
 
            if eno in _end_of_stream_errors:
 
1995
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
2080
1996
                # The connection was closed by the other side.  Callers expect
2081
1997
                # an empty string to signal end-of-stream.
2082
1998
                return ""
2111
2027
 
2112
2028
def send_all(sock, bytes, report_activity=None):
2113
2029
    """Send all bytes on a socket.
2114
 
 
 
2030
 
2115
2031
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2116
2032
    some platforms, and catches EINTR which may be thrown if the send is
2117
2033
    interrupted by a signal.
2118
2034
 
2119
2035
    This is preferred to socket.sendall(), because it avoids portability bugs
2120
2036
    and provides activity reporting.
2121
 
 
 
2037
 
2122
2038
    :param report_activity: Call this as bytes are read, see
2123
2039
        Transport._report_activity
2124
2040
    """
2125
2041
    sent_total = 0
2126
2042
    byte_count = len(bytes)
2127
 
    view = memoryview(bytes)
2128
2043
    while sent_total < byte_count:
2129
2044
        try:
2130
 
            sent = sock.send(view[sent_total:sent_total+MAX_SOCKET_CHUNK])
2131
 
        except (socket.error, IOError) as e:
2132
 
            if e.args[0] in _end_of_stream_errors:
2133
 
                raise errors.ConnectionReset(
2134
 
                    "Error trying to write to socket", e)
 
2045
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2046
        except socket.error, e:
2135
2047
            if e.args[0] != errno.EINTR:
2136
2048
                raise
2137
2049
        else:
2138
 
            if sent == 0:
2139
 
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
2140
 
                                             % (sock,))
2141
2050
            sent_total += sent
2142
 
            if report_activity is not None:
2143
 
                report_activity(sent, 'write')
2144
 
 
2145
 
 
2146
 
def connect_socket(address):
2147
 
    # Slight variation of the socket.create_connection() function (provided by
2148
 
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
2149
 
    # provide it for previous python versions. Also, we don't use the timeout
2150
 
    # parameter (provided by the python implementation) so we don't implement
2151
 
    # it either).
2152
 
    err = socket.error('getaddrinfo returns an empty list')
2153
 
    host, port = address
2154
 
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
2155
 
        af, socktype, proto, canonname, sa = res
2156
 
        sock = None
2157
 
        try:
2158
 
            sock = socket.socket(af, socktype, proto)
2159
 
            sock.connect(sa)
2160
 
            return sock
2161
 
 
2162
 
        except socket.error as err:
2163
 
            # 'err' is now the most recent error
2164
 
            if sock is not None:
2165
 
                sock.close()
2166
 
    raise err
 
2051
            report_activity(sent, 'write')
2167
2052
 
2168
2053
 
2169
2054
def dereference_path(path):
2188
2073
def resource_string(package, resource_name):
2189
2074
    """Load a resource from a package and return it as a string.
2190
2075
 
2191
 
    Note: Only packages that start with breezy are currently supported.
 
2076
    Note: Only packages that start with bzrlib are currently supported.
2192
2077
 
2193
2078
    This is designed to be a lightweight implementation of resource
2194
2079
    loading in a way which is API compatible with the same API from
2197
2082
    If and when pkg_resources becomes a standard library, this routine
2198
2083
    can delegate to it.
2199
2084
    """
2200
 
    # Check package name is within breezy
2201
 
    if package == "breezy":
 
2085
    # Check package name is within bzrlib
 
2086
    if package == "bzrlib":
2202
2087
        resource_relpath = resource_name
2203
 
    elif package.startswith("breezy."):
2204
 
        package = package[len("breezy."):].replace('.', os.sep)
 
2088
    elif package.startswith("bzrlib."):
 
2089
        package = package[len("bzrlib."):].replace('.', os.sep)
2205
2090
        resource_relpath = pathjoin(package, resource_name)
2206
2091
    else:
2207
 
        raise errors.BzrError('resource package %s not in breezy' % package)
 
2092
        raise errors.BzrError('resource package %s not in bzrlib' % package)
2208
2093
 
2209
2094
    # Map the resource to a file and read its contents
2210
 
    base = dirname(breezy.__file__)
 
2095
    base = dirname(bzrlib.__file__)
2211
2096
    if getattr(sys, 'frozen', None):    # bzr.exe
2212
2097
        base = abspath(pathjoin(base, '..', '..'))
2213
 
    f = file(pathjoin(base, resource_relpath), "rU")
2214
 
    try:
2215
 
        return f.read()
2216
 
    finally:
2217
 
        f.close()
 
2098
    filename = pathjoin(base, resource_relpath)
 
2099
    return open(filename, 'rU').read()
 
2100
 
2218
2101
 
2219
2102
def file_kind_from_stat_mode_thunk(mode):
2220
2103
    global file_kind_from_stat_mode
2221
2104
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2222
2105
        try:
2223
 
            from ._readdir_pyx import UTF8DirReader
 
2106
            from bzrlib._readdir_pyx import UTF8DirReader
2224
2107
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2225
 
        except ImportError as e:
 
2108
        except ImportError, e:
2226
2109
            # This is one time where we won't warn that an extension failed to
2227
2110
            # load. The extension is never available on Windows anyway.
2228
 
            from ._readdir_py import (
 
2111
            from bzrlib._readdir_py import (
2229
2112
                _kind_from_mode as file_kind_from_stat_mode
2230
2113
                )
2231
2114
    return file_kind_from_stat_mode(mode)
2232
2115
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2233
2116
 
2234
 
def file_stat(f, _lstat=os.lstat):
 
2117
 
 
2118
def file_kind(f, _lstat=os.lstat):
2235
2119
    try:
2236
 
        # XXX cache?
2237
 
        return _lstat(f)
2238
 
    except OSError as e:
 
2120
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
2121
    except OSError, e:
2239
2122
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2240
2123
            raise errors.NoSuchFile(f)
2241
2124
        raise
2242
2125
 
2243
 
def file_kind(f, _lstat=os.lstat):
2244
 
    stat_value = file_stat(f, _lstat)
2245
 
    return file_kind_from_stat_mode(stat_value.st_mode)
2246
2126
 
2247
2127
def until_no_eintr(f, *a, **kw):
2248
2128
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2249
 
 
 
2129
    
2250
2130
    WARNING: you must be certain that it is safe to retry the call repeatedly
2251
2131
    if EINTR does occur.  This is typically only true for low-level operations
2252
2132
    like os.read.  If in any doubt, don't use this.
2254
2134
    Keep in mind that this is not a complete solution to EINTR.  There is
2255
2135
    probably code in the Python standard library and other dependencies that
2256
2136
    may encounter EINTR if a signal arrives (and there is signal handler for
2257
 
    that signal).  So this function can reduce the impact for IO that breezy
 
2137
    that signal).  So this function can reduce the impact for IO that bzrlib
2258
2138
    directly controls, but it is not a complete solution.
2259
2139
    """
2260
2140
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2261
2141
    while True:
2262
2142
        try:
2263
2143
            return f(*a, **kw)
2264
 
        except (IOError, OSError) as e:
 
2144
        except (IOError, OSError), e:
2265
2145
            if e.errno == errno.EINTR:
2266
2146
                continue
2267
2147
            raise
2268
2148
 
2269
2149
 
 
2150
def re_compile_checked(re_string, flags=0, where=""):
 
2151
    """Return a compiled re, or raise a sensible error.
 
2152
 
 
2153
    This should only be used when compiling user-supplied REs.
 
2154
 
 
2155
    :param re_string: Text form of regular expression.
 
2156
    :param flags: eg re.IGNORECASE
 
2157
    :param where: Message explaining to the user the context where
 
2158
        it occurred, eg 'log search filter'.
 
2159
    """
 
2160
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2161
    try:
 
2162
        re_obj = re.compile(re_string, flags)
 
2163
        re_obj.search("")
 
2164
        return re_obj
 
2165
    except re.error, e:
 
2166
        if where:
 
2167
            where = ' in ' + where
 
2168
        # despite the name 'error' is a type
 
2169
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2170
            % (where, re_string, e))
 
2171
 
 
2172
 
2270
2173
if sys.platform == "win32":
 
2174
    import msvcrt
2271
2175
    def getchar():
2272
 
        import msvcrt
2273
2176
        return msvcrt.getch()
2274
2177
else:
 
2178
    import tty
 
2179
    import termios
2275
2180
    def getchar():
2276
 
        import tty
2277
 
        import termios
2278
2181
        fd = sys.stdin.fileno()
2279
2182
        settings = termios.tcgetattr(fd)
2280
2183
        try:
2284
2187
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2285
2188
        return ch
2286
2189
 
2287
 
if sys.platform.startswith('linux'):
 
2190
 
 
2191
if sys.platform == 'linux2':
2288
2192
    def _local_concurrency():
2289
 
        try:
2290
 
            return os.sysconf('SC_NPROCESSORS_ONLN')
2291
 
        except (ValueError, OSError, AttributeError):
2292
 
            return None
 
2193
        concurrency = None
 
2194
        prefix = 'processor'
 
2195
        for line in file('/proc/cpuinfo', 'rb'):
 
2196
            if line.startswith(prefix):
 
2197
                concurrency = int(line[line.find(':')+1:]) + 1
 
2198
        return concurrency
2293
2199
elif sys.platform == 'darwin':
2294
2200
    def _local_concurrency():
2295
2201
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2296
2202
                                stdout=subprocess.PIPE).communicate()[0]
2297
 
elif "bsd" in sys.platform:
 
2203
elif sys.platform[0:7] == 'freebsd':
2298
2204
    def _local_concurrency():
2299
2205
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2300
2206
                                stdout=subprocess.PIPE).communicate()[0]
2325
2231
    if _cached_local_concurrency is not None and use_cache:
2326
2232
        return _cached_local_concurrency
2327
2233
 
2328
 
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
 
2234
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2329
2235
    if concurrency is None:
2330
2236
        try:
2331
 
            import multiprocessing
2332
 
            concurrency = multiprocessing.cpu_count()
2333
 
        except (ImportError, NotImplementedError):
2334
 
            # multiprocessing is only available on Python >= 2.6
2335
 
            # and multiprocessing.cpu_count() isn't implemented on all
2336
 
            # platforms
2337
 
            try:
2338
 
                concurrency = _local_concurrency()
2339
 
            except (OSError, IOError):
2340
 
                pass
 
2237
            concurrency = _local_concurrency()
 
2238
        except (OSError, IOError):
 
2239
            pass
2341
2240
    try:
2342
2241
        concurrency = int(concurrency)
2343
2242
    except (TypeError, ValueError):
2355
2254
        self.encode = encode
2356
2255
 
2357
2256
    def write(self, object):
2358
 
        if isinstance(object, str):
 
2257
        if type(object) is str:
2359
2258
            self.stream.write(object)
2360
2259
        else:
2361
2260
            data, _ = self.encode(object, self.errors)
2364
2263
if sys.platform == 'win32':
2365
2264
    def open_file(filename, mode='r', bufsize=-1):
2366
2265
        """This function is used to override the ``open`` builtin.
2367
 
 
 
2266
        
2368
2267
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2369
2268
        child processes.  Deleting or renaming a closed file opened with this
2370
2269
        function is not blocking child processes.
2403
2302
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2404
2303
else:
2405
2304
    open_file = open
2406
 
 
2407
 
 
2408
 
def available_backup_name(base, exists):
2409
 
    """Find a non-existing backup file name.
2410
 
 
2411
 
    This will *not* create anything, this only return a 'free' entry.  This
2412
 
    should be used for checking names in a directory below a locked
2413
 
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
2414
 
    Leap) and generally discouraged.
2415
 
 
2416
 
    :param base: The base name.
2417
 
 
2418
 
    :param exists: A callable returning True if the path parameter exists.
2419
 
    """
2420
 
    counter = 1
2421
 
    name = "%s.~%d~" % (base, counter)
2422
 
    while exists(name):
2423
 
        counter += 1
2424
 
        name = "%s.~%d~" % (base, counter)
2425
 
    return name
2426
 
 
2427
 
 
2428
 
def set_fd_cloexec(fd):
2429
 
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
2430
 
    support for this is not available.
2431
 
    """
2432
 
    try:
2433
 
        import fcntl
2434
 
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
2435
 
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
2436
 
    except (ImportError, AttributeError):
2437
 
        # Either the fcntl module or specific constants are not present
2438
 
        pass
2439
 
 
2440
 
 
2441
 
def find_executable_on_path(name):
2442
 
    """Finds an executable on the PATH.
2443
 
    
2444
 
    On Windows, this will try to append each extension in the PATHEXT
2445
 
    environment variable to the name, if it cannot be found with the name
2446
 
    as given.
2447
 
    
2448
 
    :param name: The base name of the executable.
2449
 
    :return: The path to the executable found or None.
2450
 
    """
2451
 
    if sys.platform == 'win32':
2452
 
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
2453
 
        exts = [ext.lower() for ext in exts]
2454
 
        base, ext = os.path.splitext(name)
2455
 
        if ext != '':
2456
 
            if ext.lower() not in exts:
2457
 
                return None
2458
 
            name = base
2459
 
            exts = [ext]
2460
 
    else:
2461
 
        exts = ['']
2462
 
    path = os.environ.get('PATH')
2463
 
    if path is not None:
2464
 
        path = path.split(os.pathsep)
2465
 
        for ext in exts:
2466
 
            for d in path:
2467
 
                f = os.path.join(d, name) + ext
2468
 
                if os.access(f, os.X_OK):
2469
 
                    return f
2470
 
    if sys.platform == 'win32':
2471
 
        app_path = win32utils.get_app_path(name)
2472
 
        if app_path != name:
2473
 
            return app_path
2474
 
    return None
2475
 
 
2476
 
 
2477
 
def _posix_is_local_pid_dead(pid):
2478
 
    """True if pid doesn't correspond to live process on this machine"""
2479
 
    try:
2480
 
        # Special meaning of unix kill: just check if it's there.
2481
 
        os.kill(pid, 0)
2482
 
    except OSError as e:
2483
 
        if e.errno == errno.ESRCH:
2484
 
            # On this machine, and really not found: as sure as we can be
2485
 
            # that it's dead.
2486
 
            return True
2487
 
        elif e.errno == errno.EPERM:
2488
 
            # exists, though not ours
2489
 
            return False
2490
 
        else:
2491
 
            mutter("os.kill(%d, 0) failed: %s" % (pid, e))
2492
 
            # Don't really know.
2493
 
            return False
2494
 
    else:
2495
 
        # Exists and our process: not dead.
2496
 
        return False
2497
 
 
2498
 
if sys.platform == "win32":
2499
 
    is_local_pid_dead = win32utils.is_local_pid_dead
2500
 
else:
2501
 
    is_local_pid_dead = _posix_is_local_pid_dead
2502
 
 
2503
 
_maybe_ignored = ['EAGAIN', 'EINTR', 'ENOTSUP', 'EOPNOTSUPP', 'EACCES']
2504
 
_fdatasync_ignored = [getattr(errno, name) for name in _maybe_ignored
2505
 
                      if getattr(errno, name, None) is not None]
2506
 
 
2507
 
 
2508
 
def fdatasync(fileno):
2509
 
    """Flush file contents to disk if possible.
2510
 
    
2511
 
    :param fileno: Integer OS file handle.
2512
 
    :raises TransportNotPossible: If flushing to disk is not possible.
2513
 
    """
2514
 
    fn = getattr(os, 'fdatasync', getattr(os, 'fsync', None))
2515
 
    if fn is not None:
2516
 
        try:
2517
 
            fn(fileno)
2518
 
        except IOError as e:
2519
 
            # See bug #1075108, on some platforms fdatasync exists, but can
2520
 
            # raise ENOTSUP. However, we are calling fdatasync to be helpful
2521
 
            # and reduce the chance of corruption-on-powerloss situations. It
2522
 
            # is not a mandatory call, so it is ok to suppress failures.
2523
 
            trace.mutter("ignoring error calling fdatasync: %s" % (e,))
2524
 
            if getattr(e, 'errno', None) not in _fdatasync_ignored:
2525
 
                raise
2526
 
 
2527
 
 
2528
 
def ensure_empty_directory_exists(path, exception_class):
2529
 
    """Make sure a local directory exists and is empty.
2530
 
    
2531
 
    If it does not exist, it is created.  If it exists and is not empty, an
2532
 
    instance of exception_class is raised.
2533
 
    """
2534
 
    try:
2535
 
        os.mkdir(path)
2536
 
    except OSError as e:
2537
 
        if e.errno != errno.EEXIST:
2538
 
            raise
2539
 
        if os.listdir(path) != []:
2540
 
            raise exception_class(path)
2541
 
 
2542
 
 
2543
 
def is_environment_error(evalue):
2544
 
    """True if exception instance is due to a process environment issue
2545
 
 
2546
 
    This includes OSError and IOError, but also other errors that come from
2547
 
    the operating system or core libraries but are not subclasses of those.
2548
 
    """
2549
 
    if isinstance(evalue, (EnvironmentError, select.error)):
2550
 
        return True
2551
 
    if sys.platform == "win32" and win32utils._is_pywintypes_error(evalue):
2552
 
        return True
2553
 
    return False