/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/diff.py

  • Committer: Robey Pointer
  • Date: 2006-09-08 18:46:29 UTC
  • mto: This revision was merged to the branch mainline in revision 1996.
  • Revision ID: robey@lag.net-20060908184629-e3fc4c61ca21508c
pychecker is on crack; go back to using 'is None'.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
from bzrlib.trace import mutter
 
17
import errno
 
18
import os
 
19
import re
 
20
import subprocess
 
21
import sys
 
22
import tempfile
 
23
import time
 
24
 
 
25
# compatability - plugins import compare_trees from diff!!!
 
26
# deprecated as of 0.10
 
27
from bzrlib.delta import compare_trees
19
28
from bzrlib.errors import BzrError
20
 
from bzrlib.delta import compare_trees
 
29
import bzrlib.errors as errors
 
30
import bzrlib.osutils
 
31
from bzrlib.patiencediff import unified_diff
 
32
import bzrlib.patiencediff
 
33
from bzrlib.symbol_versioning import (deprecated_function,
 
34
        zero_eight)
 
35
from bzrlib.textfile import check_text_lines
 
36
from bzrlib.trace import mutter, warning
 
37
 
21
38
 
22
39
# TODO: Rather than building a changeset object, we should probably
23
40
# invoke callbacks on an object.  That object can either accumulate a
24
41
# list, write them out directly, etc etc.
25
42
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
 
    import difflib
28
 
    
 
43
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
44
                  allow_binary=False, sequence_matcher=None,
 
45
                  path_encoding='utf8'):
29
46
    # FIXME: difflib is wrong if there is no trailing newline.
30
47
    # The syntax used by patch seems to be "\ No newline at
31
48
    # end of file" following the last diff line from that
41
58
    # both sequences are empty.
42
59
    if not oldlines and not newlines:
43
60
        return
44
 
 
45
 
    ud = difflib.unified_diff(oldlines, newlines,
46
 
                              fromfile=old_label, tofile=new_label)
47
 
 
 
61
    
 
62
    if allow_binary is False:
 
63
        check_text_lines(oldlines)
 
64
        check_text_lines(newlines)
 
65
 
 
66
    if sequence_matcher is None:
 
67
        sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
68
    ud = unified_diff(oldlines, newlines,
 
69
                      fromfile=old_filename.encode(path_encoding),
 
70
                      tofile=new_filename.encode(path_encoding),
 
71
                      sequencematcher=sequence_matcher)
 
72
 
 
73
    ud = list(ud)
48
74
    # work-around for difflib being too smart for its own good
49
75
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
50
76
    if not oldlines:
51
 
        ud = list(ud)
52
77
        ud[2] = ud[2].replace('-1,0', '-0,0')
53
78
    elif not newlines:
54
 
        ud = list(ud)
55
79
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
80
    # work around for difflib emitting random spaces after the label
 
81
    ud[0] = ud[0][:-2] + '\n'
 
82
    ud[1] = ud[1][:-2] + '\n'
56
83
 
57
84
    for line in ud:
58
85
        to_file.write(line)
61
88
    print >>to_file
62
89
 
63
90
 
64
 
 
65
 
 
66
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
91
def _set_lang_C():
 
92
    """Set the env var LANG=C"""
 
93
    os.environ['LANG'] = 'C'
 
94
 
 
95
 
 
96
def _spawn_external_diff(diffcmd, capture_errors=True):
 
97
    """Spawn the externall diff process, and return the child handle.
 
98
 
 
99
    :param diffcmd: The command list to spawn
 
100
    :param capture_errors: Capture stderr as well as setting LANG=C.
 
101
        This lets us read and understand the output of diff, and respond 
 
102
        to any errors.
 
103
    :return: A Popen object.
 
104
    """
 
105
    if capture_errors:
 
106
        preexec_fn = _set_lang_C
 
107
        stderr = subprocess.PIPE
 
108
    else:
 
109
        preexec_fn = None
 
110
        stderr = None
 
111
 
 
112
    try:
 
113
        pipe = subprocess.Popen(diffcmd,
 
114
                                stdin=subprocess.PIPE,
 
115
                                stdout=subprocess.PIPE,
 
116
                                stderr=stderr,
 
117
                                preexec_fn=preexec_fn)
 
118
    except OSError, e:
 
119
        if e.errno == errno.ENOENT:
 
120
            raise errors.NoDiff(str(e))
 
121
        raise
 
122
 
 
123
    return pipe
 
124
 
 
125
 
 
126
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
67
127
                  diff_opts):
68
128
    """Display a diff by calling out to the external diff program."""
69
 
    import sys
70
 
    
71
 
    if to_file != sys.stdout:
72
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
73
 
                                  to_file)
74
 
 
75
129
    # make sure our own output is properly ordered before the diff
76
130
    to_file.flush()
77
131
 
78
 
    from tempfile import NamedTemporaryFile
79
 
    import os
80
 
 
81
 
    oldtmpf = NamedTemporaryFile()
82
 
    newtmpf = NamedTemporaryFile()
 
132
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
133
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
134
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
135
    newtmpf = os.fdopen(newtmp_fd, 'wb')
83
136
 
84
137
    try:
85
138
        # TODO: perhaps a special case for comparing to or from the empty
92
145
        oldtmpf.writelines(oldlines)
93
146
        newtmpf.writelines(newlines)
94
147
 
95
 
        oldtmpf.flush()
96
 
        newtmpf.flush()
 
148
        oldtmpf.close()
 
149
        newtmpf.close()
97
150
 
98
151
        if not diff_opts:
99
152
            diff_opts = []
100
153
        diffcmd = ['diff',
101
 
                   '--label', old_label,
102
 
                   oldtmpf.name,
103
 
                   '--label', new_label,
104
 
                   newtmpf.name]
 
154
                   '--label', old_filename,
 
155
                   old_abspath,
 
156
                   '--label', new_filename,
 
157
                   new_abspath,
 
158
                   '--binary',
 
159
                  ]
105
160
 
106
161
        # diff only allows one style to be specified; they don't override.
107
162
        # note that some of these take optargs, and the optargs can be
127
182
        if diff_opts:
128
183
            diffcmd.extend(diff_opts)
129
184
 
130
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
185
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
186
        out,err = pipe.communicate()
 
187
        rc = pipe.returncode
131
188
        
132
 
        if rc != 0 and rc != 1:
 
189
        # internal_diff() adds a trailing newline, add one here for consistency
 
190
        out += '\n'
 
191
        if rc == 2:
 
192
            # 'diff' gives retcode == 2 for all sorts of errors
 
193
            # one of those is 'Binary files differ'.
 
194
            # Bad options could also be the problem.
 
195
            # 'Binary files' is not a real error, so we suppress that error.
 
196
            lang_c_out = out
 
197
 
 
198
            # Since we got here, we want to make sure to give an i18n error
 
199
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
200
            out, err = pipe.communicate()
 
201
 
 
202
            # Write out the new i18n diff response
 
203
            to_file.write(out+'\n')
 
204
            if pipe.returncode != 2:
 
205
                raise BzrError('external diff failed with exit code 2'
 
206
                               ' when run with LANG=C, but not when run'
 
207
                               ' natively: %r' % (diffcmd,))
 
208
 
 
209
            first_line = lang_c_out.split('\n', 1)[0]
 
210
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
211
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
212
            if m is None:
 
213
                raise BzrError('external diff failed with exit code 2;'
 
214
                               ' command: %r' % (diffcmd,))
 
215
            else:
 
216
                # Binary files differ, just return
 
217
                return
 
218
 
 
219
        # If we got to here, we haven't written out the output of diff
 
220
        # do so now
 
221
        to_file.write(out)
 
222
        if rc not in (0, 1):
133
223
            # returns 1 if files differ; that's OK
134
224
            if rc < 0:
135
225
                msg = 'signal %d' % (-rc)
136
226
            else:
137
227
                msg = 'exit code %d' % rc
138
228
                
139
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
229
            raise BzrError('external diff failed with %s; command: %r' 
 
230
                           % (rc, diffcmd))
 
231
 
 
232
 
140
233
    finally:
141
234
        oldtmpf.close()                 # and delete
142
235
        newtmpf.close()
143
 
    
144
 
 
145
 
 
146
 
def show_diff(b, revision, specific_files, external_diff_options=None):
 
236
        # Clean up. Warn in case the files couldn't be deleted
 
237
        # (in case windows still holds the file open, but not
 
238
        # if the files have already been deleted)
 
239
        try:
 
240
            os.remove(old_abspath)
 
241
        except OSError, e:
 
242
            if e.errno not in (errno.ENOENT,):
 
243
                warning('Failed to delete temporary file: %s %s',
 
244
                        old_abspath, e)
 
245
        try:
 
246
            os.remove(new_abspath)
 
247
        except OSError:
 
248
            if e.errno not in (errno.ENOENT,):
 
249
                warning('Failed to delete temporary file: %s %s',
 
250
                        new_abspath, e)
 
251
 
 
252
 
 
253
@deprecated_function(zero_eight)
 
254
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
255
              revision2=None, output=None, b2=None):
147
256
    """Shortcut for showing the diff to the working tree.
148
257
 
 
258
    Please use show_diff_trees instead.
 
259
 
149
260
    b
150
261
        Branch.
151
262
 
152
263
    revision
153
 
        None for each, or otherwise the old revision to compare against.
154
 
    
155
 
    The more general form is show_diff_trees(), where the caller
156
 
    supplies any two trees.
157
 
    """
158
 
    import sys
159
 
 
160
 
    if revision == None:
161
 
        old_tree = b.basis_tree()
162
 
    else:
163
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
164
 
        
165
 
    new_tree = b.working_tree()
166
 
 
167
 
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
168
 
                    external_diff_options)
169
 
 
 
264
        None for 'basis tree', or otherwise the old revision to compare against.
 
265
    
 
266
    The more general form is show_diff_trees(), where the caller
 
267
    supplies any two trees.
 
268
    """
 
269
    if output is None:
 
270
        output = sys.stdout
 
271
 
 
272
    if from_spec is None:
 
273
        old_tree = b.bzrdir.open_workingtree()
 
274
        if b2 is None:
 
275
            old_tree = old_tree = old_tree.basis_tree()
 
276
    else:
 
277
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
278
 
 
279
    if revision2 is None:
 
280
        if b2 is None:
 
281
            new_tree = b.bzrdir.open_workingtree()
 
282
        else:
 
283
            new_tree = b2.bzrdir.open_workingtree()
 
284
    else:
 
285
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
 
286
 
 
287
    return show_diff_trees(old_tree, new_tree, output, specific_files,
 
288
                           external_diff_options)
 
289
 
 
290
 
 
291
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
292
                    old_revision_spec=None, new_revision_spec=None,
 
293
                    old_label='a/', new_label='b/'):
 
294
    """Helper for cmd_diff.
 
295
 
 
296
   tree 
 
297
        A WorkingTree
 
298
 
 
299
    specific_files
 
300
        The specific files to compare, or None
 
301
 
 
302
    external_diff_options
 
303
        If non-None, run an external diff, and pass it these options
 
304
 
 
305
    old_revision_spec
 
306
        If None, use basis tree as old revision, otherwise use the tree for
 
307
        the specified revision. 
 
308
 
 
309
    new_revision_spec
 
310
        If None, use working tree as new revision, otherwise use the tree for
 
311
        the specified revision.
 
312
    
 
313
    The more general form is show_diff_trees(), where the caller
 
314
    supplies any two trees.
 
315
    """
 
316
    def spec_tree(spec):
 
317
        if tree:
 
318
            revision = spec.in_store(tree.branch)
 
319
        else:
 
320
            revision = spec.in_store(None)
 
321
        revision_id = revision.rev_id
 
322
        branch = revision.branch
 
323
        return branch.repository.revision_tree(revision_id)
 
324
    if old_revision_spec is None:
 
325
        old_tree = tree.basis_tree()
 
326
    else:
 
327
        old_tree = spec_tree(old_revision_spec)
 
328
 
 
329
    if new_revision_spec is None:
 
330
        new_tree = tree
 
331
    else:
 
332
        new_tree = spec_tree(new_revision_spec)
 
333
    if new_tree is not tree:
 
334
        extra_trees = (tree,)
 
335
    else:
 
336
        extra_trees = None
 
337
 
 
338
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
339
                           external_diff_options,
 
340
                           old_label=old_label, new_label=new_label,
 
341
                           extra_trees=extra_trees)
170
342
 
171
343
 
172
344
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
173
 
                    external_diff_options=None):
 
345
                    external_diff_options=None,
 
346
                    old_label='a/', new_label='b/',
 
347
                    extra_trees=None):
174
348
    """Show in text form the changes from one tree to another.
175
349
 
176
350
    to_files
178
352
 
179
353
    external_diff_options
180
354
        If set, use an external GNU diff and pass these options.
 
355
 
 
356
    extra_trees
 
357
        If set, more Trees to use for looking up file ids
181
358
    """
182
 
 
183
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
184
 
    old_label = ''
185
 
    new_label = ''
186
 
 
187
 
    DEVNULL = '/dev/null'
188
 
    # Windows users, don't panic about this filename -- it is a
189
 
    # special signal to GNU patch that the file should be created or
190
 
    # deleted respectively.
 
359
    old_tree.lock_read()
 
360
    try:
 
361
        new_tree.lock_read()
 
362
        try:
 
363
            return _show_diff_trees(old_tree, new_tree, to_file,
 
364
                                    specific_files, external_diff_options,
 
365
                                    old_label=old_label, new_label=new_label,
 
366
                                    extra_trees=extra_trees)
 
367
        finally:
 
368
            new_tree.unlock()
 
369
    finally:
 
370
        old_tree.unlock()
 
371
 
 
372
 
 
373
def _show_diff_trees(old_tree, new_tree, to_file,
 
374
                     specific_files, external_diff_options, 
 
375
                     old_label='a/', new_label='b/', extra_trees=None):
 
376
 
 
377
    # GNU Patch uses the epoch date to detect files that are being added
 
378
    # or removed in a diff.
 
379
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
191
380
 
192
381
    # TODO: Generation of pseudo-diffs for added/deleted files could
193
382
    # be usefully made into a much faster special case.
200
389
    else:
201
390
        diff_file = internal_diff
202
391
    
203
 
 
204
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
 
                          specific_files=specific_files)
206
 
 
 
392
    delta = new_tree.changes_from(old_tree,
 
393
        specific_files=specific_files,
 
394
        extra_trees=extra_trees, require_versioned=True)
 
395
 
 
396
    has_changes = 0
207
397
    for path, file_id, kind in delta.removed:
208
 
        print >>to_file, '*** removed %s %r' % (kind, path)
209
 
        if kind == 'file':
210
 
            diff_file(old_label + path,
211
 
                      old_tree.get_file(file_id).readlines(),
212
 
                      DEVNULL, 
213
 
                      [],
214
 
                      to_file)
215
 
 
 
398
        has_changes = 1
 
399
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
 
400
        old_name = '%s%s\t%s' % (old_label, path,
 
401
                                 _patch_header_date(old_tree, file_id, path))
 
402
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
403
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
404
                                         new_name, None, None, to_file)
216
405
    for path, file_id, kind in delta.added:
217
 
        print >>to_file, '*** added %s %r' % (kind, path)
218
 
        if kind == 'file':
219
 
            diff_file(DEVNULL,
220
 
                      [],
221
 
                      new_label + path,
222
 
                      new_tree.get_file(file_id).readlines(),
223
 
                      to_file)
224
 
 
225
 
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
226
 
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
406
        has_changes = 1
 
407
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
 
408
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
409
        new_name = '%s%s\t%s' % (new_label, path,
 
410
                                 _patch_header_date(new_tree, file_id, path))
 
411
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
412
                                         old_name, None, None, to_file, 
 
413
                                         reverse=True)
 
414
    for (old_path, new_path, file_id, kind,
 
415
         text_modified, meta_modified) in delta.renamed:
 
416
        has_changes = 1
 
417
        prop_str = get_prop_change(meta_modified)
 
418
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
419
                    kind, old_path.encode('utf8'),
 
420
                    new_path.encode('utf8'), prop_str)
 
421
        old_name = '%s%s\t%s' % (old_label, old_path,
 
422
                                 _patch_header_date(old_tree, file_id,
 
423
                                                    old_path))
 
424
        new_name = '%s%s\t%s' % (new_label, new_path,
 
425
                                 _patch_header_date(new_tree, file_id,
 
426
                                                    new_path))
 
427
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
428
                                    new_name, new_tree,
 
429
                                    text_modified, kind, to_file, diff_file)
 
430
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
431
        has_changes = 1
 
432
        prop_str = get_prop_change(meta_modified)
 
433
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
 
434
        old_name = '%s%s\t%s' % (old_label, path,
 
435
                                 _patch_header_date(old_tree, file_id, path))
 
436
        new_name = '%s%s\t%s' % (new_label, path,
 
437
                                 _patch_header_date(new_tree, file_id, path))
227
438
        if text_modified:
228
 
            diff_file(old_label + old_path,
229
 
                      old_tree.get_file(file_id).readlines(),
230
 
                      new_label + new_path,
231
 
                      new_tree.get_file(file_id).readlines(),
232
 
                      to_file)
233
 
 
234
 
    for path, file_id, kind in delta.modified:
235
 
        print >>to_file, '*** modified %s %r' % (kind, path)
236
 
        if kind == 'file':
237
 
            diff_file(old_label + path,
238
 
                      old_tree.get_file(file_id).readlines(),
239
 
                      new_label + path,
240
 
                      new_tree.get_file(file_id).readlines(),
241
 
                      to_file)
242
 
 
243
 
 
244
 
 
245
 
 
246
 
 
 
439
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
440
                                        new_name, new_tree,
 
441
                                        True, kind, to_file, diff_file)
 
442
 
 
443
    return has_changes
 
444
 
 
445
 
 
446
def _patch_header_date(tree, file_id, path):
 
447
    """Returns a timestamp suitable for use in a patch header."""
 
448
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
 
449
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
 
450
 
 
451
 
 
452
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
453
    """Complain if paths are not in either inventory or tree.
 
454
 
 
455
    It's OK with the files exist in either tree's inventory, or 
 
456
    if they exist in the tree but are not versioned.
 
457
    
 
458
    This can be used by operations such as bzr status that can accept
 
459
    unknown or ignored files.
 
460
    """
 
461
    mutter("check paths: %r", paths)
 
462
    if not paths:
 
463
        return
 
464
    s = old_tree.filter_unversioned_files(paths)
 
465
    s = new_tree.filter_unversioned_files(s)
 
466
    s = [path for path in s if not new_tree.has_filename(path)]
 
467
    if s:
 
468
        raise errors.PathsDoNotExist(sorted(s))
 
469
 
 
470
 
 
471
def get_prop_change(meta_modified):
 
472
    if meta_modified:
 
473
        return " (properties changed)"
 
474
    else:
 
475
        return  ""
 
476
 
 
477
 
 
478
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
479
                                new_path, new_tree, text_modified,
 
480
                                kind, to_file, diff_file):
 
481
    if text_modified:
 
482
        new_entry = new_tree.inventory[file_id]
 
483
        old_tree.inventory[file_id].diff(diff_file,
 
484
                                         old_path, old_tree,
 
485
                                         new_path, new_entry, 
 
486
                                         new_tree, to_file)