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
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from datetime import datetime
29
from ntpath import (abspath as _nt_abspath,
31
normpath as _nt_normpath,
32
realpath as _nt_realpath,
33
splitdrive as _nt_splitdrive,
43
from tempfile import (
37
48
from bzrlib import (
292
303
running python.exe under cmd.exe return capital C:\\
293
304
running win32 python inside a cygwin shell returns lowercase c:\\
295
drive, path = ntpath.splitdrive(path)
306
drive, path = _nt_splitdrive(path)
296
307
return drive.upper() + path
299
310
def _win32_abspath(path):
300
# Real ntpath.abspath doesn't have a problem with a unicode cwd
301
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
304
315
def _win98_abspath(path):
315
326
# /path => C:/path
316
327
path = unicode(path)
317
328
# check for absolute path
318
drive = ntpath.splitdrive(path)[0]
329
drive = _nt_splitdrive(path)[0]
319
330
if drive == '' and path[:2] not in('//','\\\\'):
320
331
cwd = os.getcwdu()
321
332
# we cannot simply os.path.join cwd and path
322
333
# because os.path.join('C:','/path') produce '/path'
323
334
# and this is incorrect
324
335
if path[:1] in ('/','\\'):
325
cwd = ntpath.splitdrive(cwd)[0]
336
cwd = _nt_splitdrive(cwd)[0]
327
338
path = cwd + '\\' + path
328
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
331
342
def _win32_realpath(path):
332
# Real ntpath.realpath doesn't have a problem with a unicode cwd
333
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
336
347
def _win32_pathjoin(*args):
337
return ntpath.join(*args).replace('\\', '/')
348
return _nt_join(*args).replace('\\', '/')
340
351
def _win32_normpath(path):
341
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
344
355
def _win32_getcwd():
349
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
352
371
def _win32_rename(old, new):
353
372
"""We expect to be able to atomically replace 'new' with old.
356
375
and then deleted.
359
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)
360
379
except OSError, e:
361
380
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
362
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)
370
399
def _mac_getcwd():
371
400
return unicodedata.normalize('NFC', os.getcwdu())
377
406
realpath = _posix_realpath
378
407
pathjoin = os.path.join
379
408
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
380
410
getcwd = os.getcwdu
382
411
dirname = os.path.dirname
383
412
basename = os.path.basename
384
413
split = os.path.split
385
414
splitext = os.path.splitext
386
mkdtemp = tempfile.mkdtemp
387
rmtree = shutil.rmtree
415
# These were already imported into local scope
416
# mkdtemp = tempfile.mkdtemp
417
# rmtree = shutil.rmtree
389
419
MIN_ABS_PATHLENGTH = 1
441
471
On my standard US Windows XP, the preferred encoding is
442
472
cp1252, but the console is cp437
444
:param trace: If True trace the selected encoding via mutter().
446
474
from bzrlib.trace import mutter
447
475
output_encoding = getattr(sys.stdout, 'encoding', None)
449
477
input_encoding = getattr(sys.stdin, 'encoding', None)
450
478
if not input_encoding:
451
479
output_encoding = get_user_encoding()
453
mutter('encoding stdout as osutils.get_user_encoding() %r',
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
456
483
output_encoding = input_encoding
458
mutter('encoding stdout as sys.stdin encoding %r',
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
462
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
463
487
if output_encoding == 'cp0':
464
488
# invalid encoding (cp0 means 'no codepage' on Windows)
465
489
output_encoding = get_user_encoding()
467
mutter('cp0 is invalid encoding.'
490
mutter('cp0 is invalid encoding.'
468
491
' encoding stdout as osutils.get_user_encoding() %r',
505
528
"""True if f is a regular file."""
507
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
530
return S_ISREG(os.lstat(f)[ST_MODE])
512
535
"""True if f is a symlink."""
514
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
537
return S_ISLNK(os.lstat(f)[ST_MODE])
926
949
def parent_directories(filename):
927
950
"""Return the list of parent directories, deepest first.
929
952
For example, parent_directories("a/b/c") -> ["a/b", "a"].
955
978
# NB: This docstring is just an example, not a doctest, because doctest
956
979
# currently can't cope with the use of lazy imports in this namespace --
959
982
# This currently doesn't report the failure at the time it occurs, because
960
983
# they tend to happen very early in startup when we can't check config
961
984
# files etc, and also we want to report all failures but not spam the user
1227
1250
# but for now, we haven't optimized...
1228
1251
return [canonical_relpath(base, p) for p in paths]
1231
def decode_filename(filename):
1232
"""Decode the filename using the filesystem encoding
1234
If it is unicode, it is returned.
1235
Otherwise it is decoded from the the filesystem's encoding. If decoding
1236
fails, a errors.BadFilenameEncoding exception is raised.
1238
if type(filename) is unicode:
1241
return filename.decode(_fs_enc)
1242
except UnicodeDecodeError:
1243
raise errors.BadFilenameEncoding(filename, _fs_enc)
1246
1253
def safe_unicode(unicode_or_utf8_string):
1247
1254
"""Coerce unicode_or_utf8_string into unicode.
1331
1338
def normalizes_filenames():
1332
1339
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1336
1343
return _platform_normalizes_filenames
1342
1349
On platforms where the system normalizes filenames (Mac OSX),
1343
1350
you can access a file by any path which will normalize correctly.
1344
1351
On platforms where the system does not normalize filenames
1345
(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.
1347
1354
Internally, bzr only supports NFC normalization, since that is
1348
1355
the standard for XML documents.
1410
1417
terminal_width() returns None.
1413
# Keep some state so that terminal_width can detect if _terminal_size has
1414
# returned a different size since the process started. See docstring and
1415
# comments of terminal_width for details.
1416
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1417
_terminal_size_state = 'no_data'
1418
_first_terminal_size = None
1420
1421
def terminal_width():
1421
1422
"""Return terminal width.
1426
1427
- if BZR_COLUMNS is set, returns its value
1427
1428
- if there is no controlling terminal, returns None
1428
- query the OS, if the queried size has changed since the last query,
1430
1429
- if COLUMNS is set, returns its value,
1431
- if the OS has a value (even though it's never changed), return its value.
1433
1431
From there, we need to query the OS to get the size of the controlling
1436
On Unices we query the OS by:
1437
1435
- get termios.TIOCGWINSZ
1438
1436
- if an error occurs or a negative value is obtained, returns None
1440
On Windows we query the OS by:
1441
1440
- win32utils.get_console_size() decides,
1442
1441
- returns None on error (provided default value)
1444
# Note to implementors: if changing the rules for determining the width,
1445
# make sure you've considered the behaviour in these cases:
1446
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1447
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1449
# - (add more interesting cases here, if you find any)
1450
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1451
# but we don't want to register a signal handler because it is impossible
1452
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1453
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1454
# time so we can notice if the reported size has changed, which should have
1457
1444
# If BZR_COLUMNS is set, take it, user is always right
1463
1450
isatty = getattr(sys.stdout, 'isatty', None)
1464
if isatty is None or not isatty():
1451
if isatty is None or not isatty():
1465
1452
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1469
width, height = os_size = _terminal_size(None, None)
1470
global _first_terminal_size, _terminal_size_state
1471
if _terminal_size_state == 'no_data':
1472
_first_terminal_size = os_size
1473
_terminal_size_state = 'unchanged'
1474
elif (_terminal_size_state == 'unchanged' and
1475
_first_terminal_size != os_size):
1476
_terminal_size_state = 'changed'
1478
# If the OS claims to know how wide the terminal is, and this value has
1479
# ever changed, use that.
1480
if _terminal_size_state == 'changed':
1481
if width is not None and width > 0:
1484
# 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))
1486
1459
return int(os.environ['COLUMNS'])
1487
1460
except (KeyError, ValueError):
1490
# Finally, use an unchanged size from the OS, if we have one.
1491
if _terminal_size_state == 'unchanged':
1492
if width is not None and width > 0:
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
1495
# The width could not be determined.
1499
1471
def _win32_terminal_size(width, height):
1526
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
1529
1526
def supports_executable():
1530
1527
return sys.platform != "win32"
2035
2028
def send_all(sock, bytes, report_activity=None):
2036
2029
"""Send all bytes on a socket.
2038
2031
Breaks large blocks in smaller chunks to avoid buffering limitations on
2039
2032
some platforms, and catches EINTR which may be thrown if the send is
2040
2033
interrupted by a signal.
2042
2035
This is preferred to socket.sendall(), because it avoids portability bugs
2043
2036
and provides activity reporting.
2045
2038
:param report_activity: Call this as bytes are read, see
2046
2039
Transport._report_activity
2102
2095
base = dirname(bzrlib.__file__)
2103
2096
if getattr(sys, 'frozen', None): # bzr.exe
2104
2097
base = abspath(pathjoin(base, '..', '..'))
2105
f = file(pathjoin(base, resource_relpath), "rU")
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2111
2102
def file_kind_from_stat_mode_thunk(mode):
2112
2103
global file_kind_from_stat_mode
2136
2127
def until_no_eintr(f, *a, **kw):
2137
2128
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2139
2130
WARNING: you must be certain that it is safe to retry the call repeatedly
2140
2131
if EINTR does occur. This is typically only true for low-level operations
2141
2132
like os.read. If in any doubt, don't use this.
2272
2263
if sys.platform == 'win32':
2273
2264
def open_file(filename, mode='r', bufsize=-1):
2274
2265
"""This function is used to override the ``open`` builtin.
2276
2267
But it uses O_NOINHERIT flag so the file handle is not inherited by
2277
2268
child processes. Deleting or renaming a closed file opened with this
2278
2269
function is not blocking child processes.
2311
2302
return os.fdopen(os.open(filename, flags), mode, bufsize)
2313
2304
open_file = open
2316
def getuser_unicode():
2317
"""Return the username as unicode.
2320
user_encoding = get_user_encoding()
2321
username = getpass.getuser().decode(user_encoding)
2322
except UnicodeDecodeError:
2323
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
