/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-13 04:33:55 UTC
  • mfrom: (5147 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5149.
  • Revision ID: andrew.bennetts@canonical.com-20100413043355-lg3id0uwtju0k3zs
MergeĀ lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import os
18
18
import re
21
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
22
import sys
23
23
import time
 
24
import codecs
 
25
import warnings
24
26
 
25
27
from bzrlib.lazy_import import lazy_import
26
28
lazy_import(globals(), """
27
 
import codecs
28
29
from datetime import datetime
29
30
import errno
30
31
from ntpath import (abspath as _nt_abspath,
38
39
from shutil import (
39
40
    rmtree,
40
41
    )
 
42
import signal
 
43
import socket
 
44
import subprocess
41
45
import tempfile
42
46
from tempfile import (
43
47
    mkdtemp,
47
51
from bzrlib import (
48
52
    cache_utf8,
49
53
    errors,
 
54
    trace,
50
55
    win32utils,
51
56
    )
52
57
""")
53
58
 
 
59
from bzrlib.symbol_versioning import (
 
60
    deprecated_function,
 
61
    deprecated_in,
 
62
    )
 
63
 
54
64
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
55
65
# of 2.5
56
66
if sys.version_info < (2, 5):
69
79
from bzrlib import symbol_versioning
70
80
 
71
81
 
 
82
# Cross platform wall-clock time functionality with decent resolution.
 
83
# On Linux ``time.clock`` returns only CPU time. On Windows, ``time.time()``
 
84
# only has a resolution of ~15ms. Note that ``time.clock()`` is not
 
85
# synchronized with ``time.time()``, this is only meant to be used to find
 
86
# delta times by subtracting from another call to this function.
 
87
timer_func = time.time
 
88
if sys.platform == 'win32':
 
89
    timer_func = time.clock
 
90
 
72
91
# On win32, O_BINARY is used to indicate the file should
73
92
# be opened in binary mode, rather than text mode.
74
93
# On other platforms, O_BINARY doesn't exist, because
75
94
# they always open in binary mode, so it is okay to
76
 
# OR with 0 on those platforms
 
95
# OR with 0 on those platforms.
 
96
# O_NOINHERIT and O_TEXT exists only on win32 too.
77
97
O_BINARY = getattr(os, 'O_BINARY', 0)
 
98
O_TEXT = getattr(os, 'O_TEXT', 0)
 
99
O_NOINHERIT = getattr(os, 'O_NOINHERIT', 0)
 
100
 
 
101
 
 
102
def get_unicode_argv():
 
103
    try:
 
104
        user_encoding = get_user_encoding()
 
105
        return [a.decode(user_encoding) for a in sys.argv[1:]]
 
106
    except UnicodeDecodeError:
 
107
        raise errors.BzrError(("Parameter '%r' is unsupported by the current "
 
108
                                                            "encoding." % a))
78
109
 
79
110
 
80
111
def make_readonly(filename):
97
128
 
98
129
    :param paths: A container (and hence not None) of paths.
99
130
    :return: A set of paths sufficient to include everything in paths via
100
 
        is_inside_any, drawn from the paths parameter.
 
131
        is_inside, drawn from the paths parameter.
101
132
    """
102
 
    search_paths = set()
103
 
    paths = set(paths)
104
 
    for path in paths:
105
 
        other_paths = paths.difference([path])
106
 
        if not is_inside_any(other_paths, path):
107
 
            # this is a top level path, we must check it.
108
 
            search_paths.add(path)
109
 
    return search_paths
 
133
    if len(paths) < 2:
 
134
        return set(paths)
 
135
 
 
136
    def sort_key(path):
 
137
        return path.split('/')
 
138
    sorted_paths = sorted(list(paths), key=sort_key)
 
139
 
 
140
    search_paths = [sorted_paths[0]]
 
141
    for path in sorted_paths[1:]:
 
142
        if not is_inside(search_paths[-1], path):
 
143
            # This path is unique, add it
 
144
            search_paths.append(path)
 
145
 
 
146
    return set(search_paths)
110
147
 
111
148
 
112
149
_QUOTE_RE = None
121
158
    global _QUOTE_RE
122
159
    if _QUOTE_RE is None:
123
160
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
124
 
        
 
161
 
125
162
    if _QUOTE_RE.search(f):
126
163
        return '"' + f + '"'
127
164
    else:
152
189
    try:
153
190
        return _kind_marker_map[kind]
154
191
    except KeyError:
155
 
        raise errors.BzrError('invalid file kind %r' % kind)
 
192
        # Slightly faster than using .get(, '') when the common case is that
 
193
        # kind will be found
 
194
        return ''
156
195
 
157
196
 
158
197
lexists = getattr(os.path, 'lexists', None)
171
210
 
172
211
def fancy_rename(old, new, rename_func, unlink_func):
173
212
    """A fancy rename, when you don't have atomic rename.
174
 
    
 
213
 
175
214
    :param old: The old path, to rename from
176
215
    :param new: The new path, to rename to
177
216
    :param rename_func: The potentially non-atomic rename function
178
 
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
217
    :param unlink_func: A way to delete the target file if the full rename
 
218
        succeeds
179
219
    """
180
 
 
181
220
    # sftp rename doesn't allow overwriting, so play tricks:
182
221
    base = os.path.basename(new)
183
222
    dirname = os.path.dirname(new)
184
 
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
223
    # callers use different encodings for the paths so the following MUST
 
224
    # respect that. We rely on python upcasting to unicode if new is unicode
 
225
    # and keeping a str if not.
 
226
    tmp_name = 'tmp.%s.%.9f.%d.%s' % (base, time.time(),
 
227
                                      os.getpid(), rand_chars(10))
185
228
    tmp_name = pathjoin(dirname, tmp_name)
186
229
 
187
230
    # Rename the file out of the way, but keep track if it didn't exist
207
250
    else:
208
251
        file_existed = True
209
252
 
 
253
    failure_exc = None
210
254
    success = False
211
255
    try:
212
256
        try:
218
262
            # source and target may be aliases of each other (e.g. on a
219
263
            # case-insensitive filesystem), so we may have accidentally renamed
220
264
            # source by when we tried to rename target
221
 
            if not (file_existed and e.errno in (None, errno.ENOENT)):
222
 
                raise
 
265
            failure_exc = sys.exc_info()
 
266
            if (file_existed and e.errno in (None, errno.ENOENT)
 
267
                and old.lower() == new.lower()):
 
268
                # source and target are the same file on a case-insensitive
 
269
                # filesystem, so we don't generate an exception
 
270
                failure_exc = None
223
271
    finally:
224
272
        if file_existed:
225
273
            # If the file used to exist, rename it back into place
228
276
                unlink_func(tmp_name)
229
277
            else:
230
278
                rename_func(tmp_name, new)
 
279
    if failure_exc is not None:
 
280
        raise failure_exc[0], failure_exc[1], failure_exc[2]
231
281
 
232
282
 
233
283
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
317
367
    """We expect to be able to atomically replace 'new' with old.
318
368
 
319
369
    On win32, if new exists, it must be moved out of the way first,
320
 
    and then deleted. 
 
370
    and then deleted.
321
371
    """
322
372
    try:
323
373
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
324
374
    except OSError, e:
325
375
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
326
 
            # If we try to rename a non-existant file onto cwd, we get 
327
 
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
376
            # If we try to rename a non-existant file onto cwd, we get
 
377
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
328
378
            # if the old path doesn't exist, sometimes we get EACCES
329
379
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
330
380
            os.lstat(old)
384
434
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
385
435
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
386
436
        return shutil.rmtree(path, ignore_errors, onerror)
 
437
 
 
438
    f = win32utils.get_unicode_argv     # special function or None
 
439
    if f is not None:
 
440
        get_unicode_argv = f
 
441
 
387
442
elif sys.platform == 'darwin':
388
443
    getcwd = _mac_getcwd
389
444
 
470
525
 
471
526
def is_inside(dir, fname):
472
527
    """True if fname is inside dir.
473
 
    
 
528
 
474
529
    The parameters should typically be passed to osutils.normpath first, so
475
530
    that . and .. and repeated slashes are eliminated, and the separators
476
531
    are canonical for the platform.
477
 
    
478
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
532
 
 
533
    The empty string as a dir name is taken as top-of-tree and matches
479
534
    everything.
480
535
    """
481
 
    # XXX: Most callers of this can actually do something smarter by 
 
536
    # XXX: Most callers of this can actually do something smarter by
482
537
    # looking at the inventory
483
538
    if dir == fname:
484
539
        return True
485
 
    
 
540
 
486
541
    if dir == '':
487
542
        return True
488
543
 
508
563
    return False
509
564
 
510
565
 
511
 
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
 
566
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
567
             report_activity=None, direction='read'):
512
568
    """Copy contents of one file to another.
513
569
 
514
570
    The read_length can either be -1 to read to end-of-file (EOF) or
517
573
    The buff_size represents the maximum size for each read operation
518
574
    performed on from_file.
519
575
 
 
576
    :param report_activity: Call this as bytes are read, see
 
577
        Transport._report_activity
 
578
    :param direction: Will be passed to report_activity
 
579
 
520
580
    :return: The number of bytes copied.
521
581
    """
522
582
    length = 0
530
590
            if not block:
531
591
                # EOF reached
532
592
                break
 
593
            if report_activity is not None:
 
594
                report_activity(len(block), direction)
533
595
            to_file.write(block)
534
596
 
535
597
            actual_bytes_read = len(block)
542
604
            if not block:
543
605
                # EOF reached
544
606
                break
 
607
            if report_activity is not None:
 
608
                report_activity(len(block), direction)
545
609
            to_file.write(block)
546
610
            length += len(block)
547
611
    return length
588
652
    return s.hexdigest()
589
653
 
590
654
 
 
655
def size_sha_file(f):
 
656
    """Calculate the size and hexdigest of an open file.
 
657
 
 
658
    The file cursor should be already at the start and
 
659
    the caller is responsible for closing the file afterwards.
 
660
    """
 
661
    size = 0
 
662
    s = sha()
 
663
    BUFSIZE = 128<<10
 
664
    while True:
 
665
        b = f.read(BUFSIZE)
 
666
        if not b:
 
667
            break
 
668
        size += len(b)
 
669
        s.update(b)
 
670
    return size, s.hexdigest()
 
671
 
 
672
 
591
673
def sha_file_by_name(fname):
592
674
    """Calculate the SHA1 of a file by reading the full text"""
593
675
    s = sha()
594
 
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
676
    f = os.open(fname, os.O_RDONLY | O_BINARY | O_NOINHERIT)
595
677
    try:
596
678
        while True:
597
679
            b = os.read(f, 1<<16)
639
721
    return offset.days * 86400 + offset.seconds
640
722
 
641
723
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
642
 
    
 
724
_default_format_by_weekday_num = [wd + " %Y-%m-%d %H:%M:%S" for wd in weekdays]
 
725
 
 
726
 
643
727
def format_date(t, offset=0, timezone='original', date_fmt=None,
644
728
                show_offset=True):
645
729
    """Return a formatted date string.
658
742
    date_str = time.strftime(date_fmt, tt)
659
743
    return date_str + offset_str
660
744
 
 
745
 
 
746
# Cache of formatted offset strings
 
747
_offset_cache = {}
 
748
 
 
749
 
 
750
def format_date_with_offset_in_original_timezone(t, offset=0,
 
751
    _cache=_offset_cache):
 
752
    """Return a formatted date string in the original timezone.
 
753
 
 
754
    This routine may be faster then format_date.
 
755
 
 
756
    :param t: Seconds since the epoch.
 
757
    :param offset: Timezone offset in seconds east of utc.
 
758
    """
 
759
    if offset is None:
 
760
        offset = 0
 
761
    tt = time.gmtime(t + offset)
 
762
    date_fmt = _default_format_by_weekday_num[tt[6]]
 
763
    date_str = time.strftime(date_fmt, tt)
 
764
    offset_str = _cache.get(offset, None)
 
765
    if offset_str is None:
 
766
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
767
        _cache[offset] = offset_str
 
768
    return date_str + offset_str
 
769
 
 
770
 
661
771
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
662
772
                      show_offset=True):
663
773
    """Return an unicode date string formatted according to the current locale.
674
784
               _format_date(t, offset, timezone, date_fmt, show_offset)
675
785
    date_str = time.strftime(date_fmt, tt)
676
786
    if not isinstance(date_str, unicode):
677
 
        date_str = date_str.decode(bzrlib.user_encoding, 'replace')
 
787
        date_str = date_str.decode(get_user_encoding(), 'replace')
678
788
    return date_str + offset_str
679
789
 
 
790
 
680
791
def _format_date(t, offset, timezone, date_fmt, show_offset):
681
792
    if timezone == 'utc':
682
793
        tt = time.gmtime(t)
701
812
 
702
813
def compact_date(when):
703
814
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
704
 
    
 
815
 
705
816
 
706
817
def format_delta(delta):
707
818
    """Get a nice looking string for a time delta.
783
894
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
784
895
def rand_chars(num):
785
896
    """Return a random string of num alphanumeric characters
786
 
    
787
 
    The result only contains lowercase chars because it may be used on 
 
897
 
 
898
    The result only contains lowercase chars because it may be used on
788
899
    case-insensitive filesystems.
789
900
    """
790
901
    s = ''
812
923
            rps.append(f)
813
924
    return rps
814
925
 
 
926
 
815
927
def joinpath(p):
816
928
    for f in p:
817
929
        if (f == '..') or (f is None) or (f == ''):
819
931
    return pathjoin(*p)
820
932
 
821
933
 
 
934
def parent_directories(filename):
 
935
    """Return the list of parent directories, deepest first.
 
936
    
 
937
    For example, parent_directories("a/b/c") -> ["a/b", "a"].
 
938
    """
 
939
    parents = []
 
940
    parts = splitpath(dirname(filename))
 
941
    while parts:
 
942
        parents.append(joinpath(parts))
 
943
        parts.pop()
 
944
    return parents
 
945
 
 
946
 
 
947
_extension_load_failures = []
 
948
 
 
949
 
 
950
def failed_to_load_extension(exception):
 
951
    """Handle failing to load a binary extension.
 
952
 
 
953
    This should be called from the ImportError block guarding the attempt to
 
954
    import the native extension.  If this function returns, the pure-Python
 
955
    implementation should be loaded instead::
 
956
 
 
957
    >>> try:
 
958
    >>>     import bzrlib._fictional_extension_pyx
 
959
    >>> except ImportError, e:
 
960
    >>>     bzrlib.osutils.failed_to_load_extension(e)
 
961
    >>>     import bzrlib._fictional_extension_py
 
962
    """
 
963
    # NB: This docstring is just an example, not a doctest, because doctest
 
964
    # currently can't cope with the use of lazy imports in this namespace --
 
965
    # mbp 20090729
 
966
    
 
967
    # This currently doesn't report the failure at the time it occurs, because
 
968
    # they tend to happen very early in startup when we can't check config
 
969
    # files etc, and also we want to report all failures but not spam the user
 
970
    # with 10 warnings.
 
971
    from bzrlib import trace
 
972
    exception_str = str(exception)
 
973
    if exception_str not in _extension_load_failures:
 
974
        trace.mutter("failed to load compiled extension: %s" % exception_str)
 
975
        _extension_load_failures.append(exception_str)
 
976
 
 
977
 
 
978
def report_extension_load_failures():
 
979
    if not _extension_load_failures:
 
980
        return
 
981
    from bzrlib.config import GlobalConfig
 
982
    if GlobalConfig().get_user_option_as_bool('ignore_missing_extensions'):
 
983
        return
 
984
    # the warnings framework should by default show this only once
 
985
    from bzrlib.trace import warning
 
986
    warning(
 
987
        "bzr: warning: some compiled extensions could not be loaded; "
 
988
        "see <https://answers.launchpad.net/bzr/+faq/703>")
 
989
    # we no longer show the specific missing extensions here, because it makes
 
990
    # the message too long and scary - see
 
991
    # https://bugs.launchpad.net/bzr/+bug/430529
 
992
 
 
993
 
 
994
try:
 
995
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
996
except ImportError, e:
 
997
    failed_to_load_extension(e)
 
998
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
999
 
 
1000
 
822
1001
def split_lines(s):
823
1002
    """Split s into lines, but without removing the newline characters."""
 
1003
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
1004
    # chunks_to_lines do the heavy lifting.
 
1005
    if isinstance(s, str):
 
1006
        # chunks_to_lines only supports 8-bit strings
 
1007
        return chunks_to_lines([s])
 
1008
    else:
 
1009
        return _split_lines(s)
 
1010
 
 
1011
 
 
1012
def _split_lines(s):
 
1013
    """Split s into lines, but without removing the newline characters.
 
1014
 
 
1015
    This supports Unicode or plain string objects.
 
1016
    """
824
1017
    lines = s.split('\n')
825
1018
    result = [line + '\n' for line in lines[:-1]]
826
1019
    if lines[-1]:
845
1038
        shutil.copyfile(src, dest)
846
1039
 
847
1040
 
848
 
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
849
 
# Forgiveness than Permission (EAFP) because:
850
 
# - root can damage a solaris file system by using unlink,
851
 
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
852
 
#   EACCES, OSX: EPERM) when invoked on a directory.
853
1041
def delete_any(path):
854
 
    """Delete a file or directory."""
 
1042
    """Delete a file, symlink or directory.  
 
1043
    
 
1044
    Will delete even if readonly.
 
1045
    """
 
1046
    try:
 
1047
       _delete_file_or_dir(path)
 
1048
    except (OSError, IOError), e:
 
1049
        if e.errno in (errno.EPERM, errno.EACCES):
 
1050
            # make writable and try again
 
1051
            try:
 
1052
                make_writable(path)
 
1053
            except (OSError, IOError):
 
1054
                pass
 
1055
            _delete_file_or_dir(path)
 
1056
        else:
 
1057
            raise
 
1058
 
 
1059
 
 
1060
def _delete_file_or_dir(path):
 
1061
    # Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
1062
    # Forgiveness than Permission (EAFP) because:
 
1063
    # - root can damage a solaris file system by using unlink,
 
1064
    # - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
1065
    #   EACCES, OSX: EPERM) when invoked on a directory.
855
1066
    if isdir(path): # Takes care of symlinks
856
1067
        os.rmdir(path)
857
1068
    else:
877
1088
            and sys.platform not in ('cygwin', 'win32'))
878
1089
 
879
1090
 
 
1091
def readlink(abspath):
 
1092
    """Return a string representing the path to which the symbolic link points.
 
1093
 
 
1094
    :param abspath: The link absolute unicode path.
 
1095
 
 
1096
    This his guaranteed to return the symbolic link in unicode in all python
 
1097
    versions.
 
1098
    """
 
1099
    link = abspath.encode(_fs_enc)
 
1100
    target = os.readlink(link)
 
1101
    target = target.decode(_fs_enc)
 
1102
    return target
 
1103
 
 
1104
 
880
1105
def contains_whitespace(s):
881
1106
    """True if there are any whitespace characters in s."""
882
1107
    # string.whitespace can include '\xa0' in certain locales, because it is
926
1151
 
927
1152
    s = []
928
1153
    head = rp
929
 
    while len(head) >= len(base):
 
1154
    while True:
 
1155
        if len(head) <= len(base) and head != base:
 
1156
            raise errors.PathNotChild(rp, base)
930
1157
        if head == base:
931
1158
            break
932
 
        head, tail = os.path.split(head)
 
1159
        head, tail = split(head)
933
1160
        if tail:
934
 
            s.insert(0, tail)
935
 
    else:
936
 
        raise errors.PathNotChild(rp, base)
 
1161
            s.append(tail)
937
1162
 
938
1163
    if s:
939
 
        return pathjoin(*s)
 
1164
        return pathjoin(*reversed(s))
940
1165
    else:
941
1166
        return ''
942
1167
 
943
1168
 
 
1169
def _cicp_canonical_relpath(base, path):
 
1170
    """Return the canonical path relative to base.
 
1171
 
 
1172
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
1173
    will return the relpath as stored on the file-system rather than in the
 
1174
    case specified in the input string, for all existing portions of the path.
 
1175
 
 
1176
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1177
    have a number of paths to convert, you should use canonical_relpaths().
 
1178
    """
 
1179
    # TODO: it should be possible to optimize this for Windows by using the
 
1180
    # win32 API FindFiles function to look for the specified name - but using
 
1181
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1182
    # the short term.
 
1183
 
 
1184
    rel = relpath(base, path)
 
1185
    # '.' will have been turned into ''
 
1186
    if not rel:
 
1187
        return rel
 
1188
 
 
1189
    abs_base = abspath(base)
 
1190
    current = abs_base
 
1191
    _listdir = os.listdir
 
1192
 
 
1193
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1194
    bit_iter = iter(rel.split('/'))
 
1195
    for bit in bit_iter:
 
1196
        lbit = bit.lower()
 
1197
        try:
 
1198
            next_entries = _listdir(current)
 
1199
        except OSError: # enoent, eperm, etc
 
1200
            # We can't find this in the filesystem, so just append the
 
1201
            # remaining bits.
 
1202
            current = pathjoin(current, bit, *list(bit_iter))
 
1203
            break
 
1204
        for look in next_entries:
 
1205
            if lbit == look.lower():
 
1206
                current = pathjoin(current, look)
 
1207
                break
 
1208
        else:
 
1209
            # got to the end, nothing matched, so we just return the
 
1210
            # non-existing bits as they were specified (the filename may be
 
1211
            # the target of a move, for example).
 
1212
            current = pathjoin(current, bit, *list(bit_iter))
 
1213
            break
 
1214
    return current[len(abs_base):].lstrip('/')
 
1215
 
 
1216
# XXX - TODO - we need better detection/integration of case-insensitive
 
1217
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1218
# filesystems), for example, so could probably benefit from the same basic
 
1219
# support there.  For now though, only Windows and OSX get that support, and
 
1220
# they get it for *all* file-systems!
 
1221
if sys.platform in ('win32', 'darwin'):
 
1222
    canonical_relpath = _cicp_canonical_relpath
 
1223
else:
 
1224
    canonical_relpath = relpath
 
1225
 
 
1226
def canonical_relpaths(base, paths):
 
1227
    """Create an iterable to canonicalize a sequence of relative paths.
 
1228
 
 
1229
    The intent is for this implementation to use a cache, vastly speeding
 
1230
    up multiple transformations in the same directory.
 
1231
    """
 
1232
    # but for now, we haven't optimized...
 
1233
    return [canonical_relpath(base, p) for p in paths]
 
1234
 
944
1235
def safe_unicode(unicode_or_utf8_string):
945
1236
    """Coerce unicode_or_utf8_string into unicode.
946
1237
 
947
1238
    If it is unicode, it is returned.
948
 
    Otherwise it is decoded from utf-8. If a decoding error
949
 
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
950
 
    as a BzrBadParameter exception.
 
1239
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1240
    wrapped in a BzrBadParameterNotUnicode exception.
951
1241
    """
952
1242
    if isinstance(unicode_or_utf8_string, unicode):
953
1243
        return unicode_or_utf8_string
1040
1330
 
1041
1331
    On platforms where the system normalizes filenames (Mac OSX),
1042
1332
    you can access a file by any path which will normalize correctly.
1043
 
    On platforms where the system does not normalize filenames 
 
1333
    On platforms where the system does not normalize filenames
1044
1334
    (Windows, Linux), you have to access a file by its exact path.
1045
1335
 
1046
 
    Internally, bzr only supports NFC normalization, since that is 
 
1336
    Internally, bzr only supports NFC normalization, since that is
1047
1337
    the standard for XML documents.
1048
1338
 
1049
1339
    So return the normalized path, and a flag indicating if the file
1066
1356
    normalized_filename = _inaccessible_normalized_filename
1067
1357
 
1068
1358
 
 
1359
def set_signal_handler(signum, handler, restart_syscall=True):
 
1360
    """A wrapper for signal.signal that also calls siginterrupt(signum, False)
 
1361
    on platforms that support that.
 
1362
 
 
1363
    :param restart_syscall: if set, allow syscalls interrupted by a signal to
 
1364
        automatically restart (by calling `signal.siginterrupt(signum,
 
1365
        False)`).  May be ignored if the feature is not available on this
 
1366
        platform or Python version.
 
1367
    """
 
1368
    old_handler = signal.signal(signum, handler)
 
1369
    if restart_syscall:
 
1370
        try:
 
1371
            siginterrupt = signal.siginterrupt
 
1372
        except AttributeError: # siginterrupt doesn't exist on this platform, or for this version of
 
1373
            # Python.
 
1374
            pass
 
1375
        else:
 
1376
            siginterrupt(signum, False)
 
1377
    return old_handler
 
1378
 
 
1379
 
 
1380
default_terminal_width = 80
 
1381
"""The default terminal width for ttys.
 
1382
 
 
1383
This is defined so that higher levels can share a common fallback value when
 
1384
terminal_width() returns None.
 
1385
"""
 
1386
 
 
1387
 
1069
1388
def terminal_width():
1070
 
    """Return estimated terminal width."""
1071
 
    if sys.platform == 'win32':
1072
 
        return win32utils.get_console_size()[0]
1073
 
    width = 0
 
1389
    """Return terminal width.
 
1390
 
 
1391
    None is returned if the width can't established precisely.
 
1392
 
 
1393
    The rules are:
 
1394
    - if BZR_COLUMNS is set, returns its value
 
1395
    - if there is no controlling terminal, returns None
 
1396
    - if COLUMNS is set, returns its value,
 
1397
 
 
1398
    From there, we need to query the OS to get the size of the controlling
 
1399
    terminal.
 
1400
 
 
1401
    Unices:
 
1402
    - get termios.TIOCGWINSZ
 
1403
    - if an error occurs or a negative value is obtained, returns None
 
1404
 
 
1405
    Windows:
 
1406
    
 
1407
    - win32utils.get_console_size() decides,
 
1408
    - returns None on error (provided default value)
 
1409
    """
 
1410
 
 
1411
    # If BZR_COLUMNS is set, take it, user is always right
 
1412
    try:
 
1413
        return int(os.environ['BZR_COLUMNS'])
 
1414
    except (KeyError, ValueError):
 
1415
        pass
 
1416
 
 
1417
    isatty = getattr(sys.stdout, 'isatty', None)
 
1418
    if  isatty is None or not isatty():
 
1419
        # Don't guess, setting BZR_COLUMNS is the recommended way to override.
 
1420
        return None
 
1421
 
 
1422
    # If COLUMNS is set, take it, the terminal knows better (even inside a
 
1423
    # given terminal, the application can decide to set COLUMNS to a lower
 
1424
    # value (splitted screen) or a bigger value (scroll bars))
 
1425
    try:
 
1426
        return int(os.environ['COLUMNS'])
 
1427
    except (KeyError, ValueError):
 
1428
        pass
 
1429
 
 
1430
    width, height = _terminal_size(None, None)
 
1431
    if width <= 0:
 
1432
        # Consider invalid values as meaning no width
 
1433
        return None
 
1434
 
 
1435
    return width
 
1436
 
 
1437
 
 
1438
def _win32_terminal_size(width, height):
 
1439
    width, height = win32utils.get_console_size(defaultx=width, defaulty=height)
 
1440
    return width, height
 
1441
 
 
1442
 
 
1443
def _ioctl_terminal_size(width, height):
1074
1444
    try:
1075
1445
        import struct, fcntl, termios
1076
1446
        s = struct.pack('HHHH', 0, 0, 0, 0)
1077
1447
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1078
 
        width = struct.unpack('HHHH', x)[1]
1079
 
    except IOError:
 
1448
        height, width = struct.unpack('HHHH', x)[0:2]
 
1449
    except (IOError, AttributeError):
1080
1450
        pass
1081
 
    if width <= 0:
1082
 
        try:
1083
 
            width = int(os.environ['COLUMNS'])
1084
 
        except:
 
1451
    return width, height
 
1452
 
 
1453
_terminal_size = None
 
1454
"""Returns the terminal size as (width, height).
 
1455
 
 
1456
:param width: Default value for width.
 
1457
:param height: Default value for height.
 
1458
 
 
1459
This is defined specifically for each OS and query the size of the controlling
 
1460
terminal. If any error occurs, the provided default values should be returned.
 
1461
"""
 
1462
if sys.platform == 'win32':
 
1463
    _terminal_size = _win32_terminal_size
 
1464
else:
 
1465
    _terminal_size = _ioctl_terminal_size
 
1466
 
 
1467
 
 
1468
def _terminal_size_changed(signum, frame):
 
1469
    """Set COLUMNS upon receiving a SIGnal for WINdow size CHange."""
 
1470
    width, height = _terminal_size(None, None)
 
1471
    if width is not None:
 
1472
        os.environ['COLUMNS'] = str(width)
 
1473
 
 
1474
 
 
1475
_registered_sigwinch = False
 
1476
 
 
1477
def watch_sigwinch():
 
1478
    """Register for SIGWINCH, once and only once."""
 
1479
    global _registered_sigwinch
 
1480
    if not _registered_sigwinch:
 
1481
        if sys.platform == 'win32':
 
1482
            # Martin (gz) mentioned WINDOW_BUFFER_SIZE_RECORD from
 
1483
            # ReadConsoleInput but I've no idea how to plug that in
 
1484
            # the current design -- vila 20091216
1085
1485
            pass
1086
 
    if width <= 0:
1087
 
        width = 80
1088
 
 
1089
 
    return width
 
1486
        else:
 
1487
            set_signal_handler(signal.SIGWINCH, _terminal_size_changed)
 
1488
        _registered_sigwinch = True
1090
1489
 
1091
1490
 
1092
1491
def supports_executable():
1129
1528
 
1130
1529
 
1131
1530
def check_legal_path(path):
1132
 
    """Check whether the supplied path is legal.  
 
1531
    """Check whether the supplied path is legal.
1133
1532
    This is only required on Windows, so we don't test on other platforms
1134
1533
    right now.
1135
1534
    """
1169
1568
 
1170
1569
def walkdirs(top, prefix=""):
1171
1570
    """Yield data about all the directories in a tree.
1172
 
    
 
1571
 
1173
1572
    This yields all the data about the contents of a directory at a time.
1174
1573
    After each directory has been yielded, if the caller has mutated the list
1175
1574
    to exclude some directories, they are then not descended into.
1176
 
    
 
1575
 
1177
1576
    The data yielded is of the form:
1178
1577
    ((directory-relpath, directory-path-from-top),
1179
1578
    [(relpath, basename, kind, lstat, path-from-top), ...]),
1180
1579
     - directory-relpath is the relative path of the directory being returned
1181
1580
       with respect to top. prefix is prepended to this.
1182
 
     - directory-path-from-root is the path including top for this directory. 
 
1581
     - directory-path-from-root is the path including top for this directory.
1183
1582
       It is suitable for use with os functions.
1184
1583
     - relpath is the relative path within the subtree being walked.
1185
1584
     - basename is the basename of the path
1187
1586
       present within the tree - but it may be recorded as versioned. See
1188
1587
       versioned_kind.
1189
1588
     - lstat is the stat data *if* the file was statted.
1190
 
     - planned, not implemented: 
 
1589
     - planned, not implemented:
1191
1590
       path_from_tree_root is the path from the root of the tree.
1192
1591
 
1193
 
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
1592
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1194
1593
        allows one to walk a subtree but get paths that are relative to a tree
1195
1594
        rooted higher up.
1196
1595
    :return: an iterator over the dirs.
1197
1596
    """
1198
1597
    #TODO there is a bit of a smell where the results of the directory-
1199
 
    # summary in this, and the path from the root, may not agree 
 
1598
    # summary in this, and the path from the root, may not agree
1200
1599
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
1201
1600
    # potentially confusing output. We should make this more robust - but
1202
1601
    # not at a speed cost. RBC 20060731
1286
1685
            #       for win98 anyway.
1287
1686
            try:
1288
1687
                from bzrlib._walkdirs_win32 import Win32ReadDir
1289
 
            except ImportError:
1290
 
                _selected_dir_reader = UnicodeDirReader()
1291
 
            else:
1292
1688
                _selected_dir_reader = Win32ReadDir()
1293
 
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1689
            except ImportError:
 
1690
                pass
 
1691
        elif fs_encoding in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1294
1692
            # ANSI_X3.4-1968 is a form of ASCII
1295
 
            _selected_dir_reader = UnicodeDirReader()
1296
 
        else:
1297
1693
            try:
1298
1694
                from bzrlib._readdir_pyx import UTF8DirReader
1299
 
            except ImportError:
1300
 
                # No optimised code path
1301
 
                _selected_dir_reader = UnicodeDirReader()
1302
 
            else:
1303
1695
                _selected_dir_reader = UTF8DirReader()
 
1696
            except ImportError, e:
 
1697
                failed_to_load_extension(e)
 
1698
                pass
 
1699
 
 
1700
    if _selected_dir_reader is None:
 
1701
        # Fallback to the python version
 
1702
        _selected_dir_reader = UnicodeDirReader()
 
1703
 
1304
1704
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1305
1705
    # But we don't actually uses 1-3 in pending, so set them to None
1306
1706
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1372
1772
def copy_tree(from_path, to_path, handlers={}):
1373
1773
    """Copy all of the entries in from_path into to_path.
1374
1774
 
1375
 
    :param from_path: The base directory to copy. 
 
1775
    :param from_path: The base directory to copy.
1376
1776
    :param to_path: The target directory. If it does not exist, it will
1377
1777
        be created.
1378
1778
    :param handlers: A dictionary of functions, which takes a source and
1411
1811
            real_handlers[kind](abspath, relpath)
1412
1812
 
1413
1813
 
 
1814
def copy_ownership(dst, src=None):
 
1815
    """Copy usr/grp ownership from src file/dir to dst file/dir.
 
1816
 
 
1817
    If src is None, the containing directory is used as source. If chown
 
1818
    fails, the error is ignored and a warning is printed.
 
1819
    """
 
1820
    chown = getattr(os, 'chown', None)
 
1821
    if chown is None:
 
1822
        return
 
1823
 
 
1824
    if src == None:
 
1825
        src = os.path.dirname(dst)
 
1826
        if src == '':
 
1827
            src = '.'
 
1828
 
 
1829
    try:
 
1830
        s = os.stat(src)
 
1831
        chown(dst, s.st_uid, s.st_gid)
 
1832
    except OSError, e:
 
1833
        trace.warning("Unable to copy ownership from '%s' to '%s': IOError: %s." % (src, dst, e))
 
1834
 
 
1835
 
 
1836
def mkdir_with_ownership(path, ownership_src=None):
 
1837
    """Create the directory 'path' with specified ownership.
 
1838
 
 
1839
    If ownership_src is given, copies (chown) usr/grp ownership
 
1840
    from 'ownership_src' to 'path'. If ownership_src is None, use the
 
1841
    containing dir ownership.
 
1842
    """
 
1843
    os.mkdir(path)
 
1844
    copy_ownership(path, ownership_src)
 
1845
 
 
1846
 
 
1847
def open_with_ownership(filename, mode='r', bufsize=-1, ownership_src=None):
 
1848
    """Open the file 'filename' with the specified ownership.
 
1849
 
 
1850
    If ownership_src is specified, copy usr/grp ownership from ownership_src
 
1851
    to filename. If ownership_src is None, copy ownership from containing
 
1852
    directory.
 
1853
    Returns the opened file object.
 
1854
    """
 
1855
    f = open(filename, mode, bufsize)
 
1856
    copy_ownership(filename, ownership_src)
 
1857
    return f
 
1858
 
 
1859
 
1414
1860
def path_prefix_key(path):
1415
1861
    """Generate a prefix-order path key for path.
1416
1862
 
1516
1962
        return socket.gethostname().decode(get_user_encoding())
1517
1963
 
1518
1964
 
1519
 
def recv_all(socket, bytes):
 
1965
# We must not read/write any more than 64k at a time from/to a socket so we
 
1966
# don't risk "no buffer space available" errors on some platforms.  Windows in
 
1967
# particular is likely to throw WSAECONNABORTED or WSAENOBUFS if given too much
 
1968
# data at once.
 
1969
MAX_SOCKET_CHUNK = 64 * 1024
 
1970
 
 
1971
def read_bytes_from_socket(sock, report_activity=None,
 
1972
        max_read_size=MAX_SOCKET_CHUNK):
 
1973
    """Read up to max_read_size of bytes from sock and notify of progress.
 
1974
 
 
1975
    Translates "Connection reset by peer" into file-like EOF (return an
 
1976
    empty string rather than raise an error), and repeats the recv if
 
1977
    interrupted by a signal.
 
1978
    """
 
1979
    while 1:
 
1980
        try:
 
1981
            bytes = sock.recv(max_read_size)
 
1982
        except socket.error, e:
 
1983
            eno = e.args[0]
 
1984
            if eno == getattr(errno, "WSAECONNRESET", errno.ECONNRESET):
 
1985
                # The connection was closed by the other side.  Callers expect
 
1986
                # an empty string to signal end-of-stream.
 
1987
                return ""
 
1988
            elif eno == errno.EINTR:
 
1989
                # Retry the interrupted recv.
 
1990
                continue
 
1991
            raise
 
1992
        else:
 
1993
            if report_activity is not None:
 
1994
                report_activity(len(bytes), 'read')
 
1995
            return bytes
 
1996
 
 
1997
 
 
1998
def recv_all(socket, count):
1520
1999
    """Receive an exact number of bytes.
1521
2000
 
1522
2001
    Regular Socket.recv() may return less than the requested number of bytes,
1523
 
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
2002
    depending on what's in the OS buffer.  MSG_WAITALL is not available
1524
2003
    on all platforms, but this should work everywhere.  This will return
1525
2004
    less than the requested amount if the remote end closes.
1526
2005
 
1527
2006
    This isn't optimized and is intended mostly for use in testing.
1528
2007
    """
1529
2008
    b = ''
1530
 
    while len(b) < bytes:
1531
 
        new = socket.recv(bytes - len(b))
 
2009
    while len(b) < count:
 
2010
        new = read_bytes_from_socket(socket, None, count - len(b))
1532
2011
        if new == '':
1533
2012
            break # eof
1534
2013
        b += new
1535
2014
    return b
1536
2015
 
1537
2016
 
1538
 
def send_all(socket, bytes):
 
2017
def send_all(sock, bytes, report_activity=None):
1539
2018
    """Send all bytes on a socket.
 
2019
 
 
2020
    Breaks large blocks in smaller chunks to avoid buffering limitations on
 
2021
    some platforms, and catches EINTR which may be thrown if the send is
 
2022
    interrupted by a signal.
1540
2023
 
1541
 
    Regular socket.sendall() can give socket error 10053 on Windows.  This
1542
 
    implementation sends no more than 64k at a time, which avoids this problem.
 
2024
    This is preferred to socket.sendall(), because it avoids portability bugs
 
2025
    and provides activity reporting.
 
2026
 
 
2027
    :param report_activity: Call this as bytes are read, see
 
2028
        Transport._report_activity
1543
2029
    """
1544
 
    chunk_size = 2**16
1545
 
    for pos in xrange(0, len(bytes), chunk_size):
1546
 
        socket.sendall(bytes[pos:pos+chunk_size])
 
2030
    sent_total = 0
 
2031
    byte_count = len(bytes)
 
2032
    while sent_total < byte_count:
 
2033
        try:
 
2034
            sent = sock.send(buffer(bytes, sent_total, MAX_SOCKET_CHUNK))
 
2035
        except socket.error, e:
 
2036
            if e.args[0] != errno.EINTR:
 
2037
                raise
 
2038
        else:
 
2039
            sent_total += sent
 
2040
            report_activity(sent, 'write')
1547
2041
 
1548
2042
 
1549
2043
def dereference_path(path):
1600
2094
        try:
1601
2095
            from bzrlib._readdir_pyx import UTF8DirReader
1602
2096
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1603
 
        except ImportError:
 
2097
        except ImportError, e:
 
2098
            # This is one time where we won't warn that an extension failed to
 
2099
            # load. The extension is never available on Windows anyway.
1604
2100
            from bzrlib._readdir_py import (
1605
2101
                _kind_from_mode as file_kind_from_stat_mode
1606
2102
                )
1617
2113
        raise
1618
2114
 
1619
2115
 
 
2116
def until_no_eintr(f, *a, **kw):
 
2117
    """Run f(*a, **kw), retrying if an EINTR error occurs.
 
2118
    
 
2119
    WARNING: you must be certain that it is safe to retry the call repeatedly
 
2120
    if EINTR does occur.  This is typically only true for low-level operations
 
2121
    like os.read.  If in any doubt, don't use this.
 
2122
 
 
2123
    Keep in mind that this is not a complete solution to EINTR.  There is
 
2124
    probably code in the Python standard library and other dependencies that
 
2125
    may encounter EINTR if a signal arrives (and there is signal handler for
 
2126
    that signal).  So this function can reduce the impact for IO that bzrlib
 
2127
    directly controls, but it is not a complete solution.
 
2128
    """
 
2129
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
2130
    while True:
 
2131
        try:
 
2132
            return f(*a, **kw)
 
2133
        except (IOError, OSError), e:
 
2134
            if e.errno == errno.EINTR:
 
2135
                continue
 
2136
            raise
 
2137
 
 
2138
 
 
2139
def re_compile_checked(re_string, flags=0, where=""):
 
2140
    """Return a compiled re, or raise a sensible error.
 
2141
 
 
2142
    This should only be used when compiling user-supplied REs.
 
2143
 
 
2144
    :param re_string: Text form of regular expression.
 
2145
    :param flags: eg re.IGNORECASE
 
2146
    :param where: Message explaining to the user the context where
 
2147
        it occurred, eg 'log search filter'.
 
2148
    """
 
2149
    # from https://bugs.launchpad.net/bzr/+bug/251352
 
2150
    try:
 
2151
        re_obj = re.compile(re_string, flags)
 
2152
        re_obj.search("")
 
2153
        return re_obj
 
2154
    except re.error, e:
 
2155
        if where:
 
2156
            where = ' in ' + where
 
2157
        # despite the name 'error' is a type
 
2158
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
2159
            % (where, re_string, e))
 
2160
 
 
2161
 
 
2162
if sys.platform == "win32":
 
2163
    import msvcrt
 
2164
    def getchar():
 
2165
        return msvcrt.getch()
 
2166
else:
 
2167
    import tty
 
2168
    import termios
 
2169
    def getchar():
 
2170
        fd = sys.stdin.fileno()
 
2171
        settings = termios.tcgetattr(fd)
 
2172
        try:
 
2173
            tty.setraw(fd)
 
2174
            ch = sys.stdin.read(1)
 
2175
        finally:
 
2176
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
2177
        return ch
 
2178
 
 
2179
 
 
2180
if sys.platform == 'linux2':
 
2181
    def _local_concurrency():
 
2182
        concurrency = None
 
2183
        prefix = 'processor'
 
2184
        for line in file('/proc/cpuinfo', 'rb'):
 
2185
            if line.startswith(prefix):
 
2186
                concurrency = int(line[line.find(':')+1:]) + 1
 
2187
        return concurrency
 
2188
elif sys.platform == 'darwin':
 
2189
    def _local_concurrency():
 
2190
        return subprocess.Popen(['sysctl', '-n', 'hw.availcpu'],
 
2191
                                stdout=subprocess.PIPE).communicate()[0]
 
2192
elif sys.platform[0:7] == 'freebsd':
 
2193
    def _local_concurrency():
 
2194
        return subprocess.Popen(['sysctl', '-n', 'hw.ncpu'],
 
2195
                                stdout=subprocess.PIPE).communicate()[0]
 
2196
elif sys.platform == 'sunos5':
 
2197
    def _local_concurrency():
 
2198
        return subprocess.Popen(['psrinfo', '-p',],
 
2199
                                stdout=subprocess.PIPE).communicate()[0]
 
2200
elif sys.platform == "win32":
 
2201
    def _local_concurrency():
 
2202
        # This appears to return the number of cores.
 
2203
        return os.environ.get('NUMBER_OF_PROCESSORS')
 
2204
else:
 
2205
    def _local_concurrency():
 
2206
        # Who knows ?
 
2207
        return None
 
2208
 
 
2209
 
 
2210
_cached_local_concurrency = None
 
2211
 
 
2212
def local_concurrency(use_cache=True):
 
2213
    """Return how many processes can be run concurrently.
 
2214
 
 
2215
    Rely on platform specific implementations and default to 1 (one) if
 
2216
    anything goes wrong.
 
2217
    """
 
2218
    global _cached_local_concurrency
 
2219
 
 
2220
    if _cached_local_concurrency is not None and use_cache:
 
2221
        return _cached_local_concurrency
 
2222
 
 
2223
    concurrency = os.environ.get('BZR_CONCURRENCY', None)
 
2224
    if concurrency is None:
 
2225
        try:
 
2226
            concurrency = _local_concurrency()
 
2227
        except (OSError, IOError):
 
2228
            pass
 
2229
    try:
 
2230
        concurrency = int(concurrency)
 
2231
    except (TypeError, ValueError):
 
2232
        concurrency = 1
 
2233
    if use_cache:
 
2234
        _cached_concurrency = concurrency
 
2235
    return concurrency
 
2236
 
 
2237
 
 
2238
class UnicodeOrBytesToBytesWriter(codecs.StreamWriter):
 
2239
    """A stream writer that doesn't decode str arguments."""
 
2240
 
 
2241
    def __init__(self, encode, stream, errors='strict'):
 
2242
        codecs.StreamWriter.__init__(self, stream, errors)
 
2243
        self.encode = encode
 
2244
 
 
2245
    def write(self, object):
 
2246
        if type(object) is str:
 
2247
            self.stream.write(object)
 
2248
        else:
 
2249
            data, _ = self.encode(object, self.errors)
 
2250
            self.stream.write(data)
 
2251
 
 
2252
if sys.platform == 'win32':
 
2253
    def open_file(filename, mode='r', bufsize=-1):
 
2254
        """This function is used to override the ``open`` builtin.
 
2255
        
 
2256
        But it uses O_NOINHERIT flag so the file handle is not inherited by
 
2257
        child processes.  Deleting or renaming a closed file opened with this
 
2258
        function is not blocking child processes.
 
2259
        """
 
2260
        writing = 'w' in mode
 
2261
        appending = 'a' in mode
 
2262
        updating = '+' in mode
 
2263
        binary = 'b' in mode
 
2264
 
 
2265
        flags = O_NOINHERIT
 
2266
        # see http://msdn.microsoft.com/en-us/library/yeby3zcb%28VS.71%29.aspx
 
2267
        # for flags for each modes.
 
2268
        if binary:
 
2269
            flags |= O_BINARY
 
2270
        else:
 
2271
            flags |= O_TEXT
 
2272
 
 
2273
        if writing:
 
2274
            if updating:
 
2275
                flags |= os.O_RDWR
 
2276
            else:
 
2277
                flags |= os.O_WRONLY
 
2278
            flags |= os.O_CREAT | os.O_TRUNC
 
2279
        elif appending:
 
2280
            if updating:
 
2281
                flags |= os.O_RDWR
 
2282
            else:
 
2283
                flags |= os.O_WRONLY
 
2284
            flags |= os.O_CREAT | os.O_APPEND
 
2285
        else: #reading
 
2286
            if updating:
 
2287
                flags |= os.O_RDWR
 
2288
            else:
 
2289
                flags |= os.O_RDONLY
 
2290
 
 
2291
        return os.fdopen(os.open(filename, flags), mode, bufsize)
 
2292
else:
 
2293
    open_file = open