← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Robert Collins
  • Date: 2005-09-27 06:15:35 UTC
  • mto: (1092.3.4)
  • mto: This revision was merged to the branch mainline in revision 1391.
  • Revision ID: robertc@robertcollins.net-20050927061535-6321f7191439d108
print test case exceptions after the test log

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# -*- coding: UTF-8 -*-
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
from bzrlib import (
18
 
    errors,
19
 
    osutils,
20
 
    )
21
 
from bzrlib.inventory import InventoryEntry
22
17
from bzrlib.trace import mutter
23
 
from bzrlib.symbol_versioning import deprecated_function, zero_nine
24
 
 
25
18
 
26
19
class TreeDelta(object):
27
20
    """Describes changes from one tree to another.
33
26
    removed
34
27
        (path, id, kind)
35
28
    renamed
36
 
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
29
        (oldpath, newpath, id, kind, text_modified)
37
30
    modified
38
 
        (path, id, kind, text_modified, meta_modified)
 
31
        (path, id, kind)
39
32
    unchanged
40
33
        (path, id, kind)
41
 
    unversioned
42
 
        (path, kind)
43
34
 
44
35
    Each id is listed only once.
45
36
 
46
37
    Files that are both modified and renamed are listed only in
47
 
    renamed, with the text_modified flag true. The text_modified
48
 
    applies either to the the content of the file or the target of the
49
 
    symbolic link, depending of the kind of file.
 
38
    renamed, with the text_modified flag true.
50
39
 
51
40
    Files are only considered renamed if their name has changed or
52
41
    their parent directory has changed.  Renaming a directory
58
47
        self.added = []
59
48
        self.removed = []
60
49
        self.renamed = []
61
 
        self.kind_changed = []
62
50
        self.modified = []
63
51
        self.unchanged = []
64
 
        self.unversioned = []
65
52
 
66
53
    def __eq__(self, other):
67
54
        if not isinstance(other, TreeDelta):
70
57
               and self.removed == other.removed \
71
58
               and self.renamed == other.renamed \
72
59
               and self.modified == other.modified \
73
 
               and self.unchanged == other.unchanged \
74
 
               and self.kind_changed == other.kind_changed \
75
 
               and self.unversioned == other.unversioned
 
60
               and self.unchanged == other.unchanged
76
61
 
77
62
    def __ne__(self, other):
78
63
        return not (self == other)
79
64
 
80
65
    def __repr__(self):
81
 
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
82
 
            " kind_changed=%r, modified=%r, unchanged=%r," \
83
 
            " unversioned=%r)" % (self.added,
84
 
            self.removed, self.renamed, self.kind_changed, self.modified,
85
 
            self.unchanged, self.unversioned)
 
66
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
67
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
68
            self.modified, self.unchanged)
86
69
 
87
70
    def has_changed(self):
88
 
        return bool(self.modified
89
 
                    or self.added
90
 
                    or self.removed
91
 
                    or self.renamed
92
 
                    or self.kind_changed)
 
71
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
72
        changes += len(self.modified) 
 
73
        return (changes != 0)
93
74
 
94
75
    def touches_file_id(self, file_id):
95
76
        """Return True if file_id is modified by this delta."""
100
81
        for v in self.renamed:
101
82
            if v[2] == file_id:
102
83
                return True
103
 
        for v in self.kind_changed:
104
 
            if v[1] == file_id:
105
 
                return True
106
84
        return False
107
85
            
108
86
 
109
 
    def show(self, to_file, show_ids=False, show_unchanged=False,
110
 
             short_status=False):
111
 
        """output this delta in status-like form to to_file."""
112
 
        def show_list(files, short_status_letter=''):
113
 
            for item in files:
114
 
                path, fid, kind = item[:3]
115
 
 
 
87
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
88
        def show_list(files):
 
89
            for path, fid, kind in files:
116
90
                if kind == 'directory':
117
91
                    path += '/'
118
92
                elif kind == 'symlink':
119
93
                    path += '@'
120
 
 
121
 
                if len(item) == 5 and item[4]:
122
 
                    path += '*'
123
 
 
 
94
                    
124
95
                if show_ids:
125
 
                    print >>to_file, '%s  %-30s %s' % (short_status_letter,
126
 
                        path, fid)
 
96
                    print >>to_file, '  %-30s %s' % (path, fid)
127
97
                else:
128
 
                    print >>to_file, '%s  %s' % (short_status_letter, path)
 
98
                    print >>to_file, ' ', path
129
99
            
130
100
        if self.removed:
131
 
            if not short_status:
132
 
                print >>to_file, 'removed:'
133
 
                show_list(self.removed)
134
 
            else:
135
 
                show_list(self.removed, 'D')
 
101
            print >>to_file, 'removed:'
 
102
            show_list(self.removed)
136
103
                
137
104
        if self.added:
138
 
            if not short_status:
139
 
                print >>to_file, 'added:'
140
 
                show_list(self.added)
141
 
            else:
142
 
                show_list(self.added, 'A')
143
 
 
144
 
        extra_modified = []
 
105
            print >>to_file, 'added:'
 
106
            show_list(self.added)
145
107
 
146
108
        if self.renamed:
147
 
            short_status_letter = 'R'
148
 
            if not short_status:
149
 
                print >>to_file, 'renamed:'
150
 
                short_status_letter = ''
151
 
            for (oldpath, newpath, fid, kind,
152
 
                 text_modified, meta_modified) in self.renamed:
153
 
                if text_modified or meta_modified:
154
 
                    extra_modified.append((newpath, fid, kind,
155
 
                                           text_modified, meta_modified))
156
 
                if meta_modified:
157
 
                    newpath += '*'
158
 
                if show_ids:
159
 
                    print >>to_file, '%s  %s => %s %s' % (
160
 
                        short_status_letter, oldpath, newpath, fid)
161
 
                else:
162
 
                    print >>to_file, '%s  %s => %s' % (
163
 
                        short_status_letter, oldpath, newpath)
164
 
 
165
 
        if self.kind_changed:
166
 
            if short_status:
167
 
                short_status_letter = 'K'
168
 
            else:
169
 
                print >>to_file, 'kind changed:'
170
 
                short_status_letter = ''
171
 
            for (path, fid, old_kind, new_kind) in self.kind_changed:
172
 
                if show_ids:
173
 
                    suffix = ' '+fid
174
 
                else:
175
 
                    suffix = ''
176
 
                print >>to_file, '%s  %s (%s => %s)%s' % (
177
 
                    short_status_letter, path, old_kind, new_kind, suffix)
178
 
 
179
 
        if self.modified or extra_modified:
180
 
            short_status_letter = 'M'
181
 
            if not short_status:
182
 
                print >>to_file, 'modified:'
183
 
                short_status_letter = ''
184
 
            show_list(self.modified, short_status_letter)
185
 
            show_list(extra_modified, short_status_letter)
 
109
            print >>to_file, 'renamed:'
 
110
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
111
                if show_ids:
 
112
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
113
                else:
 
114
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
115
                    
 
116
        if self.modified:
 
117
            print >>to_file, 'modified:'
 
118
            show_list(self.modified)
186
119
            
187
120
        if show_unchanged and self.unchanged:
188
 
            if not short_status:
189
 
                print >>to_file, 'unchanged:'
190
 
                show_list(self.unchanged)
191
 
            else:
192
 
                show_list(self.unchanged, 'S')
193
 
 
194
 
        if self.unversioned:
195
 
            print >>to_file, 'unknown:'
196
 
            show_list(self.unversioned)
197
 
 
198
 
 
199
 
@deprecated_function(zero_nine)
200
 
def compare_trees(old_tree, new_tree, want_unchanged=False,
201
 
                  specific_files=None, extra_trees=None,
202
 
                  require_versioned=False):
203
 
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
204
 
    return new_tree.changes_from(old_tree,
205
 
        want_unchanged=want_unchanged,
206
 
        specific_files=specific_files,
207
 
        extra_trees=extra_trees,
208
 
        require_versioned=require_versioned,
209
 
        include_root=False)
210
 
 
211
 
 
212
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
213
 
                   include_root, extra_trees=None,
214
 
                   want_unversioned=False):
215
 
    """Worker function that implements Tree.changes_from."""
 
121
            print >>to_file, 'unchanged:'
 
122
            show_list(self.unchanged)
 
123
 
 
124
 
 
125
 
 
126
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
127
    """Describe changes from one tree to another.
 
128
 
 
129
    Returns a TreeDelta with details of added, modified, renamed, and
 
130
    deleted entries.
 
131
 
 
132
    The root entry is specifically exempt.
 
133
 
 
134
    This only considers versioned files.
 
135
 
 
136
    want_unchanged
 
137
        If true, also list files unchanged from one version to
 
138
        the next.
 
139
 
 
140
    specific_files
 
141
        If true, only check for changes to specified names or
 
142
        files within them.
 
143
    """
 
144
 
 
145
    from osutils import is_inside_any
 
146
    
 
147
    old_inv = old_tree.inventory
 
148
    new_inv = new_tree.inventory
216
149
    delta = TreeDelta()
217
 
    # mutter('start compare_trees')
218
 
 
219
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
220
 
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
221
 
            specific_files, extra_trees=extra_trees,
222
 
            want_unversioned=want_unversioned):
223
 
        if versioned == (False, False):
224
 
            delta.unversioned.append((path[1], None, kind[1]))
225
 
            continue
226
 
        if not include_root and (None, None) == parent_id:
227
 
            continue
228
 
        fully_present = tuple((versioned[x] and kind[x] is not None) for
229
 
                              x in range(2))
230
 
        if fully_present[0] != fully_present[1]:
231
 
            if fully_present[1] is True:
232
 
                delta.added.append((path[1], file_id, kind[1]))
 
150
    mutter('start compare_trees')
 
151
 
 
152
    # TODO: match for specific files can be rather smarter by finding
 
153
    # the IDs of those files up front and then considering only that.
 
154
 
 
155
    for file_id in old_tree:
 
156
        if file_id in new_tree:
 
157
            old_ie = old_inv[file_id]
 
158
            new_ie = new_inv[file_id]
 
159
 
 
160
            kind = old_ie.kind
 
161
            assert kind == new_ie.kind
 
162
            
 
163
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
164
                   'invalid file kind %r' % kind
 
165
 
 
166
            if kind == 'root_directory':
 
167
                continue
 
168
            
 
169
            if specific_files:
 
170
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
171
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
172
                    continue
 
173
 
 
174
            if kind == 'file':
 
175
                old_sha1 = old_tree.get_file_sha1(file_id)
 
176
                new_sha1 = new_tree.get_file_sha1(file_id)
 
177
                text_modified = (old_sha1 != new_sha1)
233
178
            else:
234
 
                assert fully_present[0] is True
235
 
                delta.removed.append((path[0], file_id, kind[0]))
236
 
        elif fully_present[0] is False:
237
 
            continue
238
 
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
239
 
            # If the name changes, or the parent_id changes, we have a rename
240
 
            # (if we move a parent, that doesn't count as a rename for the
241
 
            # file)
242
 
            delta.renamed.append((path[0],
243
 
                                  path[1],
244
 
                                  file_id,
245
 
                                  kind[1],
246
 
                                  content_change,
247
 
                                  (executable[0] != executable[1])))
248
 
        elif kind[0] != kind[1]:
249
 
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
250
 
        elif content_change is True or executable[0] != executable[1]:
251
 
            delta.modified.append((path[1], file_id, kind[1],
252
 
                                   content_change,
253
 
                                   (executable[0] != executable[1])))
 
179
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
180
                text_modified = False
 
181
 
 
182
            # TODO: Can possibly avoid calculating path strings if the
 
183
            # two files are unchanged and their names and parents are
 
184
            # the same and the parents are unchanged all the way up.
 
185
            # May not be worthwhile.
 
186
            
 
187
            if (old_ie.name != new_ie.name
 
188
                or old_ie.parent_id != new_ie.parent_id):
 
189
                delta.renamed.append((old_inv.id2path(file_id),
 
190
                                      new_inv.id2path(file_id),
 
191
                                      file_id, kind,
 
192
                                      text_modified))
 
193
            elif text_modified:
 
194
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
 
195
            elif want_unchanged:
 
196
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
254
197
        else:
255
 
            delta.unchanged.append((path[1], file_id, kind[1]))
 
198
            kind = old_inv.get_file_kind(file_id)
 
199
            if kind == 'root_directory':
 
200
                continue
 
201
            old_path = old_inv.id2path(file_id)
 
202
            if specific_files:
 
203
                if not is_inside_any(specific_files, old_path):
 
204
                    continue
 
205
            delta.removed.append((old_path, file_id, kind))
256
206
 
 
207
    mutter('start looking for new files')
 
208
    for file_id in new_inv:
 
209
        if file_id in old_inv:
 
210
            continue
 
211
        kind = new_inv.get_file_kind(file_id)
 
212
        if kind == 'root_directory':
 
213
            continue
 
214
        new_path = new_inv.id2path(file_id)
 
215
        if specific_files:
 
216
            if not is_inside_any(specific_files, new_path):
 
217
                continue
 
218
        delta.added.append((new_path, file_id, kind))
 
219
            
257
220
    delta.removed.sort()
258
221
    delta.added.sort()
259
222
    delta.renamed.sort()
260
 
    # TODO: jam 20060529 These lists shouldn't need to be sorted
261
 
    #       since we added them in alphabetical order.
262
223
    delta.modified.sort()
263
224
    delta.unchanged.sort()
264
225
 
265
226
    return delta
266
 
 
267
 
 
268
 
class _ChangeReporter(object):
269
 
    """Report changes between two trees"""
270
 
 
271
 
    def __init__(self, output=None, suppress_root_add=True,
272
 
                 output_file=None, unversioned_filter=None):
273
 
        """Constructor
274
 
 
275
 
        :param output: a function with the signature of trace.note, i.e.
276
 
            accepts a format and parameters.
277
 
        :param supress_root_add: If true, adding the root will be ignored
278
 
            (i.e. when a tree has just been initted)
279
 
        :param output_file: If supplied, a file-like object to write to.
280
 
            Only one of output and output_file may be supplied.
281
 
        :param unversioned_filter: A filter function to be called on 
282
 
            unversioned files. This should return True to ignore a path.
283
 
            By default, no filtering takes place.
284
 
        """
285
 
        if output_file is not None:
286
 
            if output is not None:
287
 
                raise BzrError('Cannot specify both output and output_file')
288
 
            def output(fmt, *args):
289
 
                output_file.write((fmt % args) + '\n')
290
 
        self.output = output
291
 
        if self.output is None:
292
 
            from bzrlib import trace
293
 
            self.output = trace.note
294
 
        self.suppress_root_add = suppress_root_add
295
 
        self.modified_map = {'kind changed': 'K',
296
 
                             'unchanged': ' ',
297
 
                             'created': 'N',
298
 
                             'modified': 'M',
299
 
                             'deleted': 'D'}
300
 
        self.versioned_map = {'added': '+', # versioned target
301
 
                              'unchanged': ' ', # versioned in both
302
 
                              'removed': '-', # versioned in source
303
 
                              'unversioned': '?', # versioned in neither
304
 
                              }
305
 
        self.unversioned_filter = unversioned_filter
306
 
 
307
 
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
308
 
               kind):
309
 
        """Report one change to a file
310
 
 
311
 
        :param file_id: The file_id of the file
312
 
        :param path: The old and new paths as generated by Tree._iter_changes.
313
 
        :param versioned: may be 'added', 'removed', 'unchanged', or
314
 
            'unversioned.
315
 
        :param renamed: may be True or False
316
 
        :param modified: may be 'created', 'deleted', 'kind changed',
317
 
            'modified' or 'unchanged'.
318
 
        :param exe_change: True if the execute bit has changed
319
 
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
320
 
            None indicates no file present.
321
 
        """
322
 
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
323
 
            return
324
 
        if versioned == 'unversioned':
325
 
            # skip ignored unversioned files if needed.
326
 
            if self.unversioned_filter is not None:
327
 
                if self.unversioned_filter(paths[1]):
328
 
                    return
329
 
            # dont show a content change in the output.
330
 
            modified = 'unchanged'
331
 
        # we show both paths in the following situations:
332
 
        # the file versioning is unchanged AND
333
 
        # ( the path is different OR
334
 
        #   the kind is different)
335
 
        if (versioned == 'unchanged' and
336
 
            (renamed or modified == 'kind changed')):
337
 
            if renamed:
338
 
                # on a rename, we show old and new
339
 
                old_path, path = paths
340
 
            else:
341
 
                # if its not renamed, we're showing both for kind changes
342
 
                # so only show the new path
343
 
                old_path, path = paths[1], paths[1]
344
 
            # if the file is not missing in the source, we show its kind
345
 
            # when we show two paths.
346
 
            if kind[0] is not None:
347
 
                old_path += osutils.kind_marker(kind[0])
348
 
            old_path += " => "
349
 
        elif versioned == 'removed':
350
 
            # not present in target
351
 
            old_path = ""
352
 
            path = paths[0]
353
 
        else:
354
 
            old_path = ""
355
 
            path = paths[1]
356
 
        if renamed:
357
 
            rename = "R"
358
 
        else:
359
 
            rename = self.versioned_map[versioned]
360
 
        # we show the old kind on the new path when the content is deleted.
361
 
        if modified == 'deleted':
362
 
            path += osutils.kind_marker(kind[0])
363
 
        # otherwise we always show the current kind when there is one
364
 
        elif kind[1] is not None:
365
 
            path += osutils.kind_marker(kind[1])
366
 
        if exe_change:
367
 
            exe = '*'
368
 
        else:
369
 
            exe = ' '
370
 
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
371
 
                    old_path, path)
372
 
 
373
 
 
374
 
def report_changes(change_iterator, reporter):
375
 
    """Report the changes from a change iterator.
376
 
 
377
 
    This is essentially a translation from low-level to medium-level changes.
378
 
    Further processing may be required to produce a human-readable output.
379
 
    Unfortunately, some tree-changing operations are very complex
380
 
    :change_iterator: an iterator or sequence of changes in the format
381
 
        generated by Tree._iter_changes
382
 
    :param reporter: The _ChangeReporter that will report the changes.
383
 
    """
384
 
    versioned_change_map = {
385
 
        (True, True)  : 'unchanged',
386
 
        (True, False) : 'removed',
387
 
        (False, True) : 'added',
388
 
        (False, False): 'unversioned',
389
 
        }
390
 
    for (file_id, path, content_change, versioned, parent_id, name, kind,
391
 
         executable) in change_iterator:
392
 
        exe_change = False
393
 
        # files are "renamed" if they are moved or if name changes, as long
394
 
        # as it had a value
395
 
        if None not in name and None not in parent_id and\
396
 
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
397
 
            renamed = True
398
 
        else:
399
 
            renamed = False
400
 
        if kind[0] != kind[1]:
401
 
            if kind[0] is None:
402
 
                modified = "created"
403
 
            elif kind[1] is None:
404
 
                modified = "deleted"
405
 
            else:
406
 
                modified = "kind changed"
407
 
        else:
408
 
            if content_change:
409
 
                modified = "modified"
410
 
            else:
411
 
                modified = "unchanged"
412
 
            if kind[1] == "file":
413
 
                exe_change = (executable[0] != executable[1])
414
 
        versioned_change = versioned_change_map[versioned]
415
 
        reporter.report(file_id, path, versioned_change, renamed, modified,
416
 
                        exe_change, kind)