~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Parth Malwankar
  • Date: 2010-06-15 02:13:24 UTC
  • mto: This revision was merged to the branch mainline in revision 5303.
  • Revision ID: parth.malwankar@gmail.com-20100615021324-wegs8s7m4llufs77
updated NEWS to indicate the correct timeout for lock contention.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
25
26
from bzrlib.lazy_import import lazy_import
26
27
lazy_import(globals(), """
27
28
from datetime import datetime
28
 
import errno
 
29
import getpass
29
30
from ntpath import (abspath as _nt_abspath,
30
31
                    join as _nt_join,
31
32
                    normpath as _nt_normpath,
360
361
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
361
362
 
362
363
 
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
364
def _win32_rename(old, new):
372
365
    """We expect to be able to atomically replace 'new' with old.
373
366
 
375
368
    and then deleted.
376
369
    """
377
370
    try:
378
 
        fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
 
371
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
372
    except OSError, e:
380
373
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
374
            # If we try to rename a non-existant file onto cwd, we get
386
379
        raise
387
380
 
388
381
 
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
382
def _mac_getcwd():
400
383
    return unicodedata.normalize('NFC', os.getcwdu())
401
384
 
406
389
realpath = _posix_realpath
407
390
pathjoin = os.path.join
408
391
normpath = os.path.normpath
409
 
rename = _wrapped_rename # overridden below on win32
410
392
getcwd = os.getcwdu
 
393
rename = os.rename
411
394
dirname = os.path.dirname
412
395
basename = os.path.basename
413
396
split = os.path.split
1417
1400
terminal_width() returns None.
1418
1401
"""
1419
1402
 
 
1403
# Keep some state so that terminal_width can detect if _terminal_size has
 
1404
# returned a different size since the process started.  See docstring and
 
1405
# comments of terminal_width for details.
 
1406
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
 
1407
_terminal_size_state = 'no_data'
 
1408
_first_terminal_size = None
1420
1409
 
1421
1410
def terminal_width():
1422
1411
    """Return terminal width.
1426
1415
    The rules are:
1427
1416
    - if BZR_COLUMNS is set, returns its value
1428
1417
    - if there is no controlling terminal, returns None
 
1418
    - query the OS, if the queried size has changed since the last query,
 
1419
      return its value,
1429
1420
    - if COLUMNS is set, returns its value,
 
1421
    - if the OS has a value (even though it's never changed), return its value.
1430
1422
 
1431
1423
    From there, we need to query the OS to get the size of the controlling
1432
1424
    terminal.
1433
1425
 
1434
 
    Unices:
 
1426
    On Unices we query the OS by:
1435
1427
    - get termios.TIOCGWINSZ
1436
1428
    - if an error occurs or a negative value is obtained, returns None
1437
1429
 
1438
 
    Windows:
1439
 
    
 
1430
    On Windows we query the OS by:
1440
1431
    - win32utils.get_console_size() decides,
1441
1432
    - returns None on error (provided default value)
1442
1433
    """
 
1434
    # Note to implementors: if changing the rules for determining the width,
 
1435
    # make sure you've considered the behaviour in these cases:
 
1436
    #  - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
 
1437
    #  - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
 
1438
    #    0,0.
 
1439
    #  - (add more interesting cases here, if you find any)
 
1440
    # Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
 
1441
    # but we don't want to register a signal handler because it is impossible
 
1442
    # to do so without risking EINTR errors in Python <= 2.6.5 (see
 
1443
    # <http://bugs.python.org/issue8354>).  Instead we check TIOCGWINSZ every
 
1444
    # time so we can notice if the reported size has changed, which should have
 
1445
    # a similar effect.
1443
1446
 
1444
1447
    # If BZR_COLUMNS is set, take it, user is always right
1445
1448
    try:
1448
1451
        pass
1449
1452
 
1450
1453
    isatty = getattr(sys.stdout, 'isatty', None)
1451
 
    if  isatty is None or not isatty():
 
1454
    if isatty is None or not isatty():
1452
1455
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
1453
1456
        return None
1454
1457
 
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))
 
1458
    # Query the OS
 
1459
    width, height = os_size = _terminal_size(None, None)
 
1460
    global _first_terminal_size, _terminal_size_state
 
1461
    if _terminal_size_state == 'no_data':
 
1462
        _first_terminal_size = os_size
 
1463
        _terminal_size_state = 'unchanged'
 
1464
    elif (_terminal_size_state == 'unchanged' and
 
1465
          _first_terminal_size != os_size):
 
1466
        _terminal_size_state = 'changed'
 
1467
 
 
1468
    # If the OS claims to know how wide the terminal is, and this value has
 
1469
    # ever changed, use that.
 
1470
    if _terminal_size_state == 'changed':
 
1471
        if width is not None and width > 0:
 
1472
            return width
 
1473
 
 
1474
    # If COLUMNS is set, use it.
1458
1475
    try:
1459
1476
        return int(os.environ['COLUMNS'])
1460
1477
    except (KeyError, ValueError):
1461
1478
        pass
1462
1479
 
1463
 
    width, height = _terminal_size(None, None)
1464
 
    if width <= 0:
1465
 
        # Consider invalid values as meaning no width
1466
 
        return None
 
1480
    # Finally, use an unchanged size from the OS, if we have one.
 
1481
    if _terminal_size_state == 'unchanged':
 
1482
        if width is not None and width > 0:
 
1483
            return width
1467
1484
 
1468
 
    return width
 
1485
    # The width could not be determined.
 
1486
    return None
1469
1487
 
1470
1488
 
1471
1489
def _win32_terminal_size(width, height):
1498
1516
    _terminal_size = _ioctl_terminal_size
1499
1517
 
1500
1518
 
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
1519
def supports_executable():
1527
1520
    return sys.platform != "win32"
1528
1521
 
2095
2088
    base = dirname(bzrlib.__file__)
2096
2089
    if getattr(sys, 'frozen', None):    # bzr.exe
2097
2090
        base = abspath(pathjoin(base, '..', '..'))
2098
 
    filename = pathjoin(base, resource_relpath)
2099
 
    return open(filename, 'rU').read()
2100
 
 
 
2091
    f = file(pathjoin(base, resource_relpath), "rU")
 
2092
    try:
 
2093
        return f.read()
 
2094
    finally:
 
2095
        f.close()
2101
2096
 
2102
2097
def file_kind_from_stat_mode_thunk(mode):
2103
2098
    global file_kind_from_stat_mode
2302
2297
        return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2298
else:
2304
2299
    open_file = open
 
2300
 
 
2301
 
 
2302
def getuser_unicode():
 
2303
    """Return the username as unicode.
 
2304
    """
 
2305
    try:
 
2306
        user_encoding = get_user_encoding()
 
2307
        username = getpass.getuser().decode(user_encoding)
 
2308
    except UnicodeDecodeError:
 
2309
        raise errors.BzrError("Can't decode username as %s." % \
 
2310
                user_encoding)
 
2311
    return username