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)
25
27
from bzrlib.lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
29
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
40
from tempfile import mkdtemp
45
from tempfile import (
43
50
from bzrlib import (
298
305
running python.exe under cmd.exe return capital C:\\
299
306
running win32 python inside a cygwin shell returns lowercase c:\\
301
drive, path = ntpath.splitdrive(path)
308
drive, path = _nt_splitdrive(path)
302
309
return drive.upper() + path
305
312
def _win32_abspath(path):
306
# Real ntpath.abspath doesn't have a problem with a unicode cwd
307
return _win32_fixdrive(ntpath.abspath(unicode(path)).replace('\\', '/'))
313
# Real _nt_abspath doesn't have a problem with a unicode cwd
314
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
310
317
def _win98_abspath(path):
321
328
# /path => C:/path
322
329
path = unicode(path)
323
330
# check for absolute path
324
drive = ntpath.splitdrive(path)[0]
331
drive = _nt_splitdrive(path)[0]
325
332
if drive == '' and path[:2] not in('//','\\\\'):
326
333
cwd = os.getcwdu()
327
334
# we cannot simply os.path.join cwd and path
328
335
# because os.path.join('C:','/path') produce '/path'
329
336
# and this is incorrect
330
337
if path[:1] in ('/','\\'):
331
cwd = ntpath.splitdrive(cwd)[0]
338
cwd = _nt_splitdrive(cwd)[0]
333
340
path = cwd + '\\' + path
334
return _win32_fixdrive(ntpath.normpath(path).replace('\\', '/'))
341
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
337
344
def _win32_realpath(path):
338
# Real ntpath.realpath doesn't have a problem with a unicode cwd
339
return _win32_fixdrive(ntpath.realpath(unicode(path)).replace('\\', '/'))
345
# Real _nt_realpath doesn't have a problem with a unicode cwd
346
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
342
349
def _win32_pathjoin(*args):
343
return ntpath.join(*args).replace('\\', '/')
350
return _nt_join(*args).replace('\\', '/')
346
353
def _win32_normpath(path):
347
return _win32_fixdrive(ntpath.normpath(unicode(path)).replace('\\', '/'))
354
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
350
357
def _win32_getcwd():
389
396
basename = os.path.basename
390
397
split = os.path.split
391
398
splitext = os.path.splitext
392
# These were already lazily imported into local scope
399
# These were already imported into local scope
393
400
# mkdtemp = tempfile.mkdtemp
394
401
# rmtree = shutil.rmtree
448
455
On my standard US Windows XP, the preferred encoding is
449
456
cp1252, but the console is cp437
451
:param trace: If True trace the selected encoding via mutter().
453
458
from bzrlib.trace import mutter
454
459
output_encoding = getattr(sys.stdout, 'encoding', None)
456
461
input_encoding = getattr(sys.stdin, 'encoding', None)
457
462
if not input_encoding:
458
463
output_encoding = get_user_encoding()
460
mutter('encoding stdout as osutils.get_user_encoding() %r',
464
mutter('encoding stdout as osutils.get_user_encoding() %r',
463
467
output_encoding = input_encoding
465
mutter('encoding stdout as sys.stdin encoding %r',
468
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
469
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
470
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
470
471
if output_encoding == 'cp0':
471
472
# invalid encoding (cp0 means 'no codepage' on Windows)
472
473
output_encoding = get_user_encoding()
474
mutter('cp0 is invalid encoding.'
474
mutter('cp0 is invalid encoding.'
475
475
' encoding stdout as osutils.get_user_encoding() %r',
512
512
"""True if f is a regular file."""
514
return stat.S_ISREG(os.lstat(f)[stat.ST_MODE])
514
return S_ISREG(os.lstat(f)[ST_MODE])
519
519
"""True if f is a symlink."""
521
return stat.S_ISLNK(os.lstat(f)[stat.ST_MODE])
521
return S_ISLNK(os.lstat(f)[ST_MODE])
933
933
def parent_directories(filename):
934
934
"""Return the list of parent directories, deepest first.
936
936
For example, parent_directories("a/b/c") -> ["a/b", "a"].
962
962
# NB: This docstring is just an example, not a doctest, because doctest
963
963
# currently can't cope with the use of lazy imports in this namespace --
966
966
# This currently doesn't report the failure at the time it occurs, because
967
967
# they tend to happen very early in startup when we can't check config
968
968
# files etc, and also we want to report all failures but not spam the user
1133
1133
def relpath(base, path):
1134
"""Return path relative to base, or raise PathNotChild exception.
1134
"""Return path relative to base, or raise exception.
1136
1136
The path may be either an absolute path or a path relative to the
1137
1137
current working directory.
1139
1139
os.path.commonprefix (python2.4) has a bad bug that it works just
1140
1140
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
1141
1141
avoids that problem.
1143
NOTE: `base` should not have a trailing slash otherwise you'll get
1144
PathNotChild exceptions regardless of `path`.
1147
1144
if len(base) < MIN_ABS_PATHLENGTH:
1234
1231
# but for now, we haven't optimized...
1235
1232
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)
1253
1234
def safe_unicode(unicode_or_utf8_string):
1254
1235
"""Coerce unicode_or_utf8_string into unicode.
1338
1319
def normalizes_filenames():
1339
1320
"""Return True if this platform normalizes unicode filenames.
1322
Mac OSX does, Windows/Linux do not.
1343
1324
return _platform_normalizes_filenames
1349
1330
On platforms where the system normalizes filenames (Mac OSX),
1350
1331
you can access a file by any path which will normalize correctly.
1351
1332
On platforms where the system does not normalize filenames
1352
(everything else), you have to access a file by its exact path.
1333
(Windows, Linux), you have to access a file by its exact path.
1354
1335
Internally, bzr only supports NFC normalization, since that is
1355
1336
the standard for XML documents.
1417
1398
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
1427
1402
def terminal_width():
1428
1403
"""Return terminal width.
1433
1408
- if BZR_COLUMNS is set, returns its value
1434
1409
- if there is no controlling terminal, returns None
1435
- query the OS, if the queried size has changed since the last query,
1437
1410
- if COLUMNS is set, returns its value,
1438
- if the OS has a value (even though it's never changed), return its value.
1440
1412
From there, we need to query the OS to get the size of the controlling
1443
On Unices we query the OS by:
1444
1416
- get termios.TIOCGWINSZ
1445
1417
- if an error occurs or a negative value is obtained, returns None
1447
On Windows we query the OS by:
1448
1421
- win32utils.get_console_size() decides,
1449
1422
- 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
1464
1425
# If BZR_COLUMNS is set, take it, user is always right
1470
1431
isatty = getattr(sys.stdout, 'isatty', None)
1471
if isatty is None or not isatty():
1432
if isatty is None or not isatty():
1472
1433
# Don't guess, setting BZR_COLUMNS is the recommended way to override.
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.
1436
# If COLUMNS is set, take it, the terminal knows better (even inside a
1437
# given terminal, the application can decide to set COLUMNS to a lower
1438
# value (splitted screen) or a bigger value (scroll bars))
1493
1440
return int(os.environ['COLUMNS'])
1494
1441
except (KeyError, ValueError):
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:
1444
width, height = _terminal_size(None, None)
1446
# Consider invalid values as meaning no width
1502
# The width could not be determined.
1506
1452
def _win32_terminal_size(width, height):
1533
1479
_terminal_size = _ioctl_terminal_size
1482
def _terminal_size_changed(signum, frame):
1483
"""Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
1484
width, height = _terminal_size(None, None)
1485
if width is not None:
1486
os.environ['COLUMNS'] = str(width)
1489
_registered_sigwinch = False
1490
def watch_sigwinch():
1491
"""Register for SIGWINCH, once and only once.
1493
Do nothing if the signal module is not available.
1495
global _registered_sigwinch
1496
if not _registered_sigwinch:
1499
if getattr(signal, "SIGWINCH", None) is not None:
1500
set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
1502
# python doesn't provide signal support, nothing we can do about it
1504
_registered_sigwinch = True
1536
1507
def supports_executable():
1537
1508
return sys.platform != "win32"
2042
2009
def send_all(sock, bytes, report_activity=None):
2043
2010
"""Send all bytes on a socket.
2045
2012
Breaks large blocks in smaller chunks to avoid buffering limitations on
2046
2013
some platforms, and catches EINTR which may be thrown if the send is
2047
2014
interrupted by a signal.
2049
2016
This is preferred to socket.sendall(), because it avoids portability bugs
2050
2017
and provides activity reporting.
2052
2019
:param report_activity: Call this as bytes are read, see
2053
2020
Transport._report_activity
2109
2076
base = dirname(bzrlib.__file__)
2110
2077
if getattr(sys, 'frozen', None): # bzr.exe
2111
2078
base = abspath(pathjoin(base, '..', '..'))
2112
f = file(pathjoin(base, resource_relpath), "rU")
2079
filename = pathjoin(base, resource_relpath)
2080
return open(filename, 'rU').read()
2118
2083
def file_kind_from_stat_mode_thunk(mode):
2119
2084
global file_kind_from_stat_mode
2143
2108
def until_no_eintr(f, *a, **kw):
2144
2109
"""Run f(*a, **kw), retrying if an EINTR error occurs.
2146
2111
WARNING: you must be certain that it is safe to retry the call repeatedly
2147
2112
if EINTR does occur. This is typically only true for low-level operations
2148
2113
like os.read. If in any doubt, don't use this.
2166
@deprecated_function(deprecated_in((2, 2, 0)))
2167
2131
def re_compile_checked(re_string, flags=0, where=""):
2168
2132
"""Return a compiled re, or raise a sensible error.
2179
2143
re_obj = re.compile(re_string, flags)
2180
2144
re_obj.search("")
2182
except errors.InvalidPattern, e:
2184
2148
where = ' in ' + where
2185
2149
# despite the name 'error' is a type
2186
raise errors.BzrCommandError('Invalid regular expression%s: %s'
2150
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
2151
% (where, re_string, e))
2190
2154
if sys.platform == "win32":
2280
2244
if sys.platform == 'win32':
2281
2245
def open_file(filename, mode='r', bufsize=-1):
2282
2246
"""This function is used to override the ``open`` builtin.
2284
2248
But it uses O_NOINHERIT flag so the file handle is not inherited by
2285
2249
child processes. Deleting or renaming a closed file opened with this
2286
2250
function is not blocking child processes.
2319
2283
return os.fdopen(os.open(filename, flags), mode, bufsize)
2321
2285
open_file = open
2324
def getuser_unicode():
2325
"""Return the username as unicode.
2328
user_encoding = get_user_encoding()
2329
username = getpass.getuser().decode(user_encoding)
2330
except UnicodeDecodeError:
2331
raise errors.BzrError("Can't decode username as %s." % \
added
removed
bzrlib/osutils.py
