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 (
48
37
from bzrlib import (
303
292
running python.exe under cmd.exe return capital C:\\
304
293
running win32 python inside a cygwin shell returns lowercase c:\\
306
drive, path = _nt_splitdrive(path)
295
drive, path = ntpath.splitdrive(path)
307
296
return drive.upper() + path
310
299
def _win32_abspath(path):
311
# Real _nt_abspath doesn't have a problem with a unicode cwd
312
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
300
# Real ntpath.abspath doesn't have a problem with a unicode cwd
301
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
315
304
def _win98_abspath(path):
326
315
# /path => C:/path
327
316
path = unicode(path)
328
317
# check for absolute path
329
drive = _nt_splitdrive(path)[0]
318
drive = ntpath.splitdrive(path)[0]
330
319
if drive == '' and path[:2] not in('//','\\\\'):
331
320
cwd = os.getcwdu()
332
321
# we cannot simply os.path.join cwd and path
333
322
# because os.path.join('C:','/path') produce '/path'
334
323
# and this is incorrect
335
324
if path[:1] in ('/','\\'):
336
cwd = _nt_splitdrive(cwd)[0]
325
cwd = ntpath.splitdrive(cwd)[0]
338
327
path = cwd + '\\' + path
339
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
328
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
342
331
def _win32_realpath(path):
343
# Real _nt_realpath doesn't have a problem with a unicode cwd
344
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
332
# Real ntpath.realpath doesn't have a problem with a unicode cwd
333
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
347
336
def _win32_pathjoin(*args):
348
return _nt_join(*args).replace('\\', '/')
337
return ntpath.join(*args).replace('\\', '/')
351
340
def _win32_normpath(path):
352
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
341
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
355
344
def _win32_getcwd():
360
349
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
352
def _win32_rename(old, new):
372
353
"""We expect to be able to atomically replace 'new' with old.
375
356
and then deleted.
378
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
359
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
379
360
except OSError, e:
380
361
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
381
362
# 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
370
def _mac_getcwd():
400
371
return unicodedata.normalize('NFC', os.getcwdu())
406
377
realpath = _posix_realpath
407
378
pathjoin = os.path.join
408
379
normpath = os.path.normpath
409
rename = _wrapped_rename # overridden below on win32
410
380
getcwd = os.getcwdu
411
382
dirname = os.path.dirname
412
383
basename = os.path.basename
413
384
split = os.path.split
414
385
splitext = os.path.splitext
415
# These were already imported into local scope
416
# mkdtemp = tempfile.mkdtemp
417
# rmtree = shutil.rmtree
386
mkdtemp = tempfile.mkdtemp
387
rmtree = shutil.rmtree
419
389
MIN_ABS_PATHLENGTH = 1
471
441
On my standard US Windows XP, the preferred encoding is
472
442
cp1252, but the console is cp437
444
:param trace: If True trace the selected encoding via mutter().
474
446
from bzrlib.trace import mutter
475
447
output_encoding = getattr(sys.stdout, 'encoding', None)
477
449
input_encoding = getattr(sys.stdin, 'encoding', None)
478
450
if not input_encoding:
479
451
output_encoding = get_user_encoding()
480
mutter('encoding stdout as osutils.get_user_encoding() %r',
453
mutter('encoding stdout as osutils.get_user_encoding() %r',
483
456
output_encoding = input_encoding
484
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
458
mutter('encoding stdout as sys.stdin encoding %r',
486
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
462
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
487
463
if output_encoding == 'cp0':
488
464
# invalid encoding (cp0 means 'no codepage' on Windows)
489
465
output_encoding = get_user_encoding()
490
mutter('cp0 is invalid encoding.'
467
mutter('cp0 is invalid encoding.'
491
468
' encoding stdout as osutils.get_user_encoding() %r',
528
505
"""True if f is a regular file."""
530
return S_ISREG(os.lstat(f)[ST_MODE])
507
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
535
512
"""True if f is a symlink."""
537
return S_ISLNK(os.lstat(f)[ST_MODE])
514
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
949
926
def parent_directories(filename):
950
927
"""Return the list of parent directories, deepest first.
952
929
For example, parent_directories("a/b/c") -> ["a/b", "a"].
978
955
# NB: This docstring is just an example, not a doctest, because doctest
979
956
# currently can't cope with the use of lazy imports in this namespace --
982
959
# This currently doesn't report the failure at the time it occurs, because
983
960
# they tend to happen very early in startup when we can't check config
984
961
# files etc, and also we want to report all failures but not spam the user
1250
1227
# but for now, we haven't optimized...
1251
1228
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)
1253
1246
def safe_unicode(unicode_or_utf8_string):
1254
1247
"""Coerce unicode_or_utf8_string into unicode.
1338
1331
def normalizes_filenames():
1339
1332
"""Return True if this platform normalizes unicode filenames.
1341
Mac OSX does, Windows/Linux do not.
1343
1336
return _platform_normalizes_filenames
1349
1342
On platforms where the system normalizes filenames (Mac OSX),
1350
1343
you can access a file by any path which will normalize correctly.
1351
1344
On platforms where the system does not normalize filenames
1352
(Windows, Linux), you have to access a file by its exact path.
1345
(everything else), you have to access a file by its exact path.
1354
1347
Internally, bzr only supports NFC normalization, since that is
1355
1348
the standard for XML documents.
1417
1410
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
1421
1420
def terminal_width():
1422
1421
"""Return terminal width.
1427
1426
- if BZR_COLUMNS is set, returns its value
1428
1427
- if there is no controlling terminal, returns None
1428
- query the OS, if the queried size has changed since the last query,
1429
1430
- if COLUMNS is set, returns its value,
1431
- if the OS has a value (even though it's never changed), return its value.
1431
1433
From there, we need to query the OS to get the size of the controlling
1436
On Unices we query the OS by:
1435
1437
- get termios.TIOCGWINSZ
1436
1438
- if an error occurs or a negative value is obtained, returns None
1440
On Windows we query the OS by:
1440
1441
- win32utils.get_console_size() decides,
1441
1442
- 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
1444
1457
# If BZR_COLUMNS is set, take it, user is always right
1450
1463
isatty = getattr(sys.stdout, 'isatty', None)
1451
if isatty is None or not isatty():
1464
if isatty is None or not isatty():
1452
1465
# 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))
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.
1459
1486
return int(os.environ['COLUMNS'])
1460
1487
except (KeyError, ValueError):
1463
width, height = _terminal_size(None, None)
1465
# Consider invalid values as meaning no width
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:
1495
# The width could not be determined.
1471
1499
def _win32_terminal_size(width, height):
1498
1526
_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
1529
def supports_executable():
1527
1530
return sys.platform != "win32"
2028
2035
def send_all(sock, bytes, report_activity=None):
2029
2036
"""Send all bytes on a socket.
2031
2038
Breaks large blocks in smaller chunks to avoid buffering limitations on
2032
2039
some platforms, and catches EINTR which may be thrown if the send is
2033
2040
interrupted by a signal.
2035
2042
This is preferred to socket.sendall(), because it avoids portability bugs
2036
2043
and provides activity reporting.
2038
2045
:param report_activity: Call this as bytes are read, see
2039
2046
Transport._report_activity
2095
2102
base = dirname(bzrlib.__file__)
2096
2103
if getattr(sys, 'frozen', None): # bzr.exe
2097
2104
base = abspath(pathjoin(base, '..', '..'))
2098
filename = pathjoin(base, resource_relpath)
2099
return open(filename, 'rU').read()
2105
f = file(pathjoin(base, resource_relpath), "rU")
2102
2111
def file_kind_from_stat_mode_thunk(mode):
2103
2112
global file_kind_from_stat_mode
2127
2136
def until_no_eintr(f, *a, **kw):
2128
2137
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2130
2139
WARNING: you must be certain that it is safe to retry the call repeatedly
2131
2140
if EINTR does occur. This is typically only true for low-level operations
2132
2141
like os.read. If in any doubt, don't use this.
2263
2272
if sys.platform == 'win32':
2264
2273
def open_file(filename, mode='r', bufsize=-1):
2265
2274
"""This function is used to override the ``open`` builtin.
2267
2276
But it uses O_NOINHERIT flag so the file handle is not inherited by
2268
2277
child processes. Deleting or renaming a closed file opened with this
2269
2278
function is not blocking child processes.
2302
2311
return os.fdopen(os.open(filename, flags), mode, bufsize)
2304
2313
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
