← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/annotate.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007 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
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
30
30
 
 
31
from bzrlib.lazy_import import lazy_import
 
32
lazy_import(globals(), """
 
33
from bzrlib import (
 
34
    patiencediff,
 
35
    tsort,
 
36
    )
 
37
""")
31
38
from bzrlib import (
32
39
    errors,
33
40
    osutils,
34
 
    patiencediff,
35
 
    tsort,
36
41
    )
37
42
from bzrlib.config import extract_email_address
38
43
from bzrlib.repository import _strip_NULL_ghosts
39
 
from bzrlib.revision import CURRENT_REVISION, Revision
40
 
 
41
 
 
 
44
from bzrlib.revision import (
 
45
    CURRENT_REVISION,
 
46
    Revision,
 
47
    )
 
48
from bzrlib.symbol_versioning import (
 
49
    deprecated_function,
 
50
    deprecated_in,
 
51
    )
 
52
 
 
53
 
 
54
@deprecated_function(deprecated_in((2, 4, 0)))
42
55
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
43
56
                  to_file=None, show_ids=False):
44
57
    """Annotate file_id at revision rev_id in branch.
55
68
        used.
56
69
    :param show_ids: Show revision ids in the annotation output.
57
70
    """
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)
 
71
    tree = branch.repository.revision_tree(rev_id)
 
72
    annotate_file_tree(tree, file_id, to_file, verbose=verbose,
 
73
        full=full, show_ids=show_ids, branch=branch)
69
74
 
70
75
 
71
76
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
72
 
    show_ids=False):
 
77
    show_ids=False, branch=None):
73
78
    """Annotate file_id in a tree.
74
79
 
75
80
    The tree should already be read_locked() when annotate_file_tree is called.
81
86
        reasonable text width.
82
87
    :param full: XXXX Not sure what this does.
83
88
    :param show_ids: Show revision ids in the annotation output.
 
89
    :param branch: Branch to use for revision revno lookups
84
90
    """
85
 
    rev_id = tree.last_revision()
86
 
    branch = tree.branch
 
91
    if branch is None:
 
92
        branch = tree.branch
 
93
    if to_file is None:
 
94
        to_file = sys.stdout
87
95
 
88
96
    # Handle the show_ids case
89
97
    annotations = list(tree.annotate_iter(file_id))
90
98
    if show_ids:
91
99
        return _show_id_annotations(annotations, to_file, full)
92
100
 
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,
 
101
    if not getattr(tree, "get_revision_id", False):
 
102
        # Create a virtual revision to represent the current tree state.
 
103
        # Should get some more pending commit attributes, like pending tags,
 
104
        # bugfixes etc.
 
105
        current_rev = Revision(CURRENT_REVISION)
 
106
        current_rev.parent_ids = tree.get_parent_ids()
 
107
        try:
 
108
            current_rev.committer = branch.get_config().username()
 
109
        except errors.NoWhoami:
 
110
            current_rev.committer = 'local user'
 
111
        current_rev.message = "?"
 
112
        current_rev.timestamp = round(time.time(), 3)
 
113
        current_rev.timezone = osutils.local_time_offset()
 
114
    else:
 
115
        current_rev = None
 
116
    annotation = list(_expand_annotations(annotations, branch,
103
117
        current_rev))
104
118
    _print_annotations(annotation, verbose, to_file, full)
105
119
 
151
165
 
152
166
 
153
167
def _show_id_annotations(annotations, to_file, full):
 
168
    if not annotations:
 
169
        return
154
170
    last_rev_id = None
155
171
    max_origin_len = max(len(origin) for origin, text in annotations)
156
172
    for origin, text in annotations:
163
179
    return
164
180
 
165
181
 
166
 
def _annotations(repo, file_id, rev_id):
167
 
    """Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
168
 
    annotations = repo.texts.annotate((file_id, rev_id))
169
 
    # 
170
 
    return [(key[-1], line) for (key, line) in annotations]
171
 
 
172
 
 
173
182
def _expand_annotations(annotations, branch, current_rev=None):
174
 
    """Expand a a files annotations into command line UI ready tuples.
 
183
    """Expand a file's annotations into command line UI ready tuples.
175
184
 
176
185
    Each tuple includes detailed information, such as the author name, and date
177
186
    string for the commit, rather than just the revision id.
182
191
    """
183
192
    repository = branch.repository
184
193
    if current_rev is not None:
185
 
        # This can probably become a function on MutableTree, get_revno_map there,
186
 
        # or something.
 
194
        # This can probably become a function on MutableTree, get_revno_map
 
195
        # there, or something.
187
196
        last_revision = current_rev.revision_id
188
197
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
 
198
        # XXX: The main difficulty is that we need to inject a single new node
 
199
        #      (current_rev) into the graph before it gets numbered, etc.
 
200
        #      Once KnownGraph gets an 'add_node()' function, we can use
 
201
        #      VF.get_known_graph_ancestry().
189
202
        graph = repository.get_graph()
190
203
        revision_graph = dict(((key, value) for key, value in
191
204
            graph.iter_ancestry(current_rev.parent_ids) if value is not None))
208
221
        revision_id_to_revno[CURRENT_REVISION] = (
209
222
            "%d?" % (branch.revno() + 1),)
210
223
        revisions[CURRENT_REVISION] = current_rev
211
 
    revision_ids = [o for o in revision_ids if 
 
224
    revision_ids = [o for o in revision_ids if
212
225
                    repository.has_revision(o)]
213
 
    revisions.update((r.revision_id, r) for r in 
 
226
    revisions.update((r.revision_id, r) for r in
214
227
                     repository.get_revisions(revision_ids))
215
228
    for origin, text in annotations:
216
229
        text = text.rstrip('\r\n')
229
242
                                     time.gmtime(rev.timestamp + tz))
230
243
            # a lazy way to get something like the email address
231
244
            # TODO: Get real email address
232
 
            author = rev.get_apparent_author()
 
245
            author = rev.get_apparent_authors()[0]
233
246
            try:
234
247
                author = extract_email_address(author)
235
248
            except errors.NoEmailInUsername:
241
254
               _left_matching_blocks=None,
242
255
               heads_provider=None):
243
256
    """Create a new annotated version from new lines and parent annotations.
244
 
    
 
257
 
245
258
    :param parents_lines: List of annotated lines for all parents
246
259
    :param new_lines: The un-annotated new lines
247
260
    :param new_revision_id: The revision-id to associate with new lines
250
263
        between the text and its left-hand-parent.  The format is
251
264
        the SequenceMatcher.get_matching_blocks format
252
265
        (start_left, start_right, length_of_match).
253
 
    :param heads_provider: An object which provids a .heads() call to resolve
 
266
    :param heads_provider: An object which provides a .heads() call to resolve
254
267
        if any revision ids are children of others.
255
268
        If None, then any ancestry disputes will be resolved with
256
269
        new_revision_id
306
319
 
307
320
 
308
321
def _get_matching_blocks(old, new):
309
 
    matcher = patiencediff.PatienceSequenceMatcher(None,
310
 
        old, new)
 
322
    matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
311
323
    return matcher.get_matching_blocks()
312
324
 
313
325
 
 
326
_break_annotation_tie = None
 
327
 
 
328
def _old_break_annotation_tie(annotated_lines):
 
329
    """Chose an attribution between several possible ones.
 
330
 
 
331
    :param annotated_lines: A list of tuples ((file_id, rev_id), line) where
 
332
        the lines are identical but the revids different while no parent
 
333
        relation exist between them
 
334
 
 
335
     :return : The "winning" line. This must be one with a revid that
 
336
         guarantees that further criss-cross merges will converge. Failing to
 
337
         do so have performance implications.
 
338
    """
 
339
    # sort lexicographically so that we always get a stable result.
 
340
 
 
341
    # TODO: while 'sort' is the easiest (and nearly the only possible solution)
 
342
    # with the current implementation, chosing the oldest revision is known to
 
343
    # provide better results (as in matching user expectations). The most
 
344
    # common use case being manual cherry-pick from an already existing
 
345
    # revision.
 
346
    return sorted(annotated_lines)[0]
 
347
 
 
348
 
314
349
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
315
350
                                     child_lines, start_child, end_child,
316
351
                                     right_lines, start_right, end_right,
321
356
    :param plain_child_lines: The unannotated new lines for the child text
322
357
    :param child_lines: Lines for the child text which have been annotated
323
358
        for the left parent
324
 
    :param start_child: Position in plain_child_lines and child_lines to start the
325
 
        match searching
326
 
    :param end_child: Last position in plain_child_lines and child_lines to search
327
 
        for a match
 
359
 
 
360
    :param start_child: Position in plain_child_lines and child_lines to start
 
361
        the match searching
 
362
    :param end_child: Last position in plain_child_lines and child_lines to
 
363
        search for a match
328
364
    :param right_lines: The annotated lines for the whole text for the right
329
365
        parent
330
366
    :param start_right: Position in right_lines to start the match
366
402
                    if len(heads) == 1:
367
403
                        output_append((iter(heads).next(), left[1]))
368
404
                    else:
369
 
                        # Both claim different origins, sort lexicographically
370
 
                        # so that we always get a stable result.
371
 
                        output_append(sorted([left, right])[0])
 
405
                        # Both claim different origins, get a stable result.
 
406
                        # If the result is not stable, there is a risk a
 
407
                        # performance degradation as criss-cross merges will
 
408
                        # flip-flop the attribution.
 
409
                        if _break_annotation_tie is None:
 
410
                            output_append(
 
411
                                _old_break_annotation_tie([left, right]))
 
412
                        else:
 
413
                            output_append(_break_annotation_tie([left, right]))
372
414
        last_child_idx = child_idx + match_len
373
415
 
374
416
 
398
440
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
399
441
                                                   annotated_lines)
400
442
    for right_idx, left_idx, match_len in matching_left_and_right:
401
 
        # annotated lines from last_left_idx to left_idx did not match the lines from
402
 
        # last_right_idx
403
 
        # to right_idx, the raw lines should be compared to determine what annotations
404
 
        # need to be updated
 
443
        # annotated lines from last_left_idx to left_idx did not match the
 
444
        # lines from last_right_idx to right_idx, the raw lines should be
 
445
        # compared to determine what annotations need to be updated
405
446
        if last_right_idx == right_idx or last_left_idx == left_idx:
406
447
            # One of the sides is empty, so this is a pure insertion
407
448
            lines_extend(annotated_lines[last_left_idx:left_idx])
419
460
        # If left and right agree on a range, just push that into the output
420
461
        lines_extend(annotated_lines[left_idx:left_idx + match_len])
421
462
    return lines
 
463
 
 
464
 
 
465
try:
 
466
    from bzrlib._annotator_pyx import Annotator
 
467
except ImportError, e:
 
468
    osutils.failed_to_load_extension(e)
 
469
    from bzrlib._annotator_py import Annotator