← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2005-09-06 15:19:44 UTC
  • mto: (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1397.
  • Revision ID: robertc@robertcollins.net-20050906151944-04320f095a2abc31
minor refactors to store, create an ImmutableMemoryStore for testing or other such operations

Show diffs side-by-side

added added

removed removed

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