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

  • Committer: Robert Collins
  • Date: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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