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
25
26
from bzrlib.lazy_import import lazy_import
26
27
lazy_import(globals(), """
27
28
from datetime import datetime
29
30
from ntpath import (abspath as _nt_abspath,
31
32
normpath as _nt_normpath,
360
361
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
371
364
def _win32_rename(old, new):
372
365
"""We expect to be able to atomically replace 'new' with old.
375
368
and then deleted.
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
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)
399
382
def _mac_getcwd():
400
383
return unicodedata.normalize('NFC', os.getcwdu())
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
411
394
dirname = os.path.dirname
412
395
basename = os.path.basename
413
396
split = os.path.split
471
454
On my standard US Windows XP, the preferred encoding is
472
455
cp1252, but the console is cp437
457
:param trace: If True trace the selected encoding via mutter().
474
459
from bzrlib.trace import mutter
475
460
output_encoding = getattr(sys.stdout, 'encoding', None)
477
462
input_encoding = getattr(sys.stdin, 'encoding', None)
478
463
if not input_encoding:
479
464
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
466
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
469
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
471
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
475
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
476
if output_encoding == 'cp0':
488
477
# invalid encoding (cp0 means 'no codepage' on Windows)
489
478
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
480
mutter('cp0 is invalid encoding.'
491
481
' encoding stdout as osutils.get_user_encoding() %r',
949
939
def parent_directories(filename):
950
940
"""Return the list of parent directories, deepest first.
952
942
For example, parent_directories("a/b/c") -> ["a/b", "a"].
978
968
# NB: This docstring is just an example, not a doctest, because doctest
979
969
# currently can't cope with the use of lazy imports in this namespace --
982
972
# This currently doesn't report the failure at the time it occurs, because
983
973
# they tend to happen very early in startup when we can't check config
984
974
# files etc, and also we want to report all failures but not spam the user
1250
1240
# but for now, we haven't optimized...
1251
1241
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)
1253
1259
def safe_unicode(unicode_or_utf8_string):
1254
1260
"""Coerce unicode_or_utf8_string into unicode.
1338
1344
def normalizes_filenames():
1339
1345
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1343
1349
return _platform_normalizes_filenames
1349
1355
On platforms where the system normalizes filenames (Mac OSX),
1350
1356
you can access a file by any path which will normalize correctly.
1351
1357
On platforms where the system does not normalize filenames
1352
(Windows, Linux), you have to access a file by its exact path.
1358
(everything else), you have to access a file by its exact path.
1354
1360
Internally, bzr only supports NFC normalization, since that is
1355
1361
the standard for XML documents.
1417
1423
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
1421
1433
def terminal_width():
1422
1434
"""Return terminal width.
1427
1439
- if BZR_COLUMNS is set, returns its value
1428
1440
- if there is no controlling terminal, returns None
1441
- query the OS, if the queried size has changed since the last query,
1429
1443
- if COLUMNS is set, returns its value,
1444
- if the OS has a value (even though it's never changed), return its value.
1431
1446
From there, we need to query the OS to get the size of the controlling
1449
On Unices we query the OS by:
1435
1450
- get termios.TIOCGWINSZ
1436
1451
- if an error occurs or a negative value is obtained, returns None
1453
On Windows we query the OS by:
1440
1454
- win32utils.get_console_size() decides,
1441
1455
- 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
1444
1470
# If BZR_COLUMNS is set, take it, user is always right
1450
1476
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1477
if isatty is None or not isatty():
1452
1478
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
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))
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.
1459
1499
return int(os.environ['COLUMNS'])
1460
1500
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
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:
1508
# The width could not be determined.
1471
1512
def _win32_terminal_size(width, height):
1498
1539
_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
1526
1542
def supports_executable():
1527
1543
return sys.platform != "win32"
2028
2048
def send_all(sock, bytes, report_activity=None):
2029
2049
"""Send all bytes on a socket.
2031
2051
Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2052
some platforms, and catches EINTR which may be thrown if the send is
2033
2053
interrupted by a signal.
2035
2055
This is preferred to socket.sendall(), because it avoids portability bugs
2036
2056
and provides activity reporting.
2038
2058
:param report_activity: Call this as bytes are read, see
2039
2059
Transport._report_activity
2095
2115
base = dirname(bzrlib.__file__)
2096
2116
if getattr(sys, 'frozen', None): # bzr.exe
2097
2117
base = abspath(pathjoin(base, '..', '..'))
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2118
f = file(pathjoin(base, resource_relpath), "rU")
2102
2124
def file_kind_from_stat_mode_thunk(mode):
2103
2125
global file_kind_from_stat_mode
2127
2149
def until_no_eintr(f, *a, **kw):
2128
2150
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2152
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2153
if EINTR does occur. This is typically only true for low-level operations
2132
2154
like os.read. If in any doubt, don't use this.
2263
2285
if sys.platform == 'win32':
2264
2286
def open_file(filename, mode='r', bufsize=-1):
2265
2287
"""This function is used to override the ``open`` builtin.
2267
2289
But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2290
child processes. Deleting or renaming a closed file opened with this
2269
2291
function is not blocking child processes.
2302
2324
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2326
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
