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
26
25
from bzrlib.lazy_import import lazy_import
27
26
lazy_import(globals(), """
28
27
from datetime import datetime
30
29
from ntpath import (abspath as _nt_abspath,
32
31
normpath as _nt_normpath,
361
360
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
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))
367
new_e.to_filename = new
364
371
def _win32_rename(old, new):
365
372
"""We expect to be able to atomically replace 'new' with old.
368
375
and then deleted.
371
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
378
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
372
379
except OSError, e:
373
380
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
374
381
# If we try to rename a non-existant file onto cwd, we get
389
def _wrapped_rename(old, new):
390
"""Rename a file or directory"""
393
except (IOError, OSError), e:
394
# this is eventually called by all rename-like functions, so should
396
raise _add_rename_error_details(e, old, new)
382
399
def _mac_getcwd():
383
400
return unicodedata.normalize('NFC', os.getcwdu())
389
406
realpath = _posix_realpath
390
407
pathjoin = os.path.join
391
408
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
392
410
getcwd = os.getcwdu
394
411
dirname = os.path.dirname
395
412
basename = os.path.basename
396
413
split = os.path.split
454
471
On my standard US Windows XP, the preferred encoding is
455
472
cp1252, but the console is cp437
457
:param trace: If True trace the selected encoding via mutter().
459
474
from bzrlib.trace import mutter
460
475
output_encoding = getattr(sys.stdout, 'encoding', None)
462
477
input_encoding = getattr(sys.stdin, 'encoding', None)
463
478
if not input_encoding:
464
479
output_encoding = get_user_encoding()
466
mutter('encoding stdout as osutils.get_user_encoding() %r',
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
469
483
output_encoding = input_encoding
471
mutter('encoding stdout as sys.stdin encoding %r',
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
475
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
476
487
if output_encoding == 'cp0':
477
488
# invalid encoding (cp0 means 'no codepage' on Windows)
478
489
output_encoding = get_user_encoding()
480
mutter('cp0 is invalid encoding.'
490
mutter('cp0 is invalid encoding.'
481
491
' encoding stdout as osutils.get_user_encoding() %r',
939
949
def parent_directories(filename):
940
950
"""Return the list of parent directories, deepest first.
942
952
For example, parent_directories("a/b/c") -> ["a/b", "a"].
968
978
# NB: This docstring is just an example, not a doctest, because doctest
969
979
# currently can't cope with the use of lazy imports in this namespace --
972
982
# This currently doesn't report the failure at the time it occurs, because
973
983
# they tend to happen very early in startup when we can't check config
974
984
# files etc, and also we want to report all failures but not spam the user
1240
1250
# but for now, we haven't optimized...
1241
1251
return [canonical_relpath(base, p) for p in paths]
1244
def decode_filename(filename):
1245
"""Decode the filename using the filesystem encoding
1247
If it is unicode, it is returned.
1248
Otherwise it is decoded from the the filesystem's encoding. If decoding
1249
fails, a errors.BadFilenameEncoding exception is raised.
1251
if type(filename) is unicode:
1254
return filename.decode(_fs_enc)
1255
except UnicodeDecodeError:
1256
raise errors.BadFilenameEncoding(filename, _fs_enc)
1259
1253
def safe_unicode(unicode_or_utf8_string):
1260
1254
"""Coerce unicode_or_utf8_string into unicode.
1344
1338
def normalizes_filenames():
1345
1339
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1349
1343
return _platform_normalizes_filenames
1355
1349
On platforms where the system normalizes filenames (Mac OSX),
1356
1350
you can access a file by any path which will normalize correctly.
1357
1351
On platforms where the system does not normalize filenames
1358
(everything else), you have to access a file by its exact path.
1352
(Windows, Linux), you have to access a file by its exact path.
1360
1354
Internally, bzr only supports NFC normalization, since that is
1361
1355
the standard for XML documents.
1423
1417
terminal_width() returns None.
1426
# Keep some state so that terminal_width can detect if _terminal_size has
1427
# returned a different size since the process started. See docstring and
1428
# comments of terminal_width for details.
1429
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1430
_terminal_size_state = 'no_data'
1431
_first_terminal_size = None
1433
1421
def terminal_width():
1434
1422
"""Return terminal width.
1439
1427
- if BZR_COLUMNS is set, returns its value
1440
1428
- if there is no controlling terminal, returns None
1441
- query the OS, if the queried size has changed since the last query,
1443
1429
- if COLUMNS is set, returns its value,
1444
- if the OS has a value (even though it's never changed), return its value.
1446
1431
From there, we need to query the OS to get the size of the controlling
1449
On Unices we query the OS by:
1450
1435
- get termios.TIOCGWINSZ
1451
1436
- if an error occurs or a negative value is obtained, returns None
1453
On Windows we query the OS by:
1454
1440
- win32utils.get_console_size() decides,
1455
1441
- returns None on error (provided default value)
1457
# Note to implementors: if changing the rules for determining the width,
1458
# make sure you've considered the behaviour in these cases:
1459
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1460
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1462
# - (add more interesting cases here, if you find any)
1463
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1464
# but we don't want to register a signal handler because it is impossible
1465
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1466
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1467
# time so we can notice if the reported size has changed, which should have
1470
1444
# If BZR_COLUMNS is set, take it, user is always right
1476
1450
isatty = getattr(sys.stdout, 'isatty', None)
1477
if isatty is None or not isatty():
1451
if isatty is None or not isatty():
1478
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1482
width, height = os_size = _terminal_size(None, None)
1483
global _first_terminal_size, _terminal_size_state
1484
if _terminal_size_state == 'no_data':
1485
_first_terminal_size = os_size
1486
_terminal_size_state = 'unchanged'
1487
elif (_terminal_size_state == 'unchanged' and
1488
_first_terminal_size != os_size):
1489
_terminal_size_state = 'changed'
1491
# If the OS claims to know how wide the terminal is, and this value has
1492
# ever changed, use that.
1493
if _terminal_size_state == 'changed':
1494
if width is not None and width > 0:
1497
# If COLUMNS is set, use it.
1455
# If COLUMNS is set, take it, the terminal knows better (even inside a
1456
# given terminal, the application can decide to set COLUMNS to a lower
1457
# value (splitted screen) or a bigger value (scroll bars))
1499
1459
return int(os.environ['COLUMNS'])
1500
1460
except (KeyError, ValueError):
1503
# Finally, use an unchanged size from the OS, if we have one.
1504
if _terminal_size_state == 'unchanged':
1505
if width is not None and width > 0:
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1508
# The width could not be determined.
1512
1471
def _win32_terminal_size(width, height):
1539
1498
_terminal_size = _ioctl_terminal_size
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)
1508
_registered_sigwinch = False
1509
def watch_sigwinch():
1510
"""Register for SIGWINCH, once and only once.
1512
Do nothing if the signal module is not available.
1514
global _registered_sigwinch
1515
if not _registered_sigwinch:
1518
if getattr(signal, "SIGWINCH", None) is not None:
1519
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1521
# python doesn't provide signal support, nothing we can do about it
1523
_registered_sigwinch = True
1542
1526
def supports_executable():
1543
1527
return sys.platform != "win32"
2048
2028
def send_all(sock, bytes, report_activity=None):
2049
2029
"""Send all bytes on a socket.
2051
2031
Breaks large blocks in smaller chunks to avoid buffering limitations on
2052
2032
some platforms, and catches EINTR which may be thrown if the send is
2053
2033
interrupted by a signal.
2055
2035
This is preferred to socket.sendall(), because it avoids portability bugs
2056
2036
and provides activity reporting.
2058
2038
:param report_activity: Call this as bytes are read, see
2059
2039
Transport._report_activity
2115
2095
base = dirname(bzrlib.__file__)
2116
2096
if getattr(sys, 'frozen', None): # bzr.exe
2117
2097
base = abspath(pathjoin(base, '..', '..'))
2118
f = file(pathjoin(base, resource_relpath), "rU")
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2124
2102
def file_kind_from_stat_mode_thunk(mode):
2125
2103
global file_kind_from_stat_mode
2149
2127
def until_no_eintr(f, *a, **kw):
2150
2128
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2152
2130
WARNING: you must be certain that it is safe to retry the call repeatedly
2153
2131
if EINTR does occur. This is typically only true for low-level operations
2154
2132
like os.read. If in any doubt, don't use this.
2285
2263
if sys.platform == 'win32':
2286
2264
def open_file(filename, mode='r', bufsize=-1):
2287
2265
"""This function is used to override the ``open`` builtin.
2289
2267
But it uses O_NOINHERIT flag so the file handle is not inherited by
2290
2268
child processes. Deleting or renaming a closed file opened with this
2291
2269
function is not blocking child processes.
2324
2302
return os.fdopen(os.open(filename, flags), mode, bufsize)
2326
2304
open_file = open
2329
def getuser_unicode():
2330
"""Return the username as unicode.
2333
user_encoding = get_user_encoding()
2334
username = getpass.getuser().decode(user_encoding)
2335
except UnicodeDecodeError:
2336
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
