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.
106
return path.split('/')
107
sorted_paths = sorted(list(paths), key=sort_key)
109
search_paths = [sorted_paths[0]]
110
for path in sorted_paths[1:]:
111
if not is_inside(search_paths[-1], path):
112
# This path is unique, add it
113
search_paths.append(path)
115
return set(search_paths)
122
"""Return a quoted filename filename
124
This previously used backslash quoting, but that works poorly on
126
# TODO: I'm not really sure this is the best format either.x
128
if _QUOTE_RE is None:
129
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
131
if _QUOTE_RE.search(f):
137
_directory_kind = 'directory'
140
"""Return the current umask"""
141
# Assume that people aren't messing with the umask while running
142
# XXX: This is not thread safe, but there is no way to get the
143
# umask without setting it
151
_directory_kind: "/",
153
'tree-reference': '+',
157
def kind_marker(kind):
159
return _kind_marker_map[kind]
161
raise errors.BzrError('invalid file kind %r' % kind)
164
lexists = getattr(os.path, 'lexists', None)
168
stat = getattr(os, 'lstat', os.stat)
172
if e.errno == errno.ENOENT:
175
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
178
def fancy_rename(old, new, rename_func, unlink_func):
179
"""A fancy rename, when you don't have atomic rename.
181
:param old: The old path, to rename from
182
:param new: The new path, to rename to
183
:param rename_func: The potentially non-atomic rename function
184
:param unlink_func: A way to delete the target file if the full rename succeeds
187
# sftp rename doesn't allow overwriting, so play tricks:
188
base = os.path.basename(new)
189
dirname = os.path.dirname(new)
190
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
191
tmp_name = pathjoin(dirname, tmp_name)
193
# Rename the file out of the way, but keep track if it didn't exist
194
# We don't want to grab just any exception
195
# something like EACCES should prevent us from continuing
196
# The downside is that the rename_func has to throw an exception
197
# with an errno = ENOENT, or NoSuchFile
200
rename_func(new, tmp_name)
201
except (errors.NoSuchFile,), e:
204
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
205
# function raises an IOError with errno is None when a rename fails.
206
# This then gets caught here.
207
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
210
if (getattr(e, 'errno', None) is None
211
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
219
# This may throw an exception, in which case success will
221
rename_func(old, new)
223
except (IOError, OSError), e:
224
# source and target may be aliases of each other (e.g. on a
225
# case-insensitive filesystem), so we may have accidentally renamed
226
# source by when we tried to rename target
227
if not (file_existed and e.errno in (None, errno.ENOENT)):
231
# If the file used to exist, rename it back into place
232
# otherwise just delete it from the tmp location
234
unlink_func(tmp_name)
236
rename_func(tmp_name, new)
239
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
240
# choke on a Unicode string containing a relative path if
241
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
243
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
244
def _posix_abspath(path):
245
# jam 20060426 rather than encoding to fsencoding
246
# copy posixpath.abspath, but use os.getcwdu instead
247
if not posixpath.isabs(path):
248
path = posixpath.join(getcwd(), path)
249
return posixpath.normpath(path)
252
def _posix_realpath(path):
253
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
256
def _win32_fixdrive(path):
257
"""Force drive letters to be consistent.
259
win32 is inconsistent whether it returns lower or upper case
260
and even if it was consistent the user might type the other
261
so we force it to uppercase
262
running python.exe under cmd.exe return capital C:\\
263
running win32 python inside a cygwin shell returns lowercase c:\\
265
drive, path = _nt_splitdrive(path)
266
return drive.upper() + path
269
def _win32_abspath(path):
270
# Real _nt_abspath doesn't have a problem with a unicode cwd
271
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
274
def _win98_abspath(path):
275
"""Return the absolute version of a path.
276
Windows 98 safe implementation (python reimplementation
277
of Win32 API function GetFullPathNameW)
282
# \\HOST\path => //HOST/path
283
# //HOST/path => //HOST/path
284
# path => C:/cwd/path
287
# check for absolute path
288
drive = _nt_splitdrive(path)[0]
289
if drive == '' and path[:2] not in('//','\\\\'):
291
# we cannot simply os.path.join cwd and path
292
# because os.path.join('C:','/path') produce '/path'
293
# and this is incorrect
294
if path[:1] in ('/','\\'):
295
cwd = _nt_splitdrive(cwd)[0]
297
path = cwd + '\\' + path
298
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
301
def _win32_realpath(path):
302
# Real _nt_realpath doesn't have a problem with a unicode cwd
303
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
306
def _win32_pathjoin(*args):
307
return _nt_join(*args).replace('\\', '/')
310
def _win32_normpath(path):
311
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
315
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
318
def _win32_mkdtemp(*args, **kwargs):
319
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
322
def _win32_rename(old, new):
323
"""We expect to be able to atomically replace 'new' with old.
325
On win32, if new exists, it must be moved out of the way first,
329
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
331
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
332
# If we try to rename a non-existant file onto cwd, we get
333
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
334
# if the old path doesn't exist, sometimes we get EACCES
335
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
341
return unicodedata.normalize('NFC', os.getcwdu())
344
# Default is to just use the python builtins, but these can be rebound on
345
# particular platforms.
346
abspath = _posix_abspath
347
realpath = _posix_realpath
348
pathjoin = os.path.join
349
normpath = os.path.normpath
352
dirname = os.path.dirname
353
basename = os.path.basename
354
split = os.path.split
355
splitext = os.path.splitext
356
# These were already imported into local scope
357
# mkdtemp = tempfile.mkdtemp
358
# rmtree = shutil.rmtree
360
MIN_ABS_PATHLENGTH = 1
363
if sys.platform == 'win32':
364
if win32utils.winver == 'Windows 98':
365
abspath = _win98_abspath
367
abspath = _win32_abspath
368
realpath = _win32_realpath
369
pathjoin = _win32_pathjoin
370
normpath = _win32_normpath
371
getcwd = _win32_getcwd
372
mkdtemp = _win32_mkdtemp
373
rename = _win32_rename
375
MIN_ABS_PATHLENGTH = 3
377
def _win32_delete_readonly(function, path, excinfo):
378
"""Error handler for shutil.rmtree function [for win32]
379
Helps to remove files and dirs marked as read-only.
381
exception = excinfo[1]
382
if function in (os.remove, os.rmdir) \
383
and isinstance(exception, OSError) \
384
and exception.errno == errno.EACCES:
390
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
391
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
392
return shutil.rmtree(path, ignore_errors, onerror)
393
elif sys.platform == 'darwin':
397
def get_terminal_encoding():
398
"""Find the best encoding for printing to the screen.
400
This attempts to check both sys.stdout and sys.stdin to see
401
what encoding they are in, and if that fails it falls back to
402
osutils.get_user_encoding().
403
The problem is that on Windows, locale.getpreferredencoding()
404
is not the same encoding as that used by the console:
405
http://mail.python.org/pipermail/python-list/2003-May/162357.html
407
On my standard US Windows XP, the preferred encoding is
408
cp1252, but the console is cp437
410
from bzrlib.trace import mutter
411
output_encoding = getattr(sys.stdout, 'encoding', None)
412
if not output_encoding:
413
input_encoding = getattr(sys.stdin, 'encoding', None)
414
if not input_encoding:
415
output_encoding = get_user_encoding()
416
mutter('encoding stdout as osutils.get_user_encoding() %r',
419
output_encoding = input_encoding
420
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
422
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
423
if output_encoding == 'cp0':
424
# invalid encoding (cp0 means 'no codepage' on Windows)
425
output_encoding = get_user_encoding()
426
mutter('cp0 is invalid encoding.'
427
' encoding stdout as osutils.get_user_encoding() %r',
431
codecs.lookup(output_encoding)
433
sys.stderr.write('bzr: warning:'
434
' unknown terminal encoding %s.\n'
435
' Using encoding %s instead.\n'
436
% (output_encoding, get_user_encoding())
438
output_encoding = get_user_encoding()
440
return output_encoding
443
def normalizepath(f):
444
if getattr(os.path, 'realpath', None) is not None:
448
[p,e] = os.path.split(f)
449
if e == "" or e == "." or e == "..":
452
return pathjoin(F(p), e)
456
"""True if f is an accessible directory."""
458
return S_ISDIR(os.lstat(f)[ST_MODE])
464
"""True if f is a regular file."""
466
return S_ISREG(os.lstat(f)[ST_MODE])
471
"""True if f is a symlink."""
473
return S_ISLNK(os.lstat(f)[ST_MODE])
477
def is_inside(dir, fname):
478
"""True if fname is inside dir.
480
The parameters should typically be passed to osutils.normpath first, so
481
that . and .. and repeated slashes are eliminated, and the separators
482
are canonical for the platform.
484
The empty string as a dir name is taken as top-of-tree and matches
487
# XXX: Most callers of this can actually do something smarter by
488
# looking at the inventory
498
return fname.startswith(dir)
501
def is_inside_any(dir_list, fname):
502
"""True if fname is inside any of given dirs."""
503
for dirname in dir_list:
504
if is_inside(dirname, fname):
509
def is_inside_or_parent_of_any(dir_list, fname):
510
"""True if fname is a child or a parent of any of the given files."""
511
for dirname in dir_list:
512
if is_inside(dirname, fname) or is_inside(fname, dirname):
517
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
518
report_activity=None, direction='read'):
519
"""Copy contents of one file to another.
521
The read_length can either be -1 to read to end-of-file (EOF) or
522
it can specify the maximum number of bytes to read.
524
The buff_size represents the maximum size for each read operation
525
performed on from_file.
527
:param report_activity: Call this as bytes are read, see
528
Transport._report_activity
529
:param direction: Will be passed to report_activity
531
:return: The number of bytes copied.
535
# read specified number of bytes
537
while read_length > 0:
538
num_bytes_to_read = min(read_length, buff_size)
540
block = from_file.read(num_bytes_to_read)
544
if report_activity is not None:
545
report_activity(len(block), direction)
548
actual_bytes_read = len(block)
549
read_length -= actual_bytes_read
550
length += actual_bytes_read
554
block = from_file.read(buff_size)
558
if report_activity is not None:
559
report_activity(len(block), direction)
565
def pump_string_file(bytes, file_handle, segment_size=None):
566
"""Write bytes to file_handle in many smaller writes.
568
:param bytes: The string to write.
569
:param file_handle: The file to write to.
571
# Write data in chunks rather than all at once, because very large
572
# writes fail on some platforms (e.g. Windows with SMB mounted
575
segment_size = 5242880 # 5MB
576
segments = range(len(bytes) / segment_size + 1)
577
write = file_handle.write
578
for segment_index in segments:
579
segment = buffer(bytes, segment_index * segment_size, segment_size)
583
def file_iterator(input_file, readsize=32768):
585
b = input_file.read(readsize)
592
"""Calculate the hexdigest of an open file.
594
The file cursor should be already at the start.
606
def size_sha_file(f):
607
"""Calculate the size and hexdigest of an open file.
609
The file cursor should be already at the start and
610
the caller is responsible for closing the file afterwards.
621
return size, s.hexdigest()
624
def sha_file_by_name(fname):
625
"""Calculate the SHA1 of a file by reading the full text"""
627
f = os.open(fname, os.O_RDONLY | O_BINARY)
630
b = os.read(f, 1<<16)
638
def sha_strings(strings, _factory=sha):
639
"""Return the sha-1 of concatenation of strings"""
641
map(s.update, strings)
645
def sha_string(f, _factory=sha):
646
return _factory(f).hexdigest()
649
def fingerprint_file(f):
651
return {'size': len(b),
652
'sha1': sha(b).hexdigest()}
655
def compare_files(a, b):
656
"""Returns true if equal in contents"""
667
def local_time_offset(t=None):
668
"""Return offset of local zone from GMT, either at present or at time t."""
671
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
672
return offset.days * 86400 + offset.seconds
674
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
676
def format_date(t, offset=0, timezone='original', date_fmt=None,
678
"""Return a formatted date string.
680
:param t: Seconds since the epoch.
681
:param offset: Timezone offset in seconds east of utc.
682
:param timezone: How to display the time: 'utc', 'original' for the
683
timezone specified by offset, or 'local' for the process's current
685
:param date_fmt: strftime format.
686
:param show_offset: Whether to append the timezone.
688
(date_fmt, tt, offset_str) = \
689
_format_date(t, offset, timezone, date_fmt, show_offset)
690
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
691
date_str = time.strftime(date_fmt, tt)
692
return date_str + offset_str
694
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
696
"""Return an unicode date string formatted according to the current locale.
698
:param t: Seconds since the epoch.
699
:param offset: Timezone offset in seconds east of utc.
700
:param timezone: How to display the time: 'utc', 'original' for the
701
timezone specified by offset, or 'local' for the process's current
703
:param date_fmt: strftime format.
704
:param show_offset: Whether to append the timezone.
706
(date_fmt, tt, offset_str) = \
707
_format_date(t, offset, timezone, date_fmt, show_offset)
708
date_str = time.strftime(date_fmt, tt)
709
if not isinstance(date_str, unicode):
710
date_str = date_str.decode(bzrlib.user_encoding, 'replace')
711
return date_str + offset_str
713
def _format_date(t, offset, timezone, date_fmt, show_offset):
714
if timezone == 'utc':
717
elif timezone == 'original':
720
tt = time.gmtime(t + offset)
721
elif timezone == 'local':
722
tt = time.localtime(t)
723
offset = local_time_offset(t)
725
raise errors.UnsupportedTimezoneFormat(timezone)
727
date_fmt = "%a %Y-%m-%d %H:%M:%S"
729
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
732
return (date_fmt, tt, offset_str)
735
def compact_date(when):
736
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
739
def format_delta(delta):
740
"""Get a nice looking string for a time delta.
742
:param delta: The time difference in seconds, can be positive or negative.
743
positive indicates time in the past, negative indicates time in the
744
future. (usually time.time() - stored_time)
745
:return: String formatted to show approximate resolution
751
direction = 'in the future'
755
if seconds < 90: # print seconds up to 90 seconds
757
return '%d second %s' % (seconds, direction,)
759
return '%d seconds %s' % (seconds, direction)
761
minutes = int(seconds / 60)
762
seconds -= 60 * minutes
767
if minutes < 90: # print minutes, seconds up to 90 minutes
769
return '%d minute, %d second%s %s' % (
770
minutes, seconds, plural_seconds, direction)
772
return '%d minutes, %d second%s %s' % (
773
minutes, seconds, plural_seconds, direction)
775
hours = int(minutes / 60)
776
minutes -= 60 * hours
783
return '%d hour, %d minute%s %s' % (hours, minutes,
784
plural_minutes, direction)
785
return '%d hours, %d minute%s %s' % (hours, minutes,
786
plural_minutes, direction)
789
"""Return size of given open file."""
790
return os.fstat(f.fileno())[ST_SIZE]
793
# Define rand_bytes based on platform.
795
# Python 2.4 and later have os.urandom,
796
# but it doesn't work on some arches
798
rand_bytes = os.urandom
799
except (NotImplementedError, AttributeError):
800
# If python doesn't have os.urandom, or it doesn't work,
801
# then try to first pull random data from /dev/urandom
803
rand_bytes = file('/dev/urandom', 'rb').read
804
# Otherwise, use this hack as a last resort
805
except (IOError, OSError):
806
# not well seeded, but better than nothing
811
s += chr(random.randint(0, 255))
816
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
818
"""Return a random string of num alphanumeric characters
820
The result only contains lowercase chars because it may be used on
821
case-insensitive filesystems.
824
for raw_byte in rand_bytes(num):
825
s += ALNUM[ord(raw_byte) % 36]
829
## TODO: We could later have path objects that remember their list
830
## decomposition (might be too tricksy though.)
833
"""Turn string into list of parts."""
834
# split on either delimiter because people might use either on
836
ps = re.split(r'[\\/]', p)
841
raise errors.BzrError("sorry, %r not allowed in path" % f)
842
elif (f == '.') or (f == ''):
851
if (f == '..') or (f is None) or (f == ''):
852
raise errors.BzrError("sorry, %r not allowed in path" % f)
857
from bzrlib._chunks_to_lines_pyx import chunks_to_lines
859
from bzrlib._chunks_to_lines_py import chunks_to_lines
863
"""Split s into lines, but without removing the newline characters."""
864
# Trivially convert a fulltext into a 'chunked' representation, and let
865
# chunks_to_lines do the heavy lifting.
866
if isinstance(s, str):
867
# chunks_to_lines only supports 8-bit strings
868
return chunks_to_lines([s])
870
return _split_lines(s)
874
"""Split s into lines, but without removing the newline characters.
876
This supports Unicode or plain string objects.
878
lines = s.split('\n')
879
result = [line + '\n' for line in lines[:-1]]
881
result.append(lines[-1])
885
def hardlinks_good():
886
return sys.platform not in ('win32', 'cygwin', 'darwin')
889
def link_or_copy(src, dest):
890
"""Hardlink a file, or copy it if it can't be hardlinked."""
891
if not hardlinks_good():
892
shutil.copyfile(src, dest)
896
except (OSError, IOError), e:
897
if e.errno != errno.EXDEV:
899
shutil.copyfile(src, dest)
902
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
903
# Forgiveness than Permission (EAFP) because:
904
# - root can damage a solaris file system by using unlink,
905
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
906
# EACCES, OSX: EPERM) when invoked on a directory.
907
def delete_any(path):
908
"""Delete a file or directory."""
909
if isdir(path): # Takes care of symlinks
916
if getattr(os, 'symlink', None) is not None:
923
if getattr(os, 'link', None) is not None:
929
def host_os_dereferences_symlinks():
930
return (has_symlinks()
931
and sys.platform not in ('cygwin', 'win32'))
934
def readlink(abspath):
935
"""Return a string representing the path to which the symbolic link points.
937
:param abspath: The link absolute unicode path.
939
This his guaranteed to return the symbolic link in unicode in all python
942
link = abspath.encode(_fs_enc)
943
target = os.readlink(link)
944
target = target.decode(_fs_enc)
948
def contains_whitespace(s):
949
"""True if there are any whitespace characters in s."""
950
# string.whitespace can include '\xa0' in certain locales, because it is
951
# considered "non-breaking-space" as part of ISO-8859-1. But it
952
# 1) Isn't a breaking whitespace
953
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
955
# 3) '\xa0' isn't unicode safe since it is >128.
957
# This should *not* be a unicode set of characters in case the source
958
# string is not a Unicode string. We can auto-up-cast the characters since
959
# they are ascii, but we don't want to auto-up-cast the string in case it
961
for ch in ' \t\n\r\v\f':
968
def contains_linebreaks(s):
969
"""True if there is any vertical whitespace in s."""
977
def relpath(base, path):
978
"""Return path relative to base, or raise exception.
980
The path may be either an absolute path or a path relative to the
981
current working directory.
983
os.path.commonprefix (python2.4) has a bad bug that it works just
984
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
988
if len(base) < MIN_ABS_PATHLENGTH:
989
# must have space for e.g. a drive letter
990
raise ValueError('%r is too short to calculate a relative path'
997
while len(head) >= len(base):
1000
head, tail = os.path.split(head)
1004
raise errors.PathNotChild(rp, base)
1012
def _cicp_canonical_relpath(base, path):
1013
"""Return the canonical path relative to base.
1015
Like relpath, but on case-insensitive-case-preserving file-systems, this
1016
will return the relpath as stored on the file-system rather than in the
1017
case specified in the input string, for all existing portions of the path.
1019
This will cause O(N) behaviour if called for every path in a tree; if you
1020
have a number of paths to convert, you should use canonical_relpaths().
1022
# TODO: it should be possible to optimize this for Windows by using the
1023
# win32 API FindFiles function to look for the specified name - but using
1024
# os.listdir() still gives us the correct, platform agnostic semantics in
1027
rel = relpath(base, path)
1028
# '.' will have been turned into ''
1032
abs_base = abspath(base)
1034
_listdir = os.listdir
1036
# use an explicit iterator so we can easily consume the rest on early exit.
1037
bit_iter = iter(rel.split('/'))
1038
for bit in bit_iter:
1040
for look in _listdir(current):
1041
if lbit == look.lower():
1042
current = pathjoin(current, look)
1045
# got to the end, nothing matched, so we just return the
1046
# non-existing bits as they were specified (the filename may be
1047
# the target of a move, for example).
1048
current = pathjoin(current, bit, *list(bit_iter))
1050
return current[len(abs_base)+1:]
1052
# XXX - TODO - we need better detection/integration of case-insensitive
1053
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
1054
# filesystems), for example, so could probably benefit from the same basic
1055
# support there. For now though, only Windows and OSX get that support, and
1056
# they get it for *all* file-systems!
1057
if sys.platform in ('win32', 'darwin'):
1058
canonical_relpath = _cicp_canonical_relpath
1060
canonical_relpath = relpath
1062
def canonical_relpaths(base, paths):
1063
"""Create an iterable to canonicalize a sequence of relative paths.
1065
The intent is for this implementation to use a cache, vastly speeding
1066
up multiple transformations in the same directory.
1068
# but for now, we haven't optimized...
1069
return [canonical_relpath(base, p) for p in paths]
1071
def safe_unicode(unicode_or_utf8_string):
1072
"""Coerce unicode_or_utf8_string into unicode.
1074
If it is unicode, it is returned.
1075
Otherwise it is decoded from utf-8. If decoding fails, the exception is
1076
wrapped in a BzrBadParameterNotUnicode exception.
1078
if isinstance(unicode_or_utf8_string, unicode):
1079
return unicode_or_utf8_string
1081
return unicode_or_utf8_string.decode('utf8')
1082
except UnicodeDecodeError:
1083
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1086
def safe_utf8(unicode_or_utf8_string):
1087
"""Coerce unicode_or_utf8_string to a utf8 string.
1089
If it is a str, it is returned.
1090
If it is Unicode, it is encoded into a utf-8 string.
1092
if isinstance(unicode_or_utf8_string, str):
1093
# TODO: jam 20070209 This is overkill, and probably has an impact on
1094
# performance if we are dealing with lots of apis that want a
1097
# Make sure it is a valid utf-8 string
1098
unicode_or_utf8_string.decode('utf-8')
1099
except UnicodeDecodeError:
1100
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
1101
return unicode_or_utf8_string
1102
return unicode_or_utf8_string.encode('utf-8')
1105
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
1106
' Revision id generators should be creating utf8'
1110
def safe_revision_id(unicode_or_utf8_string, warn=True):
1111
"""Revision ids should now be utf8, but at one point they were unicode.
1113
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
1115
:param warn: Functions that are sanitizing user data can set warn=False
1116
:return: None or a utf8 revision id.
1118
if (unicode_or_utf8_string is None
1119
or unicode_or_utf8_string.__class__ == str):
1120
return unicode_or_utf8_string
1122
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
1124
return cache_utf8.encode(unicode_or_utf8_string)
1127
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1128
' generators should be creating utf8 file ids.')
1131
def safe_file_id(unicode_or_utf8_string, warn=True):
1132
"""File ids should now be utf8, but at one point they were unicode.
1134
This is the same as safe_utf8, except it uses the cached encode functions
1135
to save a little bit of performance.
1137
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1139
:param warn: Functions that are sanitizing user data can set warn=False
1140
:return: None or a utf8 file id.
1142
if (unicode_or_utf8_string is None
1143
or unicode_or_utf8_string.__class__ == str):
1144
return unicode_or_utf8_string
1146
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1148
return cache_utf8.encode(unicode_or_utf8_string)
1151
_platform_normalizes_filenames = False
1152
if sys.platform == 'darwin':
1153
_platform_normalizes_filenames = True
1156
def normalizes_filenames():
1157
"""Return True if this platform normalizes unicode filenames.
1159
Mac OSX does, Windows/Linux do not.
1161
return _platform_normalizes_filenames
1164
def _accessible_normalized_filename(path):
1165
"""Get the unicode normalized path, and if you can access the file.
1167
On platforms where the system normalizes filenames (Mac OSX),
1168
you can access a file by any path which will normalize correctly.
1169
On platforms where the system does not normalize filenames
1170
(Windows, Linux), you have to access a file by its exact path.
1172
Internally, bzr only supports NFC normalization, since that is
1173
the standard for XML documents.
1175
So return the normalized path, and a flag indicating if the file
1176
can be accessed by that path.
1179
return unicodedata.normalize('NFC', unicode(path)), True
1182
def _inaccessible_normalized_filename(path):
1183
__doc__ = _accessible_normalized_filename.__doc__
1185
normalized = unicodedata.normalize('NFC', unicode(path))
1186
return normalized, normalized == path
1189
if _platform_normalizes_filenames:
1190
normalized_filename = _accessible_normalized_filename
1192
normalized_filename = _inaccessible_normalized_filename
1195
def terminal_width():
1196
"""Return estimated terminal width."""
1197
if sys.platform == 'win32':
1198
return win32utils.get_console_size()[0]
1201
import struct, fcntl, termios
1202
s = struct.pack('HHHH', 0, 0, 0, 0)
1203
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1204
width = struct.unpack('HHHH', x)[1]
1209
width = int(os.environ['COLUMNS'])
1218
def supports_executable():
1219
return sys.platform != "win32"
1222
def supports_posix_readonly():
1223
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1225
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1226
directory controls creation/deletion, etc.
1228
And under win32, readonly means that the directory itself cannot be
1229
deleted. The contents of a readonly directory can be changed, unlike POSIX
1230
where files in readonly directories cannot be added, deleted or renamed.
1232
return sys.platform != "win32"
1235
def set_or_unset_env(env_variable, value):
1236
"""Modify the environment, setting or removing the env_variable.
1238
:param env_variable: The environment variable in question
1239
:param value: The value to set the environment to. If None, then
1240
the variable will be removed.
1241
:return: The original value of the environment variable.
1243
orig_val = os.environ.get(env_variable)
1245
if orig_val is not None:
1246
del os.environ[env_variable]
1248
if isinstance(value, unicode):
1249
value = value.encode(get_user_encoding())
1250
os.environ[env_variable] = value
1254
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1257
def check_legal_path(path):
1258
"""Check whether the supplied path is legal.
1259
This is only required on Windows, so we don't test on other platforms
1262
if sys.platform != "win32":
1264
if _validWin32PathRE.match(path) is None:
1265
raise errors.IllegalPath(path)
1268
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1270
def _is_error_enotdir(e):
1271
"""Check if this exception represents ENOTDIR.
1273
Unfortunately, python is very inconsistent about the exception
1274
here. The cases are:
1275
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1276
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1277
which is the windows error code.
1278
3) Windows, Python2.5 uses errno == EINVAL and
1279
winerror == ERROR_DIRECTORY
1281
:param e: An Exception object (expected to be OSError with an errno
1282
attribute, but we should be able to cope with anything)
1283
:return: True if this represents an ENOTDIR error. False otherwise.
1285
en = getattr(e, 'errno', None)
1286
if (en == errno.ENOTDIR
1287
or (sys.platform == 'win32'
1288
and (en == _WIN32_ERROR_DIRECTORY
1289
or (en == errno.EINVAL
1290
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1296
def walkdirs(top, prefix=""):
1297
"""Yield data about all the directories in a tree.
1299
This yields all the data about the contents of a directory at a time.
1300
After each directory has been yielded, if the caller has mutated the list
1301
to exclude some directories, they are then not descended into.
1303
The data yielded is of the form:
1304
((directory-relpath, directory-path-from-top),
1305
[(relpath, basename, kind, lstat, path-from-top), ...]),
1306
- directory-relpath is the relative path of the directory being returned
1307
with respect to top. prefix is prepended to this.
1308
- directory-path-from-root is the path including top for this directory.
1309
It is suitable for use with os functions.
1310
- relpath is the relative path within the subtree being walked.
1311
- basename is the basename of the path
1312
- kind is the kind of the file now. If unknown then the file is not
1313
present within the tree - but it may be recorded as versioned. See
1315
- lstat is the stat data *if* the file was statted.
1316
- planned, not implemented:
1317
path_from_tree_root is the path from the root of the tree.
1319
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1320
allows one to walk a subtree but get paths that are relative to a tree
1322
:return: an iterator over the dirs.
1324
#TODO there is a bit of a smell where the results of the directory-
1325
# summary in this, and the path from the root, may not agree
1326
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1327
# potentially confusing output. We should make this more robust - but
1328
# not at a speed cost. RBC 20060731
1330
_directory = _directory_kind
1331
_listdir = os.listdir
1332
_kind_from_mode = file_kind_from_stat_mode
1333
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1335
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1336
relroot, _, _, _, top = pending.pop()
1338
relprefix = relroot + u'/'
1341
top_slash = top + u'/'
1344
append = dirblock.append
1346
names = sorted(_listdir(top))
1348
if not _is_error_enotdir(e):
1352
abspath = top_slash + name
1353
statvalue = _lstat(abspath)
1354
kind = _kind_from_mode(statvalue.st_mode)
1355
append((relprefix + name, name, kind, statvalue, abspath))
1356
yield (relroot, top), dirblock
1358
# push the user specified dirs from dirblock
1359
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1362
class DirReader(object):
1363
"""An interface for reading directories."""
1365
def top_prefix_to_starting_dir(self, top, prefix=""):
1366
"""Converts top and prefix to a starting dir entry
1368
:param top: A utf8 path
1369
:param prefix: An optional utf8 path to prefix output relative paths
1371
:return: A tuple starting with prefix, and ending with the native
1374
raise NotImplementedError(self.top_prefix_to_starting_dir)
1376
def read_dir(self, prefix, top):
1377
"""Read a specific dir.
1379
:param prefix: A utf8 prefix to be preprended to the path basenames.
1380
:param top: A natively encoded path to read.
1381
:return: A list of the directories contents. Each item contains:
1382
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1384
raise NotImplementedError(self.read_dir)
1387
_selected_dir_reader = None
1390
def _walkdirs_utf8(top, prefix=""):
1391
"""Yield data about all the directories in a tree.
1393
This yields the same information as walkdirs() only each entry is yielded
1394
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1395
are returned as exact byte-strings.
1397
:return: yields a tuple of (dir_info, [file_info])
1398
dir_info is (utf8_relpath, path-from-top)
1399
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1400
if top is an absolute path, path-from-top is also an absolute path.
1401
path-from-top might be unicode or utf8, but it is the correct path to
1402
pass to os functions to affect the file in question. (such as os.lstat)
1404
global _selected_dir_reader
1405
if _selected_dir_reader is None:
1406
fs_encoding = _fs_enc.upper()
1407
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1408
# Win98 doesn't have unicode apis like FindFirstFileW
1409
# TODO: We possibly could support Win98 by falling back to the
1410
# original FindFirstFile, and using TCHAR instead of WCHAR,
1411
# but that gets a bit tricky, and requires custom compiling
1414
from bzrlib._walkdirs_win32 import Win32ReadDir
1415
_selected_dir_reader = Win32ReadDir()
1418
elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1419
# ANSI_X3.4-1968 is a form of ASCII
1421
from bzrlib._readdir_pyx import UTF8DirReader
1422
_selected_dir_reader = UTF8DirReader()
1426
if _selected_dir_reader is None:
1427
# Fallback to the python version
1428
_selected_dir_reader = UnicodeDirReader()
1430
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1431
# But we don't actually uses 1-3 in pending, so set them to None
1432
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1433
read_dir = _selected_dir_reader.read_dir
1434
_directory = _directory_kind
1436
relroot, _, _, _, top = pending[-1].pop()
1439
dirblock = sorted(read_dir(relroot, top))
1440
yield (relroot, top), dirblock
1441
# push the user specified dirs from dirblock
1442
next = [d for d in reversed(dirblock) if d[2] == _directory]
1444
pending.append(next)
1447
class UnicodeDirReader(DirReader):
1448
"""A dir reader for non-utf8 file systems, which transcodes."""
1450
__slots__ = ['_utf8_encode']
1453
self._utf8_encode = codecs.getencoder('utf8')
1455
def top_prefix_to_starting_dir(self, top, prefix=""):
1456
"""See DirReader.top_prefix_to_starting_dir."""
1457
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1459
def read_dir(self, prefix, top):
1460
"""Read a single directory from a non-utf8 file system.
1462
top, and the abspath element in the output are unicode, all other paths
1463
are utf8. Local disk IO is done via unicode calls to listdir etc.
1465
This is currently the fallback code path when the filesystem encoding is
1466
not UTF-8. It may be better to implement an alternative so that we can
1467
safely handle paths that are not properly decodable in the current
1470
See DirReader.read_dir for details.
1472
_utf8_encode = self._utf8_encode
1474
_listdir = os.listdir
1475
_kind_from_mode = file_kind_from_stat_mode
1478
relprefix = prefix + '/'
1481
top_slash = top + u'/'
1484
append = dirblock.append
1485
for name in sorted(_listdir(top)):
1487
name_utf8 = _utf8_encode(name)[0]
1488
except UnicodeDecodeError:
1489
raise errors.BadFilenameEncoding(
1490
_utf8_encode(relprefix)[0] + name, _fs_enc)
1491
abspath = top_slash + name
1492
statvalue = _lstat(abspath)
1493
kind = _kind_from_mode(statvalue.st_mode)
1494
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1498
def copy_tree(from_path, to_path, handlers={}):
1499
"""Copy all of the entries in from_path into to_path.
1501
:param from_path: The base directory to copy.
1502
:param to_path: The target directory. If it does not exist, it will
1504
:param handlers: A dictionary of functions, which takes a source and
1505
destinations for files, directories, etc.
1506
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1507
'file', 'directory', and 'symlink' should always exist.
1508
If they are missing, they will be replaced with 'os.mkdir()',
1509
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1511
# Now, just copy the existing cached tree to the new location
1512
# We use a cheap trick here.
1513
# Absolute paths are prefixed with the first parameter
1514
# relative paths are prefixed with the second.
1515
# So we can get both the source and target returned
1516
# without any extra work.
1518
def copy_dir(source, dest):
1521
def copy_link(source, dest):
1522
"""Copy the contents of a symlink"""
1523
link_to = os.readlink(source)
1524
os.symlink(link_to, dest)
1526
real_handlers = {'file':shutil.copy2,
1527
'symlink':copy_link,
1528
'directory':copy_dir,
1530
real_handlers.update(handlers)
1532
if not os.path.exists(to_path):
1533
real_handlers['directory'](from_path, to_path)
1535
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1536
for relpath, name, kind, st, abspath in entries:
1537
real_handlers[kind](abspath, relpath)
1540
def path_prefix_key(path):
1541
"""Generate a prefix-order path key for path.
1543
This can be used to sort paths in the same way that walkdirs does.
1545
return (dirname(path) , path)
1548
def compare_paths_prefix_order(path_a, path_b):
1549
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1550
key_a = path_prefix_key(path_a)
1551
key_b = path_prefix_key(path_b)
1552
return cmp(key_a, key_b)
1555
_cached_user_encoding = None
1558
def get_user_encoding(use_cache=True):
1559
"""Find out what the preferred user encoding is.
1561
This is generally the encoding that is used for command line parameters
1562
and file contents. This may be different from the terminal encoding
1563
or the filesystem encoding.
1565
:param use_cache: Enable cache for detected encoding.
1566
(This parameter is turned on by default,
1567
and required only for selftesting)
1569
:return: A string defining the preferred user encoding
1571
global _cached_user_encoding
1572
if _cached_user_encoding is not None and use_cache:
1573
return _cached_user_encoding
1575
if sys.platform == 'darwin':
1576
# python locale.getpreferredencoding() always return
1577
# 'mac-roman' on darwin. That's a lie.
1578
sys.platform = 'posix'
1580
if os.environ.get('LANG', None) is None:
1581
# If LANG is not set, we end up with 'ascii', which is bad
1582
# ('mac-roman' is more than ascii), so we set a default which
1583
# will give us UTF-8 (which appears to work in all cases on
1584
# OSX). Users are still free to override LANG of course, as
1585
# long as it give us something meaningful. This work-around
1586
# *may* not be needed with python 3k and/or OSX 10.5, but will
1587
# work with them too -- vila 20080908
1588
os.environ['LANG'] = 'en_US.UTF-8'
1591
sys.platform = 'darwin'
1596
user_encoding = locale.getpreferredencoding()
1597
except locale.Error, e:
1598
sys.stderr.write('bzr: warning: %s\n'
1599
' Could not determine what text encoding to use.\n'
1600
' This error usually means your Python interpreter\n'
1601
' doesn\'t support the locale set by $LANG (%s)\n'
1602
" Continuing with ascii encoding.\n"
1603
% (e, os.environ.get('LANG')))
1604
user_encoding = 'ascii'
1606
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1607
# treat that as ASCII, and not support printing unicode characters to the
1610
# For python scripts run under vim, we get '', so also treat that as ASCII
1611
if user_encoding in (None, 'cp0', ''):
1612
user_encoding = 'ascii'
1616
codecs.lookup(user_encoding)
1618
sys.stderr.write('bzr: warning:'
1619
' unknown encoding %s.'
1620
' Continuing with ascii encoding.\n'
1623
user_encoding = 'ascii'
1626
_cached_user_encoding = user_encoding
1628
return user_encoding
1631
def get_host_name():
1632
"""Return the current unicode host name.
1634
This is meant to be used in place of socket.gethostname() because that
1635
behaves inconsistently on different platforms.
1637
if sys.platform == "win32":
1639
return win32utils.get_host_name()
1642
return socket.gethostname().decode(get_user_encoding())
1645
def recv_all(socket, bytes):
1646
"""Receive an exact number of bytes.
1648
Regular Socket.recv() may return less than the requested number of bytes,
1649
dependning on what's in the OS buffer. MSG_WAITALL is not available
1650
on all platforms, but this should work everywhere. This will return
1651
less than the requested amount if the remote end closes.
1653
This isn't optimized and is intended mostly for use in testing.
1656
while len(b) < bytes:
1657
new = until_no_eintr(socket.recv, bytes - len(b))
1664
def send_all(socket, bytes, report_activity=None):
1665
"""Send all bytes on a socket.
1667
Regular socket.sendall() can give socket error 10053 on Windows. This
1668
implementation sends no more than 64k at a time, which avoids this problem.
1670
:param report_activity: Call this as bytes are read, see
1671
Transport._report_activity
1674
for pos in xrange(0, len(bytes), chunk_size):
1675
block = bytes[pos:pos+chunk_size]
1676
if report_activity is not None:
1677
report_activity(len(block), 'write')
1678
until_no_eintr(socket.sendall, block)
1681
def dereference_path(path):
1682
"""Determine the real path to a file.
1684
All parent elements are dereferenced. But the file itself is not
1686
:param path: The original path. May be absolute or relative.
1687
:return: the real path *to* the file
1689
parent, base = os.path.split(path)
1690
# The pathjoin for '.' is a workaround for Python bug #1213894.
1691
# (initial path components aren't dereferenced)
1692
return pathjoin(realpath(pathjoin('.', parent)), base)
1695
def supports_mapi():
1696
"""Return True if we can use MAPI to launch a mail client."""
1697
return sys.platform == "win32"
1700
def resource_string(package, resource_name):
1701
"""Load a resource from a package and return it as a string.
1703
Note: Only packages that start with bzrlib are currently supported.
1705
This is designed to be a lightweight implementation of resource
1706
loading in a way which is API compatible with the same API from
1708
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1709
If and when pkg_resources becomes a standard library, this routine
1712
# Check package name is within bzrlib
1713
if package == "bzrlib":
1714
resource_relpath = resource_name
1715
elif package.startswith("bzrlib."):
1716
package = package[len("bzrlib."):].replace('.', os.sep)
1717
resource_relpath = pathjoin(package, resource_name)
1719
raise errors.BzrError('resource package %s not in bzrlib' % package)
1721
# Map the resource to a file and read its contents
1722
base = dirname(bzrlib.__file__)
1723
if getattr(sys, 'frozen', None): # bzr.exe
1724
base = abspath(pathjoin(base, '..', '..'))
1725
filename = pathjoin(base, resource_relpath)
1726
return open(filename, 'rU').read()
1729
def file_kind_from_stat_mode_thunk(mode):
1730
global file_kind_from_stat_mode
1731
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
1733
from bzrlib._readdir_pyx import UTF8DirReader
1734
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1736
from bzrlib._readdir_py import (
1737
_kind_from_mode as file_kind_from_stat_mode
1739
return file_kind_from_stat_mode(mode)
1740
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1743
def file_kind(f, _lstat=os.lstat):
1745
return file_kind_from_stat_mode(_lstat(f).st_mode)
1747
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1748
raise errors.NoSuchFile(f)
1752
def until_no_eintr(f, *a, **kw):
1753
"""Run f(*a, **kw), retrying if an EINTR error occurs."""
1754
# Borrowed from Twisted's twisted.python.util.untilConcludes function.
1758
except (IOError, OSError), e:
1759
if e.errno == errno.EINTR:
1763
def re_compile_checked(re_string, flags=0, where=""):
1764
"""Return a compiled re, or raise a sensible error.
1766
This should only be used when compiling user-supplied REs.
1768
:param re_string: Text form of regular expression.
1769
:param flags: eg re.IGNORECASE
1770
:param where: Message explaining to the user the context where
1771
it occurred, eg 'log search filter'.
1773
# from https://bugs.launchpad.net/bzr/+bug/251352
1775
re_obj = re.compile(re_string, flags)
1780
where = ' in ' + where
1781
# despite the name 'error' is a type
1782
raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
1783
% (where, re_string, e))
1786
if sys.platform == "win32":
1789
return msvcrt.getch()
1794
fd = sys.stdin.fileno()
1795
settings = termios.tcgetattr(fd)
1798
ch = sys.stdin.read(1)
1800
termios.tcsetattr(fd, termios.TCSADRAIN, settings)