← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: John Arbash Meinel
  • Date: 2007-01-24 17:59:50 UTC
  • mto: This revision was merged to the branch mainline in revision 2245.
  • Revision ID: john@arbash-meinel.com-20070124175950-jsf09jr7wq3u1neb
Add tests that decorators generate useful wrappers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from bzrlib import (
18
 
    osutils,
19
 
    )
20
 
from bzrlib.trace import is_quiet
 
17
from bzrlib import errors
 
18
from bzrlib.inventory import InventoryEntry
 
19
from bzrlib.trace import mutter
 
20
from bzrlib.symbol_versioning import deprecated_function, zero_nine
21
21
 
22
22
 
23
23
class TreeDelta(object):
24
24
    """Describes changes from one tree to another.
25
25
 
26
 
    Contains seven lists:
 
26
    Contains four lists:
27
27
 
28
28
    added
29
29
        (path, id, kind)
31
31
        (path, id, kind)
32
32
    renamed
33
33
        (oldpath, newpath, id, kind, text_modified, meta_modified)
34
 
    kind_changed
35
 
        (path, id, old_kind, new_kind)
36
34
    modified
37
35
        (path, id, kind, text_modified, meta_modified)
38
36
    unchanged
39
37
        (path, id, kind)
40
 
    unversioned
41
 
        (path, None, kind)
42
38
 
43
39
    Each id is listed only once.
44
40
 
45
41
    Files that are both modified and renamed are listed only in
46
42
    renamed, with the text_modified flag true. The text_modified
47
 
    applies either to the content of the file or the target of the
 
43
    applies either to the the content of the file or the target of the
48
44
    symbolic link, depending of the kind of file.
49
45
 
50
46
    Files are only considered renamed if their name has changed or
57
53
        self.added = []
58
54
        self.removed = []
59
55
        self.renamed = []
60
 
        self.kind_changed = []
61
56
        self.modified = []
62
57
        self.unchanged = []
63
 
        self.unversioned = []
64
58
 
65
59
    def __eq__(self, other):
66
60
        if not isinstance(other, TreeDelta):
69
63
               and self.removed == other.removed \
70
64
               and self.renamed == other.renamed \
71
65
               and self.modified == other.modified \
72
 
               and self.unchanged == other.unchanged \
73
 
               and self.kind_changed == other.kind_changed \
74
 
               and self.unversioned == other.unversioned
 
66
               and self.unchanged == other.unchanged
75
67
 
76
68
    def __ne__(self, other):
77
69
        return not (self == other)
78
70
 
79
71
    def __repr__(self):
80
 
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
81
 
            " kind_changed=%r, modified=%r, unchanged=%r," \
82
 
            " unversioned=%r)" % (self.added,
83
 
            self.removed, self.renamed, self.kind_changed, self.modified,
84
 
            self.unchanged, self.unversioned)
 
72
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
73
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
74
            self.modified, self.unchanged)
85
75
 
86
76
    def has_changed(self):
87
77
        return bool(self.modified
88
78
                    or self.added
89
79
                    or self.removed
90
 
                    or self.renamed
91
 
                    or self.kind_changed)
 
80
                    or self.renamed)
92
81
 
93
82
    def touches_file_id(self, file_id):
94
83
        """Return True if file_id is modified by this delta."""
99
88
        for v in self.renamed:
100
89
            if v[2] == file_id:
101
90
                return True
102
 
        for v in self.kind_changed:
103
 
            if v[1] == file_id:
104
 
                return True
105
91
        return False
106
 
 
107
 
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
108
 
                            short_status=False):
109
 
        import StringIO
110
 
        output = StringIO.StringIO()
111
 
        report_delta(output, self, short_status, show_ids, show_unchanged)
112
 
        return output.getvalue()
113
 
 
114
 
 
115
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
116
 
                   include_root, extra_trees=None,
117
 
                   require_versioned=False, want_unversioned=False):
118
 
    """Worker function that implements Tree.changes_from."""
 
92
            
 
93
 
 
94
    def show(self, to_file, show_ids=False, show_unchanged=False, short_status=False):
 
95
        """output this delta in status-like form to to_file."""
 
96
        def show_list(files, short_status_letter=''):
 
97
            for item in files:
 
98
                path, fid, kind = item[:3]
 
99
 
 
100
                if kind == 'directory':
 
101
                    path += '/'
 
102
                elif kind == 'symlink':
 
103
                    path += '@'
 
104
 
 
105
                if len(item) == 5 and item[4]:
 
106
                    path += '*'
 
107
 
 
108
                if show_ids:
 
109
                    print >>to_file, '%s  %-30s %s' % (short_status_letter, path, fid)
 
110
                else:
 
111
                    print >>to_file, '%s  %s' % (short_status_letter, path)
 
112
            
 
113
        if self.removed:
 
114
            if not short_status:
 
115
                print >>to_file, 'removed:'
 
116
                show_list(self.removed)
 
117
            else:
 
118
                show_list(self.removed, 'D')
 
119
                
 
120
        if self.added:
 
121
            if not short_status:
 
122
                print >>to_file, 'added:'
 
123
                show_list(self.added)
 
124
            else:
 
125
                show_list(self.added, 'A')
 
126
 
 
127
        extra_modified = []
 
128
 
 
129
        if self.renamed:
 
130
            short_status_letter = 'R'
 
131
            if not short_status:
 
132
                print >>to_file, 'renamed:'
 
133
                short_status_letter = ''
 
134
            for (oldpath, newpath, fid, kind,
 
135
                 text_modified, meta_modified) in self.renamed:
 
136
                if text_modified or meta_modified:
 
137
                    extra_modified.append((newpath, fid, kind,
 
138
                                           text_modified, meta_modified))
 
139
                if meta_modified:
 
140
                    newpath += '*'
 
141
                if show_ids:
 
142
                    print >>to_file, '%s  %s => %s %s' % (short_status_letter,
 
143
                                                          oldpath, newpath, fid)
 
144
                else:
 
145
                    print >>to_file, '%s  %s => %s' % (short_status_letter,
 
146
                                                       oldpath, newpath)
 
147
                    
 
148
        if self.modified or extra_modified:
 
149
            short_status_letter = 'M'
 
150
            if not short_status:
 
151
                print >>to_file, 'modified:'
 
152
                short_status_letter = ''
 
153
            show_list(self.modified, short_status_letter)
 
154
            show_list(extra_modified, short_status_letter)
 
155
            
 
156
        if show_unchanged and self.unchanged:
 
157
            if not short_status:
 
158
                print >>to_file, 'unchanged:'
 
159
                show_list(self.unchanged)
 
160
            else:
 
161
                show_list(self.unchanged, 'S')
 
162
 
 
163
 
 
164
@deprecated_function(zero_nine)
 
165
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
166
                  specific_files=None, extra_trees=None,
 
167
                  require_versioned=False):
 
168
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
169
    return new_tree.changes_from(old_tree,
 
170
        want_unchanged=want_unchanged,
 
171
        specific_files=specific_files,
 
172
        extra_trees=extra_trees,
 
173
        require_versioned=require_versioned,
 
174
        include_root=False)
 
175
 
 
176
 
 
177
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
 
178
                   include_root):
119
179
    delta = TreeDelta()
120
180
    # mutter('start compare_trees')
121
181
 
122
182
    for (file_id, path, content_change, versioned, parent_id, name, kind,
123
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
124
 
            specific_files, extra_trees=extra_trees,
125
 
            require_versioned=require_versioned,
126
 
            want_unversioned=want_unversioned):
127
 
        if versioned == (False, False):
128
 
            delta.unversioned.append((path[1], None, kind[1]))
129
 
            continue
 
183
         executable) in new_tree._iter_changes(old_tree, want_unchanged, 
 
184
                                               specific_file_ids):
130
185
        if not include_root and (None, None) == parent_id:
131
186
            continue
 
187
        assert kind[0] == kind[1] or None in kind
 
188
        # the only 'kind change' permitted is creation/deletion
132
189
        fully_present = tuple((versioned[x] and kind[x] is not None) for
133
190
                              x in range(2))
134
191
        if fully_present[0] != fully_present[1]:
135
192
            if fully_present[1] is True:
136
 
                delta.added.append((path[1], file_id, kind[1]))
 
193
                delta.added.append((path, file_id, kind[1]))
137
194
            else:
138
 
                delta.removed.append((path[0], file_id, kind[0]))
 
195
                assert fully_present[0] is True
 
196
                old_path = old_tree.id2path(file_id)
 
197
                delta.removed.append((old_path, file_id, kind[0]))
139
198
        elif fully_present[0] is False:
140
199
            continue
141
200
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
142
201
            # If the name changes, or the parent_id changes, we have a rename
143
202
            # (if we move a parent, that doesn't count as a rename for the
144
203
            # file)
145
 
            delta.renamed.append((path[0],
146
 
                                  path[1],
147
 
                                  file_id,
 
204
            old_path = old_tree.id2path(file_id)
 
205
            delta.renamed.append((old_path,
 
206
                                  path,
 
207
                                  file_id, 
148
208
                                  kind[1],
149
 
                                  content_change,
 
209
                                  content_change, 
150
210
                                  (executable[0] != executable[1])))
151
 
        elif kind[0] != kind[1]:
152
 
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
153
 
        elif content_change or executable[0] != executable[1]:
154
 
            delta.modified.append((path[1], file_id, kind[1],
155
 
                                   content_change,
 
211
        elif content_change is True or executable[0] != executable[1]:
 
212
            delta.modified.append((path, file_id, kind[1],
 
213
                                   content_change, 
156
214
                                   (executable[0] != executable[1])))
157
215
        else:
158
 
            delta.unchanged.append((path[1], file_id, kind[1]))
 
216
            delta.unchanged.append((path, file_id, kind[1]))
159
217
 
160
218
    delta.removed.sort()
161
219
    delta.added.sort()
166
224
    delta.unchanged.sort()
167
225
 
168
226
    return delta
169
 
 
170
 
 
171
 
class _ChangeReporter(object):
172
 
    """Report changes between two trees"""
173
 
 
174
 
    def __init__(self, output=None, suppress_root_add=True,
175
 
                 output_file=None, unversioned_filter=None, view_info=None):
176
 
        """Constructor
177
 
 
178
 
        :param output: a function with the signature of trace.note, i.e.
179
 
            accepts a format and parameters.
180
 
        :param supress_root_add: If true, adding the root will be ignored
181
 
            (i.e. when a tree has just been initted)
182
 
        :param output_file: If supplied, a file-like object to write to.
183
 
            Only one of output and output_file may be supplied.
184
 
        :param unversioned_filter: A filter function to be called on
185
 
            unversioned files. This should return True to ignore a path.
186
 
            By default, no filtering takes place.
187
 
        :param view_info: A tuple of view_name,view_files if only
188
 
            items inside a view are to be reported on, or None for
189
 
            no view filtering.
190
 
        """
191
 
        if output_file is not None:
192
 
            if output is not None:
193
 
                raise BzrError('Cannot specify both output and output_file')
194
 
            def output(fmt, *args):
195
 
                output_file.write((fmt % args) + '\n')
196
 
        self.output = output
197
 
        if self.output is None:
198
 
            from bzrlib import trace
199
 
            self.output = trace.note
200
 
        self.suppress_root_add = suppress_root_add
201
 
        self.modified_map = {'kind changed': 'K',
202
 
                             'unchanged': ' ',
203
 
                             'created': 'N',
204
 
                             'modified': 'M',
205
 
                             'deleted': 'D'}
206
 
        self.versioned_map = {'added': '+', # versioned target
207
 
                              'unchanged': ' ', # versioned in both
208
 
                              'removed': '-', # versioned in source
209
 
                              'unversioned': '?', # versioned in neither
210
 
                              }
211
 
        self.unversioned_filter = unversioned_filter
212
 
        if view_info is None:
213
 
            self.view_name = None
214
 
            self.view_files = []
215
 
        else:
216
 
            self.view_name = view_info[0]
217
 
            self.view_files = view_info[1]
218
 
            self.output("Operating on whole tree but only reporting on "
219
 
                        "'%s' view." % (self.view_name,))
220
 
 
221
 
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
222
 
               kind):
223
 
        """Report one change to a file
224
 
 
225
 
        :param file_id: The file_id of the file
226
 
        :param path: The old and new paths as generated by Tree.iter_changes.
227
 
        :param versioned: may be 'added', 'removed', 'unchanged', or
228
 
            'unversioned.
229
 
        :param renamed: may be True or False
230
 
        :param modified: may be 'created', 'deleted', 'kind changed',
231
 
            'modified' or 'unchanged'.
232
 
        :param exe_change: True if the execute bit has changed
233
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
234
 
            None indicates no file present.
235
 
        """
236
 
        if is_quiet():
237
 
            return
238
 
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
239
 
            return
240
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
241
 
            paths[1]):
242
 
            return
243
 
        if versioned == 'unversioned':
244
 
            # skip ignored unversioned files if needed.
245
 
            if self.unversioned_filter is not None:
246
 
                if self.unversioned_filter(paths[1]):
247
 
                    return
248
 
            # dont show a content change in the output.
249
 
            modified = 'unchanged'
250
 
        # we show both paths in the following situations:
251
 
        # the file versioning is unchanged AND
252
 
        # ( the path is different OR
253
 
        #   the kind is different)
254
 
        if (versioned == 'unchanged' and
255
 
            (renamed or modified == 'kind changed')):
256
 
            if renamed:
257
 
                # on a rename, we show old and new
258
 
                old_path, path = paths
259
 
            else:
260
 
                # if it's not renamed, we're showing both for kind changes
261
 
                # so only show the new path
262
 
                old_path, path = paths[1], paths[1]
263
 
            # if the file is not missing in the source, we show its kind
264
 
            # when we show two paths.
265
 
            if kind[0] is not None:
266
 
                old_path += osutils.kind_marker(kind[0])
267
 
            old_path += " => "
268
 
        elif versioned == 'removed':
269
 
            # not present in target
270
 
            old_path = ""
271
 
            path = paths[0]
272
 
        else:
273
 
            old_path = ""
274
 
            path = paths[1]
275
 
        if renamed:
276
 
            rename = "R"
277
 
        else:
278
 
            rename = self.versioned_map[versioned]
279
 
        # we show the old kind on the new path when the content is deleted.
280
 
        if modified == 'deleted':
281
 
            path += osutils.kind_marker(kind[0])
282
 
        # otherwise we always show the current kind when there is one
283
 
        elif kind[1] is not None:
284
 
            path += osutils.kind_marker(kind[1])
285
 
        if exe_change:
286
 
            exe = '*'
287
 
        else:
288
 
            exe = ' '
289
 
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
290
 
                    old_path, path)
291
 
 
292
 
def report_changes(change_iterator, reporter):
293
 
    """Report the changes from a change iterator.
294
 
 
295
 
    This is essentially a translation from low-level to medium-level changes.
296
 
    Further processing may be required to produce a human-readable output.
297
 
    Unfortunately, some tree-changing operations are very complex
298
 
    :change_iterator: an iterator or sequence of changes in the format
299
 
        generated by Tree.iter_changes
300
 
    :param reporter: The _ChangeReporter that will report the changes.
301
 
    """
302
 
    versioned_change_map = {
303
 
        (True, True)  : 'unchanged',
304
 
        (True, False) : 'removed',
305
 
        (False, True) : 'added',
306
 
        (False, False): 'unversioned',
307
 
        }
308
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
309
 
         executable) in change_iterator:
310
 
        exe_change = False
311
 
        # files are "renamed" if they are moved or if name changes, as long
312
 
        # as it had a value
313
 
        if None not in name and None not in parent_id and\
314
 
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
315
 
            renamed = True
316
 
        else:
317
 
            renamed = False
318
 
        if kind[0] != kind[1]:
319
 
            if kind[0] is None:
320
 
                modified = "created"
321
 
            elif kind[1] is None:
322
 
                modified = "deleted"
323
 
            else:
324
 
                modified = "kind changed"
325
 
        else:
326
 
            if content_change:
327
 
                modified = "modified"
328
 
            else:
329
 
                modified = "unchanged"
330
 
            if kind[1] == "file":
331
 
                exe_change = (executable[0] != executable[1])
332
 
        versioned_change = versioned_change_map[versioned]
333
 
        reporter.report(file_id, path, versioned_change, renamed, modified,
334
 
                        exe_change, kind)
335
 
 
336
 
def report_delta(to_file, delta, short_status=False, show_ids=False, 
337
 
         show_unchanged=False, indent='', filter=None):
338
 
    """Output this delta in status-like form to to_file.
339
 
 
340
 
    :param to_file: A file-like object where the output is displayed.
341
 
 
342
 
    :param delta: A TreeDelta containing the changes to be displayed
343
 
 
344
 
    :param short_status: Single-line status if True.
345
 
 
346
 
    :param show_ids: Output the file ids if True.
347
 
 
348
 
    :param show_unchanged: Output the unchanged files if True.
349
 
 
350
 
    :param indent: Added at the beginning of all output lines (for merged
351
 
        revisions).
352
 
 
353
 
    :param filter: A callable receiving a path and a file id and
354
 
        returning True if the path should be displayed.
355
 
    """
356
 
 
357
 
    def decorate_path(path, kind, meta_modified=None):
358
 
        if kind == 'directory':
359
 
            path += '/'
360
 
        elif kind == 'symlink':
361
 
            path += '@'
362
 
        if meta_modified:
363
 
            path += '*'
364
 
        return path
365
 
 
366
 
    def show_more_renamed(item):
367
 
        (oldpath, file_id, kind,
368
 
         text_modified, meta_modified, newpath) = item
369
 
        dec_new_path = decorate_path(newpath, kind, meta_modified)
370
 
        to_file.write(' => %s' % dec_new_path)
371
 
        if text_modified or meta_modified:
372
 
            extra_modified.append((newpath, file_id, kind,
373
 
                                   text_modified, meta_modified))
374
 
 
375
 
    def show_more_kind_changed(item):
376
 
        (path, file_id, old_kind, new_kind) = item
377
 
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
378
 
 
379
 
    def show_path(path, file_id, kind, meta_modified,
380
 
                  default_format, with_file_id_format):
381
 
        dec_path = decorate_path(path, kind, meta_modified)
382
 
        if show_ids:
383
 
            to_file.write(with_file_id_format % dec_path)
384
 
        else:
385
 
            to_file.write(default_format % dec_path)
386
 
 
387
 
    def show_list(files, long_status_name, short_status_letter,
388
 
                  default_format='%s', with_file_id_format='%-30s',
389
 
                  show_more=None):
390
 
        if files:
391
 
            header_shown = False
392
 
            if short_status:
393
 
                prefix = short_status_letter
394
 
            else:
395
 
                prefix = ''
396
 
            prefix = indent + prefix + '  '
397
 
 
398
 
            for item in files:
399
 
                path, file_id, kind = item[:3]
400
 
                if (filter is not None and not filter(path, file_id)):
401
 
                    continue
402
 
                if not header_shown and not short_status:
403
 
                    to_file.write(indent + long_status_name + ':\n')
404
 
                    header_shown = True
405
 
                meta_modified = None
406
 
                if len(item) == 5:
407
 
                    meta_modified = item[4]
408
 
 
409
 
                to_file.write(prefix)
410
 
                show_path(path, file_id, kind, meta_modified,
411
 
                          default_format, with_file_id_format)
412
 
                if show_more is not None:
413
 
                    show_more(item)
414
 
                if show_ids:
415
 
                    to_file.write(' %s' % file_id)
416
 
                to_file.write('\n')
417
 
 
418
 
    show_list(delta.removed, 'removed', 'D')
419
 
    show_list(delta.added, 'added', 'A')
420
 
    extra_modified = []
421
 
    # Reorder delta.renamed tuples so that all lists share the same
422
 
    # order for their 3 first fields and that they also begin like
423
 
    # the delta.modified tuples
424
 
    renamed = [(p, i, k, tm, mm, np)
425
 
               for  p, np, i, k, tm, mm  in delta.renamed]
426
 
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
427
 
              show_more=show_more_renamed)
428
 
    show_list(delta.kind_changed, 'kind changed', 'K',
429
 
              with_file_id_format='%s',
430
 
              show_more=show_more_kind_changed)
431
 
    show_list(delta.modified + extra_modified, 'modified', 'M')
432
 
    if show_unchanged:
433
 
        show_list(delta.unchanged, 'unchanged', 'S')
434
 
 
435
 
    show_list(delta.unversioned, 'unknown', ' ')
436