← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: John Arbash Meinel
  • Date: 2006-12-19 14:19:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2200.
  • Revision ID: john@arbash-meinel.com-20061219141931-jhjpdy5hzgnr2b44
Update documentation as per Martin's suggestion.

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