~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

  • Committer: Ian Clatworthy
  • Date: 2008-03-27 07:51:10 UTC
  • mto: (3311.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3312.
  • Revision ID: ian.clatworthy@canonical.com-20080327075110-afgd7x03ybju06ez
Reduce evangelism in the User Guide

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007 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
17
"""File annotate based on weave storage"""
18
18
 
19
19
# TODO: Choice of more or less verbose formats:
20
 
#
 
20
21
21
# interposed: show more details between blocks of modified lines
22
22
 
23
23
# TODO: Show which revision caused a line to merge into the parent
24
24
 
25
25
# TODO: perhaps abbreviate timescales depending on how recent they are
26
 
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.
 
26
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.  
27
27
 
28
28
import sys
29
29
import time
35
35
    tsort,
36
36
    )
37
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
38
 
41
39
 
42
40
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
59
57
        to_file = sys.stdout
60
58
 
61
59
    # Handle the show_ids case
62
 
    annotations = _annotations(branch.repository, file_id, rev_id)
 
60
    last_rev_id = None
63
61
    if show_ids:
64
 
        return _show_id_annotations(annotations, to_file, full)
 
62
        annotations = _annotations(branch.repository, file_id, rev_id)
 
63
        max_origin_len = max(len(origin) for origin, text in annotations)
 
64
        for origin, text in annotations:
 
65
            if full or last_rev_id != origin:
 
66
                this = origin
 
67
            else:
 
68
                this = ''
 
69
            to_file.write('%*s | %s' % (max_origin_len, this, text))
 
70
            last_rev_id = origin
 
71
        return
65
72
 
66
73
    # 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.
74
 
 
75
 
    The tree should already be read_locked() when annotate_file_tree is called.
76
 
 
77
 
    :param tree: The tree to look for revision numbers and history from.
78
 
    :param file_id: The file_id to annotate.
79
 
    :param to_file: The file to output the annotation to.
80
 
    :param verbose: Show all details rather than truncating to ensure
81
 
        reasonable text width.
82
 
    :param full: XXXX Not sure what this does.
83
 
    :param show_ids: Show revision ids in the annotation output.
84
 
    """
85
 
    rev_id = tree.last_revision()
86
 
    branch = tree.branch
87
 
 
88
 
    # Handle the show_ids case
89
 
    annotations = list(tree.annotate_iter(file_id))
90
 
    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):
108
 
    """Print annotations to to_file.
109
 
 
110
 
    :param to_file: The file to output the annotation to.
111
 
    :param verbose: Show all details rather than truncating to ensure
112
 
        reasonable text width.
113
 
    :param full: XXXX Not sure what this does.
114
 
    """
 
74
    annotation = list(_annotate_file(branch, rev_id, file_id))
115
75
    if len(annotation) == 0:
116
76
        max_origin_len = max_revno_len = max_revid_len = 0
117
77
    else:
150
110
        prevanno = anno
151
111
 
152
112
 
153
 
def _show_id_annotations(annotations, to_file, full):
154
 
    if not annotations:
155
 
        return
156
 
    last_rev_id = None
157
 
    max_origin_len = max(len(origin) for origin, text in annotations)
158
 
    for origin, text in annotations:
159
 
        if full or last_rev_id != origin:
160
 
            this = origin
161
 
        else:
162
 
            this = ''
163
 
        to_file.write('%*s | %s' % (max_origin_len, this, text))
164
 
        last_rev_id = origin
165
 
    return
166
 
 
167
 
 
168
113
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
 
def _expand_annotations(annotations, branch, current_rev=None):
176
 
    """Expand a file's annotations into command line UI ready tuples.
177
 
 
178
 
    Each tuple includes detailed information, such as the author name, and date
179
 
    string for the commit, rather than just the revision id.
180
 
 
181
 
    :param annotations: The annotations to expand.
182
 
    :param revision_id_to_revno: A map from id to revision numbers.
183
 
    :param branch: A locked branch to query for revision details.
 
114
    """Return the list of (origin,text) for a revision of a file in a repository."""
 
115
    w = repo.weave_store.get_weave(file_id, repo.get_transaction())
 
116
    return list(w.annotate_iter(rev_id))
 
117
 
 
118
 
 
119
def _annotate_file(branch, rev_id, file_id):
 
120
    """Yield the origins for each line of a file.
 
121
 
 
122
    This includes detailed information, such as the author name, and
 
123
    date string for the commit, rather than just the revision id.
184
124
    """
185
 
    repository = branch.repository
186
 
    if current_rev is not None:
187
 
        # This can probably become a function on MutableTree, get_revno_map there,
188
 
        # or something.
189
 
        last_revision = current_rev.revision_id
190
 
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
191
 
        # XXX: The main difficulty is that we need to inject a single new node
192
 
        #      (current_rev) into the graph before it gets numbered, etc.
193
 
        #      Once KnownGraph gets an 'add_node()' function, we can use
194
 
        #      VF.get_known_graph_ancestry().
195
 
        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))
198
 
        revision_graph = _strip_NULL_ghosts(revision_graph)
199
 
        revision_graph[last_revision] = current_rev.parent_ids
200
 
        merge_sorted_revisions = tsort.merge_sort(
201
 
            revision_graph,
202
 
            last_revision,
203
 
            None,
204
 
            generate_revno=True)
205
 
        revision_id_to_revno = dict((rev_id, revno)
206
 
            for seq_num, rev_id, depth, revno, end_of_merge in
207
 
                merge_sorted_revisions)
208
 
    else:
209
 
        revision_id_to_revno = branch.get_revision_id_to_revno_map()
 
125
    revision_id_to_revno = branch.get_revision_id_to_revno_map()
 
126
    annotations = _annotations(branch.repository, file_id, rev_id)
210
127
    last_origin = None
211
128
    revision_ids = set(o for o, t in annotations)
212
 
    revisions = {}
213
 
    if CURRENT_REVISION in revision_ids:
214
 
        revision_id_to_revno[CURRENT_REVISION] = (
215
 
            "%d?" % (branch.revno() + 1),)
216
 
        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))
 
129
    revision_ids = [o for o in revision_ids if 
 
130
                    branch.repository.has_revision(o)]
 
131
    revisions = dict((r.revision_id, r) for r in 
 
132
                     branch.repository.get_revisions(revision_ids))
221
133
    for origin, text in annotations:
222
134
        text = text.rstrip('\r\n')
223
135
        if origin == last_origin:
235
147
                                     time.gmtime(rev.timestamp + tz))
236
148
            # a lazy way to get something like the email address
237
149
            # TODO: Get real email address
238
 
            author = rev.get_apparent_authors()[0]
 
150
            author = rev.get_apparent_author()
239
151
            try:
240
152
                author = extract_email_address(author)
241
153
            except errors.NoEmailInUsername:
247
159
               _left_matching_blocks=None,
248
160
               heads_provider=None):
249
161
    """Create a new annotated version from new lines and parent annotations.
250
 
 
 
162
    
251
163
    :param parents_lines: List of annotated lines for all parents
252
164
    :param new_lines: The un-annotated new lines
253
165
    :param new_revision_id: The revision-id to associate with new lines
256
168
        between the text and its left-hand-parent.  The format is
257
169
        the SequenceMatcher.get_matching_blocks format
258
170
        (start_left, start_right, length_of_match).
259
 
    :param heads_provider: An object which provides a .heads() call to resolve
 
171
    :param heads_provider: An object which provids a .heads() call to resolve
260
172
        if any revision ids are children of others.
261
173
        If None, then any ancestry disputes will be resolved with
262
174
        new_revision_id
317
229
    return matcher.get_matching_blocks()
318
230
 
319
231
 
320
 
_break_annotation_tie = None
321
 
 
322
 
def _old_break_annotation_tie(annotated_lines):
323
 
    """Chose an attribution between several possible ones.
324
 
 
325
 
    :param annotated_lines: A list of tuples ((file_id, rev_id), line) where
326
 
        the lines are identical but the revids different while no parent
327
 
        relation exist between them
328
 
 
329
 
     :return : The "winning" line. This must be one with a revid that
330
 
         guarantees that further criss-cross merges will converge. Failing to
331
 
         do so have performance implications.
332
 
    """
333
 
    # sort lexicographically so that we always get a stable result.
334
 
 
335
 
    # TODO: while 'sort' is the easiest (and nearly the only possible solution)
336
 
    # with the current implementation, chosing the oldest revision is known to
337
 
    # provide better results (as in matching user expectations). The most
338
 
    # common use case being manual cherry-pick from an already existing
339
 
    # revision.
340
 
    return sorted(annotated_lines)[0]
341
 
 
342
 
 
343
232
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
344
233
                                     child_lines, start_child, end_child,
345
234
                                     right_lines, start_right, end_right,
350
239
    :param plain_child_lines: The unannotated new lines for the child text
351
240
    :param child_lines: Lines for the child text which have been annotated
352
241
        for the left parent
353
 
 
354
 
    :param start_child: Position in plain_child_lines and child_lines to start
355
 
        the match searching
356
 
    :param end_child: Last position in plain_child_lines and child_lines to
357
 
        search for a match
 
242
    :param start_child: Position in plain_child_lines and child_lines to start the
 
243
        match searching
 
244
    :param end_child: Last position in plain_child_lines and child_lines to search
 
245
        for a match
358
246
    :param right_lines: The annotated lines for the whole text for the right
359
247
        parent
360
248
    :param start_right: Position in right_lines to start the match
396
284
                    if len(heads) == 1:
397
285
                        output_append((iter(heads).next(), left[1]))
398
286
                    else:
399
 
                        # Both claim different origins, get a stable result.
400
 
                        # If the result is not stable, there is a risk a
401
 
                        # performance degradation as criss-cross merges will
402
 
                        # flip-flop the attribution.
403
 
                        if _break_annotation_tie is None:
404
 
                            output_append(
405
 
                                _old_break_annotation_tie([left, right]))
406
 
                        else:
407
 
                            output_append(_break_annotation_tie([left, right]))
 
287
                        # Both claim different origins
 
288
                        output_append((revision_id, left[1]))
 
289
                        # We know that revision_id is the head for
 
290
                        # left and right, so cache it
 
291
                        heads_provider.cache(
 
292
                            (revision_id, left[0]),
 
293
                            (revision_id,))
 
294
                        heads_provider.cache(
 
295
                            (revision_id, right[0]),
 
296
                            (revision_id,))
408
297
        last_child_idx = child_idx + match_len
409
298
 
410
299
 
422
311
    :param heads_provider: When parents disagree on the lineage of a line, we
423
312
        need to check if one side supersedes the other.
424
313
    """
425
 
    if len(new_lines) != len(annotated_lines):
426
 
        raise AssertionError("mismatched new_lines and annotated_lines")
 
314
    assert len(new_lines) == len(annotated_lines)
427
315
    # First compare the newly annotated lines with the right annotated lines.
428
316
    # Lines which were not changed in left or right should match. This tends to
429
317
    # be the bulk of the lines, and they will need no further processing.
434
322
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
435
323
                                                   annotated_lines)
436
324
    for right_idx, left_idx, match_len in matching_left_and_right:
437
 
        # annotated lines from last_left_idx to left_idx did not match the
438
 
        # lines from last_right_idx to right_idx, the raw lines should be
439
 
        # compared to determine what annotations need to be updated
 
325
        # annotated lines from last_left_idx to left_idx did not match the lines from
 
326
        # last_right_idx
 
327
        # to right_idx, the raw lines should be compared to determine what annotations
 
328
        # need to be updated
440
329
        if last_right_idx == right_idx or last_left_idx == left_idx:
441
330
            # One of the sides is empty, so this is a pure insertion
442
331
            lines_extend(annotated_lines[last_left_idx:left_idx])
452
341
        last_right_idx = right_idx + match_len
453
342
        last_left_idx = left_idx + match_len
454
343
        # If left and right agree on a range, just push that into the output
 
344
        assert len(lines) == left_idx
455
345
        lines_extend(annotated_lines[left_idx:left_idx + match_len])
456
346
    return lines
457
 
 
458
 
 
459
 
try:
460
 
    from bzrlib._annotator_pyx import Annotator
461
 
except ImportError, e:
462
 
    osutils.failed_to_load_extension(e)
463
 
    from bzrlib._annotator_py import Annotator