/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: Martin Pool
  • Date: 2006-06-20 03:57:11 UTC
  • mto: This revision was merged to the branch mainline in revision 1798.
  • Revision ID: mbp@sourcefrog.net-20060620035711-400bb6b6bc6ff95b
Add pyflakes makefile target; fix many warnings

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
3
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
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
 
 
17
import time
 
18
 
 
19
from bzrlib.delta import compare_trees
 
20
from bzrlib.errors import BzrError
 
21
import bzrlib.errors as errors
 
22
from bzrlib.patiencediff import unified_diff
 
23
import bzrlib.patiencediff
 
24
from bzrlib.symbol_versioning import (deprecated_function,
 
25
        zero_eight)
 
26
from bzrlib.textfile import check_text_lines
18
27
from bzrlib.trace import mutter
19
 
from bzrlib.errors import BzrError
20
 
from bzrlib.delta import compare_trees
 
28
 
21
29
 
22
30
# TODO: Rather than building a changeset object, we should probably
23
31
# invoke callbacks on an object.  That object can either accumulate a
24
32
# list, write them out directly, etc etc.
25
33
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
 
    import difflib
28
 
    
 
34
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
35
                  allow_binary=False, sequence_matcher=None,
 
36
                  path_encoding='utf8'):
29
37
    # FIXME: difflib is wrong if there is no trailing newline.
30
38
    # The syntax used by patch seems to be "\ No newline at
31
39
    # end of file" following the last diff line from that
41
49
    # both sequences are empty.
42
50
    if not oldlines and not newlines:
43
51
        return
44
 
 
45
 
    ud = difflib.unified_diff(oldlines, newlines,
46
 
                              fromfile=old_label, tofile=new_label)
47
 
 
 
52
    
 
53
    if allow_binary is False:
 
54
        check_text_lines(oldlines)
 
55
        check_text_lines(newlines)
 
56
 
 
57
    if sequence_matcher is None:
 
58
        sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
59
    ud = unified_diff(oldlines, newlines,
 
60
                      fromfile=old_filename.encode(path_encoding),
 
61
                      tofile=new_filename.encode(path_encoding),
 
62
                      sequencematcher=sequence_matcher)
 
63
 
 
64
    ud = list(ud)
48
65
    # work-around for difflib being too smart for its own good
49
66
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
50
67
    if not oldlines:
51
 
        ud = list(ud)
52
68
        ud[2] = ud[2].replace('-1,0', '-0,0')
53
69
    elif not newlines:
54
 
        ud = list(ud)
55
70
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
71
    # work around for difflib emitting random spaces after the label
 
72
    ud[0] = ud[0][:-2] + '\n'
 
73
    ud[1] = ud[1][:-2] + '\n'
56
74
 
57
75
    for line in ud:
58
76
        to_file.write(line)
61
79
    print >>to_file
62
80
 
63
81
 
64
 
 
65
 
 
66
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
82
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
67
83
                  diff_opts):
68
84
    """Display a diff by calling out to the external diff program."""
69
85
    import sys
98
114
        if not diff_opts:
99
115
            diff_opts = []
100
116
        diffcmd = ['diff',
101
 
                   '--label', old_label,
 
117
                   '--label', old_filename,
102
118
                   oldtmpf.name,
103
 
                   '--label', new_label,
 
119
                   '--label', new_filename,
104
120
                   newtmpf.name]
105
121
 
106
122
        # diff only allows one style to be specified; they don't override.
140
156
    finally:
141
157
        oldtmpf.close()                 # and delete
142
158
        newtmpf.close()
143
 
    
144
 
 
145
 
 
146
 
def show_diff(b, revision, specific_files, external_diff_options=None):
 
159
 
 
160
 
 
161
@deprecated_function(zero_eight)
 
162
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
163
              revision2=None, output=None, b2=None):
147
164
    """Shortcut for showing the diff to the working tree.
148
165
 
 
166
    Please use show_diff_trees instead.
 
167
 
149
168
    b
150
169
        Branch.
151
170
 
152
171
    revision
153
 
        None for each, or otherwise the old revision to compare against.
 
172
        None for 'basis tree', or otherwise the old revision to compare against.
 
173
    
 
174
    The more general form is show_diff_trees(), where the caller
 
175
    supplies any two trees.
 
176
    """
 
177
    if output is None:
 
178
        import sys
 
179
        output = sys.stdout
 
180
 
 
181
    if from_spec is None:
 
182
        old_tree = b.bzrdir.open_workingtree()
 
183
        if b2 is None:
 
184
            old_tree = old_tree = old_tree.basis_tree()
 
185
    else:
 
186
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
187
 
 
188
    if revision2 is None:
 
189
        if b2 is None:
 
190
            new_tree = b.bzrdir.open_workingtree()
 
191
        else:
 
192
            new_tree = b2.bzrdir.open_workingtree()
 
193
    else:
 
194
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
 
195
 
 
196
    return show_diff_trees(old_tree, new_tree, output, specific_files,
 
197
                           external_diff_options)
 
198
 
 
199
 
 
200
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
201
                    old_revision_spec=None, new_revision_spec=None,
 
202
                    old_label='a/', new_label='b/'):
 
203
    """Helper for cmd_diff.
 
204
 
 
205
   tree 
 
206
        A WorkingTree
 
207
 
 
208
    specific_files
 
209
        The specific files to compare, or None
 
210
 
 
211
    external_diff_options
 
212
        If non-None, run an external diff, and pass it these options
 
213
 
 
214
    old_revision_spec
 
215
        If None, use basis tree as old revision, otherwise use the tree for
 
216
        the specified revision. 
 
217
 
 
218
    new_revision_spec
 
219
        If None, use working tree as new revision, otherwise use the tree for
 
220
        the specified revision.
154
221
    
155
222
    The more general form is show_diff_trees(), where the caller
156
223
    supplies any two trees.
157
224
    """
158
225
    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
 
 
 
226
    output = sys.stdout
 
227
    def spec_tree(spec):
 
228
        revision_id = spec.in_store(tree.branch).rev_id
 
229
        return tree.branch.repository.revision_tree(revision_id)
 
230
    if old_revision_spec is None:
 
231
        old_tree = tree.basis_tree()
 
232
    else:
 
233
        old_tree = spec_tree(old_revision_spec)
 
234
 
 
235
    if new_revision_spec is None:
 
236
        new_tree = tree
 
237
    else:
 
238
        new_tree = spec_tree(new_revision_spec)
 
239
 
 
240
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
241
                           external_diff_options,
 
242
                           old_label=old_label, new_label=new_label)
170
243
 
171
244
 
172
245
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
173
 
                    external_diff_options=None):
 
246
                    external_diff_options=None,
 
247
                    old_label='a/', new_label='b/'):
174
248
    """Show in text form the changes from one tree to another.
175
249
 
176
250
    to_files
179
253
    external_diff_options
180
254
        If set, use an external GNU diff and pass these options.
181
255
    """
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.
 
256
    old_tree.lock_read()
 
257
    try:
 
258
        new_tree.lock_read()
 
259
        try:
 
260
            return _show_diff_trees(old_tree, new_tree, to_file,
 
261
                                    specific_files, external_diff_options,
 
262
                                    old_label=old_label, new_label=new_label)
 
263
        finally:
 
264
            new_tree.unlock()
 
265
    finally:
 
266
        old_tree.unlock()
 
267
 
 
268
 
 
269
def _show_diff_trees(old_tree, new_tree, to_file,
 
270
                     specific_files, external_diff_options, 
 
271
                     old_label='a/', new_label='b/' ):
 
272
 
 
273
    # GNU Patch uses the epoch date to detect files that are being added
 
274
    # or removed in a diff.
 
275
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
191
276
 
192
277
    # TODO: Generation of pseudo-diffs for added/deleted files could
193
278
    # be usefully made into a much faster special case.
194
279
 
 
280
    _raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
 
281
 
195
282
    if external_diff_options:
196
283
        assert isinstance(external_diff_options, basestring)
197
284
        opts = external_diff_options.split()
200
287
    else:
201
288
        diff_file = internal_diff
202
289
    
203
 
 
204
290
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
291
                          specific_files=specific_files)
206
292
 
 
293
    has_changes = 0
207
294
    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
 
 
 
295
        has_changes = 1
 
296
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
 
297
        old_name = '%s%s\t%s' % (old_label, path,
 
298
                                 _patch_header_date(old_tree, file_id, path))
 
299
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
300
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
301
                                         new_name, None, None, to_file)
216
302
    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)
 
303
        has_changes = 1
 
304
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
 
305
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
306
        new_name = '%s%s\t%s' % (new_label, path,
 
307
                                 _patch_header_date(new_tree, file_id, path))
 
308
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
309
                                         old_name, None, None, to_file, 
 
310
                                         reverse=True)
 
311
    for (old_path, new_path, file_id, kind,
 
312
         text_modified, meta_modified) in delta.renamed:
 
313
        has_changes = 1
 
314
        prop_str = get_prop_change(meta_modified)
 
315
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
316
                    kind, old_path.encode('utf8'),
 
317
                    new_path.encode('utf8'), prop_str)
 
318
        old_name = '%s%s\t%s' % (old_label, old_path,
 
319
                                 _patch_header_date(old_tree, file_id,
 
320
                                                    old_path))
 
321
        new_name = '%s%s\t%s' % (new_label, new_path,
 
322
                                 _patch_header_date(new_tree, file_id,
 
323
                                                    new_path))
 
324
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
325
                                    new_name, new_tree,
 
326
                                    text_modified, kind, to_file, diff_file)
 
327
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
328
        has_changes = 1
 
329
        prop_str = get_prop_change(meta_modified)
 
330
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
 
331
        old_name = '%s%s\t%s' % (old_label, path,
 
332
                                 _patch_header_date(old_tree, file_id, path))
 
333
        new_name = '%s%s\t%s' % (new_label, path,
 
334
                                 _patch_header_date(new_tree, file_id, path))
227
335
        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
 
 
 
336
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
337
                                        new_name, new_tree,
 
338
                                        True, kind, to_file, diff_file)
 
339
 
 
340
    return has_changes
 
341
 
 
342
 
 
343
def _patch_header_date(tree, file_id, path):
 
344
    """Returns a timestamp suitable for use in a patch header."""
 
345
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
 
346
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
 
347
 
 
348
 
 
349
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
 
350
    """Complain if paths are not versioned in either tree."""
 
351
    if not specific_files:
 
352
        return
 
353
    old_unversioned = old_tree.filter_unversioned_files(specific_files)
 
354
    new_unversioned = new_tree.filter_unversioned_files(specific_files)
 
355
    unversioned = old_unversioned.intersection(new_unversioned)
 
356
    if unversioned:
 
357
        raise errors.PathsNotVersionedError(sorted(unversioned))
 
358
    
 
359
 
 
360
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
361
    """Complain if paths are not in either inventory or tree.
 
362
 
 
363
    It's OK with the files exist in either tree's inventory, or 
 
364
    if they exist in the tree but are not versioned.
 
365
    
 
366
    This can be used by operations such as bzr status that can accept
 
367
    unknown or ignored files.
 
368
    """
 
369
    mutter("check paths: %r", paths)
 
370
    if not paths:
 
371
        return
 
372
    s = old_tree.filter_unversioned_files(paths)
 
373
    s = new_tree.filter_unversioned_files(s)
 
374
    s = [path for path in s if not new_tree.has_filename(path)]
 
375
    if s:
 
376
        raise errors.PathsDoNotExist(sorted(s))
 
377
 
 
378
 
 
379
def get_prop_change(meta_modified):
 
380
    if meta_modified:
 
381
        return " (properties changed)"
 
382
    else:
 
383
        return  ""
 
384
 
 
385
 
 
386
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
387
                                new_path, new_tree, text_modified,
 
388
                                kind, to_file, diff_file):
 
389
    if text_modified:
 
390
        new_entry = new_tree.inventory[file_id]
 
391
        old_tree.inventory[file_id].diff(diff_file,
 
392
                                         old_path, old_tree,
 
393
                                         new_path, new_entry, 
 
394
                                         new_tree, to_file)