← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin
  • Date: 2011-03-22 00:33:21 UTC
  • mto: This revision was merged to the branch mainline in revision 5731.
  • Revision ID: gzlist@googlemail.com-20110322003321-h3n4q806g759tk7v
Tweak function descriptions in delta header for clarity

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/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
import errno
17
18
import os
18
19
import re
19
20
import stat
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
import sys
22
22
import time
23
23
import codecs
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from datetime import datetime
28
 
import errno
29
28
import getpass
30
 
from ntpath import (abspath as _nt_abspath,
31
 
                    join as _nt_join,
32
 
                    normpath as _nt_normpath,
33
 
                    realpath as _nt_realpath,
34
 
                    splitdrive as _nt_splitdrive,
35
 
                    )
 
29
import ntpath
36
30
import posixpath
 
31
# We need to import both shutil and rmtree as we export the later on posix
 
32
# and need the former on windows
37
33
import shutil
38
 
from shutil import (
39
 
    rmtree,
40
 
    )
 
34
from shutil import rmtree
41
35
import socket
42
36
import subprocess
 
37
# We need to import both tempfile and mkdtemp as we export the later on posix
 
38
# and need the former on windows
43
39
import tempfile
44
 
from tempfile import (
45
 
    mkdtemp,
46
 
    )
 
40
from tempfile import mkdtemp
47
41
import unicodedata
48
42
 
49
43
from bzrlib import (
304
298
    running python.exe under cmd.exe return capital C:\\
305
299
    running win32 python inside a cygwin shell returns lowercase c:\\
306
300
    """
307
 
    drive, path = _nt_splitdrive(path)
 
301
    drive, path = ntpath.splitdrive(path)
308
302
    return drive.upper() + path
309
303
 
310
304
 
311
305
def _win32_abspath(path):
312
 
    # Real _nt_abspath doesn't have a problem with a unicode cwd
313
 
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
306
    # Real ntpath.abspath doesn't have a problem with a unicode cwd
 
307
    return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
314
308
 
315
309
 
316
310
def _win98_abspath(path):
327
321
    #   /path       => C:/path
328
322
    path = unicode(path)
329
323
    # check for absolute path
330
 
    drive = _nt_splitdrive(path)[0]
 
324
    drive = ntpath.splitdrive(path)[0]
331
325
    if drive == '' and path[:2] not in('//','\\\\'):
332
326
        cwd = os.getcwdu()
333
327
        # we cannot simply os.path.join cwd and path
334
328
        # because os.path.join('C:','/path') produce '/path'
335
329
        # and this is incorrect
336
330
        if path[:1] in ('/','\\'):
337
 
            cwd = _nt_splitdrive(cwd)[0]
 
331
            cwd = ntpath.splitdrive(cwd)[0]
338
332
            path = path[1:]
339
333
        path = cwd + '\\' + path
340
 
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
334
    return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
341
335
 
342
336
 
343
337
def _win32_realpath(path):
344
 
    # Real _nt_realpath doesn't have a problem with a unicode cwd
345
 
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
338
    # Real ntpath.realpath doesn't have a problem with a unicode cwd
 
339
    return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
346
340
 
347
341
 
348
342
def _win32_pathjoin(*args):
349
 
    return _nt_join(*args).replace('\\', '/')
 
343
    return ntpath.join(*args).replace('\\', '/')
350
344
 
351
345
 
352
346
def _win32_normpath(path):
353
 
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
347
    return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
348
 
355
349
 
356
350
def _win32_getcwd():
361
355
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
362
356
 
363
357
 
364
 
def _add_rename_error_details(e, old, new):
365
 
    new_e = OSError(e.errno, "failed to rename %s to %s: %s"
366
 
        % (old, new, e.strerror))
367
 
    new_e.filename = old
368
 
    new_e.to_filename = new
369
 
    return new_e
370
 
 
371
 
 
372
358
def _win32_rename(old, new):
373
359
    """We expect to be able to atomically replace 'new' with old.
374
360
 
376
362
    and then deleted.
377
363
    """
378
364
    try:
379
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
365
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
380
366
    except OSError, e:
381
367
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
382
368
            # If we try to rename a non-existant file onto cwd, we get
387
373
        raise
388
374
 
389
375
 
390
 
def _wrapped_rename(old, new):
391
 
    """Rename a file or directory"""
392
 
    try:
393
 
        os.rename(old, new)
394
 
    except (IOError, OSError), e:
395
 
        # this is eventually called by all rename-like functions, so should 
396
 
        # catch all of them
397
 
        raise _add_rename_error_details(e, old, new)
398
 
 
399
 
 
400
376
def _mac_getcwd():
401
377
    return unicodedata.normalize('NFC', os.getcwdu())
402
378
 
407
383
realpath = _posix_realpath
408
384
pathjoin = os.path.join
409
385
normpath = os.path.normpath
410
 
rename = _wrapped_rename # overridden below on win32
411
386
getcwd = os.getcwdu
 
387
rename = os.rename
412
388
dirname = os.path.dirname
413
389
basename = os.path.basename
414
390
split = os.path.split
415
391
splitext = os.path.splitext
416
 
# These were already imported into local scope
 
392
# These were already lazily imported into local scope
417
393
# mkdtemp = tempfile.mkdtemp
418
394
# rmtree = shutil.rmtree
419
395
 
459
435
    getcwd = _mac_getcwd
460
436
 
461
437
 
462
 
def get_terminal_encoding():
 
438
def get_terminal_encoding(trace=False):
463
439
    """Find the best encoding for printing to the screen.
464
440
 
465
441
    This attempts to check both sys.stdout and sys.stdin to see
471
447
 
472
448
    On my standard US Windows XP, the preferred encoding is
473
449
    cp1252, but the console is cp437
 
450
 
 
451
    :param trace: If True trace the selected encoding via mutter().
474
452
    """
475
453
    from bzrlib.trace import mutter
476
454
    output_encoding = getattr(sys.stdout, 'encoding', None)
478
456
        input_encoding = getattr(sys.stdin, 'encoding', None)
479
457
        if not input_encoding:
480
458
            output_encoding = get_user_encoding()
481
 
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
459
            if trace:
 
460
                mutter('encoding stdout as osutils.get_user_encoding() %r',
482
461
                   output_encoding)
483
462
        else:
484
463
            output_encoding = input_encoding
485
 
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
464
            if trace:
 
465
                mutter('encoding stdout as sys.stdin encoding %r',
 
466
                    output_encoding)
486
467
    else:
487
 
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
468
        if trace:
 
469
            mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
488
470
    if output_encoding == 'cp0':
489
471
        # invalid encoding (cp0 means 'no codepage' on Windows)
490
472
        output_encoding = get_user_encoding()
491
 
        mutter('cp0 is invalid encoding.'
 
473
        if trace:
 
474
            mutter('cp0 is invalid encoding.'
492
475
               ' encoding stdout as osutils.get_user_encoding() %r',
493
476
               output_encoding)
494
477
    # check encoding
520
503
def isdir(f):
521
504
    """True if f is an accessible directory."""
522
505
    try:
523
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
506
        return stat.S_ISDIR(os.lstat(f)[stat.ST_MODE])
524
507
    except OSError:
525
508
        return False
526
509
 
528
511
def isfile(f):
529
512
    """True if f is a regular file."""
530
513
    try:
531
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
514
        return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
532
515
    except OSError:
533
516
        return False
534
517
 
535
518
def islink(f):
536
519
    """True if f is a symlink."""
537
520
    try:
538
 
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
521
        return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
539
522
    except OSError:
540
523
        return False
541
524
 
881
864
 
882
865
def filesize(f):
883
866
    """Return size of given open file."""
884
 
    return os.fstat(f.fileno())[ST_SIZE]
 
867
    return os.fstat(f.fileno())[stat.ST_SIZE]
885
868
 
886
869
 
887
870
# Define rand_bytes based on platform.
949
932
 
950
933
def parent_directories(filename):
951
934
    """Return the list of parent directories, deepest first.
952
 
    
 
935
 
953
936
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
954
937
    """
955
938
    parents = []
979
962
    # NB: This docstring is just an example, not a doctest, because doctest
980
963
    # currently can't cope with the use of lazy imports in this namespace --
981
964
    # mbp 20090729
982
 
    
 
965
 
983
966
    # This currently doesn't report the failure at the time it occurs, because
984
967
    # they tend to happen very early in startup when we can't check config
985
968
    # files etc, and also we want to report all failures but not spam the user
986
969
    # with 10 warnings.
987
 
    from bzrlib import trace
988
970
    exception_str = str(exception)
989
971
    if exception_str not in _extension_load_failures:
990
972
        trace.mutter("failed to load compiled extension: %s" % exception_str)
1055
1037
 
1056
1038
 
1057
1039
def delete_any(path):
1058
 
    """Delete a file, symlink or directory.  
1059
 
    
 
1040
    """Delete a file, symlink or directory.
 
1041
 
1060
1042
    Will delete even if readonly.
1061
1043
    """
1062
1044
    try:
1251
1233
    # but for now, we haven't optimized...
1252
1234
    return [canonical_relpath(base, p) for p in paths]
1253
1235
 
 
1236
 
 
1237
def decode_filename(filename):
 
1238
    """Decode the filename using the filesystem encoding
 
1239
 
 
1240
    If it is unicode, it is returned.
 
1241
    Otherwise it is decoded from the the filesystem's encoding. If decoding
 
1242
    fails, a errors.BadFilenameEncoding exception is raised.
 
1243
    """
 
1244
    if type(filename) is unicode:
 
1245
        return filename
 
1246
    try:
 
1247
        return filename.decode(_fs_enc)
 
1248
    except UnicodeDecodeError:
 
1249
        raise errors.BadFilenameEncoding(filename, _fs_enc)
 
1250
 
 
1251
 
1254
1252
def safe_unicode(unicode_or_utf8_string):
1255
1253
    """Coerce unicode_or_utf8_string into unicode.
1256
1254
 
1339
1337
def normalizes_filenames():
1340
1338
    """Return True if this platform normalizes unicode filenames.
1341
1339
 
1342
 
    Mac OSX does, Windows/Linux do not.
 
1340
    Only Mac OSX.
1343
1341
    """
1344
1342
    return _platform_normalizes_filenames
1345
1343
 
1350
1348
    On platforms where the system normalizes filenames (Mac OSX),
1351
1349
    you can access a file by any path which will normalize correctly.
1352
1350
    On platforms where the system does not normalize filenames
1353
 
    (Windows, Linux), you have to access a file by its exact path.
 
1351
    (everything else), you have to access a file by its exact path.
1354
1352
 
1355
1353
    Internally, bzr only supports NFC normalization, since that is
1356
1354
    the standard for XML documents.
1418
1416
terminal_width() returns None.
1419
1417
"""
1420
1418
 
 
1419
# Keep some state so that terminal_width can detect if _terminal_size has
 
1420
# returned a different size since the process started.  See docstring and
 
1421
# comments of terminal_width for details.
 
1422
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1423
_terminal_size_state = 'no_data'
 
1424
_first_terminal_size = None
1421
1425
 
1422
1426
def terminal_width():
1423
1427
    """Return terminal width.
1427
1431
    The rules are:
1428
1432
    - if BZR_COLUMNS is set, returns its value
1429
1433
    - if there is no controlling terminal, returns None
 
1434
    - query the OS, if the queried size has changed since the last query,
 
1435
      return its value,
1430
1436
    - if COLUMNS is set, returns its value,
 
1437
    - if the OS has a value (even though it's never changed), return its value.
1431
1438
 
1432
1439
    From there, we need to query the OS to get the size of the controlling
1433
1440
    terminal.
1434
1441
 
1435
 
    Unices:
 
1442
    On Unices we query the OS by:
1436
1443
    - get termios.TIOCGWINSZ
1437
1444
    - if an error occurs or a negative value is obtained, returns None
1438
1445
 
1439
 
    Windows:
1440
 
    
 
1446
    On Windows we query the OS by:
1441
1447
    - win32utils.get_console_size() decides,
1442
1448
    - returns None on error (provided default value)
1443
1449
    """
 
1450
    # Note to implementors: if changing the rules for determining the width,
 
1451
    # make sure you've considered the behaviour in these cases:
 
1452
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1453
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1454
    #    0,0.
 
1455
    #  - (add more interesting cases here, if you find any)
 
1456
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1457
    # but we don't want to register a signal handler because it is impossible
 
1458
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1459
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1460
    # time so we can notice if the reported size has changed, which should have
 
1461
    # a similar effect.
1444
1462
 
1445
1463
    # If BZR_COLUMNS is set, take it, user is always right
 
1464
    # Except if they specified 0 in which case, impose no limit here
1446
1465
    try:
1447
 
        return int(os.environ['BZR_COLUMNS'])
 
1466
        width = int(os.environ['BZR_COLUMNS'])
1448
1467
    except (KeyError, ValueError):
1449
 
        pass
 
1468
        width = None
 
1469
    if width is not None:
 
1470
        if width > 0:
 
1471
            return width
 
1472
        else:
 
1473
            return None
1450
1474
 
1451
1475
    isatty = getattr(sys.stdout, 'isatty', None)
1452
 
    if  isatty is None or not isatty():
 
1476
    if isatty is None or not isatty():
1453
1477
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
1478
        return None
1455
1479
 
1456
 
    # If COLUMNS is set, take it, the terminal knows better (even inside a
1457
 
    # given terminal, the application can decide to set COLUMNS to a lower
1458
 
    # value (splitted screen) or a bigger value (scroll bars))
 
1480
    # Query the OS
 
1481
    width, height = os_size = _terminal_size(None, None)
 
1482
    global _first_terminal_size, _terminal_size_state
 
1483
    if _terminal_size_state == 'no_data':
 
1484
        _first_terminal_size = os_size
 
1485
        _terminal_size_state = 'unchanged'
 
1486
    elif (_terminal_size_state == 'unchanged' and
 
1487
          _first_terminal_size != os_size):
 
1488
        _terminal_size_state = 'changed'
 
1489
 
 
1490
    # If the OS claims to know how wide the terminal is, and this value has
 
1491
    # ever changed, use that.
 
1492
    if _terminal_size_state == 'changed':
 
1493
        if width is not None and width > 0:
 
1494
            return width
 
1495
 
 
1496
    # If COLUMNS is set, use it.
1459
1497
    try:
1460
1498
        return int(os.environ['COLUMNS'])
1461
1499
    except (KeyError, ValueError):
1462
1500
        pass
1463
1501
 
1464
 
    width, height = _terminal_size(None, None)
1465
 
    if width <= 0:
1466
 
        # Consider invalid values as meaning no width
1467
 
        return None
 
1502
    # Finally, use an unchanged size from the OS, if we have one.
 
1503
    if _terminal_size_state == 'unchanged':
 
1504
        if width is not None and width > 0:
 
1505
            return width
1468
1506
 
1469
 
    return width
 
1507
    # The width could not be determined.
 
1508
    return None
1470
1509
 
1471
1510
 
1472
1511
def _win32_terminal_size(width, height):
1499
1538
    _terminal_size = _ioctl_terminal_size
1500
1539
 
1501
1540
 
1502
 
def _terminal_size_changed(signum, frame):
1503
 
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1504
 
    width, height = _terminal_size(None, None)
1505
 
    if width is not None:
1506
 
        os.environ['COLUMNS'] = str(width)
1507
 
 
1508
 
 
1509
 
_registered_sigwinch = False
1510
 
def watch_sigwinch():
1511
 
    """Register for SIGWINCH, once and only once.
1512
 
 
1513
 
    Do nothing if the signal module is not available.
1514
 
    """
1515
 
    global _registered_sigwinch
1516
 
    if not _registered_sigwinch:
1517
 
        try:
1518
 
            import signal
1519
 
            if getattr(signal, "SIGWINCH", None) is not None:
1520
 
                set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
 
        except ImportError:
1522
 
            # python doesn't provide signal support, nothing we can do about it
1523
 
            pass
1524
 
        _registered_sigwinch = True
1525
 
 
1526
 
 
1527
1541
def supports_executable():
1528
1542
    return sys.platform != "win32"
1529
1543
 
1652
1666
        dirblock = []
1653
1667
        append = dirblock.append
1654
1668
        try:
1655
 
            names = sorted(_listdir(top))
 
1669
            names = sorted(map(decode_filename, _listdir(top)))
1656
1670
        except OSError, e:
1657
1671
            if not _is_error_enotdir(e):
1658
1672
                raise
1866
1880
        s = os.stat(src)
1867
1881
        chown(dst, s.st_uid, s.st_gid)
1868
1882
    except OSError, e:
1869
 
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1883
        trace.warning(
 
1884
            'Unable to copy ownership from "%s" to "%s". '
 
1885
            'You may want to set it manually.', src, dst)
 
1886
        trace.log_exception_quietly()
1870
1887
 
1871
1888
 
1872
1889
def path_prefix_key(path):
1960
1977
    return user_encoding
1961
1978
 
1962
1979
 
 
1980
def get_diff_header_encoding():
 
1981
    return get_terminal_encoding()
 
1982
 
 
1983
 
1963
1984
def get_host_name():
1964
1985
    """Return the current unicode host name.
1965
1986
 
1980
2001
# data at once.
1981
2002
MAX_SOCKET_CHUNK = 64 * 1024
1982
2003
 
 
2004
_end_of_stream_errors = [errno.ECONNRESET]
 
2005
for _eno in ['WSAECONNRESET', 'WSAECONNABORTED']:
 
2006
    _eno = getattr(errno, _eno, None)
 
2007
    if _eno is not None:
 
2008
        _end_of_stream_errors.append(_eno)
 
2009
del _eno
 
2010
 
 
2011
 
1983
2012
def read_bytes_from_socket(sock, report_activity=None,
1984
2013
        max_read_size=MAX_SOCKET_CHUNK):
1985
2014
    """Read up to max_read_size of bytes from sock and notify of progress.
1993
2022
            bytes = sock.recv(max_read_size)
1994
2023
        except socket.error, e:
1995
2024
            eno = e.args[0]
1996
 
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
2025
            if eno in _end_of_stream_errors:
1997
2026
                # The connection was closed by the other side.  Callers expect
1998
2027
                # an empty string to signal end-of-stream.
1999
2028
                return ""
2028
2057
 
2029
2058
def send_all(sock, bytes, report_activity=None):
2030
2059
    """Send all bytes on a socket.
2031
 
 
 
2060
 
2032
2061
    Breaks large blocks in smaller chunks to avoid buffering limitations on
2033
2062
    some platforms, and catches EINTR which may be thrown if the send is
2034
2063
    interrupted by a signal.
2035
2064
 
2036
2065
    This is preferred to socket.sendall(), because it avoids portability bugs
2037
2066
    and provides activity reporting.
2038
 
 
 
2067
 
2039
2068
    :param report_activity: Call this as bytes are read, see
2040
2069
        Transport._report_activity
2041
2070
    """
2052
2081
            report_activity(sent, 'write')
2053
2082
 
2054
2083
 
 
2084
def connect_socket(address):
 
2085
    # Slight variation of the socket.create_connection() function (provided by
 
2086
    # python-2.6) that can fail if getaddrinfo returns an empty list. We also
 
2087
    # provide it for previous python versions. Also, we don't use the timeout
 
2088
    # parameter (provided by the python implementation) so we don't implement
 
2089
    # it either).
 
2090
    err = socket.error('getaddrinfo returns an empty list')
 
2091
    host, port = address
 
2092
    for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM):
 
2093
        af, socktype, proto, canonname, sa = res
 
2094
        sock = None
 
2095
        try:
 
2096
            sock = socket.socket(af, socktype, proto)
 
2097
            sock.connect(sa)
 
2098
            return sock
 
2099
 
 
2100
        except socket.error, err:
 
2101
            # 'err' is now the most recent error
 
2102
            if sock is not None:
 
2103
                sock.close()
 
2104
    raise err
 
2105
 
 
2106
 
2055
2107
def dereference_path(path):
2056
2108
    """Determine the real path to a file.
2057
2109
 
2096
2148
    base = dirname(bzrlib.__file__)
2097
2149
    if getattr(sys, 'frozen', None):    # bzr.exe
2098
2150
        base = abspath(pathjoin(base, '..', '..'))
2099
 
    filename = pathjoin(base, resource_relpath)
2100
 
    return open(filename, 'rU').read()
2101
 
 
 
2151
    f = file(pathjoin(base, resource_relpath), "rU")
 
2152
    try:
 
2153
        return f.read()
 
2154
    finally:
 
2155
        f.close()
2102
2156
 
2103
2157
def file_kind_from_stat_mode_thunk(mode):
2104
2158
    global file_kind_from_stat_mode
2127
2181
 
2128
2182
def until_no_eintr(f, *a, **kw):
2129
2183
    """Run f(*a, **kw), retrying if an EINTR error occurs.
2130
 
    
 
2184
 
2131
2185
    WARNING: you must be certain that it is safe to retry the call repeatedly
2132
2186
    if EINTR does occur.  This is typically only true for low-level operations
2133
2187
    like os.read.  If in any doubt, don't use this.
2148
2202
            raise
2149
2203
 
2150
2204
 
 
2205
@deprecated_function(deprecated_in((2, 2, 0)))
2151
2206
def re_compile_checked(re_string, flags=0, where=""):
2152
2207
    """Return a compiled re, or raise a sensible error.
2153
2208
 
2163
2218
        re_obj = re.compile(re_string, flags)
2164
2219
        re_obj.search("")
2165
2220
        return re_obj
2166
 
    except re.error, e:
 
2221
    except errors.InvalidPattern, e:
2167
2222
        if where:
2168
2223
            where = ' in ' + where
2169
2224
        # despite the name 'error' is a type
2170
 
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2171
 
            % (where, re_string, e))
 
2225
        raise errors.BzrCommandError('Invalid regular expression%s: %s'
 
2226
            % (where, e.msg))
2172
2227
 
2173
2228
 
2174
2229
if sys.platform == "win32":
2188
2243
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
2189
2244
        return ch
2190
2245
 
2191
 
 
2192
2246
if sys.platform == 'linux2':
2193
2247
    def _local_concurrency():
2194
 
        concurrency = None
2195
 
        prefix = 'processor'
2196
 
        for line in file('/proc/cpuinfo', 'rb'):
2197
 
            if line.startswith(prefix):
2198
 
                concurrency = int(line[line.find(':')+1:]) + 1
2199
 
        return concurrency
 
2248
        try:
 
2249
            return os.sysconf('SC_NPROCESSORS_ONLN')
 
2250
        except (ValueError, OSError, AttributeError):
 
2251
            return None
2200
2252
elif sys.platform == 'darwin':
2201
2253
    def _local_concurrency():
2202
2254
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
2203
2255
                                stdout=subprocess.PIPE).communicate()[0]
2204
 
elif sys.platform[0:7] == 'freebsd':
 
2256
elif "bsd" in sys.platform:
2205
2257
    def _local_concurrency():
2206
2258
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
2207
2259
                                stdout=subprocess.PIPE).communicate()[0]
2235
2287
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
2236
2288
    if concurrency is None:
2237
2289
        try:
2238
 
            concurrency = _local_concurrency()
2239
 
        except (OSError, IOError):
2240
 
            pass
 
2290
            import multiprocessing
 
2291
        except ImportError:
 
2292
            # multiprocessing is only available on Python >= 2.6
 
2293
            try:
 
2294
                concurrency = _local_concurrency()
 
2295
            except (OSError, IOError):
 
2296
                pass
 
2297
        else:
 
2298
            concurrency = multiprocessing.cpu_count()
2241
2299
    try:
2242
2300
        concurrency = int(concurrency)
2243
2301
    except (TypeError, ValueError):
2264
2322
if sys.platform == 'win32':
2265
2323
    def open_file(filename, mode='r', bufsize=-1):
2266
2324
        """This function is used to override the ``open`` builtin.
2267
 
        
 
2325
 
2268
2326
        But it uses O_NOINHERIT flag so the file handle is not inherited by
2269
2327
        child processes.  Deleting or renaming a closed file opened with this
2270
2328
        function is not blocking child processes.
2315
2373
        raise errors.BzrError("Can't decode username as %s." % \
2316
2374
                user_encoding)
2317
2375
    return username
 
2376
 
 
2377
 
 
2378
def available_backup_name(base, exists):
 
2379
    """Find a non-existing backup file name.
 
2380
 
 
2381
    This will *not* create anything, this only return a 'free' entry.  This
 
2382
    should be used for checking names in a directory below a locked
 
2383
    tree/branch/repo to avoid race conditions. This is LBYL (Look Before You
 
2384
    Leap) and generally discouraged.
 
2385
 
 
2386
    :param base: The base name.
 
2387
 
 
2388
    :param exists: A callable returning True if the path parameter exists.
 
2389
    """
 
2390
    counter = 1
 
2391
    name = "%s.~%d~" % (base, counter)
 
2392
    while exists(name):
 
2393
        counter += 1
 
2394
        name = "%s.~%d~" % (base, counter)
 
2395
    return name
 
2396
 
 
2397
 
 
2398
def set_fd_cloexec(fd):
 
2399
    """Set a Unix file descriptor's FD_CLOEXEC flag.  Do nothing if platform
 
2400
    support for this is not available.
 
2401
    """
 
2402
    try:
 
2403
        import fcntl
 
2404
        old = fcntl.fcntl(fd, fcntl.F_GETFD)
 
2405
        fcntl.fcntl(fd, fcntl.F_SETFD, old | fcntl.FD_CLOEXEC)
 
2406
    except (ImportError, AttributeError):
 
2407
        # Either the fcntl module or specific constants are not present
 
2408
        pass
 
2409
 
 
2410
 
 
2411
def find_executable_on_path(name):
 
2412
    """Finds an executable on the PATH.
 
2413
    
 
2414
    On Windows, this will try to append each extension in the PATHEXT
 
2415
    environment variable to the name, if it cannot be found with the name
 
2416
    as given.
 
2417
    
 
2418
    :param name: The base name of the executable.
 
2419
    :return: The path to the executable found or None.
 
2420
    """
 
2421
    path = os.environ.get('PATH')
 
2422
    if path is None:
 
2423
        return None
 
2424
    path = path.split(os.pathsep)
 
2425
    if sys.platform == 'win32':
 
2426
        exts = os.environ.get('PATHEXT', '').split(os.pathsep)
 
2427
        exts = [ext.lower() for ext in exts]
 
2428
        base, ext = os.path.splitext(name)
 
2429
        if ext != '':
 
2430
            if ext.lower() not in exts:
 
2431
                return None
 
2432
            name = base
 
2433
            exts = [ext]
 
2434
    else:
 
2435
        exts = ['']
 
2436
    for ext in exts:
 
2437
        for d in path:
 
2438
            f = os.path.join(d, name) + ext
 
2439
            if os.access(f, os.X_OK):
 
2440
                return f
 
2441
    return None