/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/annotate.py

Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/annotate.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
16
16
 
17
17
"""File annotate based on weave storage"""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
# TODO: Choice of more or less verbose formats:
20
22
#
21
23
# interposed: show more details between blocks of modified lines
28
30
import sys
29
31
import time
30
32
 
31
 
from bzrlib import (
32
 
    errors,
33
 
    osutils,
 
33
from .lazy_import import lazy_import
 
34
lazy_import(globals(), """
 
35
from breezy import (
34
36
    patiencediff,
35
37
    tsort,
36
38
    )
37
 
from bzrlib.config import extract_email_address
38
 
from bzrlib.repository import _strip_NULL_ghosts
39
 
from bzrlib.revision import CURRENT_REVISION, Revision
40
 
 
41
 
 
42
 
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
43
 
                  to_file=None, show_ids=False):
44
 
    """Annotate file_id at revision rev_id in branch.
45
 
 
46
 
    The branch should already be read_locked() when annotate_file is called.
47
 
 
48
 
    :param branch: The branch to look for revision numbers and history from.
49
 
    :param rev_id: The revision id to annotate.
50
 
    :param file_id: The file_id to annotate.
51
 
    :param verbose: Show all details rather than truncating to ensure
52
 
        reasonable text width.
53
 
    :param full: XXXX Not sure what this does.
54
 
    :param to_file: The file to output the annotation to; if None stdout is
55
 
        used.
56
 
    :param show_ids: Show revision ids in the annotation output.
57
 
    """
58
 
    if to_file is None:
59
 
        to_file = sys.stdout
60
 
 
61
 
    # Handle the show_ids case
62
 
    annotations = _annotations(branch.repository, file_id, rev_id)
63
 
    if show_ids:
64
 
        return _show_id_annotations(annotations, to_file, full)
65
 
 
66
 
    # Calculate the lengths of the various columns
67
 
    annotation = list(_expand_annotations(annotations, branch))
68
 
    _print_annotations(annotation, verbose, to_file, full)
69
 
 
70
 
 
71
 
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
72
 
    show_ids=False):
 
39
""")
 
40
from . import (
 
41
    osutils,
 
42
    )
 
43
from .config import (
 
44
    NoEmailInUsername,
 
45
    NoWhoami,
 
46
    extract_email_address,
 
47
    )
 
48
from .repository import _strip_NULL_ghosts
 
49
from .revision import (
 
50
    CURRENT_REVISION,
 
51
    Revision,
 
52
    )
 
53
 
 
54
 
 
55
def annotate_file_tree(tree, path, to_file, verbose=False, full=False,
 
56
                       show_ids=False, branch=None, file_id=None):
73
57
    """Annotate file_id in a tree.
74
58
 
75
59
    The tree should already be read_locked() when annotate_file_tree is called.
76
60
 
77
61
    :param tree: The tree to look for revision numbers and history from.
78
 
    :param file_id: The file_id to annotate.
 
62
    :param path: The path to annotate
79
63
    :param to_file: The file to output the annotation to.
80
64
    :param verbose: Show all details rather than truncating to ensure
81
65
        reasonable text width.
82
66
    :param full: XXXX Not sure what this does.
83
67
    :param show_ids: Show revision ids in the annotation output.
 
68
    :param file_id: The file_id to annotate (must match file path)
 
69
    :param branch: Branch to use for revision revno lookups
84
70
    """
85
 
    rev_id = tree.last_revision()
86
 
    branch = tree.branch
 
71
    if branch is None:
 
72
        branch = tree.branch
 
73
    if to_file is None:
 
74
        to_file = sys.stdout
87
75
 
 
76
    encoding = osutils.get_terminal_encoding()
88
77
    # Handle the show_ids case
89
 
    annotations = list(tree.annotate_iter(file_id))
 
78
    annotations = list(tree.annotate_iter(path, file_id))
90
79
    if show_ids:
91
 
        return _show_id_annotations(annotations, to_file, full)
92
 
 
93
 
    # Create a virtual revision to represent the current tree state.
94
 
    # Should get some more pending commit attributes, like pending tags,
95
 
    # bugfixes etc.
96
 
    current_rev = Revision(CURRENT_REVISION)
97
 
    current_rev.parent_ids = tree.get_parent_ids()
98
 
    current_rev.committer = tree.branch.get_config().username()
99
 
    current_rev.message = "?"
100
 
    current_rev.timestamp = round(time.time(), 3)
101
 
    current_rev.timezone = osutils.local_time_offset()
102
 
    annotation = list(_expand_annotations(annotations, tree.branch,
103
 
        current_rev))
104
 
    _print_annotations(annotation, verbose, to_file, full)
105
 
 
106
 
 
107
 
def _print_annotations(annotation, verbose, to_file, full):
 
80
        return _show_id_annotations(annotations, to_file, full, encoding)
 
81
 
 
82
    if not getattr(tree, "get_revision_id", False):
 
83
        # Create a virtual revision to represent the current tree state.
 
84
        # Should get some more pending commit attributes, like pending tags,
 
85
        # bugfixes etc.
 
86
        current_rev = Revision(CURRENT_REVISION)
 
87
        current_rev.parent_ids = tree.get_parent_ids()
 
88
        try:
 
89
            current_rev.committer = branch.get_config_stack().get('email')
 
90
        except NoWhoami:
 
91
            current_rev.committer = 'local user'
 
92
        current_rev.message = "?"
 
93
        current_rev.timestamp = round(time.time(), 3)
 
94
        current_rev.timezone = osutils.local_time_offset()
 
95
    else:
 
96
        current_rev = None
 
97
    annotation = list(_expand_annotations(
 
98
        annotations, branch, current_rev))
 
99
    _print_annotations(annotation, verbose, to_file, full, encoding)
 
100
 
 
101
 
 
102
def _print_annotations(annotation, verbose, to_file, full, encoding):
108
103
    """Print annotations to to_file.
109
104
 
110
105
    :param to_file: The file to output the annotation to.
113
108
    :param full: XXXX Not sure what this does.
114
109
    """
115
110
    if len(annotation) == 0:
116
 
        max_origin_len = max_revno_len = max_revid_len = 0
 
111
        max_origin_len = max_revno_len = 0
117
112
    else:
118
113
        max_origin_len = max(len(x[1]) for x in annotation)
119
114
        max_revno_len = max(len(x[0]) for x in annotation)
120
 
        max_revid_len = max(len(x[3]) for x in annotation)
121
115
    if not verbose:
122
116
        max_revno_len = min(max_revno_len, 12)
123
117
    max_revno_len = max(max_revno_len, 3)
124
118
 
125
119
    # Output the annotations
126
120
    prevanno = ''
127
 
    encoding = getattr(to_file, 'encoding', None) or \
128
 
            osutils.get_terminal_encoding()
129
121
    for (revno_str, author, date_str, line_rev_id, text) in annotation:
130
122
        if verbose:
131
123
            anno = '%-*s %-*s %8s ' % (max_revno_len, revno_str,
132
124
                                       max_origin_len, author, date_str)
133
125
        else:
134
126
            if len(revno_str) > max_revno_len:
135
 
                revno_str = revno_str[:max_revno_len-1] + '>'
 
127
                revno_str = revno_str[:max_revno_len - 1] + '>'
136
128
            anno = "%-*s %-7s " % (max_revno_len, revno_str, author[:7])
137
129
        if anno.lstrip() == "" and full:
138
130
            anno = prevanno
139
 
        try:
140
 
            to_file.write(anno)
141
 
        except UnicodeEncodeError:
142
 
            # cmd_annotate should be passing in an 'exact' object, which means
143
 
            # we have a direct handle to sys.stdout or equivalent. It may not
144
 
            # be able to handle the exact Unicode characters, but 'annotate' is
145
 
            # a user function (non-scripting), so shouldn't die because of
146
 
            # unrepresentable annotation characters. So encode using 'replace',
147
 
            # and write them again.
148
 
            to_file.write(anno.encode(encoding, 'replace'))
149
 
        to_file.write('| %s\n' % (text,))
 
131
        # GZ 2017-05-21: Writing both unicode annotation and bytes from file
 
132
        # which the given to_file must cope with.
 
133
        to_file.write(anno)
 
134
        to_file.write('| %s\n' % (text.decode(encoding),))
150
135
        prevanno = anno
151
136
 
152
137
 
153
 
def _show_id_annotations(annotations, to_file, full):
 
138
def _show_id_annotations(annotations, to_file, full, encoding):
154
139
    if not annotations:
155
140
        return
156
141
    last_rev_id = None
159
144
        if full or last_rev_id != origin:
160
145
            this = origin
161
146
        else:
162
 
            this = ''
163
 
        to_file.write('%*s | %s' % (max_origin_len, this, text))
 
147
            this = b''
 
148
        to_file.write('%*s | %s' % (
 
149
            max_origin_len, this.decode('utf-8'), text.decode(encoding)))
164
150
        last_rev_id = origin
165
151
    return
166
152
 
167
153
 
168
 
def _annotations(repo, file_id, rev_id):
169
 
    """Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
170
 
    annotations = repo.texts.annotate((file_id, rev_id))
171
 
    #
172
 
    return [(key[-1], line) for (key, line) in annotations]
173
 
 
174
 
 
175
154
def _expand_annotations(annotations, branch, current_rev=None):
176
155
    """Expand a file's annotations into command line UI ready tuples.
177
156
 
183
162
    :param branch: A locked branch to query for revision details.
184
163
    """
185
164
    repository = branch.repository
 
165
    revision_ids = set(o for o, t in annotations)
186
166
    if current_rev is not None:
187
 
        # This can probably become a function on MutableTree, get_revno_map there,
188
 
        # or something.
 
167
        # This can probably become a function on MutableTree, get_revno_map
 
168
        # there, or something.
189
169
        last_revision = current_rev.revision_id
190
170
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
191
171
        # XXX: The main difficulty is that we need to inject a single new node
193
173
        #      Once KnownGraph gets an 'add_node()' function, we can use
194
174
        #      VF.get_known_graph_ancestry().
195
175
        graph = repository.get_graph()
196
 
        revision_graph = dict(((key, value) for key, value in
197
 
            graph.iter_ancestry(current_rev.parent_ids) if value is not None))
 
176
        revision_graph = {
 
177
            key: value for key, value in
 
178
            graph.iter_ancestry(current_rev.parent_ids) if value is not None}
198
179
        revision_graph = _strip_NULL_ghosts(revision_graph)
199
180
        revision_graph[last_revision] = current_rev.parent_ids
200
181
        merge_sorted_revisions = tsort.merge_sort(
202
183
            last_revision,
203
184
            None,
204
185
            generate_revno=True)
205
 
        revision_id_to_revno = dict((rev_id, revno)
 
186
        revision_id_to_revno = {
 
187
            rev_id: revno
206
188
            for seq_num, rev_id, depth, revno, end_of_merge in
207
 
                merge_sorted_revisions)
 
189
            merge_sorted_revisions}
208
190
    else:
 
191
        # TODO(jelmer): Only look up the revision ids that we need (i.e. those
 
192
        # in revision_ids). Possibly add a HPSS call that can look those up
 
193
        # in bulk over HPSS.
209
194
        revision_id_to_revno = branch.get_revision_id_to_revno_map()
210
195
    last_origin = None
211
 
    revision_ids = set(o for o, t in annotations)
212
196
    revisions = {}
213
197
    if CURRENT_REVISION in revision_ids:
214
198
        revision_id_to_revno[CURRENT_REVISION] = (
215
199
            "%d?" % (branch.revno() + 1),)
216
200
        revisions[CURRENT_REVISION] = current_rev
217
 
    revision_ids = [o for o in revision_ids if
218
 
                    repository.has_revision(o)]
219
 
    revisions.update((r.revision_id, r) for r in
220
 
                     repository.get_revisions(revision_ids))
 
201
    revisions.update(
 
202
        entry for entry in
 
203
        repository.iter_revisions(revision_ids)
 
204
        if entry[1] is not None)
221
205
    for origin, text in annotations:
222
 
        text = text.rstrip('\r\n')
 
206
        text = text.rstrip(b'\r\n')
223
207
        if origin == last_origin:
224
 
            (revno_str, author, date_str) = ('','','')
 
208
            (revno_str, author, date_str) = ('', '', '')
225
209
        else:
226
210
            last_origin = origin
227
211
            if origin not in revisions:
228
 
                (revno_str, author, date_str) = ('?','?','?')
 
212
                (revno_str, author, date_str) = ('?', '?', '?')
229
213
            else:
230
 
                revno_str = '.'.join(str(i) for i in
231
 
                                            revision_id_to_revno[origin])
 
214
                revno_str = '.'.join(
 
215
                    str(i) for i in revision_id_to_revno[origin])
232
216
            rev = revisions[origin]
233
217
            tz = rev.timezone or 0
234
218
            date_str = time.strftime('%Y%m%d',
238
222
            author = rev.get_apparent_authors()[0]
239
223
            try:
240
224
                author = extract_email_address(author)
241
 
            except errors.NoEmailInUsername:
 
225
            except NoEmailInUsername:
242
226
                pass        # use the whole name
243
227
        yield (revno_str, author, date_str, origin, text)
244
228
 
299
283
    new_cur = 0
300
284
    if matching_blocks is None:
301
285
        plain_parent_lines = [l for r, l in parent_lines]
302
 
        matcher = patiencediff.PatienceSequenceMatcher(None,
303
 
            plain_parent_lines, new_lines)
 
286
        matcher = patiencediff.PatienceSequenceMatcher(
 
287
            None, plain_parent_lines, new_lines)
304
288
        matching_blocks = matcher.get_matching_blocks()
305
289
    lines = []
306
290
    for i, j, n in matching_blocks:
307
291
        for line in new_lines[new_cur:j]:
308
292
            lines.append((new_revision_id, line))
309
 
        lines.extend(parent_lines[i:i+n])
 
293
        lines.extend(parent_lines[i:i + n])
310
294
        new_cur = j + n
311
295
    return lines
312
296
 
313
297
 
314
298
def _get_matching_blocks(old, new):
315
 
    matcher = patiencediff.PatienceSequenceMatcher(None,
316
 
        old, new)
 
299
    matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
317
300
    return matcher.get_matching_blocks()
318
301
 
319
302
 
320
303
_break_annotation_tie = None
321
304
 
 
305
 
322
306
def _old_break_annotation_tie(annotated_lines):
323
307
    """Chose an attribution between several possible ones.
324
308
 
366
350
    output_extend = output_lines.extend
367
351
    output_append = output_lines.append
368
352
    # We need to see if any of the unannotated lines match
369
 
    plain_right_subset = [l for a,l in right_lines[start_right:end_right]]
 
353
    plain_right_subset = [l for a, l in right_lines[start_right:end_right]]
370
354
    plain_child_subset = plain_child_lines[start_child:end_child]
371
355
    match_blocks = _get_matching_blocks(plain_right_subset, plain_child_subset)
372
356
 
375
359
    for right_idx, child_idx, match_len in match_blocks:
376
360
        # All the lines that don't match are just passed along
377
361
        if child_idx > last_child_idx:
378
 
            output_extend(child_lines[start_child + last_child_idx
379
 
                                      :start_child + child_idx])
380
 
        for offset in xrange(match_len):
381
 
            left = child_lines[start_child+child_idx+offset]
382
 
            right = right_lines[start_right+right_idx+offset]
 
362
            output_extend(child_lines[start_child + last_child_idx:
 
363
                                      start_child + child_idx])
 
364
        for offset in range(match_len):
 
365
            left = child_lines[start_child + child_idx + offset]
 
366
            right = right_lines[start_right + right_idx + offset]
383
367
            if left[0] == right[0]:
384
368
                # The annotations match, just return the left one
385
369
                output_append(left)
394
378
                else:
395
379
                    heads = heads_provider.heads((left[0], right[0]))
396
380
                    if len(heads) == 1:
397
 
                        output_append((iter(heads).next(), left[1]))
 
381
                        output_append((next(iter(heads)), left[1]))
398
382
                    else:
399
383
                        # Both claim different origins, get a stable result.
400
384
                        # If the result is not stable, there is a risk a
429
413
    # be the bulk of the lines, and they will need no further processing.
430
414
    lines = []
431
415
    lines_extend = lines.extend
432
 
    last_right_idx = 0 # The line just after the last match from the right side
 
416
    # The line just after the last match from the right side
 
417
    last_right_idx = 0
433
418
    last_left_idx = 0
434
419
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
435
420
                                                   annotated_lines)
457
442
 
458
443
 
459
444
try:
460
 
    from bzrlib._annotator_pyx import Annotator
461
 
except ImportError, e:
 
445
    from breezy._annotator_pyx import Annotator
 
446
except ImportError as e:
462
447
    osutils.failed_to_load_extension(e)
463
 
    from bzrlib._annotator_py import Annotator
 
448
    from breezy._annotator_py import Annotator  # noqa: F401