/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 breezy/osutils.py

  • Committer: Martin
  • Date: 2017-06-10 01:57:00 UTC
  • mto: This revision was merged to the branch mainline in revision 6679.
  • Revision ID: gzlist@googlemail.com-20170610015700-o3xeuyaqry2obiay
Go back to native str for urls and many other py3 changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/osutils.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
17
20
import os
18
21
import re
19
22
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
23
import sys
22
24
import time
23
25
import codecs
24
26
 
25
 
from bzrlib.lazy_import import lazy_import
 
27
from .lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
from datetime import datetime
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
 
                    )
 
30
from datetime import timedelta
 
31
import getpass
 
32
import locale
 
33
import ntpath
35
34
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
36
38
import shutil
37
 
from shutil import (
38
 
    rmtree,
39
 
    )
 
39
from shutil import rmtree
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
42
44
import tempfile
43
 
from tempfile import (
44
 
    mkdtemp,
45
 
    )
 
45
from tempfile import mkdtemp
46
46
import unicodedata
47
47
 
48
 
from bzrlib import (
49
 
    cache_utf8,
 
48
from breezy import (
 
49
    config,
50
50
    errors,
51
51
    trace,
52
52
    win32utils,
53
53
    )
 
54
from breezy.i18n import gettext
54
55
""")
55
56
 
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
 
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
77
70
 
78
71
 
79
72
# Cross platform wall-clock time functionality with decent resolution.
97
90
 
98
91
 
99
92
def get_unicode_argv():
 
93
    if PY3:
 
94
        return sys.argv[1:]
100
95
    try:
101
96
        user_encoding = get_user_encoding()
102
97
        return [a.decode(user_encoding) for a in sys.argv[1:]]
103
98
    except UnicodeDecodeError:
104
 
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
105
 
                                                            "encoding." % a))
 
99
        raise errors.BzrError(gettext("Parameter {0!r} encoding is unsupported by {1} "
 
100
            "application locale.").format(a, user_encoding))
106
101
 
107
102
 
108
103
def make_readonly(filename):
109
104
    """Make a filename read-only."""
110
105
    mod = os.lstat(filename).st_mode
111
106
    if not stat.S_ISLNK(mod):
112
 
        mod = mod & 0777555
113
 
        os.chmod(filename, mod)
 
107
        mod = mod & 0o777555
 
108
        chmod_if_possible(filename, mod)
114
109
 
115
110
 
116
111
def make_writable(filename):
117
112
    mod = os.lstat(filename).st_mode
118
113
    if not stat.S_ISLNK(mod):
119
 
        mod = mod | 0200
120
 
        os.chmod(filename, 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
121
135
 
122
136
 
123
137
def minimum_path_selection(paths):
198
212
            stat = getattr(os, 'lstat', os.stat)
199
213
            stat(f)
200
214
            return True
201
 
        except OSError, e:
 
215
        except OSError as e:
202
216
            if e.errno == errno.ENOENT:
203
217
                return False;
204
218
            else:
205
 
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
219
                raise errors.BzrError(gettext("lstat/stat of ({0!r}): {1!r}").format(f, e))
206
220
 
207
221
 
208
222
def fancy_rename(old, new, rename_func, unlink_func):
232
246
    file_existed = False
233
247
    try:
234
248
        rename_func(new, tmp_name)
235
 
    except (errors.NoSuchFile,), e:
 
249
    except (errors.NoSuchFile,) as e:
236
250
        pass
237
 
    except IOError, e:
 
251
    except IOError as e:
238
252
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
239
253
        # function raises an IOError with errno is None when a rename fails.
240
254
        # This then gets caught here.
241
255
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
242
256
            raise
243
 
    except Exception, e:
 
257
    except Exception as e:
244
258
        if (getattr(e, 'errno', None) is None
245
259
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
246
260
            raise
247
261
    else:
248
262
        file_existed = True
249
263
 
250
 
    failure_exc = None
251
264
    success = False
252
265
    try:
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
 
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
268
281
    finally:
269
282
        if file_existed:
270
283
            # If the file used to exist, rename it back into place
273
286
                unlink_func(tmp_name)
274
287
            else:
275
288
                rename_func(tmp_name, new)
276
 
    if failure_exc is not None:
277
 
        raise failure_exc[0], failure_exc[1], failure_exc[2]
278
289
 
279
290
 
280
291
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
281
292
# choke on a Unicode string containing a relative path if
282
293
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
283
294
# string.
284
 
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
285
295
def _posix_abspath(path):
286
296
    # jam 20060426 rather than encoding to fsencoding
287
297
    # copy posixpath.abspath, but use os.getcwdu instead
288
298
    if not posixpath.isabs(path):
289
299
        path = posixpath.join(getcwd(), path)
290
 
    return posixpath.normpath(path)
 
300
    return _posix_normpath(path)
291
301
 
292
302
 
293
303
def _posix_realpath(path):
294
304
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
295
305
 
296
306
 
 
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
 
297
362
def _win32_fixdrive(path):
298
363
    """Force drive letters to be consistent.
299
364
 
303
368
    running python.exe under cmd.exe return capital C:\\
304
369
    running win32 python inside a cygwin shell returns lowercase c:\\
305
370
    """
306
 
    drive, path = _nt_splitdrive(path)
 
371
    drive, path = ntpath.splitdrive(path)
307
372
    return drive.upper() + path
308
373
 
309
374
 
310
375
def _win32_abspath(path):
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('\\', '/'))
 
376
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
377
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
340
378
 
341
379
 
342
380
def _win32_realpath(path):
343
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
344
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
381
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
382
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
383
 
346
384
 
347
385
def _win32_pathjoin(*args):
348
 
    return _nt_join(*args).replace('\\', '/')
 
386
    return ntpath.join(*args).replace('\\', '/')
349
387
 
350
388
 
351
389
def _win32_normpath(path):
352
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
390
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
353
391
 
354
392
 
355
393
def _win32_getcwd():
356
 
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
394
    return _win32_fixdrive(_getcwd().replace('\\', '/'))
357
395
 
358
396
 
359
397
def _win32_mkdtemp(*args, **kwargs):
360
398
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
399
 
362
400
 
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
 
 
371
401
def _win32_rename(old, new):
372
402
    """We expect to be able to atomically replace 'new' with old.
373
403
 
375
405
    and then deleted.
376
406
    """
377
407
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
379
 
    except OSError, e:
 
408
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
409
    except OSError as e:
380
410
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
411
            # If we try to rename a non-existant file onto cwd, we get
382
412
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
386
416
        raise
387
417
 
388
418
 
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
 
 
399
419
def _mac_getcwd():
400
 
    return unicodedata.normalize('NFC', os.getcwdu())
401
 
 
 
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)
402
452
 
403
453
# Default is to just use the python builtins, but these can be rebound on
404
454
# particular platforms.
405
455
abspath = _posix_abspath
406
456
realpath = _posix_realpath
407
457
pathjoin = os.path.join
408
 
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
 
getcwd = os.getcwdu
 
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
411
463
dirname = os.path.dirname
412
464
basename = os.path.basename
413
465
split = os.path.split
414
466
splitext = os.path.splitext
415
 
# These were already imported into local scope
 
467
# These were already lazily imported into local scope
416
468
# mkdtemp = tempfile.mkdtemp
417
469
# rmtree = shutil.rmtree
 
470
lstat = os.lstat
 
471
fstat = os.fstat
 
472
 
 
473
def wrap_stat(st):
 
474
    return st
 
475
 
418
476
 
419
477
MIN_ABS_PATHLENGTH = 1
420
478
 
421
479
 
422
480
if sys.platform == 'win32':
423
 
    if win32utils.winver == 'Windows 98':
424
 
        abspath = _win98_abspath
425
 
    else:
426
 
        abspath = _win32_abspath
 
481
    abspath = _win32_abspath
427
482
    realpath = _win32_realpath
428
483
    pathjoin = _win32_pathjoin
429
484
    normpath = _win32_normpath
430
485
    getcwd = _win32_getcwd
431
486
    mkdtemp = _win32_mkdtemp
432
 
    rename = _win32_rename
 
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
433
496
 
434
497
    MIN_ABS_PATHLENGTH = 3
435
498
 
453
516
    f = win32utils.get_unicode_argv     # special function or None
454
517
    if f is not None:
455
518
        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
456
522
 
457
523
elif sys.platform == 'darwin':
458
524
    getcwd = _mac_getcwd
459
525
 
460
526
 
461
 
def get_terminal_encoding():
 
527
def get_terminal_encoding(trace=False):
462
528
    """Find the best encoding for printing to the screen.
463
529
 
464
530
    This attempts to check both sys.stdout and sys.stdin to see
470
536
 
471
537
    On my standard US Windows XP, the preferred encoding is
472
538
    cp1252, but the console is cp437
 
539
 
 
540
    :param trace: If True trace the selected encoding via mutter().
473
541
    """
474
 
    from bzrlib.trace import mutter
 
542
    from .trace import mutter
475
543
    output_encoding = getattr(sys.stdout, 'encoding', None)
476
544
    if not output_encoding:
477
545
        input_encoding = getattr(sys.stdin, 'encoding', None)
478
546
        if not input_encoding:
479
547
            output_encoding = get_user_encoding()
480
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
548
            if trace:
 
549
                mutter('encoding stdout as osutils.get_user_encoding() %r',
481
550
                   output_encoding)
482
551
        else:
483
552
            output_encoding = input_encoding
484
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
553
            if trace:
 
554
                mutter('encoding stdout as sys.stdin encoding %r',
 
555
                    output_encoding)
485
556
    else:
486
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
557
        if trace:
 
558
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
559
    if output_encoding == 'cp0':
488
560
        # invalid encoding (cp0 means 'no codepage' on Windows)
489
561
        output_encoding = get_user_encoding()
490
 
        mutter('cp0 is invalid encoding.'
 
562
        if trace:
 
563
            mutter('cp0 is invalid encoding.'
491
564
               ' encoding stdout as osutils.get_user_encoding() %r',
492
565
               output_encoding)
493
566
    # check encoding
494
567
    try:
495
568
        codecs.lookup(output_encoding)
496
569
    except LookupError:
497
 
        sys.stderr.write('bzr: warning:'
 
570
        sys.stderr.write('brz: warning:'
498
571
                         ' unknown terminal encoding %s.\n'
499
572
                         '  Using encoding %s instead.\n'
500
573
                         % (output_encoding, get_user_encoding())
519
592
def isdir(f):
520
593
    """True if f is an accessible directory."""
521
594
    try:
522
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
595
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
523
596
    except OSError:
524
597
        return False
525
598
 
527
600
def isfile(f):
528
601
    """True if f is a regular file."""
529
602
    try:
530
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
603
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
531
604
    except OSError:
532
605
        return False
533
606
 
534
607
def islink(f):
535
608
    """True if f is a symlink."""
536
609
    try:
537
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
610
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
538
611
    except OSError:
539
612
        return False
540
613
 
637
710
    # drives).
638
711
    if not segment_size:
639
712
        segment_size = 5242880 # 5MB
640
 
    segments = range(len(bytes) / segment_size + 1)
 
713
    offsets = range(0, len(bytes), segment_size)
 
714
    view = memoryview(bytes)
641
715
    write = file_handle.write
642
 
    for segment_index in segments:
643
 
        segment = buffer(bytes, segment_index * segment_size, segment_size)
644
 
        write(segment)
 
716
    for offset in offsets:
 
717
        write(view[offset:offset+segment_size])
645
718
 
646
719
 
647
720
def file_iterator(input_file, readsize=32768):
702
775
def sha_strings(strings, _factory=sha):
703
776
    """Return the sha-1 of concatenation of strings"""
704
777
    s = _factory()
705
 
    map(s.update, strings)
 
778
    for string in strings:
 
779
        s.update(string)
706
780
    return s.hexdigest()
707
781
 
708
782
 
728
802
            return True
729
803
 
730
804
 
 
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
 
731
815
def local_time_offset(t=None):
732
816
    """Return offset of local zone from GMT, either at present or at time t."""
733
817
    if t is None:
773
857
    """
774
858
    if offset is None:
775
859
        offset = 0
776
 
    tt = time.gmtime(t + offset)
 
860
    tt = gmtime(t + offset)
777
861
    date_fmt = _default_format_by_weekday_num[tt[6]]
778
862
    date_str = time.strftime(date_fmt, tt)
779
863
    offset_str = _cache.get(offset, None)
798
882
    (date_fmt, tt, offset_str) = \
799
883
               _format_date(t, offset, timezone, date_fmt, show_offset)
800
884
    date_str = time.strftime(date_fmt, tt)
801
 
    if not isinstance(date_str, unicode):
 
885
    if not isinstance(date_str, text_type):
802
886
        date_str = date_str.decode(get_user_encoding(), 'replace')
803
887
    return date_str + offset_str
804
888
 
805
889
 
806
890
def _format_date(t, offset, timezone, date_fmt, show_offset):
807
891
    if timezone == 'utc':
808
 
        tt = time.gmtime(t)
 
892
        tt = gmtime(t)
809
893
        offset = 0
810
894
    elif timezone == 'original':
811
895
        if offset is None:
812
896
            offset = 0
813
 
        tt = time.gmtime(t + offset)
 
897
        tt = gmtime(t + offset)
814
898
    elif timezone == 'local':
815
899
        tt = time.localtime(t)
816
900
        offset = local_time_offset(t)
826
910
 
827
911
 
828
912
def compact_date(when):
829
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
913
    return time.strftime('%Y%m%d%H%M%S', gmtime(when))
830
914
 
831
915
 
832
916
def format_delta(delta):
880
964
 
881
965
def filesize(f):
882
966
    """Return size of given open file."""
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
 
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":
895
977
    try:
896
 
        rand_bytes = file('/dev/urandom', 'rb').read
897
 
    # Otherwise, use this hack as a last resort
898
 
    except (IOError, OSError):
 
978
        rand_bytes(1)
 
979
    except NotImplementedError:
899
980
        # not well seeded, but better than nothing
900
981
        def rand_bytes(n):
901
982
            import random
915
996
    """
916
997
    s = ''
917
998
    for raw_byte in rand_bytes(num):
918
 
        s += ALNUM[ord(raw_byte) % 36]
 
999
        if not PY3:
 
1000
            s += ALNUM[ord(raw_byte) % 36]
 
1001
        else:
 
1002
            s += ALNUM[raw_byte % 36]
919
1003
    return s
920
1004
 
921
1005
 
931
1015
    rps = []
932
1016
    for f in ps:
933
1017
        if f == '..':
934
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1018
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
935
1019
        elif (f == '.') or (f == ''):
936
1020
            pass
937
1021
        else:
942
1026
def joinpath(p):
943
1027
    for f in p:
944
1028
        if (f == '..') or (f is None) or (f == ''):
945
 
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
1029
            raise errors.BzrError(gettext("sorry, %r not allowed in path") % f)
946
1030
    return pathjoin(*p)
947
1031
 
948
1032
 
949
1033
def parent_directories(filename):
950
1034
    """Return the list of parent directories, deepest first.
951
 
    
 
1035
 
952
1036
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
953
1037
    """
954
1038
    parents = []
970
1054
    implementation should be loaded instead::
971
1055
 
972
1056
    >>> try:
973
 
    >>>     import bzrlib._fictional_extension_pyx
 
1057
    >>>     import breezy._fictional_extension_pyx
974
1058
    >>> except ImportError, e:
975
 
    >>>     bzrlib.osutils.failed_to_load_extension(e)
976
 
    >>>     import bzrlib._fictional_extension_py
 
1059
    >>>     breezy.osutils.failed_to_load_extension(e)
 
1060
    >>>     import breezy._fictional_extension_py
977
1061
    """
978
1062
    # NB: This docstring is just an example, not a doctest, because doctest
979
1063
    # currently can't cope with the use of lazy imports in this namespace --
980
1064
    # mbp 20090729
981
 
    
 
1065
 
982
1066
    # This currently doesn't report the failure at the time it occurs, because
983
1067
    # they tend to happen very early in startup when we can't check config
984
1068
    # files etc, and also we want to report all failures but not spam the user
985
1069
    # with 10 warnings.
986
 
    from bzrlib import trace
987
1070
    exception_str = str(exception)
988
1071
    if exception_str not in _extension_load_failures:
989
1072
        trace.mutter("failed to load compiled extension: %s" % exception_str)
993
1076
def report_extension_load_failures():
994
1077
    if not _extension_load_failures:
995
1078
        return
996
 
    from bzrlib.config import GlobalConfig
997
 
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
1079
    if config.GlobalStack().get('ignore_missing_extensions'):
998
1080
        return
999
1081
    # the warnings framework should by default show this only once
1000
 
    from bzrlib.trace import warning
 
1082
    from .trace import warning
1001
1083
    warning(
1002
 
        "bzr: warning: some compiled extensions could not be loaded; "
 
1084
        "brz: warning: some compiled extensions could not be loaded; "
1003
1085
        "see <https://answers.launchpad.net/bzr/+faq/703>")
1004
1086
    # we no longer show the specific missing extensions here, because it makes
1005
1087
    # the message too long and scary - see
1007
1089
 
1008
1090
 
1009
1091
try:
1010
 
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
1011
 
except ImportError, e:
 
1092
    from ._chunks_to_lines_pyx import chunks_to_lines
 
1093
except ImportError as e:
1012
1094
    failed_to_load_extension(e)
1013
 
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
1095
    from ._chunks_to_lines_py import chunks_to_lines
1014
1096
 
1015
1097
 
1016
1098
def split_lines(s):
1029
1111
 
1030
1112
    This supports Unicode or plain string objects.
1031
1113
    """
1032
 
    lines = s.split('\n')
1033
 
    result = [line + '\n' for line in lines[:-1]]
 
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]]
1034
1117
    if lines[-1]:
1035
1118
        result.append(lines[-1])
1036
1119
    return result
1047
1130
        return
1048
1131
    try:
1049
1132
        os.link(src, dest)
1050
 
    except (OSError, IOError), e:
 
1133
    except (OSError, IOError) as e:
1051
1134
        if e.errno != errno.EXDEV:
1052
1135
            raise
1053
1136
        shutil.copyfile(src, dest)
1054
1137
 
1055
1138
 
1056
1139
def delete_any(path):
1057
 
    """Delete a file, symlink or directory.  
1058
 
    
 
1140
    """Delete a file, symlink or directory.
 
1141
 
1059
1142
    Will delete even if readonly.
1060
1143
    """
1061
1144
    try:
1062
1145
       _delete_file_or_dir(path)
1063
 
    except (OSError, IOError), e:
 
1146
    except (OSError, IOError) as e:
1064
1147
        if e.errno in (errno.EPERM, errno.EACCES):
1065
1148
            # make writable and try again
1066
1149
            try:
1162
1245
 
1163
1246
    if len(base) < MIN_ABS_PATHLENGTH:
1164
1247
        # must have space for e.g. a drive letter
1165
 
        raise ValueError('%r is too short to calculate a relative path'
 
1248
        raise ValueError(gettext('%r is too short to calculate a relative path')
1166
1249
            % (base,))
1167
1250
 
1168
1251
    rp = abspath(path)
1250
1333
    # but for now, we haven't optimized...
1251
1334
    return [canonical_relpath(base, p) for p in paths]
1252
1335
 
 
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
 
1253
1352
def safe_unicode(unicode_or_utf8_string):
1254
1353
    """Coerce unicode_or_utf8_string into unicode.
1255
1354
 
1257
1356
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
1258
1357
    wrapped in a BzrBadParameterNotUnicode exception.
1259
1358
    """
1260
 
    if isinstance(unicode_or_utf8_string, unicode):
 
1359
    if isinstance(unicode_or_utf8_string, text_type):
1261
1360
        return unicode_or_utf8_string
1262
1361
    try:
1263
1362
        return unicode_or_utf8_string.decode('utf8')
1284
1383
    return unicode_or_utf8_string.encode('utf-8')
1285
1384
 
1286
1385
 
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):
 
1386
def safe_revision_id(unicode_or_utf8_string):
1293
1387
    """Revision ids should now be utf8, but at one point they were unicode.
1294
1388
 
1295
1389
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1296
1390
        utf8 or None).
1297
 
    :param warn: Functions that are sanitizing user data can set warn=False
1298
1391
    :return: None or a utf8 revision id.
1299
1392
    """
1300
1393
    if (unicode_or_utf8_string is None
1301
1394
        or unicode_or_utf8_string.__class__ == str):
1302
1395
        return 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):
 
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):
1314
1402
    """File ids should now be utf8, but at one point they were unicode.
1315
1403
 
1316
1404
    This is the same as safe_utf8, except it uses the cached encode functions
1318
1406
 
1319
1407
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1320
1408
        utf8 or None).
1321
 
    :param warn: Functions that are sanitizing user data can set warn=False
1322
1409
    :return: None or a utf8 file id.
1323
1410
    """
1324
1411
    if (unicode_or_utf8_string is None
1325
1412
        or unicode_or_utf8_string.__class__ == str):
1326
1413
        return unicode_or_utf8_string
1327
 
    if warn:
1328
 
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1329
 
                               stacklevel=2)
1330
 
    return cache_utf8.encode(unicode_or_utf8_string)
 
1414
    raise TypeError('Unicode file ids are no longer supported. '
 
1415
                    'File id generators should be creating utf8 file ids.')
1331
1416
 
1332
1417
 
1333
1418
_platform_normalizes_filenames = False
1338
1423
def normalizes_filenames():
1339
1424
    """Return True if this platform normalizes unicode filenames.
1340
1425
 
1341
 
    Mac OSX does, Windows/Linux do not.
 
1426
    Only Mac OSX.
1342
1427
    """
1343
1428
    return _platform_normalizes_filenames
1344
1429
 
1349
1434
    On platforms where the system normalizes filenames (Mac OSX),
1350
1435
    you can access a file by any path which will normalize correctly.
1351
1436
    On platforms where the system does not normalize filenames
1352
 
    (Windows, Linux), you have to access a file by its exact path.
 
1437
    (everything else), you have to access a file by its exact path.
1353
1438
 
1354
1439
    Internally, bzr only supports NFC normalization, since that is
1355
1440
    the standard for XML documents.
1417
1502
terminal_width() returns None.
1418
1503
"""
1419
1504
 
 
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
1420
1511
 
1421
1512
def terminal_width():
1422
1513
    """Return terminal width.
1424
1515
    None is returned if the width can't established precisely.
1425
1516
 
1426
1517
    The rules are:
1427
 
    - if BZR_COLUMNS is set, returns its value
 
1518
    - if BRZ_COLUMNS is set, returns its value
1428
1519
    - 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,
1429
1522
    - if COLUMNS is set, returns its value,
 
1523
    - if the OS has a value (even though it's never changed), return its value.
1430
1524
 
1431
1525
    From there, we need to query the OS to get the size of the controlling
1432
1526
    terminal.
1433
1527
 
1434
 
    Unices:
 
1528
    On Unices we query the OS by:
1435
1529
    - get termios.TIOCGWINSZ
1436
1530
    - if an error occurs or a negative value is obtained, returns None
1437
1531
 
1438
 
    Windows:
1439
 
    
 
1532
    On Windows we query the OS by:
1440
1533
    - win32utils.get_console_size() decides,
1441
1534
    - returns None on error (provided default value)
1442
1535
    """
 
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.
1443
1548
 
1444
 
    # If BZR_COLUMNS is set, take it, user is always right
 
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
1445
1551
    try:
1446
 
        return int(os.environ['BZR_COLUMNS'])
 
1552
        width = int(os.environ['BRZ_COLUMNS'])
1447
1553
    except (KeyError, ValueError):
1448
 
        pass
 
1554
        width = None
 
1555
    if width is not None:
 
1556
        if width > 0:
 
1557
            return width
 
1558
        else:
 
1559
            return None
1449
1560
 
1450
1561
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
1452
 
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1562
    if isatty is None or not isatty():
 
1563
        # Don't guess, setting BRZ_COLUMNS is the recommended way to override.
1453
1564
        return None
1454
1565
 
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))
 
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.
1458
1583
    try:
1459
1584
        return int(os.environ['COLUMNS'])
1460
1585
    except (KeyError, ValueError):
1461
1586
        pass
1462
1587
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
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
1467
1592
 
1468
 
    return width
 
1593
    # The width could not be determined.
 
1594
    return None
1469
1595
 
1470
1596
 
1471
1597
def _win32_terminal_size(width, height):
1498
1624
    _terminal_size = _ioctl_terminal_size
1499
1625
 
1500
1626
 
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
 
 
1526
1627
def supports_executable():
1527
1628
    return sys.platform != "win32"
1528
1629
 
1553
1654
        if orig_val is not None:
1554
1655
            del os.environ[env_variable]
1555
1656
    else:
1556
 
        if isinstance(value, unicode):
 
1657
        if not PY3 and isinstance(value, text_type):
1557
1658
            value = value.encode(get_user_encoding())
1558
1659
        os.environ[env_variable] = value
1559
1660
    return orig_val
1651
1752
        dirblock = []
1652
1753
        append = dirblock.append
1653
1754
        try:
1654
 
            names = sorted(_listdir(top))
1655
 
        except OSError, e:
 
1755
            names = sorted(map(decode_filename, _listdir(top)))
 
1756
        except OSError as e:
1656
1757
            if not _is_error_enotdir(e):
1657
1758
                raise
1658
1759
        else:
1711
1812
    """
1712
1813
    global _selected_dir_reader
1713
1814
    if _selected_dir_reader is None:
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.
 
1815
        if sys.platform == "win32":
1721
1816
            try:
1722
 
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1817
                from ._walkdirs_win32 import Win32ReadDir
1723
1818
                _selected_dir_reader = Win32ReadDir()
1724
1819
            except ImportError:
1725
1820
                pass
1726
 
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1727
 
            # ANSI_X3.4-1968 is a form of ASCII
 
1821
        elif _fs_enc in ('utf-8', 'ascii'):
1728
1822
            try:
1729
 
                from bzrlib._readdir_pyx import UTF8DirReader
 
1823
                from ._readdir_pyx import UTF8DirReader
1730
1824
                _selected_dir_reader = UTF8DirReader()
1731
 
            except ImportError, e:
 
1825
            except ImportError as e:
1732
1826
                failed_to_load_extension(e)
1733
1827
                pass
1734
1828
 
1864
1958
    try:
1865
1959
        s = os.stat(src)
1866
1960
        chown(dst, s.st_uid, s.st_gid)
1867
 
    except OSError, e:
1868
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
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()
1869
1966
 
1870
1967
 
1871
1968
def path_prefix_key(path):
1886
1983
_cached_user_encoding = None
1887
1984
 
1888
1985
 
1889
 
def get_user_encoding(use_cache=True):
 
1986
def get_user_encoding():
1890
1987
    """Find out what the preferred user encoding is.
1891
1988
 
1892
1989
    This is generally the encoding that is used for command line parameters
1893
1990
    and file contents. This may be different from the terminal encoding
1894
1991
    or the filesystem encoding.
1895
1992
 
1896
 
    :param  use_cache:  Enable cache for detected encoding.
1897
 
                        (This parameter is turned on by default,
1898
 
                        and required only for selftesting)
1899
 
 
1900
1993
    :return: A string defining the preferred user encoding
1901
1994
    """
1902
1995
    global _cached_user_encoding
1903
 
    if _cached_user_encoding is not None and use_cache:
 
1996
    if _cached_user_encoding is not None:
1904
1997
        return _cached_user_encoding
1905
1998
 
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'
 
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)
1923
2005
    else:
1924
 
        import locale
 
2006
        # GZ 2011-12-19: On windows could call GetACP directly instead.
 
2007
        user_encoding = locale.getpreferredencoding(False)
1925
2008
 
1926
2009
    try:
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:'
 
2010
        user_encoding = codecs.lookup(user_encoding).name
 
2011
    except LookupError:
 
2012
        if user_encoding not in ("", "cp0"):
 
2013
            sys.stderr.write('brz: warning:'
1950
2014
                             ' unknown encoding %s.'
1951
2015
                             ' Continuing with ascii encoding.\n'
1952
2016
                             % user_encoding
1953
2017
                            )
1954
 
            user_encoding = 'ascii'
1955
 
 
1956
 
    if use_cache:
1957
 
        _cached_user_encoding = user_encoding
1958
 
 
 
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
1959
2030
    return user_encoding
1960
2031
 
1961
2032
 
 
2033
def get_diff_header_encoding():
 
2034
    return get_terminal_encoding()
 
2035
 
 
2036
 
1962
2037
def get_host_name():
1963
2038
    """Return the current unicode host name.
1964
2039
 
1966
2041
    behaves inconsistently on different platforms.
1967
2042
    """
1968
2043
    if sys.platform == "win32":
1969
 
        import win32utils
1970
2044
        return win32utils.get_host_name()
1971
2045
    else:
1972
2046
        import socket
 
2047
        if PY3:
 
2048
            return socket.gethostname()
1973
2049
        return socket.gethostname().decode(get_user_encoding())
1974
2050
 
1975
2051
 
1979
2055
# data at once.
1980
2056
MAX_SOCKET_CHUNK = 64 * 1024
1981
2057
 
 
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
 
1982
2066
def read_bytes_from_socket(sock, report_activity=None,
1983
2067
        max_read_size=MAX_SOCKET_CHUNK):
1984
2068
    """Read up to max_read_size of bytes from sock and notify of progress.
1987
2071
    empty string rather than raise an error), and repeats the recv if
1988
2072
    interrupted by a signal.
1989
2073
    """
1990
 
    while 1:
 
2074
    while True:
1991
2075
        try:
1992
2076
            bytes = sock.recv(max_read_size)
1993
 
        except socket.error, e:
 
2077
        except socket.error as e:
1994
2078
            eno = e.args[0]
1995
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2079
            if eno in _end_of_stream_errors:
1996
2080
                # The connection was closed by the other side.  Callers expect
1997
2081
                # an empty string to signal end-of-stream.
1998
2082
                return ""
2027
2111
 
2028
2112
def send_all(sock, bytes, report_activity=None):
2029
2113
    """Send all bytes on a socket.
2030
 
 
 
2114
 
2031
2115
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2116
    some platforms, and catches EINTR which may be thrown if the send is
2033
2117
    interrupted by a signal.
2034
2118
 
2035
2119
    This is preferred to socket.sendall(), because it avoids portability bugs
2036
2120
    and provides activity reporting.
2037
 
 
 
2121
 
2038
2122
    :param report_activity: Call this as bytes are read, see
2039
2123
        Transport._report_activity
2040
2124
    """
2041
2125
    sent_total = 0
2042
2126
    byte_count = len(bytes)
 
2127
    view = memoryview(bytes)
2043
2128
    while sent_total < byte_count:
2044
2129
        try:
2045
 
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
2046
 
        except socket.error, e:
 
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)
2047
2135
            if e.args[0] != errno.EINTR:
2048
2136
                raise
2049
2137
        else:
 
2138
            if sent == 0:
 
2139
                raise errors.ConnectionReset('Sending to %s returned 0 bytes'
 
2140
                                             % (sock,))
2050
2141
            sent_total += sent
2051
 
            report_activity(sent, 'write')
 
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
2052
2167
 
2053
2168
 
2054
2169
def dereference_path(path):
2073
2188
def resource_string(package, resource_name):
2074
2189
    """Load a resource from a package and return it as a string.
2075
2190
 
2076
 
    Note: Only packages that start with bzrlib are currently supported.
 
2191
    Note: Only packages that start with breezy are currently supported.
2077
2192
 
2078
2193
    This is designed to be a lightweight implementation of resource
2079
2194
    loading in a way which is API compatible with the same API from
2082
2197
    If and when pkg_resources becomes a standard library, this routine
2083
2198
    can delegate to it.
2084
2199
    """
2085
 
    # Check package name is within bzrlib
2086
 
    if package == "bzrlib":
 
2200
    # Check package name is within breezy
 
2201
    if package == "breezy":
2087
2202
        resource_relpath = resource_name
2088
 
    elif package.startswith("bzrlib."):
2089
 
        package = package[len("bzrlib."):].replace('.', os.sep)
 
2203
    elif package.startswith("breezy."):
 
2204
        package = package[len("breezy."):].replace('.', os.sep)
2090
2205
        resource_relpath = pathjoin(package, resource_name)
2091
2206
    else:
2092
 
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
2207
        raise errors.BzrError('resource package %s not in breezy' % package)
2093
2208
 
2094
2209
    # Map the resource to a file and read its contents
2095
 
    base = dirname(bzrlib.__file__)
 
2210
    base = dirname(breezy.__file__)
2096
2211
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2212
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2213
    f = file(pathjoin(base, resource_relpath), "rU")
 
2214
    try:
 
2215
        return f.read()
 
2216
    finally:
 
2217
        f.close()
2101
2218
 
2102
2219
def file_kind_from_stat_mode_thunk(mode):
2103
2220
    global file_kind_from_stat_mode
2104
2221
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
2105
2222
        try:
2106
 
            from bzrlib._readdir_pyx import UTF8DirReader
 
2223
            from ._readdir_pyx import UTF8DirReader
2107
2224
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
2108
 
        except ImportError, e:
 
2225
        except ImportError as e:
2109
2226
            # This is one time where we won't warn that an extension failed to
2110
2227
            # load. The extension is never available on Windows anyway.
2111
 
            from bzrlib._readdir_py import (
 
2228
            from ._readdir_py import (
2112
2229
                _kind_from_mode as file_kind_from_stat_mode
2113
2230
                )
2114
2231
    return file_kind_from_stat_mode(mode)
2115
2232
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
2116
2233
 
2117
 
 
2118
 
def file_kind(f, _lstat=os.lstat):
 
2234
def file_stat(f, _lstat=os.lstat):
2119
2235
    try:
2120
 
        return file_kind_from_stat_mode(_lstat(f).st_mode)
2121
 
    except OSError, e:
 
2236
        # XXX cache?
 
2237
        return _lstat(f)
 
2238
    except OSError as e:
2122
2239
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
2123
2240
            raise errors.NoSuchFile(f)
2124
2241
        raise
2125
2242
 
 
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)
2126
2246
 
2127
2247
def until_no_eintr(f, *a, **kw):
2128
2248
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2129
 
    
 
2249
 
2130
2250
    WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2251
    if EINTR does occur.  This is typically only true for low-level operations
2132
2252
    like os.read.  If in any doubt, don't use this.
2134
2254
    Keep in mind that this is not a complete solution to EINTR.  There is
2135
2255
    probably code in the Python standard library and other dependencies that
2136
2256
    may encounter EINTR if a signal arrives (and there is signal handler for
2137
 
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2257
    that signal).  So this function can reduce the impact for IO that breezy
2138
2258
    directly controls, but it is not a complete solution.
2139
2259
    """
2140
2260
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
2141
2261
    while True:
2142
2262
        try:
2143
2263
            return f(*a, **kw)
2144
 
        except (IOError, OSError), e:
 
2264
        except (IOError, OSError) as e:
2145
2265
            if e.errno == errno.EINTR:
2146
2266
                continue
2147
2267
            raise
2148
2268
 
2149
2269
 
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
 
 
2173
2270
if sys.platform == "win32":
2174
 
    import msvcrt
2175
2271
    def getchar():
 
2272
        import msvcrt
2176
2273
        return msvcrt.getch()
2177
2274
else:
2178
 
    import tty
2179
 
    import termios
2180
2275
    def getchar():
 
2276
        import tty
 
2277
        import termios
2181
2278
        fd = sys.stdin.fileno()
2182
2279
        settings = termios.tcgetattr(fd)
2183
2280
        try:
2187
2284
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2188
2285
        return ch
2189
2286
 
2190
 
 
2191
 
if sys.platform == 'linux2':
 
2287
if sys.platform.startswith('linux'):
2192
2288
    def _local_concurrency():
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
 
2289
        try:
 
2290
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2291
        except (ValueError, OSError, AttributeError):
 
2292
            return None
2199
2293
elif sys.platform == 'darwin':
2200
2294
    def _local_concurrency():
2201
2295
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2202
2296
                                stdout=subprocess.PIPE).communicate()[0]
2203
 
elif sys.platform[0:7] == 'freebsd':
 
2297
elif "bsd" in sys.platform:
2204
2298
    def _local_concurrency():
2205
2299
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2206
2300
                                stdout=subprocess.PIPE).communicate()[0]
2231
2325
    if _cached_local_concurrency is not None and use_cache:
2232
2326
        return _cached_local_concurrency
2233
2327
 
2234
 
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2328
    concurrency = os.environ.get('BRZ_CONCURRENCY', None)
2235
2329
    if concurrency is None:
2236
2330
        try:
2237
 
            concurrency = _local_concurrency()
2238
 
        except (OSError, IOError):
2239
 
            pass
 
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
2240
2341
    try:
2241
2342
        concurrency = int(concurrency)
2242
2343
    except (TypeError, ValueError):
2254
2355
        self.encode = encode
2255
2356
 
2256
2357
    def write(self, object):
2257
 
        if type(object) is str:
 
2358
        if isinstance(object, str):
2258
2359
            self.stream.write(object)
2259
2360
        else:
2260
2361
            data, _ = self.encode(object, self.errors)
2263
2364
if sys.platform == 'win32':
2264
2365
    def open_file(filename, mode='r', bufsize=-1):
2265
2366
        """This function is used to override the ``open`` builtin.
2266
 
        
 
2367
 
2267
2368
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2369
        child processes.  Deleting or renaming a closed file opened with this
2269
2370
        function is not blocking child processes.
2302
2403
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2404
else:
2304
2405
    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