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,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
27
25
from bzrlib.lazy_import import lazy_import
28
26
lazy_import(globals(), """
29
27
from datetime import datetime
31
from ntpath import (abspath as _nt_abspath,
33
normpath as _nt_normpath,
34
realpath as _nt_realpath,
35
splitdrive as _nt_splitdrive,
31
# We need to import both shutil and rmtree as we export the later on posix
32
# and need the former on windows
34
from shutil import rmtree
37
# We need to import both tempfile and mkdtemp as we export the later on posix
38
# and need the former on windows
45
from tempfile import (
40
from tempfile import mkdtemp
50
43
from bzrlib import (
305
298
running python.exe under cmd.exe return capital C:\\
306
299
running win32 python inside a cygwin shell returns lowercase c:\\
308
drive, path = _nt_splitdrive(path)
301
drive, path = ntpath.splitdrive(path)
309
302
return drive.upper() + path
312
305
def _win32_abspath(path):
313
# Real _nt_abspath doesn't have a problem with a unicode cwd
314
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
306
# Real ntpath.abspath doesn't have a problem with a unicode cwd
307
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
317
310
def _win98_abspath(path):
328
321
# /path => C:/path
329
322
path = unicode(path)
330
323
# check for absolute path
331
drive = _nt_splitdrive(path)[0]
324
drive = ntpath.splitdrive(path)[0]
332
325
if drive == '' and path[:2] not in('//','\\\\'):
333
326
cwd = os.getcwdu()
334
327
# we cannot simply os.path.join cwd and path
335
328
# because os.path.join('C:','/path') produce '/path'
336
329
# and this is incorrect
337
330
if path[:1] in ('/','\\'):
338
cwd = _nt_splitdrive(cwd)[0]
331
cwd = ntpath.splitdrive(cwd)[0]
340
333
path = cwd + '\\' + path
341
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
344
337
def _win32_realpath(path):
345
# Real _nt_realpath doesn't have a problem with a unicode cwd
346
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
349
342
def _win32_pathjoin(*args):
350
return _nt_join(*args).replace('\\', '/')
343
return ntpath.join(*args).replace('\\', '/')
353
346
def _win32_normpath(path):
354
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
357
350
def _win32_getcwd():
362
355
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
365
def _add_rename_error_details(e, old, new):
366
new_e = OSError(e.errno, "failed to rename %s to %s: %s"
367
% (old, new, e.strerror))
369
new_e.to_filename = new
373
358
def _win32_rename(old, new):
374
359
"""We expect to be able to atomically replace 'new' with old.
377
362
and then deleted.
380
fancy_rename(old, new, rename_func=_wrapped_rename, unlink_func=os.unlink)
365
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
381
366
except OSError, e:
382
367
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
383
368
# If we try to rename a non-existant file onto cwd, we get
391
def _wrapped_rename(old, new):
392
"""Rename a file or directory"""
395
except (IOError, OSError), e:
396
# this is eventually called by all rename-like functions, so should
398
raise _add_rename_error_details(e, old, new)
401
376
def _mac_getcwd():
402
377
return unicodedata.normalize('NFC', os.getcwdu())
408
383
realpath = _posix_realpath
409
384
pathjoin = os.path.join
410
385
normpath = os.path.normpath
411
rename = _wrapped_rename # overridden below on win32
412
386
getcwd = os.getcwdu
413
388
dirname = os.path.dirname
414
389
basename = os.path.basename
415
390
split = os.path.split
416
391
splitext = os.path.splitext
417
# These were already imported into local scope
392
# These were already lazily imported into local scope
418
393
# mkdtemp = tempfile.mkdtemp
419
394
# rmtree = shutil.rmtree
473
448
On my standard US Windows XP, the preferred encoding is
474
449
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
476
453
from bzrlib.trace import mutter
477
454
output_encoding = getattr(sys.stdout, 'encoding', None)
479
456
input_encoding = getattr(sys.stdin, 'encoding', None)
480
457
if not input_encoding:
481
458
output_encoding = get_user_encoding()
482
mutter('encoding stdout as osutils.get_user_encoding() %r',
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
485
463
output_encoding = input_encoding
486
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
465
mutter('encoding stdout as sys.stdin encoding %r',
488
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
489
470
if output_encoding == 'cp0':
490
471
# invalid encoding (cp0 means 'no codepage' on Windows)
491
472
output_encoding = get_user_encoding()
492
mutter('cp0 is invalid encoding.'
474
mutter('cp0 is invalid encoding.'
493
475
' encoding stdout as osutils.get_user_encoding() %r',
530
512
"""True if f is a regular file."""
532
return S_ISREG(os.lstat(f)[ST_MODE])
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
537
519
"""True if f is a symlink."""
539
return S_ISLNK(os.lstat(f)[ST_MODE])
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
951
933
def parent_directories(filename):
952
934
"""Return the list of parent directories, deepest first.
954
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
980
962
# NB: This docstring is just an example, not a doctest, because doctest
981
963
# currently can't cope with the use of lazy imports in this namespace --
984
966
# This currently doesn't report the failure at the time it occurs, because
985
967
# they tend to happen very early in startup when we can't check config
986
968
# files etc, and also we want to report all failures but not spam the user
1151
1133
def relpath(base, path):
1152
"""Return path relative to base, or raise exception.
1134
"""Return path relative to base, or raise PathNotChild exception.
1154
1136
The path may be either an absolute path or a path relative to the
1155
1137
current working directory.
1157
1139
os.path.commonprefix (python2.4) has a bad bug that it works just
1158
1140
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1159
1141
avoids that problem.
1143
NOTE: `base` should not have a trailing slash otherwise you'll get
1144
PathNotChild exceptions regardless of `path`.
1162
1147
if len(base) < MIN_ABS_PATHLENGTH:
1249
1234
# but for now, we haven't optimized...
1250
1235
return [canonical_relpath(base, p) for p in paths]
1238
def decode_filename(filename):
1239
"""Decode the filename using the filesystem encoding
1241
If it is unicode, it is returned.
1242
Otherwise it is decoded from the the filesystem's encoding. If decoding
1243
fails, a errors.BadFilenameEncoding exception is raised.
1245
if type(filename) is unicode:
1248
return filename.decode(_fs_enc)
1249
except UnicodeDecodeError:
1250
raise errors.BadFilenameEncoding(filename, _fs_enc)
1252
1253
def safe_unicode(unicode_or_utf8_string):
1253
1254
"""Coerce unicode_or_utf8_string into unicode.
1337
1338
def normalizes_filenames():
1338
1339
"""Return True if this platform normalizes unicode filenames.
1340
Mac OSX does, Windows/Linux do not.
1342
1343
return _platform_normalizes_filenames
1348
1349
On platforms where the system normalizes filenames (Mac OSX),
1349
1350
you can access a file by any path which will normalize correctly.
1350
1351
On platforms where the system does not normalize filenames
1351
(Windows, Linux), you have to access a file by its exact path.
1352
(everything else), you have to access a file by its exact path.
1353
1354
Internally, bzr only supports NFC normalization, since that is
1354
1355
the standard for XML documents.
1416
1417
terminal_width() returns None.
1420
# Keep some state so that terminal_width can detect if _terminal_size has
1421
# returned a different size since the process started. See docstring and
1422
# comments of terminal_width for details.
1423
# _terminal_size_state has 3 possible values: no_data, unchanged, and changed.
1424
_terminal_size_state = 'no_data'
1425
_first_terminal_size = None
1420
1427
def terminal_width():
1421
1428
"""Return terminal width.
1426
1433
- if BZR_COLUMNS is set, returns its value
1427
1434
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1428
1437
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1430
1440
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1434
1444
- get termios.TIOCGWINSZ
1435
1445
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1439
1448
- win32utils.get_console_size() decides,
1440
1449
- returns None on error (provided default value)
1451
# Note to implementors: if changing the rules for determining the width,
1452
# make sure you've considered the behaviour in these cases:
1453
# - M-x shell in emacs, where $COLUMNS is set and TIOCGWINSZ returns 0,0.
1454
# - bzr log | less, in bash, where $COLUMNS not set and TIOCGWINSZ returns
1456
# - (add more interesting cases here, if you find any)
1457
# Some programs implement "Use $COLUMNS (if set) until SIGWINCH occurs",
1458
# but we don't want to register a signal handler because it is impossible
1459
# to do so without risking EINTR errors in Python <= 2.6.5 (see
1460
# <http://bugs.python.org/issue8354>). Instead we check TIOCGWINSZ every
1461
# time so we can notice if the reported size has changed, which should have
1443
1464
# If BZR_COLUMNS is set, take it, user is always right
1449
1470
isatty = getattr(sys.stdout, 'isatty', None)
1450
if isatty is None or not isatty():
1471
if isatty is None or not isatty():
1451
1472
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
1454
# If COLUMNS is set, take it, the terminal knows better (even inside a
1455
# given terminal, the application can decide to set COLUMNS to a lower
1456
# value (splitted screen) or a bigger value (scroll bars))
1476
width, height = os_size = _terminal_size(None, None)
1477
global _first_terminal_size, _terminal_size_state
1478
if _terminal_size_state == 'no_data':
1479
_first_terminal_size = os_size
1480
_terminal_size_state = 'unchanged'
1481
elif (_terminal_size_state == 'unchanged' and
1482
_first_terminal_size != os_size):
1483
_terminal_size_state = 'changed'
1485
# If the OS claims to know how wide the terminal is, and this value has
1486
# ever changed, use that.
1487
if _terminal_size_state == 'changed':
1488
if width is not None and width > 0:
1491
# If COLUMNS is set, use it.
1458
1493
return int(os.environ['COLUMNS'])
1459
1494
except (KeyError, ValueError):
1462
width, height = _terminal_size(None, None)
1464
# Consider invalid values as meaning no width
1497
# Finally, use an unchanged size from the OS, if we have one.
1498
if _terminal_size_state == 'unchanged':
1499
if width is not None and width > 0:
1502
# The width could not be determined.
1470
1506
def _win32_terminal_size(width, height):
1497
1533
_terminal_size = _ioctl_terminal_size
1500
def _terminal_size_changed(signum, frame):
1501
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1502
width, height = _terminal_size(None, None)
1503
if width is not None:
1504
os.environ['COLUMNS'] = str(width)
1507
_registered_sigwinch = False
1508
def watch_sigwinch():
1509
"""Register for SIGWINCH, once and only once.
1511
Do nothing if the signal module is not available.
1513
global _registered_sigwinch
1514
if not _registered_sigwinch:
1517
if getattr(signal, "SIGWINCH", None) is not None:
1518
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1520
# python doesn't provide signal support, nothing we can do about it
1522
_registered_sigwinch = True
1525
1536
def supports_executable():
1526
1537
return sys.platform != "win32"
2027
2042
def send_all(sock, bytes, report_activity=None):
2028
2043
"""Send all bytes on a socket.
2030
2045
Breaks large blocks in smaller chunks to avoid buffering limitations on
2031
2046
some platforms, and catches EINTR which may be thrown if the send is
2032
2047
interrupted by a signal.
2034
2049
This is preferred to socket.sendall(), because it avoids portability bugs
2035
2050
and provides activity reporting.
2037
2052
:param report_activity: Call this as bytes are read, see
2038
2053
Transport._report_activity
2094
2109
base = dirname(bzrlib.__file__)
2095
2110
if getattr(sys, 'frozen', None): # bzr.exe
2096
2111
base = abspath(pathjoin(base, '..', '..'))
2097
filename = pathjoin(base, resource_relpath)
2098
return open(filename, 'rU').read()
2112
f = file(pathjoin(base, resource_relpath), "rU")
2101
2118
def file_kind_from_stat_mode_thunk(mode):
2102
2119
global file_kind_from_stat_mode
2126
2143
def until_no_eintr(f, *a, **kw):
2127
2144
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2129
2146
WARNING: you must be certain that it is safe to retry the call repeatedly
2130
2147
if EINTR does occur. This is typically only true for low-level operations
2131
2148
like os.read. If in any doubt, don't use this.
2262
2279
if sys.platform == 'win32':
2263
2280
def open_file(filename, mode='r', bufsize=-1):
2264
2281
"""This function is used to override the ``open`` builtin.
2266
2283
But it uses O_NOINHERIT flag so the file handle is not inherited by
2267
2284
child processes. Deleting or renaming a closed file opened with this
2268
2285
function is not blocking child processes.
2301
2318
return os.fdopen(os.open(filename, flags), mode, bufsize)
2303
2320
open_file = open
2323
def getuser_unicode():
2324
"""Return the username as unicode.
2327
user_encoding = get_user_encoding()
2328
username = getpass.getuser().decode(user_encoding)
2329
except UnicodeDecodeError:
2330
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
