/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 breezy/delta.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-16 18:26:22 UTC
  • mfrom: (7167.1.4 run-flake8)
  • Revision ID: breezy.the.bot@gmail.com-20181116182622-qw3gan3hz78a2imw
Add a flake8 test.

Merged from https://code.launchpad.net/~jelmer/brz/run-flake8/+merge/358902

Show diffs side-by-side

added added

removed removed

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