1
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
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
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
28
from datetime import datetime
30
from ntpath import (abspath as _nt_abspath,
32
normpath as _nt_normpath,
33
realpath as _nt_realpath,
34
splitdrive as _nt_splitdrive,
42
from tempfile import (
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
if sys.version_info < (2, 5):
57
import md5 as _mod_md5
59
import sha as _mod_sha
69
from bzrlib import symbol_versioning
72
# On win32, O_BINARY is used to indicate the file should
73
# be opened in binary mode, rather than text mode.
74
# On other platforms, O_BINARY doesn't exist, because
75
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
77
O_BINARY = getattr(os, 'O_BINARY', 0)
80
def make_readonly(filename):
81
"""Make a filename read-only."""
82
mod = os.lstat(filename).st_mode
83
if not stat.S_ISLNK(mod):
85
os.chmod(filename, mod)
88
def make_writable(filename):
89
mod = os.lstat(filename).st_mode
90
if not stat.S_ISLNK(mod):
92
os.chmod(filename, mod)
95
def minimum_path_selection(paths):
96
"""Return the smallset subset of paths which are outside paths.
98
:param paths: A container (and hence not None) of paths.
99
:return: A set of paths sufficient to include everything in paths via
100
is_inside, drawn from the paths parameter.
105
return path.split('/')
106
sorted_paths = sorted(list(paths), key=sort_key)
108
for path in sorted_paths:
109
if len(search_paths) == 0:
110
# Result is empty, add first path
111
search_paths.append(path)
113
if not is_inside(search_paths[-1], path):
114
# This path is unique, add it
115
search_paths.append(path)
117
return set(search_paths)
124
"""Return a quoted filename filename
126
This previously used backslash quoting, but that works poorly on
128
# TODO: I'm not really sure this is the best format either.x
130
if _QUOTE_RE is None:
131
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
133
if _QUOTE_RE.search(f):
139
_directory_kind = 'directory'
142
"""Return the current umask"""
143
# Assume that people aren't messing with the umask while running
144
# XXX: This is not thread safe, but there is no way to get the
145
# umask without setting it
153
_directory_kind: "/",
155
'tree-reference': '+',
159
def kind_marker(kind):
161
return _kind_marker_map[kind]
163
raise errors.BzrError('invalid file kind %r' % kind)
166
lexists = getattr(os.path, 'lexists', None)
170
stat = getattr(os, 'lstat', os.stat)
174
if e.errno == errno.ENOENT:
177
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
180
def fancy_rename(old, new, rename_func, unlink_func):
181
"""A fancy rename, when you don't have atomic rename.
183
:param old: The old path, to rename from
184
:param new: The new path, to rename to
185
:param rename_func: The potentially non-atomic rename function
186
:param unlink_func: A way to delete the target file if the full rename succeeds
189
# sftp rename doesn't allow overwriting, so play tricks:
190
base = os.path.basename(new)
191
dirname = os.path.dirname(new)
192
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
193
tmp_name = pathjoin(dirname, tmp_name)
195
# Rename the file out of the way, but keep track if it didn't exist
196
# We don't want to grab just any exception
197
# something like EACCES should prevent us from continuing
198
# The downside is that the rename_func has to throw an exception
199
# with an errno = ENOENT, or NoSuchFile
202
rename_func(new, tmp_name)
203
except (errors.NoSuchFile,), e:
206
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
207
# function raises an IOError with errno is None when a rename fails.
208
# This then gets caught here.
209
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
212
if (getattr(e, 'errno', None) is None
213
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
221
# This may throw an exception, in which case success will
223
rename_func(old, new)
225
except (IOError, OSError), e:
226
# source and target may be aliases of each other (e.g. on a
227
# case-insensitive filesystem), so we may have accidentally renamed
228
# source by when we tried to rename target
229
if not (file_existed and e.errno in (None, errno.ENOENT)):
233
# If the file used to exist, rename it back into place
234
# otherwise just delete it from the tmp location
236
unlink_func(tmp_name)
238
rename_func(tmp_name, new)
241
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
242
# choke on a Unicode string containing a relative path if
243
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
245
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
246
def _posix_abspath(path):
247
# jam 20060426 rather than encoding to fsencoding
248
# copy posixpath.abspath, but use os.getcwdu instead
249
if not posixpath.isabs(path):
250
path = posixpath.join(getcwd(), path)
251
return posixpath.normpath(path)
254
def _posix_realpath(path):
255
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
258
def _win32_fixdrive(path):
259
"""Force drive letters to be consistent.
261
win32 is inconsistent whether it returns lower or upper case
262
and even if it was consistent the user might type the other
263
so we force it to uppercase
264
running python.exe under cmd.exe return capital C:\\
265
running win32 python inside a cygwin shell returns lowercase c:\\
267
drive, path = _nt_splitdrive(path)
268
return drive.upper() + path
271
def _win32_abspath(path):
272
# Real _nt_abspath doesn't have a problem with a unicode cwd
273
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
276
def _win98_abspath(path):
277
"""Return the absolute version of a path.
278
Windows 98 safe implementation (python reimplementation
279
of Win32 API function GetFullPathNameW)
284
# \\HOST\path => //HOST/path
285
# //HOST/path => //HOST/path
286
# path => C:/cwd/path
289
# check for absolute path
290
drive = _nt_splitdrive(path)[0]
291
if drive == '' and path[:2] not in('//','\\\\'):
293
# we cannot simply os.path.join cwd and path
294
# because os.path.join('C:','/path') produce '/path'
295
# and this is incorrect
296
if path[:1] in ('/','\\'):
297
cwd = _nt_splitdrive(cwd)[0]
299
path = cwd + '\\' + path
300
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
303
def _win32_realpath(path):
304
# Real _nt_realpath doesn't have a problem with a unicode cwd
305
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
308
def _win32_pathjoin(*args):
309
return _nt_join(*args).replace('\\', '/')
312
def _win32_normpath(path):
313
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
317
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
320
def _win32_mkdtemp(*args, **kwargs):
321
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
324
def _win32_rename(old, new):
325
"""We expect to be able to atomically replace 'new' with old.
327
On win32, if new exists, it must be moved out of the way first,
331
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
333
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
334
# If we try to rename a non-existant file onto cwd, we get
335
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
336
# if the old path doesn't exist, sometimes we get EACCES
337
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
343
return unicodedata.normalize('NFC', os.getcwdu())
346
# Default is to just use the python builtins, but these can be rebound on
347
# particular platforms.
348
abspath = _posix_abspath
349
realpath = _posix_realpath
350
pathjoin = os.path.join
351
normpath = os.path.normpath
354
dirname = os.path.dirname
355
basename = os.path.basename
356
split = os.path.split
357
splitext = os.path.splitext
358
# These were already imported into local scope
359
# mkdtemp = tempfile.mkdtemp
360
# rmtree = shutil.rmtree
362
MIN_ABS_PATHLENGTH = 1
365
if sys.platform == 'win32':
366
if win32utils.winver == 'Windows 98':
367
abspath = _win98_abspath
369
abspath = _win32_abspath
370
realpath = _win32_realpath
371
pathjoin = _win32_pathjoin
372
normpath = _win32_normpath
373
getcwd = _win32_getcwd
374
mkdtemp = _win32_mkdtemp
375
rename = _win32_rename
377
MIN_ABS_PATHLENGTH = 3
379
def _win32_delete_readonly(function, path, excinfo):
380
"""Error handler for shutil.rmtree function [for win32]
381
Helps to remove files and dirs marked as read-only.
383
exception = excinfo[1]
384
if function in (os.remove, os.rmdir) \
385
and isinstance(exception, OSError) \
386
and exception.errno == errno.EACCES:
392
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
393
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
394
return shutil.rmtree(path, ignore_errors, onerror)
395
elif sys.platform == 'darwin':
399
def get_terminal_encoding():
400
"""Find the best encoding for printing to the screen.
402
This attempts to check both sys.stdout and sys.stdin to see
403
what encoding they are in, and if that fails it falls back to
404
osutils.get_user_encoding().
405
The problem is that on Windows, locale.getpreferredencoding()
406
is not the same encoding as that used by the console:
407
http://mail.python.org/pipermail/python-list/2003-May/162357.html
409
On my standard US Windows XP, the preferred encoding is
410
cp1252, but the console is cp437
412
from bzrlib.trace import mutter
413
output_encoding = getattr(sys.stdout, 'encoding', None)
414
if not output_encoding:
415
input_encoding = getattr(sys.stdin, 'encoding', None)
416
if not input_encoding:
417
output_encoding = get_user_encoding()
418
mutter('encoding stdout as osutils.get_user_encoding() %r',
421
output_encoding = input_encoding
422
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
424
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
425
if output_encoding == 'cp0':
426
# invalid encoding (cp0 means 'no codepage' on Windows)
427
output_encoding = get_user_encoding()
428
mutter('cp0 is invalid encoding.'
429
' encoding stdout as osutils.get_user_encoding() %r',
433
codecs.lookup(output_encoding)
435
sys.stderr.write('bzr: warning:'
436
' unknown terminal encoding %s.\n'
437
' Using encoding %s instead.\n'
438
% (output_encoding, get_user_encoding())
440
output_encoding = get_user_encoding()
442
return output_encoding
445
def normalizepath(f):
446
if getattr(os.path, 'realpath', None) is not None:
450
[p,e] = os.path.split(f)
451
if e == "" or e == "." or e == "..":
454
return pathjoin(F(p), e)
458
"""True if f is an accessible directory."""
460
return S_ISDIR(os.lstat(f)[ST_MODE])
466
"""True if f is a regular file."""
468
return S_ISREG(os.lstat(f)[ST_MODE])
473
"""True if f is a symlink."""
475
return S_ISLNK(os.lstat(f)[ST_MODE])
479
def is_inside(dir, fname):
480
"""True if fname is inside dir.
482
The parameters should typically be passed to osutils.normpath first, so
483
that . and .. and repeated slashes are eliminated, and the separators
484
are canonical for the platform.
486
The empty string as a dir name is taken as top-of-tree and matches
489
# XXX: Most callers of this can actually do something smarter by
490
# looking at the inventory
500
return fname.startswith(dir)
503
def is_inside_any(dir_list, fname):
504
"""True if fname is inside any of given dirs."""
505
for dirname in dir_list:
506
if is_inside(dirname, fname):
511
def is_inside_or_parent_of_any(dir_list, fname):
512
"""True if fname is a child or a parent of any of the given files."""
513
for dirname in dir_list:
514
if is_inside(dirname, fname) or is_inside(fname, dirname):
519
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
520
report_activity=None, direction='read'):
521
"""Copy contents of one file to another.
523
The read_length can either be -1 to read to end-of-file (EOF) or
524
it can specify the maximum number of bytes to read.
526
The buff_size represents the maximum size for each read operation
527
performed on from_file.
529
:param report_activity: Call this as bytes are read, see
530
Transport._report_activity
531
:param direction: Will be passed to report_activity
533
:return: The number of bytes copied.
537
# read specified number of bytes
539
while read_length > 0:
540
num_bytes_to_read = min(read_length, buff_size)
542
block = from_file.read(num_bytes_to_read)
546
if report_activity is not None:
547
report_activity(len(block), direction)
550
actual_bytes_read = len(block)
551
read_length -= actual_bytes_read
552
length += actual_bytes_read
556
block = from_file.read(buff_size)
560
if report_activity is not None:
561
report_activity(len(block), direction)
567
def pump_string_file(bytes, file_handle, segment_size=None):
568
"""Write bytes to file_handle in many smaller writes.
570
:param bytes: The string to write.
571
:param file_handle: The file to write to.
573
# Write data in chunks rather than all at once, because very large
574
# writes fail on some platforms (e.g. Windows with SMB mounted
577
segment_size = 5242880 # 5MB
578
segments = range(len(bytes) / segment_size + 1)
579
write = file_handle.write
580
for segment_index in segments:
581
segment = buffer(bytes, segment_index * segment_size, segment_size)
585
def file_iterator(input_file, readsize=32768):
587
b = input_file.read(readsize)
594
"""Calculate the hexdigest of an open file.
596
The file cursor should be already at the start.
608
def size_sha_file(f):
609
"""Calculate the size and hexdigest of an open file.
611
The file cursor should be already at the start and
612
the caller is responsible for closing the file afterwards.
623
return size, s.hexdigest()
626
def sha_file_by_name(fname):
627
"""Calculate the SHA1 of a file by reading the full text"""
629
f = os.open(fname, os.O_RDONLY | O_BINARY)
632
b = os.read(f, 1<<16)
640
def sha_strings(strings, _factory=sha):
641
"""Return the sha-1 of concatenation of strings"""
643
map(s.update, strings)
647
def sha_string(f, _factory=sha):
648
return _factory(f).hexdigest()
651
def fingerprint_file(f):
653
return {'size': len(b),
654
'sha1': sha(b).hexdigest()}
657
def compare_files(a, b):
658
"""Returns true if equal in contents"""
669
def local_time_offset(t=None):
670
"""Return offset of local zone from GMT, either at present or at time t."""
673
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
674
return offset.days * 86400 + offset.seconds
676
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
678
def format_date(t, offset=0, timezone='original', date_fmt=None,
680
"""Return a formatted date string.
682
:param t: Seconds since the epoch.
683
:param offset: Timezone offset in seconds east of utc.
684
:param timezone: How to display the time: 'utc', 'original' for the
685
timezone specified by offset, or 'local' for the process's current
687
:param date_fmt: strftime format.
688
:param show_offset: Whether to append the timezone.
690
(date_fmt, tt, offset_str) = \
691
_format_date(t, offset, timezone, date_fmt, show_offset)
692
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
693
date_str = time.strftime(date_fmt, tt)
694
return date_str + offset_str
696
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
698
"""Return an unicode date string formatted according to the current locale.
700
:param t: Seconds since the epoch.
701
:param offset: Timezone offset in seconds east of utc.
702
:param timezone: How to display the time: 'utc', 'original' for the
703
timezone specified by offset, or 'local' for the process's current
705
:param date_fmt: strftime format.
706
:param show_offset: Whether to append the timezone.
708
(date_fmt, tt, offset_str) = \
709
_format_date(t, offset, timezone, date_fmt, show_offset)
710
date_str = time.strftime(date_fmt, tt)
711
if not isinstance(date_str, unicode):
712
date_str = date_str.decode(bzrlib.user_encoding, 'replace')
713
return date_str + offset_str
715
def _format_date(t, offset, timezone, date_fmt, show_offset):
716
if timezone == 'utc':
719
elif timezone == 'original':
722
tt = time.gmtime(t + offset)
723
elif timezone == 'local':
724
tt = time.localtime(t)
725
offset = local_time_offset(t)
727
raise errors.UnsupportedTimezoneFormat(timezone)
729
date_fmt = "%a %Y-%m-%d %H:%M:%S"
731
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
734
return (date_fmt, tt, offset_str)
737
def compact_date(when):
738
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
741
def format_delta(delta):
742
"""Get a nice looking string for a time delta.
744
:param delta: The time difference in seconds, can be positive or negative.
745
positive indicates time in the past, negative indicates time in the
746
future. (usually time.time() - stored_time)
747
:return: String formatted to show approximate resolution
753
direction = 'in the future'
757
if seconds < 90: # print seconds up to 90 seconds
759
return '%d second %s' % (seconds, direction,)
761
return '%d seconds %s' % (seconds, direction)
763
minutes = int(seconds / 60)
764
seconds -= 60 * minutes
769
if minutes < 90: # print minutes, seconds up to 90 minutes
771
return '%d minute, %d second%s %s' % (
772
minutes, seconds, plural_seconds, direction)
774
return '%d minutes, %d second%s %s' % (
775
minutes, seconds, plural_seconds, direction)
777
hours = int(minutes / 60)
778
minutes -= 60 * hours
785
return '%d hour, %d minute%s %s' % (hours, minutes,
786
plural_minutes, direction)
787
return '%d hours, %d minute%s %s' % (hours, minutes,
788
plural_minutes, direction)
791
"""Return size of given open file."""
792
return os.fstat(f.fileno())[ST_SIZE]
795
# Define rand_bytes based on platform.
797
# Python 2.4 and later have os.urandom,
798
# but it doesn't work on some arches
800
rand_bytes = os.urandom
801
except (NotImplementedError, AttributeError):
802
# If python doesn't have os.urandom, or it doesn't work,
803
# then try to first pull random data from /dev/urandom
805
rand_bytes = file('/dev/urandom', 'rb').read
806
# Otherwise, use this hack as a last resort
807
except (IOError, OSError):
808
# not well seeded, but better than nothing
813
s += chr(random.randint(0, 255))
818
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
820
"""Return a random string of num alphanumeric characters
822
The result only contains lowercase chars because it may be used on
823
case-insensitive filesystems.
826
for raw_byte in rand_bytes(num):
827
s += ALNUM[ord(raw_byte) % 36]
831
## TODO: We could later have path objects that remember their list
832
## decomposition (might be too tricksy though.)
835
"""Turn string into list of parts."""
836
# split on either delimiter because people might use either on
838
ps = re.split(r'[\\/]', p)
843
raise errors.BzrError("sorry, %r not allowed in path" % f)
844
elif (f == '.') or (f == ''):
853
if (f == '..') or (f is None) or (f == ''):
854
raise errors.BzrError("sorry, %r not allowed in path" % f)
859
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
861
from bzrlib._chunks_to_lines_py import chunks_to_lines
865
"""Split s into lines, but without removing the newline characters."""
866
# Trivially convert a fulltext into a 'chunked' representation, and let
867
# chunks_to_lines do the heavy lifting.
868
if isinstance(s, str):
869
# chunks_to_lines only supports 8-bit strings
870
return chunks_to_lines([s])
872
return _split_lines(s)
876
"""Split s into lines, but without removing the newline characters.
878
This supports Unicode or plain string objects.
880
lines = s.split('\n')
881
result = [line + '\n' for line in lines[:-1]]
883
result.append(lines[-1])
887
def hardlinks_good():
888
return sys.platform not in ('win32', 'cygwin', 'darwin')
891
def link_or_copy(src, dest):
892
"""Hardlink a file, or copy it if it can't be hardlinked."""
893
if not hardlinks_good():
894
shutil.copyfile(src, dest)
898
except (OSError, IOError), e:
899
if e.errno != errno.EXDEV:
901
shutil.copyfile(src, dest)
904
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
905
# Forgiveness than Permission (EAFP) because:
906
# - root can damage a solaris file system by using unlink,
907
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
908
# EACCES, OSX: EPERM) when invoked on a directory.
909
def delete_any(path):
910
"""Delete a file or directory."""
911
if isdir(path): # Takes care of symlinks
918
if getattr(os, 'symlink', None) is not None:
925
if getattr(os, 'link', None) is not None:
931
def host_os_dereferences_symlinks():
932
return (has_symlinks()
933
and sys.platform not in ('cygwin', 'win32'))
936
def readlink(abspath):
937
"""Return a string representing the path to which the symbolic link points.
939
:param abspath: The link absolute unicode path.
941
This his guaranteed to return the symbolic link in unicode in all python
944
link = abspath.encode(_fs_enc)
945
target = os.readlink(link)
946
target = target.decode(_fs_enc)
950
def contains_whitespace(s):
951
"""True if there are any whitespace characters in s."""
952
# string.whitespace can include '\xa0' in certain locales, because it is
953
# considered "non-breaking-space" as part of ISO-8859-1. But it
954
# 1) Isn't a breaking whitespace
955
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
957
# 3) '\xa0' isn't unicode safe since it is >128.
959
# This should *not* be a unicode set of characters in case the source
960
# string is not a Unicode string. We can auto-up-cast the characters since
961
# they are ascii, but we don't want to auto-up-cast the string in case it
963
for ch in ' \t\n\r\v\f':
970
def contains_linebreaks(s):
971
"""True if there is any vertical whitespace in s."""
979
def relpath(base, path):
980
"""Return path relative to base, or raise exception.
982
The path may be either an absolute path or a path relative to the
983
current working directory.
985
os.path.commonprefix (python2.4) has a bad bug that it works just
986
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
990
if len(base) < MIN_ABS_PATHLENGTH:
991
# must have space for e.g. a drive letter
992
raise ValueError('%r is too short to calculate a relative path'
999
while len(head) >= len(base):
1002
head, tail = os.path.split(head)
1006
raise errors.PathNotChild(rp, base)
1014
def _cicp_canonical_relpath(base, path):
1015
"""Return the canonical path relative to base.
1017
Like relpath, but on case-insensitive-case-preserving file-systems, this
1018
will return the relpath as stored on the file-system rather than in the
1019
case specified in the input string, for all existing portions of the path.
1021
This will cause O(N) behaviour if called for every path in a tree; if you
1022
have a number of paths to convert, you should use canonical_relpaths().
1024
# TODO: it should be possible to optimize this for Windows by using the
1025
# win32 API FindFiles function to look for the specified name - but using
1026
# os.listdir() still gives us the correct, platform agnostic semantics in
1029
rel = relpath(base, path)
1030
# '.' will have been turned into ''
1034
abs_base = abspath(base)
1036
_listdir = os.listdir
1038
# use an explicit iterator so we can easily consume the rest on early exit.
1039
bit_iter = iter(rel.split('/'))
1040
for bit in bit_iter:
1042
for look in _listdir(current):
1043
if lbit == look.lower():
1044
current = pathjoin(current, look)
1047
# got to the end, nothing matched, so we just return the
1048
# non-existing bits as they were specified (the filename may be
1049
# the target of a move, for example).
1050
current = pathjoin(current, bit, *list(bit_iter))
1052
return current[len(abs_base)+1:]
1054
# XXX - TODO - we need better detection/integration of case-insensitive
1055
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1056
# filesystems), for example, so could probably benefit from the same basic
1057
# support there. For now though, only Windows and OSX get that support, and
1058
# they get it for *all* file-systems!
1059
if sys.platform in ('win32', 'darwin'):
1060
canonical_relpath = _cicp_canonical_relpath
1062
canonical_relpath = relpath
1064
def canonical_relpaths(base, paths):
1065
"""Create an iterable to canonicalize a sequence of relative paths.
1067
The intent is for this implementation to use a cache, vastly speeding
1068
up multiple transformations in the same directory.
1070
# but for now, we haven't optimized...
1071
return [canonical_relpath(base, p) for p in paths]
1073
def safe_unicode(unicode_or_utf8_string):
1074
"""Coerce unicode_or_utf8_string into unicode.
1076
If it is unicode, it is returned.
1077
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1078
wrapped in a BzrBadParameterNotUnicode exception.
1080
if isinstance(unicode_or_utf8_string, unicode):
1081
return unicode_or_utf8_string
1083
return unicode_or_utf8_string.decode('utf8')
1084
except UnicodeDecodeError:
1085
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1088
def safe_utf8(unicode_or_utf8_string):
1089
"""Coerce unicode_or_utf8_string to a utf8 string.
1091
If it is a str, it is returned.
1092
If it is Unicode, it is encoded into a utf-8 string.
1094
if isinstance(unicode_or_utf8_string, str):
1095
# TODO: jam 20070209 This is overkill, and probably has an impact on
1096
# performance if we are dealing with lots of apis that want a
1099
# Make sure it is a valid utf-8 string
1100
unicode_or_utf8_string.decode('utf-8')
1101
except UnicodeDecodeError:
1102
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1103
return unicode_or_utf8_string
1104
return unicode_or_utf8_string.encode('utf-8')
1107
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1108
' Revision id generators should be creating utf8'
1112
def safe_revision_id(unicode_or_utf8_string, warn=True):
1113
"""Revision ids should now be utf8, but at one point they were unicode.
1115
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1117
:param warn: Functions that are sanitizing user data can set warn=False
1118
:return: None or a utf8 revision id.
1120
if (unicode_or_utf8_string is None
1121
or unicode_or_utf8_string.__class__ == str):
1122
return unicode_or_utf8_string
1124
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1126
return cache_utf8.encode(unicode_or_utf8_string)
1129
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1130
' generators should be creating utf8 file ids.')
1133
def safe_file_id(unicode_or_utf8_string, warn=True):
1134
"""File ids should now be utf8, but at one point they were unicode.
1136
This is the same as safe_utf8, except it uses the cached encode functions
1137
to save a little bit of performance.
1139
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1141
:param warn: Functions that are sanitizing user data can set warn=False
1142
:return: None or a utf8 file id.
1144
if (unicode_or_utf8_string is None
1145
or unicode_or_utf8_string.__class__ == str):
1146
return unicode_or_utf8_string
1148
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1150
return cache_utf8.encode(unicode_or_utf8_string)
1153
_platform_normalizes_filenames = False
1154
if sys.platform == 'darwin':
1155
_platform_normalizes_filenames = True
1158
def normalizes_filenames():
1159
"""Return True if this platform normalizes unicode filenames.
1161
Mac OSX does, Windows/Linux do not.
1163
return _platform_normalizes_filenames
1166
def _accessible_normalized_filename(path):
1167
"""Get the unicode normalized path, and if you can access the file.
1169
On platforms where the system normalizes filenames (Mac OSX),
1170
you can access a file by any path which will normalize correctly.
1171
On platforms where the system does not normalize filenames
1172
(Windows, Linux), you have to access a file by its exact path.
1174
Internally, bzr only supports NFC normalization, since that is
1175
the standard for XML documents.
1177
So return the normalized path, and a flag indicating if the file
1178
can be accessed by that path.
1181
return unicodedata.normalize('NFC', unicode(path)), True
1184
def _inaccessible_normalized_filename(path):
1185
__doc__ = _accessible_normalized_filename.__doc__
1187
normalized = unicodedata.normalize('NFC', unicode(path))
1188
return normalized, normalized == path
1191
if _platform_normalizes_filenames:
1192
normalized_filename = _accessible_normalized_filename
1194
normalized_filename = _inaccessible_normalized_filename
1197
def terminal_width():
1198
"""Return estimated terminal width."""
1199
if sys.platform == 'win32':
1200
return win32utils.get_console_size()[0]
1203
import struct, fcntl, termios
1204
s = struct.pack('HHHH', 0, 0, 0, 0)
1205
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1206
width = struct.unpack('HHHH', x)[1]
1211
width = int(os.environ['COLUMNS'])
1220
def supports_executable():
1221
return sys.platform != "win32"
1224
def supports_posix_readonly():
1225
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1227
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1228
directory controls creation/deletion, etc.
1230
And under win32, readonly means that the directory itself cannot be
1231
deleted. The contents of a readonly directory can be changed, unlike POSIX
1232
where files in readonly directories cannot be added, deleted or renamed.
1234
return sys.platform != "win32"
1237
def set_or_unset_env(env_variable, value):
1238
"""Modify the environment, setting or removing the env_variable.
1240
:param env_variable: The environment variable in question
1241
:param value: The value to set the environment to. If None, then
1242
the variable will be removed.
1243
:return: The original value of the environment variable.
1245
orig_val = os.environ.get(env_variable)
1247
if orig_val is not None:
1248
del os.environ[env_variable]
1250
if isinstance(value, unicode):
1251
value = value.encode(get_user_encoding())
1252
os.environ[env_variable] = value
1256
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1259
def check_legal_path(path):
1260
"""Check whether the supplied path is legal.
1261
This is only required on Windows, so we don't test on other platforms
1264
if sys.platform != "win32":
1266
if _validWin32PathRE.match(path) is None:
1267
raise errors.IllegalPath(path)
1270
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1272
def _is_error_enotdir(e):
1273
"""Check if this exception represents ENOTDIR.
1275
Unfortunately, python is very inconsistent about the exception
1276
here. The cases are:
1277
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1278
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1279
which is the windows error code.
1280
3) Windows, Python2.5 uses errno == EINVAL and
1281
winerror == ERROR_DIRECTORY
1283
:param e: An Exception object (expected to be OSError with an errno
1284
attribute, but we should be able to cope with anything)
1285
:return: True if this represents an ENOTDIR error. False otherwise.
1287
en = getattr(e, 'errno', None)
1288
if (en == errno.ENOTDIR
1289
or (sys.platform == 'win32'
1290
and (en == _WIN32_ERROR_DIRECTORY
1291
or (en == errno.EINVAL
1292
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1298
def walkdirs(top, prefix=""):
1299
"""Yield data about all the directories in a tree.
1301
This yields all the data about the contents of a directory at a time.
1302
After each directory has been yielded, if the caller has mutated the list
1303
to exclude some directories, they are then not descended into.
1305
The data yielded is of the form:
1306
((directory-relpath, directory-path-from-top),
1307
[(relpath, basename, kind, lstat, path-from-top), ...]),
1308
- directory-relpath is the relative path of the directory being returned
1309
with respect to top. prefix is prepended to this.
1310
- directory-path-from-root is the path including top for this directory.
1311
It is suitable for use with os functions.
1312
- relpath is the relative path within the subtree being walked.
1313
- basename is the basename of the path
1314
- kind is the kind of the file now. If unknown then the file is not
1315
present within the tree - but it may be recorded as versioned. See
1317
- lstat is the stat data *if* the file was statted.
1318
- planned, not implemented:
1319
path_from_tree_root is the path from the root of the tree.
1321
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1322
allows one to walk a subtree but get paths that are relative to a tree
1324
:return: an iterator over the dirs.
1326
#TODO there is a bit of a smell where the results of the directory-
1327
# summary in this, and the path from the root, may not agree
1328
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1329
# potentially confusing output. We should make this more robust - but
1330
# not at a speed cost. RBC 20060731
1332
_directory = _directory_kind
1333
_listdir = os.listdir
1334
_kind_from_mode = file_kind_from_stat_mode
1335
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1337
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1338
relroot, _, _, _, top = pending.pop()
1340
relprefix = relroot + u'/'
1343
top_slash = top + u'/'
1346
append = dirblock.append
1348
names = sorted(_listdir(top))
1350
if not _is_error_enotdir(e):
1354
abspath = top_slash + name
1355
statvalue = _lstat(abspath)
1356
kind = _kind_from_mode(statvalue.st_mode)
1357
append((relprefix + name, name, kind, statvalue, abspath))
1358
yield (relroot, top), dirblock
1360
# push the user specified dirs from dirblock
1361
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1364
class DirReader(object):
1365
"""An interface for reading directories."""
1367
def top_prefix_to_starting_dir(self, top, prefix=""):
1368
"""Converts top and prefix to a starting dir entry
1370
:param top: A utf8 path
1371
:param prefix: An optional utf8 path to prefix output relative paths
1373
:return: A tuple starting with prefix, and ending with the native
1376
raise NotImplementedError(self.top_prefix_to_starting_dir)
1378
def read_dir(self, prefix, top):
1379
"""Read a specific dir.
1381
:param prefix: A utf8 prefix to be preprended to the path basenames.
1382
:param top: A natively encoded path to read.
1383
:return: A list of the directories contents. Each item contains:
1384
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1386
raise NotImplementedError(self.read_dir)
1389
_selected_dir_reader = None
1392
def _walkdirs_utf8(top, prefix=""):
1393
"""Yield data about all the directories in a tree.
1395
This yields the same information as walkdirs() only each entry is yielded
1396
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1397
are returned as exact byte-strings.
1399
:return: yields a tuple of (dir_info, [file_info])
1400
dir_info is (utf8_relpath, path-from-top)
1401
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1402
if top is an absolute path, path-from-top is also an absolute path.
1403
path-from-top might be unicode or utf8, but it is the correct path to
1404
pass to os functions to affect the file in question. (such as os.lstat)
1406
global _selected_dir_reader
1407
if _selected_dir_reader is None:
1408
fs_encoding = _fs_enc.upper()
1409
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1410
# Win98 doesn't have unicode apis like FindFirstFileW
1411
# TODO: We possibly could support Win98 by falling back to the
1412
# original FindFirstFile, and using TCHAR instead of WCHAR,
1413
# but that gets a bit tricky, and requires custom compiling
1416
from bzrlib._walkdirs_win32 import Win32ReadDir
1417
_selected_dir_reader = Win32ReadDir()
1420
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1421
# ANSI_X3.4-1968 is a form of ASCII
1423
from bzrlib._readdir_pyx import UTF8DirReader
1424
_selected_dir_reader = UTF8DirReader()
1428
if _selected_dir_reader is None:
1429
# Fallback to the python version
1430
_selected_dir_reader = UnicodeDirReader()
1432
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1433
# But we don't actually uses 1-3 in pending, so set them to None
1434
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1435
read_dir = _selected_dir_reader.read_dir
1436
_directory = _directory_kind
1438
relroot, _, _, _, top = pending[-1].pop()
1441
dirblock = sorted(read_dir(relroot, top))
1442
yield (relroot, top), dirblock
1443
# push the user specified dirs from dirblock
1444
next = [d for d in reversed(dirblock) if d[2] == _directory]
1446
pending.append(next)
1449
class UnicodeDirReader(DirReader):
1450
"""A dir reader for non-utf8 file systems, which transcodes."""
1452
__slots__ = ['_utf8_encode']
1455
self._utf8_encode = codecs.getencoder('utf8')
1457
def top_prefix_to_starting_dir(self, top, prefix=""):
1458
"""See DirReader.top_prefix_to_starting_dir."""
1459
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1461
def read_dir(self, prefix, top):
1462
"""Read a single directory from a non-utf8 file system.
1464
top, and the abspath element in the output are unicode, all other paths
1465
are utf8. Local disk IO is done via unicode calls to listdir etc.
1467
This is currently the fallback code path when the filesystem encoding is
1468
not UTF-8. It may be better to implement an alternative so that we can
1469
safely handle paths that are not properly decodable in the current
1472
See DirReader.read_dir for details.
1474
_utf8_encode = self._utf8_encode
1476
_listdir = os.listdir
1477
_kind_from_mode = file_kind_from_stat_mode
1480
relprefix = prefix + '/'
1483
top_slash = top + u'/'
1486
append = dirblock.append
1487
for name in sorted(_listdir(top)):
1489
name_utf8 = _utf8_encode(name)[0]
1490
except UnicodeDecodeError:
1491
raise errors.BadFilenameEncoding(
1492
_utf8_encode(relprefix)[0] + name, _fs_enc)
1493
abspath = top_slash + name
1494
statvalue = _lstat(abspath)
1495
kind = _kind_from_mode(statvalue.st_mode)
1496
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1500
def copy_tree(from_path, to_path, handlers={}):
1501
"""Copy all of the entries in from_path into to_path.
1503
:param from_path: The base directory to copy.
1504
:param to_path: The target directory. If it does not exist, it will
1506
:param handlers: A dictionary of functions, which takes a source and
1507
destinations for files, directories, etc.
1508
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1509
'file', 'directory', and 'symlink' should always exist.
1510
If they are missing, they will be replaced with 'os.mkdir()',
1511
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1513
# Now, just copy the existing cached tree to the new location
1514
# We use a cheap trick here.
1515
# Absolute paths are prefixed with the first parameter
1516
# relative paths are prefixed with the second.
1517
# So we can get both the source and target returned
1518
# without any extra work.
1520
def copy_dir(source, dest):
1523
def copy_link(source, dest):
1524
"""Copy the contents of a symlink"""
1525
link_to = os.readlink(source)
1526
os.symlink(link_to, dest)
1528
real_handlers = {'file':shutil.copy2,
1529
'symlink':copy_link,
1530
'directory':copy_dir,
1532
real_handlers.update(handlers)
1534
if not os.path.exists(to_path):
1535
real_handlers['directory'](from_path, to_path)
1537
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1538
for relpath, name, kind, st, abspath in entries:
1539
real_handlers[kind](abspath, relpath)
1542
def path_prefix_key(path):
1543
"""Generate a prefix-order path key for path.
1545
This can be used to sort paths in the same way that walkdirs does.
1547
return (dirname(path) , path)
1550
def compare_paths_prefix_order(path_a, path_b):
1551
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1552
key_a = path_prefix_key(path_a)
1553
key_b = path_prefix_key(path_b)
1554
return cmp(key_a, key_b)
1557
_cached_user_encoding = None
1560
def get_user_encoding(use_cache=True):
1561
"""Find out what the preferred user encoding is.
1563
This is generally the encoding that is used for command line parameters
1564
and file contents. This may be different from the terminal encoding
1565
or the filesystem encoding.
1567
:param use_cache: Enable cache for detected encoding.
1568
(This parameter is turned on by default,
1569
and required only for selftesting)
1571
:return: A string defining the preferred user encoding
1573
global _cached_user_encoding
1574
if _cached_user_encoding is not None and use_cache:
1575
return _cached_user_encoding
1577
if sys.platform == 'darwin':
1578
# python locale.getpreferredencoding() always return
1579
# 'mac-roman' on darwin. That's a lie.
1580
sys.platform = 'posix'
1582
if os.environ.get('LANG', None) is None:
1583
# If LANG is not set, we end up with 'ascii', which is bad
1584
# ('mac-roman' is more than ascii), so we set a default which
1585
# will give us UTF-8 (which appears to work in all cases on
1586
# OSX). Users are still free to override LANG of course, as
1587
# long as it give us something meaningful. This work-around
1588
# *may* not be needed with python 3k and/or OSX 10.5, but will
1589
# work with them too -- vila 20080908
1590
os.environ['LANG'] = 'en_US.UTF-8'
1593
sys.platform = 'darwin'
1598
user_encoding = locale.getpreferredencoding()
1599
except locale.Error, e:
1600
sys.stderr.write('bzr: warning: %s\n'
1601
' Could not determine what text encoding to use.\n'
1602
' This error usually means your Python interpreter\n'
1603
' doesn\'t support the locale set by $LANG (%s)\n'
1604
" Continuing with ascii encoding.\n"
1605
% (e, os.environ.get('LANG')))
1606
user_encoding = 'ascii'
1608
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1609
# treat that as ASCII, and not support printing unicode characters to the
1612
# For python scripts run under vim, we get '', so also treat that as ASCII
1613
if user_encoding in (None, 'cp0', ''):
1614
user_encoding = 'ascii'
1618
codecs.lookup(user_encoding)
1620
sys.stderr.write('bzr: warning:'
1621
' unknown encoding %s.'
1622
' Continuing with ascii encoding.\n'
1625
user_encoding = 'ascii'
1628
_cached_user_encoding = user_encoding
1630
return user_encoding
1633
def get_host_name():
1634
"""Return the current unicode host name.
1636
This is meant to be used in place of socket.gethostname() because that
1637
behaves inconsistently on different platforms.
1639
if sys.platform == "win32":
1641
return win32utils.get_host_name()
1644
return socket.gethostname().decode(get_user_encoding())
1647
def recv_all(socket, bytes):
1648
"""Receive an exact number of bytes.
1650
Regular Socket.recv() may return less than the requested number of bytes,
1651
dependning on what's in the OS buffer. MSG_WAITALL is not available
1652
on all platforms, but this should work everywhere. This will return
1653
less than the requested amount if the remote end closes.
1655
This isn't optimized and is intended mostly for use in testing.
1658
while len(b) < bytes:
1659
new = until_no_eintr(socket.recv, bytes - len(b))
1666
def send_all(socket, bytes, report_activity=None):
1667
"""Send all bytes on a socket.
1669
Regular socket.sendall() can give socket error 10053 on Windows. This
1670
implementation sends no more than 64k at a time, which avoids this problem.
1672
:param report_activity: Call this as bytes are read, see
1673
Transport._report_activity
1676
for pos in xrange(0, len(bytes), chunk_size):
1677
block = bytes[pos:pos+chunk_size]
1678
if report_activity is not None:
1679
report_activity(len(block), 'write')
1680
until_no_eintr(socket.sendall, block)
1683
def dereference_path(path):
1684
"""Determine the real path to a file.
1686
All parent elements are dereferenced. But the file itself is not
1688
:param path: The original path. May be absolute or relative.
1689
:return: the real path *to* the file
1691
parent, base = os.path.split(path)
1692
# The pathjoin for '.' is a workaround for Python bug #1213894.
1693
# (initial path components aren't dereferenced)
1694
return pathjoin(realpath(pathjoin('.', parent)), base)
1697
def supports_mapi():
1698
"""Return True if we can use MAPI to launch a mail client."""
1699
return sys.platform == "win32"
1702
def resource_string(package, resource_name):
1703
"""Load a resource from a package and return it as a string.
1705
Note: Only packages that start with bzrlib are currently supported.
1707
This is designed to be a lightweight implementation of resource
1708
loading in a way which is API compatible with the same API from
1710
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1711
If and when pkg_resources becomes a standard library, this routine
1714
# Check package name is within bzrlib
1715
if package == "bzrlib":
1716
resource_relpath = resource_name
1717
elif package.startswith("bzrlib."):
1718
package = package[len("bzrlib."):].replace('.', os.sep)
1719
resource_relpath = pathjoin(package, resource_name)
1721
raise errors.BzrError('resource package %s not in bzrlib' % package)
1723
# Map the resource to a file and read its contents
1724
base = dirname(bzrlib.__file__)
1725
if getattr(sys, 'frozen', None): # bzr.exe
1726
base = abspath(pathjoin(base, '..', '..'))
1727
filename = pathjoin(base, resource_relpath)
1728
return open(filename, 'rU').read()
1731
def file_kind_from_stat_mode_thunk(mode):
1732
global file_kind_from_stat_mode
1733
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
1735
from bzrlib._readdir_pyx import UTF8DirReader
1736
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1738
from bzrlib._readdir_py import (
1739
_kind_from_mode as file_kind_from_stat_mode
1741
return file_kind_from_stat_mode(mode)
1742
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1745
def file_kind(f, _lstat=os.lstat):
1747
return file_kind_from_stat_mode(_lstat(f).st_mode)
1749
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1750
raise errors.NoSuchFile(f)
1754
def until_no_eintr(f, *a, **kw):
1755
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
1756
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
1760
except (IOError, OSError), e:
1761
if e.errno == errno.EINTR:
1765
def re_compile_checked(re_string, flags=0, where=""):
1766
"""Return a compiled re, or raise a sensible error.
1768
This should only be used when compiling user-supplied REs.
1770
:param re_string: Text form of regular expression.
1771
:param flags: eg re.IGNORECASE
1772
:param where: Message explaining to the user the context where
1773
it occurred, eg 'log search filter'.
1775
# from https://bugs.launchpad.net/bzr/+bug/251352
1777
re_obj = re.compile(re_string, flags)
1782
where = ' in ' + where
1783
# despite the name 'error' is a type
1784
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
1785
% (where, re_string, e))
1788
if sys.platform == "win32":
1791
return msvcrt.getch()
1796
fd = sys.stdin.fileno()
1797
settings = termios.tcgetattr(fd)
1800
ch = sys.stdin.read(1)
1802
termios.tcsetattr(fd, termios.TCSADRAIN, settings)