~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Keir Mierle
  • Date: 2006-11-23 18:56:25 UTC
  • mto: (2168.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2171.
  • Revision ID: keir@cs.utoronto.ca-20061123185625-ndto53ylcb8zo1y6
Fix spacing error and add tests for status --short command flag.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
 
import os, types, re, time, errno
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
 
17
from cStringIO import StringIO
 
18
import os
 
19
import re
 
20
import stat
 
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
22
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
23
import sys
 
24
import time
 
25
 
 
26
from bzrlib.lazy_import import lazy_import
 
27
lazy_import(globals(), """
 
28
import errno
 
29
from ntpath import (abspath as _nt_abspath,
 
30
                    join as _nt_join,
 
31
                    normpath as _nt_normpath,
 
32
                    realpath as _nt_realpath,
 
33
                    splitdrive as _nt_splitdrive,
 
34
                    )
 
35
import posixpath
 
36
import sha
 
37
import shutil
 
38
from shutil import (
 
39
    rmtree,
 
40
    )
 
41
import string
 
42
import tempfile
 
43
from tempfile import (
 
44
    mkdtemp,
 
45
    )
 
46
import unicodedata
 
47
 
 
48
from bzrlib import (
 
49
    errors,
 
50
    )
 
51
""")
 
52
 
24
53
import bzrlib
 
54
from bzrlib.symbol_versioning import (
 
55
    deprecated_function,
 
56
    zero_nine,
 
57
    )
 
58
from bzrlib.trace import mutter
 
59
 
 
60
 
 
61
# On win32, O_BINARY is used to indicate the file should
 
62
# be opened in binary mode, rather than text mode.
 
63
# On other platforms, O_BINARY doesn't exist, because
 
64
# they always open in binary mode, so it is okay to
 
65
# OR with 0 on those platforms
 
66
O_BINARY = getattr(os, 'O_BINARY', 0)
 
67
 
25
68
 
26
69
def make_readonly(filename):
27
70
    """Make a filename read-only."""
28
 
    # TODO: probably needs to be fixed for windows
29
71
    mod = os.stat(filename).st_mode
30
72
    mod = mod & 0777555
31
73
    os.chmod(filename, mod)
37
79
    os.chmod(filename, mod)
38
80
 
39
81
 
40
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
82
_QUOTE_RE = None
 
83
 
 
84
 
41
85
def quotefn(f):
42
 
    """Return shell-quoted filename"""
43
 
    ## We could be a bit more terse by using double-quotes etc
44
 
    f = _QUOTE_RE.sub(r'\\\1', f)
45
 
    if f[0] == '~':
46
 
        f[0:1] = r'\~' 
47
 
    return f
48
 
 
49
 
 
50
 
def file_kind(f):
51
 
    mode = os.lstat(f)[ST_MODE]
52
 
    if S_ISREG(mode):
53
 
        return 'file'
54
 
    elif S_ISDIR(mode):
55
 
        return 'directory'
56
 
    elif S_ISLNK(mode):
57
 
        return 'symlink'
58
 
    else:
59
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f)) 
60
 
 
 
86
    """Return a quoted filename filename
 
87
 
 
88
    This previously used backslash quoting, but that works poorly on
 
89
    Windows."""
 
90
    # TODO: I'm not really sure this is the best format either.x
 
91
    global _QUOTE_RE
 
92
    if _QUOTE_RE is None:
 
93
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
94
        
 
95
    if _QUOTE_RE.search(f):
 
96
        return '"' + f + '"'
 
97
    else:
 
98
        return f
 
99
 
 
100
 
 
101
_directory_kind = 'directory'
 
102
 
 
103
_formats = {
 
104
    stat.S_IFDIR:_directory_kind,
 
105
    stat.S_IFCHR:'chardev',
 
106
    stat.S_IFBLK:'block',
 
107
    stat.S_IFREG:'file',
 
108
    stat.S_IFIFO:'fifo',
 
109
    stat.S_IFLNK:'symlink',
 
110
    stat.S_IFSOCK:'socket',
 
111
}
 
112
 
 
113
 
 
114
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
 
115
    """Generate a file kind from a stat mode. This is used in walkdirs.
 
116
 
 
117
    Its performance is critical: Do not mutate without careful benchmarking.
 
118
    """
 
119
    try:
 
120
        return _formats[stat_mode & 0170000]
 
121
    except KeyError:
 
122
        return _unknown
 
123
 
 
124
 
 
125
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
 
126
    try:
 
127
        return _mapper(_lstat(f).st_mode)
 
128
    except OSError, e:
 
129
        if getattr(e, 'errno', None) == errno.ENOENT:
 
130
            raise errors.NoSuchFile(f)
 
131
        raise
 
132
 
 
133
 
 
134
def get_umask():
 
135
    """Return the current umask"""
 
136
    # Assume that people aren't messing with the umask while running
 
137
    # XXX: This is not thread safe, but there is no way to get the
 
138
    #      umask without setting it
 
139
    umask = os.umask(0)
 
140
    os.umask(umask)
 
141
    return umask
 
142
 
 
143
 
 
144
def kind_marker(kind):
 
145
    if kind == 'file':
 
146
        return ''
 
147
    elif kind == _directory_kind:
 
148
        return '/'
 
149
    elif kind == 'symlink':
 
150
        return '@'
 
151
    else:
 
152
        raise errors.BzrError('invalid file kind %r' % kind)
 
153
 
 
154
lexists = getattr(os.path, 'lexists', None)
 
155
if lexists is None:
 
156
    def lexists(f):
 
157
        try:
 
158
            if getattr(os, 'lstat') is not None:
 
159
                os.lstat(f)
 
160
            else:
 
161
                os.stat(f)
 
162
            return True
 
163
        except OSError,e:
 
164
            if e.errno == errno.ENOENT:
 
165
                return False;
 
166
            else:
 
167
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
168
 
 
169
 
 
170
def fancy_rename(old, new, rename_func, unlink_func):
 
171
    """A fancy rename, when you don't have atomic rename.
 
172
    
 
173
    :param old: The old path, to rename from
 
174
    :param new: The new path, to rename to
 
175
    :param rename_func: The potentially non-atomic rename function
 
176
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
177
    """
 
178
 
 
179
    # sftp rename doesn't allow overwriting, so play tricks:
 
180
    import random
 
181
    base = os.path.basename(new)
 
182
    dirname = os.path.dirname(new)
 
183
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
184
    tmp_name = pathjoin(dirname, tmp_name)
 
185
 
 
186
    # Rename the file out of the way, but keep track if it didn't exist
 
187
    # We don't want to grab just any exception
 
188
    # something like EACCES should prevent us from continuing
 
189
    # The downside is that the rename_func has to throw an exception
 
190
    # with an errno = ENOENT, or NoSuchFile
 
191
    file_existed = False
 
192
    try:
 
193
        rename_func(new, tmp_name)
 
194
    except (errors.NoSuchFile,), e:
 
195
        pass
 
196
    except IOError, e:
 
197
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
 
198
        # function raises an IOError with errno is None when a rename fails.
 
199
        # This then gets caught here.
 
200
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
 
201
            raise
 
202
    except Exception, e:
 
203
        if (getattr(e, 'errno', None) is None
 
204
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
205
            raise
 
206
    else:
 
207
        file_existed = True
 
208
 
 
209
    success = False
 
210
    try:
 
211
        # This may throw an exception, in which case success will
 
212
        # not be set.
 
213
        rename_func(old, new)
 
214
        success = True
 
215
    finally:
 
216
        if file_existed:
 
217
            # If the file used to exist, rename it back into place
 
218
            # otherwise just delete it from the tmp location
 
219
            if success:
 
220
                unlink_func(tmp_name)
 
221
            else:
 
222
                rename_func(tmp_name, new)
 
223
 
 
224
 
 
225
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
226
# choke on a Unicode string containing a relative path if
 
227
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
228
# string.
 
229
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
230
def _posix_abspath(path):
 
231
    # jam 20060426 rather than encoding to fsencoding
 
232
    # copy posixpath.abspath, but use os.getcwdu instead
 
233
    if not posixpath.isabs(path):
 
234
        path = posixpath.join(getcwd(), path)
 
235
    return posixpath.normpath(path)
 
236
 
 
237
 
 
238
def _posix_realpath(path):
 
239
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
240
 
 
241
 
 
242
def _win32_fixdrive(path):
 
243
    """Force drive letters to be consistent.
 
244
 
 
245
    win32 is inconsistent whether it returns lower or upper case
 
246
    and even if it was consistent the user might type the other
 
247
    so we force it to uppercase
 
248
    running python.exe under cmd.exe return capital C:\\
 
249
    running win32 python inside a cygwin shell returns lowercase c:\\
 
250
    """
 
251
    drive, path = _nt_splitdrive(path)
 
252
    return drive.upper() + path
 
253
 
 
254
 
 
255
def _win32_abspath(path):
 
256
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
257
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
258
 
 
259
 
 
260
def _win32_realpath(path):
 
261
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
262
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
263
 
 
264
 
 
265
def _win32_pathjoin(*args):
 
266
    return _nt_join(*args).replace('\\', '/')
 
267
 
 
268
 
 
269
def _win32_normpath(path):
 
270
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
271
 
 
272
 
 
273
def _win32_getcwd():
 
274
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
275
 
 
276
 
 
277
def _win32_mkdtemp(*args, **kwargs):
 
278
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
279
 
 
280
 
 
281
def _win32_rename(old, new):
 
282
    """We expect to be able to atomically replace 'new' with old.
 
283
 
 
284
    On win32, if new exists, it must be moved out of the way first,
 
285
    and then deleted. 
 
286
    """
 
287
    try:
 
288
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
289
    except OSError, e:
 
290
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
291
            # If we try to rename a non-existant file onto cwd, we get 
 
292
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT 
 
293
            # if the old path doesn't exist, sometimes we get EACCES
 
294
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
295
            os.lstat(old)
 
296
        raise
 
297
 
 
298
 
 
299
def _mac_getcwd():
 
300
    return unicodedata.normalize('NFKC', os.getcwdu())
 
301
 
 
302
 
 
303
# Default is to just use the python builtins, but these can be rebound on
 
304
# particular platforms.
 
305
abspath = _posix_abspath
 
306
realpath = _posix_realpath
 
307
pathjoin = os.path.join
 
308
normpath = os.path.normpath
 
309
getcwd = os.getcwdu
 
310
rename = os.rename
 
311
dirname = os.path.dirname
 
312
basename = os.path.basename
 
313
# These were already imported into local scope
 
314
# mkdtemp = tempfile.mkdtemp
 
315
# rmtree = shutil.rmtree
 
316
 
 
317
MIN_ABS_PATHLENGTH = 1
 
318
 
 
319
 
 
320
if sys.platform == 'win32':
 
321
    abspath = _win32_abspath
 
322
    realpath = _win32_realpath
 
323
    pathjoin = _win32_pathjoin
 
324
    normpath = _win32_normpath
 
325
    getcwd = _win32_getcwd
 
326
    mkdtemp = _win32_mkdtemp
 
327
    rename = _win32_rename
 
328
 
 
329
    MIN_ABS_PATHLENGTH = 3
 
330
 
 
331
    def _win32_delete_readonly(function, path, excinfo):
 
332
        """Error handler for shutil.rmtree function [for win32]
 
333
        Helps to remove files and dirs marked as read-only.
 
334
        """
 
335
        exception = excinfo[1]
 
336
        if function in (os.remove, os.rmdir) \
 
337
            and isinstance(exception, OSError) \
 
338
            and exception.errno == errno.EACCES:
 
339
            make_writable(path)
 
340
            function(path)
 
341
        else:
 
342
            raise
 
343
 
 
344
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
345
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
346
        return shutil.rmtree(path, ignore_errors, onerror)
 
347
elif sys.platform == 'darwin':
 
348
    getcwd = _mac_getcwd
 
349
 
 
350
 
 
351
def get_terminal_encoding():
 
352
    """Find the best encoding for printing to the screen.
 
353
 
 
354
    This attempts to check both sys.stdout and sys.stdin to see
 
355
    what encoding they are in, and if that fails it falls back to
 
356
    bzrlib.user_encoding.
 
357
    The problem is that on Windows, locale.getpreferredencoding()
 
358
    is not the same encoding as that used by the console:
 
359
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
360
 
 
361
    On my standard US Windows XP, the preferred encoding is
 
362
    cp1252, but the console is cp437
 
363
    """
 
364
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
365
    if not output_encoding:
 
366
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
367
        if not input_encoding:
 
368
            output_encoding = bzrlib.user_encoding
 
369
            mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
370
        else:
 
371
            output_encoding = input_encoding
 
372
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
373
    else:
 
374
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
375
    if output_encoding == 'cp0':
 
376
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
377
        output_encoding = bzrlib.user_encoding
 
378
        mutter('cp0 is invalid encoding.'
 
379
               ' encoding stdout as bzrlib.user_encoding %r', output_encoding)
 
380
    return output_encoding
 
381
 
 
382
 
 
383
def normalizepath(f):
 
384
    if getattr(os.path, 'realpath', None) is not None:
 
385
        F = realpath
 
386
    else:
 
387
        F = abspath
 
388
    [p,e] = os.path.split(f)
 
389
    if e == "" or e == "." or e == "..":
 
390
        return F(f)
 
391
    else:
 
392
        return pathjoin(F(p), e)
 
393
 
 
394
 
 
395
def backup_file(fn):
 
396
    """Copy a file to a backup.
 
397
 
 
398
    Backups are named in GNU-style, with a ~ suffix.
 
399
 
 
400
    If the file is already a backup, it's not copied.
 
401
    """
 
402
    if fn[-1] == '~':
 
403
        return
 
404
    bfn = fn + '~'
 
405
 
 
406
    if has_symlinks() and os.path.islink(fn):
 
407
        target = os.readlink(fn)
 
408
        os.symlink(target, bfn)
 
409
        return
 
410
    inf = file(fn, 'rb')
 
411
    try:
 
412
        content = inf.read()
 
413
    finally:
 
414
        inf.close()
 
415
    
 
416
    outf = file(bfn, 'wb')
 
417
    try:
 
418
        outf.write(content)
 
419
    finally:
 
420
        outf.close()
61
421
 
62
422
 
63
423
def isdir(f):
68
428
        return False
69
429
 
70
430
 
71
 
 
72
431
def isfile(f):
73
432
    """True if f is a regular file."""
74
433
    try:
76
435
    except OSError:
77
436
        return False
78
437
 
 
438
def islink(f):
 
439
    """True if f is a symlink."""
 
440
    try:
 
441
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
442
    except OSError:
 
443
        return False
 
444
 
 
445
def is_inside(dir, fname):
 
446
    """True if fname is inside dir.
 
447
    
 
448
    The parameters should typically be passed to osutils.normpath first, so
 
449
    that . and .. and repeated slashes are eliminated, and the separators
 
450
    are canonical for the platform.
 
451
    
 
452
    The empty string as a dir name is taken as top-of-tree and matches 
 
453
    everything.
 
454
    """
 
455
    # XXX: Most callers of this can actually do something smarter by 
 
456
    # looking at the inventory
 
457
    if dir == fname:
 
458
        return True
 
459
    
 
460
    if dir == '':
 
461
        return True
 
462
 
 
463
    if dir[-1] != '/':
 
464
        dir += '/'
 
465
 
 
466
    return fname.startswith(dir)
 
467
 
 
468
 
 
469
def is_inside_any(dir_list, fname):
 
470
    """True if fname is inside any of given dirs."""
 
471
    for dirname in dir_list:
 
472
        if is_inside(dirname, fname):
 
473
            return True
 
474
    else:
 
475
        return False
 
476
 
 
477
 
 
478
def is_inside_or_parent_of_any(dir_list, fname):
 
479
    """True if fname is a child or a parent of any of the given files."""
 
480
    for dirname in dir_list:
 
481
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
482
            return True
 
483
    else:
 
484
        return False
 
485
 
79
486
 
80
487
def pumpfile(fromfile, tofile):
81
488
    """Copy contents of one file to another."""
82
 
    tofile.write(fromfile.read())
83
 
 
84
 
 
85
 
def uuid():
86
 
    """Return a new UUID"""
87
 
    try:
88
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
89
 
    except IOError:
90
 
        return chomp(os.popen('uuidgen').readline())
 
489
    BUFSIZE = 32768
 
490
    while True:
 
491
        b = fromfile.read(BUFSIZE)
 
492
        if not b:
 
493
            break
 
494
        tofile.write(b)
 
495
 
 
496
 
 
497
def file_iterator(input_file, readsize=32768):
 
498
    while True:
 
499
        b = input_file.read(readsize)
 
500
        if len(b) == 0:
 
501
            break
 
502
        yield b
91
503
 
92
504
 
93
505
def sha_file(f):
94
 
    import sha
95
 
    if hasattr(f, 'tell'):
 
506
    if getattr(f, 'tell', None) is not None:
96
507
        assert f.tell() == 0
97
508
    s = sha.new()
98
509
    BUFSIZE = 128<<10
104
515
    return s.hexdigest()
105
516
 
106
517
 
 
518
 
 
519
def sha_strings(strings):
 
520
    """Return the sha-1 of concatenation of strings"""
 
521
    s = sha.new()
 
522
    map(s.update, strings)
 
523
    return s.hexdigest()
 
524
 
 
525
 
107
526
def sha_string(f):
108
 
    import sha
109
527
    s = sha.new()
110
528
    s.update(f)
111
529
    return s.hexdigest()
112
530
 
113
531
 
114
 
 
115
532
def fingerprint_file(f):
116
 
    import sha
117
533
    s = sha.new()
118
534
    b = f.read()
119
535
    s.update(b)
122
538
            'sha1': s.hexdigest()}
123
539
 
124
540
 
125
 
def config_dir():
126
 
    """Return per-user configuration directory.
127
 
 
128
 
    By default this is ~/.bzr.conf/
129
 
    
130
 
    TODO: Global option --config-dir to override this.
131
 
    """
132
 
    return os.path.expanduser("~/.bzr.conf")
133
 
 
134
 
 
135
 
def _auto_user_id():
136
 
    """Calculate automatic user identification.
137
 
 
138
 
    Returns (realname, email).
139
 
 
140
 
    Only used when none is set in the environment or the id file.
141
 
 
142
 
    This previously used the FQDN as the default domain, but that can
143
 
    be very slow on machines where DNS is broken.  So now we simply
144
 
    use the hostname.
145
 
    """
146
 
    import socket
147
 
 
148
 
    # XXX: Any good way to get real user name on win32?
149
 
 
150
 
    try:
151
 
        import pwd
152
 
        uid = os.getuid()
153
 
        w = pwd.getpwuid(uid)
154
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
155
 
        username = w.pw_name.decode(bzrlib.user_encoding)
156
 
        comma = gecos.find(',')
157
 
        if comma == -1:
158
 
            realname = gecos
159
 
        else:
160
 
            realname = gecos[:comma]
161
 
        if not realname:
162
 
            realname = username
163
 
 
164
 
    except ImportError:
165
 
        import getpass
166
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
167
 
 
168
 
    return realname, (username + '@' + socket.gethostname())
169
 
 
170
 
 
171
 
def _get_user_id():
172
 
    """Return the full user id from a file or environment variable.
173
 
 
174
 
    TODO: Allow taking this from a file in the branch directory too
175
 
    for per-branch ids."""
176
 
    v = os.environ.get('BZREMAIL')
177
 
    if v:
178
 
        return v.decode(bzrlib.user_encoding)
179
 
    
180
 
    try:
181
 
        return (open(os.path.join(config_dir(), "email"))
182
 
                .read()
183
 
                .decode(bzrlib.user_encoding)
184
 
                .rstrip("\r\n"))
185
 
    except IOError, e:
186
 
        if e.errno != errno.ENOENT:
187
 
            raise e
188
 
 
189
 
    v = os.environ.get('EMAIL')
190
 
    if v:
191
 
        return v.decode(bzrlib.user_encoding)
192
 
    else:    
193
 
        return None
194
 
 
195
 
 
196
 
def username():
197
 
    """Return email-style username.
198
 
 
199
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
200
 
 
201
 
    TODO: Check it's reasonably well-formed.
202
 
    """
203
 
    v = _get_user_id()
204
 
    if v:
205
 
        return v
206
 
    
207
 
    name, email = _auto_user_id()
208
 
    if name:
209
 
        return '%s <%s>' % (name, email)
210
 
    else:
211
 
        return email
212
 
 
213
 
 
214
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
215
 
def user_email():
216
 
    """Return just the email component of a username."""
217
 
    e = _get_user_id()
218
 
    if e:
219
 
        m = _EMAIL_RE.search(e)
220
 
        if not m:
221
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
222
 
        return m.group(0)
223
 
 
224
 
    return _auto_user_id()[1]
225
 
    
226
 
 
227
 
 
228
541
def compare_files(a, b):
229
542
    """Returns true if equal in contents"""
230
543
    BUFSIZE = 4096
237
550
            return True
238
551
 
239
552
 
240
 
 
241
553
def local_time_offset(t=None):
242
554
    """Return offset of local zone from GMT, either at present or at time t."""
243
555
    # python2.3 localtime() can't take None
244
 
    if t == None:
 
556
    if t is None:
245
557
        t = time.time()
246
558
        
247
559
    if time.localtime(t).tm_isdst and time.daylight:
250
562
        return -time.timezone
251
563
 
252
564
    
253
 
def format_date(t, offset=0, timezone='original'):
 
565
def format_date(t, offset=0, timezone='original', date_fmt=None, 
 
566
                show_offset=True):
254
567
    ## TODO: Perhaps a global option to use either universal or local time?
255
568
    ## Or perhaps just let people set $TZ?
256
569
    assert isinstance(t, float)
259
572
        tt = time.gmtime(t)
260
573
        offset = 0
261
574
    elif timezone == 'original':
262
 
        if offset == None:
 
575
        if offset is None:
263
576
            offset = 0
264
577
        tt = time.gmtime(t + offset)
265
578
    elif timezone == 'local':
266
579
        tt = time.localtime(t)
267
580
        offset = local_time_offset(t)
268
581
    else:
269
 
        bailout("unsupported timezone format %r",
270
 
                ['options are "utc", "original", "local"'])
271
 
 
272
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
582
        raise errors.BzrError("unsupported timezone format %r" % timezone,
 
583
                              ['options are "utc", "original", "local"'])
 
584
    if date_fmt is None:
 
585
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
 
586
    if show_offset:
 
587
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
588
    else:
 
589
        offset_str = ''
 
590
    return (time.strftime(date_fmt, tt) +  offset_str)
274
591
 
275
592
 
276
593
def compact_date(when):
277
594
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
278
595
    
279
596
 
 
597
def format_delta(delta):
 
598
    """Get a nice looking string for a time delta.
 
599
 
 
600
    :param delta: The time difference in seconds, can be positive or negative.
 
601
        positive indicates time in the past, negative indicates time in the
 
602
        future. (usually time.time() - stored_time)
 
603
    :return: String formatted to show approximate resolution
 
604
    """
 
605
    delta = int(delta)
 
606
    if delta >= 0:
 
607
        direction = 'ago'
 
608
    else:
 
609
        direction = 'in the future'
 
610
        delta = -delta
 
611
 
 
612
    seconds = delta
 
613
    if seconds < 90: # print seconds up to 90 seconds
 
614
        if seconds == 1:
 
615
            return '%d second %s' % (seconds, direction,)
 
616
        else:
 
617
            return '%d seconds %s' % (seconds, direction)
 
618
 
 
619
    minutes = int(seconds / 60)
 
620
    seconds -= 60 * minutes
 
621
    if seconds == 1:
 
622
        plural_seconds = ''
 
623
    else:
 
624
        plural_seconds = 's'
 
625
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
626
        if minutes == 1:
 
627
            return '%d minute, %d second%s %s' % (
 
628
                    minutes, seconds, plural_seconds, direction)
 
629
        else:
 
630
            return '%d minutes, %d second%s %s' % (
 
631
                    minutes, seconds, plural_seconds, direction)
 
632
 
 
633
    hours = int(minutes / 60)
 
634
    minutes -= 60 * hours
 
635
    if minutes == 1:
 
636
        plural_minutes = ''
 
637
    else:
 
638
        plural_minutes = 's'
 
639
 
 
640
    if hours == 1:
 
641
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
642
                                            plural_minutes, direction)
 
643
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
644
                                         plural_minutes, direction)
280
645
 
281
646
def filesize(f):
282
647
    """Return size of given open file."""
283
648
    return os.fstat(f.fileno())[ST_SIZE]
284
649
 
285
650
 
286
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
651
# Define rand_bytes based on platform.
 
652
try:
 
653
    # Python 2.4 and later have os.urandom,
 
654
    # but it doesn't work on some arches
 
655
    os.urandom(1)
287
656
    rand_bytes = os.urandom
288
 
else:
289
 
    # FIXME: No good on non-Linux
290
 
    _rand_file = file('/dev/urandom', 'rb')
291
 
    rand_bytes = _rand_file.read
 
657
except (NotImplementedError, AttributeError):
 
658
    # If python doesn't have os.urandom, or it doesn't work,
 
659
    # then try to first pull random data from /dev/urandom
 
660
    try:
 
661
        rand_bytes = file('/dev/urandom', 'rb').read
 
662
    # Otherwise, use this hack as a last resort
 
663
    except (IOError, OSError):
 
664
        # not well seeded, but better than nothing
 
665
        def rand_bytes(n):
 
666
            import random
 
667
            s = ''
 
668
            while n:
 
669
                s += chr(random.randint(0, 255))
 
670
                n -= 1
 
671
            return s
 
672
 
 
673
 
 
674
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
675
def rand_chars(num):
 
676
    """Return a random string of num alphanumeric characters
 
677
    
 
678
    The result only contains lowercase chars because it may be used on 
 
679
    case-insensitive filesystems.
 
680
    """
 
681
    s = ''
 
682
    for raw_byte in rand_bytes(num):
 
683
        s += ALNUM[ord(raw_byte) % 36]
 
684
    return s
292
685
 
293
686
 
294
687
## TODO: We could later have path objects that remember their list
295
688
## decomposition (might be too tricksy though.)
296
689
 
297
690
def splitpath(p):
298
 
    """Turn string into list of parts.
299
 
 
300
 
    >>> splitpath('a')
301
 
    ['a']
302
 
    >>> splitpath('a/b')
303
 
    ['a', 'b']
304
 
    >>> splitpath('a/./b')
305
 
    ['a', 'b']
306
 
    >>> splitpath('a/.b')
307
 
    ['a', '.b']
308
 
    >>> splitpath('a/../b')
309
 
    Traceback (most recent call last):
310
 
    ...
311
 
    BzrError: ("sorry, '..' not allowed in path", [])
312
 
    """
313
 
    assert isinstance(p, types.StringTypes)
 
691
    """Turn string into list of parts."""
 
692
    assert isinstance(p, basestring)
314
693
 
315
694
    # split on either delimiter because people might use either on
316
695
    # Windows
319
698
    rps = []
320
699
    for f in ps:
321
700
        if f == '..':
322
 
            bailout("sorry, %r not allowed in path" % f)
 
701
            raise errors.BzrError("sorry, %r not allowed in path" % f)
323
702
        elif (f == '.') or (f == ''):
324
703
            pass
325
704
        else:
329
708
def joinpath(p):
330
709
    assert isinstance(p, list)
331
710
    for f in p:
332
 
        if (f == '..') or (f == None) or (f == ''):
333
 
            bailout("sorry, %r not allowed in path" % f)
334
 
    return os.path.join(*p)
335
 
 
336
 
 
 
711
        if (f == '..') or (f is None) or (f == ''):
 
712
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
713
    return pathjoin(*p)
 
714
 
 
715
 
 
716
@deprecated_function(zero_nine)
337
717
def appendpath(p1, p2):
338
718
    if p1 == '':
339
719
        return p2
340
720
    else:
341
 
        return os.path.join(p1, p2)
342
 
    
343
 
 
344
 
def extern_command(cmd, ignore_errors = False):
345
 
    mutter('external command: %s' % `cmd`)
346
 
    if os.system(cmd):
347
 
        if not ignore_errors:
348
 
            bailout('command failed')
349
 
 
 
721
        return pathjoin(p1, p2)
 
722
    
 
723
 
 
724
def split_lines(s):
 
725
    """Split s into lines, but without removing the newline characters."""
 
726
    lines = s.split('\n')
 
727
    result = [line + '\n' for line in lines[:-1]]
 
728
    if lines[-1]:
 
729
        result.append(lines[-1])
 
730
    return result
 
731
 
 
732
 
 
733
def hardlinks_good():
 
734
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
735
 
 
736
 
 
737
def link_or_copy(src, dest):
 
738
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
739
    if not hardlinks_good():
 
740
        shutil.copyfile(src, dest)
 
741
        return
 
742
    try:
 
743
        os.link(src, dest)
 
744
    except (OSError, IOError), e:
 
745
        if e.errno != errno.EXDEV:
 
746
            raise
 
747
        shutil.copyfile(src, dest)
 
748
 
 
749
def delete_any(full_path):
 
750
    """Delete a file or directory."""
 
751
    try:
 
752
        os.unlink(full_path)
 
753
    except OSError, e:
 
754
    # We may be renaming a dangling inventory id
 
755
        if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
 
756
            raise
 
757
        os.rmdir(full_path)
 
758
 
 
759
 
 
760
def has_symlinks():
 
761
    if getattr(os, 'symlink', None) is not None:
 
762
        return True
 
763
    else:
 
764
        return False
 
765
        
 
766
 
 
767
def contains_whitespace(s):
 
768
    """True if there are any whitespace characters in s."""
 
769
    for ch in string.whitespace:
 
770
        if ch in s:
 
771
            return True
 
772
    else:
 
773
        return False
 
774
 
 
775
 
 
776
def contains_linebreaks(s):
 
777
    """True if there is any vertical whitespace in s."""
 
778
    for ch in '\f\n\r':
 
779
        if ch in s:
 
780
            return True
 
781
    else:
 
782
        return False
 
783
 
 
784
 
 
785
def relpath(base, path):
 
786
    """Return path relative to base, or raise exception.
 
787
 
 
788
    The path may be either an absolute path or a path relative to the
 
789
    current working directory.
 
790
 
 
791
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
792
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
793
    avoids that problem.
 
794
    """
 
795
 
 
796
    assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
 
797
        ' exceed the platform minimum length (which is %d)' % 
 
798
        MIN_ABS_PATHLENGTH)
 
799
 
 
800
    rp = abspath(path)
 
801
 
 
802
    s = []
 
803
    head = rp
 
804
    while len(head) >= len(base):
 
805
        if head == base:
 
806
            break
 
807
        head, tail = os.path.split(head)
 
808
        if tail:
 
809
            s.insert(0, tail)
 
810
    else:
 
811
        raise errors.PathNotChild(rp, base)
 
812
 
 
813
    if s:
 
814
        return pathjoin(*s)
 
815
    else:
 
816
        return ''
 
817
 
 
818
 
 
819
def safe_unicode(unicode_or_utf8_string):
 
820
    """Coerce unicode_or_utf8_string into unicode.
 
821
 
 
822
    If it is unicode, it is returned.
 
823
    Otherwise it is decoded from utf-8. If a decoding error
 
824
    occurs, it is wrapped as a If the decoding fails, the exception is wrapped 
 
825
    as a BzrBadParameter exception.
 
826
    """
 
827
    if isinstance(unicode_or_utf8_string, unicode):
 
828
        return unicode_or_utf8_string
 
829
    try:
 
830
        return unicode_or_utf8_string.decode('utf8')
 
831
    except UnicodeDecodeError:
 
832
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
833
 
 
834
 
 
835
_platform_normalizes_filenames = False
 
836
if sys.platform == 'darwin':
 
837
    _platform_normalizes_filenames = True
 
838
 
 
839
 
 
840
def normalizes_filenames():
 
841
    """Return True if this platform normalizes unicode filenames.
 
842
 
 
843
    Mac OSX does, Windows/Linux do not.
 
844
    """
 
845
    return _platform_normalizes_filenames
 
846
 
 
847
 
 
848
def _accessible_normalized_filename(path):
 
849
    """Get the unicode normalized path, and if you can access the file.
 
850
 
 
851
    On platforms where the system normalizes filenames (Mac OSX),
 
852
    you can access a file by any path which will normalize correctly.
 
853
    On platforms where the system does not normalize filenames 
 
854
    (Windows, Linux), you have to access a file by its exact path.
 
855
 
 
856
    Internally, bzr only supports NFC/NFKC normalization, since that is 
 
857
    the standard for XML documents.
 
858
 
 
859
    So return the normalized path, and a flag indicating if the file
 
860
    can be accessed by that path.
 
861
    """
 
862
 
 
863
    return unicodedata.normalize('NFKC', unicode(path)), True
 
864
 
 
865
 
 
866
def _inaccessible_normalized_filename(path):
 
867
    __doc__ = _accessible_normalized_filename.__doc__
 
868
 
 
869
    normalized = unicodedata.normalize('NFKC', unicode(path))
 
870
    return normalized, normalized == path
 
871
 
 
872
 
 
873
if _platform_normalizes_filenames:
 
874
    normalized_filename = _accessible_normalized_filename
 
875
else:
 
876
    normalized_filename = _inaccessible_normalized_filename
 
877
 
 
878
 
 
879
def terminal_width():
 
880
    """Return estimated terminal width."""
 
881
    if sys.platform == 'win32':
 
882
        import bzrlib.win32console
 
883
        return bzrlib.win32console.get_console_size()[0]
 
884
    width = 0
 
885
    try:
 
886
        import struct, fcntl, termios
 
887
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
888
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
889
        width = struct.unpack('HHHH', x)[1]
 
890
    except IOError:
 
891
        pass
 
892
    if width <= 0:
 
893
        try:
 
894
            width = int(os.environ['COLUMNS'])
 
895
        except:
 
896
            pass
 
897
    if width <= 0:
 
898
        width = 80
 
899
 
 
900
    return width
 
901
 
 
902
 
 
903
def supports_executable():
 
904
    return sys.platform != "win32"
 
905
 
 
906
 
 
907
def set_or_unset_env(env_variable, value):
 
908
    """Modify the environment, setting or removing the env_variable.
 
909
 
 
910
    :param env_variable: The environment variable in question
 
911
    :param value: The value to set the environment to. If None, then
 
912
        the variable will be removed.
 
913
    :return: The original value of the environment variable.
 
914
    """
 
915
    orig_val = os.environ.get(env_variable)
 
916
    if value is None:
 
917
        if orig_val is not None:
 
918
            del os.environ[env_variable]
 
919
    else:
 
920
        if isinstance(value, unicode):
 
921
            value = value.encode(bzrlib.user_encoding)
 
922
        os.environ[env_variable] = value
 
923
    return orig_val
 
924
 
 
925
 
 
926
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
927
 
 
928
 
 
929
def check_legal_path(path):
 
930
    """Check whether the supplied path is legal.  
 
931
    This is only required on Windows, so we don't test on other platforms
 
932
    right now.
 
933
    """
 
934
    if sys.platform != "win32":
 
935
        return
 
936
    if _validWin32PathRE.match(path) is None:
 
937
        raise errors.IllegalPath(path)
 
938
 
 
939
 
 
940
def walkdirs(top, prefix=""):
 
941
    """Yield data about all the directories in a tree.
 
942
    
 
943
    This yields all the data about the contents of a directory at a time.
 
944
    After each directory has been yielded, if the caller has mutated the list
 
945
    to exclude some directories, they are then not descended into.
 
946
    
 
947
    The data yielded is of the form:
 
948
    ((directory-relpath, directory-path-from-top),
 
949
    [(relpath, basename, kind, lstat), ...]),
 
950
     - directory-relpath is the relative path of the directory being returned
 
951
       with respect to top. prefix is prepended to this.
 
952
     - directory-path-from-root is the path including top for this directory. 
 
953
       It is suitable for use with os functions.
 
954
     - relpath is the relative path within the subtree being walked.
 
955
     - basename is the basename of the path
 
956
     - kind is the kind of the file now. If unknown then the file is not
 
957
       present within the tree - but it may be recorded as versioned. See
 
958
       versioned_kind.
 
959
     - lstat is the stat data *if* the file was statted.
 
960
     - planned, not implemented: 
 
961
       path_from_tree_root is the path from the root of the tree.
 
962
 
 
963
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This 
 
964
        allows one to walk a subtree but get paths that are relative to a tree
 
965
        rooted higher up.
 
966
    :return: an iterator over the dirs.
 
967
    """
 
968
    #TODO there is a bit of a smell where the results of the directory-
 
969
    # summary in this, and the path from the root, may not agree 
 
970
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
971
    # potentially confusing output. We should make this more robust - but
 
972
    # not at a speed cost. RBC 20060731
 
973
    lstat = os.lstat
 
974
    pending = []
 
975
    _directory = _directory_kind
 
976
    _listdir = os.listdir
 
977
    pending = [(prefix, "", _directory, None, top)]
 
978
    while pending:
 
979
        dirblock = []
 
980
        currentdir = pending.pop()
 
981
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
982
        top = currentdir[4]
 
983
        if currentdir[0]:
 
984
            relroot = currentdir[0] + '/'
 
985
        else:
 
986
            relroot = ""
 
987
        for name in sorted(_listdir(top)):
 
988
            abspath = top + '/' + name
 
989
            statvalue = lstat(abspath)
 
990
            dirblock.append((relroot + name, name,
 
991
                file_kind_from_stat_mode(statvalue.st_mode),
 
992
                statvalue, abspath))
 
993
        yield (currentdir[0], top), dirblock
 
994
        # push the user specified dirs from dirblock
 
995
        for dir in reversed(dirblock):
 
996
            if dir[2] == _directory:
 
997
                pending.append(dir)
 
998
 
 
999
 
 
1000
def copy_tree(from_path, to_path, handlers={}):
 
1001
    """Copy all of the entries in from_path into to_path.
 
1002
 
 
1003
    :param from_path: The base directory to copy. 
 
1004
    :param to_path: The target directory. If it does not exist, it will
 
1005
        be created.
 
1006
    :param handlers: A dictionary of functions, which takes a source and
 
1007
        destinations for files, directories, etc.
 
1008
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1009
        'file', 'directory', and 'symlink' should always exist.
 
1010
        If they are missing, they will be replaced with 'os.mkdir()',
 
1011
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1012
    """
 
1013
    # Now, just copy the existing cached tree to the new location
 
1014
    # We use a cheap trick here.
 
1015
    # Absolute paths are prefixed with the first parameter
 
1016
    # relative paths are prefixed with the second.
 
1017
    # So we can get both the source and target returned
 
1018
    # without any extra work.
 
1019
 
 
1020
    def copy_dir(source, dest):
 
1021
        os.mkdir(dest)
 
1022
 
 
1023
    def copy_link(source, dest):
 
1024
        """Copy the contents of a symlink"""
 
1025
        link_to = os.readlink(source)
 
1026
        os.symlink(link_to, dest)
 
1027
 
 
1028
    real_handlers = {'file':shutil.copy2,
 
1029
                     'symlink':copy_link,
 
1030
                     'directory':copy_dir,
 
1031
                    }
 
1032
    real_handlers.update(handlers)
 
1033
 
 
1034
    if not os.path.exists(to_path):
 
1035
        real_handlers['directory'](from_path, to_path)
 
1036
 
 
1037
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1038
        for relpath, name, kind, st, abspath in entries:
 
1039
            real_handlers[kind](abspath, relpath)
 
1040
 
 
1041
 
 
1042
def path_prefix_key(path):
 
1043
    """Generate a prefix-order path key for path.
 
1044
 
 
1045
    This can be used to sort paths in the same way that walkdirs does.
 
1046
    """
 
1047
    return (dirname(path) , path)
 
1048
 
 
1049
 
 
1050
def compare_paths_prefix_order(path_a, path_b):
 
1051
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1052
    key_a = path_prefix_key(path_a)
 
1053
    key_b = path_prefix_key(path_b)
 
1054
    return cmp(key_a, key_b)
 
1055
 
 
1056
 
 
1057
_cached_user_encoding = None
 
1058
 
 
1059
 
 
1060
def get_user_encoding():
 
1061
    """Find out what the preferred user encoding is.
 
1062
 
 
1063
    This is generally the encoding that is used for command line parameters
 
1064
    and file contents. This may be different from the terminal encoding
 
1065
    or the filesystem encoding.
 
1066
 
 
1067
    :return: A string defining the preferred user encoding
 
1068
    """
 
1069
    global _cached_user_encoding
 
1070
    if _cached_user_encoding is not None:
 
1071
        return _cached_user_encoding
 
1072
 
 
1073
    if sys.platform == 'darwin':
 
1074
        # work around egregious python 2.4 bug
 
1075
        sys.platform = 'posix'
 
1076
        try:
 
1077
            import locale
 
1078
        finally:
 
1079
            sys.platform = 'darwin'
 
1080
    else:
 
1081
        import locale
 
1082
 
 
1083
    try:
 
1084
        _cached_user_encoding = locale.getpreferredencoding()
 
1085
    except locale.Error, e:
 
1086
        sys.stderr.write('bzr: warning: %s\n'
 
1087
                         '  Could not determine what text encoding to use.\n'
 
1088
                         '  This error usually means your Python interpreter\n'
 
1089
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1090
                         "  Continuing with ascii encoding.\n"
 
1091
                         % (e, os.environ.get('LANG')))
 
1092
 
 
1093
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1094
    # treat that as ASCII, and not support printing unicode characters to the
 
1095
    # console.
 
1096
    if _cached_user_encoding in (None, 'cp0'):
 
1097
        _cached_user_encoding = 'ascii'
 
1098
    return _cached_user_encoding
 
1099
 
 
1100
 
 
1101
def recv_all(socket, bytes):
 
1102
    """Receive an exact number of bytes.
 
1103
 
 
1104
    Regular Socket.recv() may return less than the requested number of bytes,
 
1105
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1106
    on all platforms, but this should work everywhere.  This will return
 
1107
    less than the requested amount if the remote end closes.
 
1108
 
 
1109
    This isn't optimized and is intended mostly for use in testing.
 
1110
    """
 
1111
    b = ''
 
1112
    while len(b) < bytes:
 
1113
        new = socket.recv(bytes - len(b))
 
1114
        if new == '':
 
1115
            break # eof
 
1116
        b += new
 
1117
    return b
 
1118
 
 
1119
def dereference_path(path):
 
1120
    """Determine the real path to a file.
 
1121
 
 
1122
    All parent elements are dereferenced.  But the file itself is not
 
1123
    dereferenced.
 
1124
    :param path: The original path.  May be absolute or relative.
 
1125
    :return: the real path *to* the file
 
1126
    """
 
1127
    parent, base = os.path.split(path)
 
1128
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1129
    # (initial path components aren't dereferenced)
 
1130
    return pathjoin(realpath(pathjoin('.', parent)), base)