← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2012-08-15 04:30:44 UTC
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20120815043044-gz33c0m7judhpvyq
Launchpad automatic translations update.

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
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
22
24
 
23
25
# TODO: Show which revision caused a line to merge into the parent
24
26
 
25
27
# TODO: perhaps abbreviate timescales depending on how recent they are
26
 
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.  
 
28
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.
27
29
 
28
30
import sys
29
31
import time
30
32
 
 
33
from bzrlib.lazy_import import lazy_import
 
34
lazy_import(globals(), """
 
35
from bzrlib import (
 
36
    patiencediff,
 
37
    tsort,
 
38
    )
 
39
""")
31
40
from bzrlib import (
32
41
    errors,
33
42
    osutils,
34
 
    patiencediff,
35
 
    tsort,
36
43
    )
37
44
from bzrlib.config import extract_email_address
38
 
 
39
 
 
40
 
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
41
 
                  to_file=None, show_ids=False):
42
 
    """Annotate file_id at revision rev_id in branch.
43
 
 
44
 
    The branch should already be read_locked() when annotate_file is called.
45
 
 
46
 
    :param branch: The branch to look for revision numbers and history from.
47
 
    :param rev_id: The revision id to annotate.
 
45
from bzrlib.repository import _strip_NULL_ghosts
 
46
from bzrlib.revision import (
 
47
    CURRENT_REVISION,
 
48
    Revision,
 
49
    )
 
50
 
 
51
 
 
52
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
 
53
    show_ids=False, branch=None):
 
54
    """Annotate file_id in a tree.
 
55
 
 
56
    The tree should already be read_locked() when annotate_file_tree is called.
 
57
 
 
58
    :param tree: The tree to look for revision numbers and history from.
48
59
    :param file_id: The file_id to annotate.
 
60
    :param to_file: The file to output the annotation to.
49
61
    :param verbose: Show all details rather than truncating to ensure
50
62
        reasonable text width.
51
63
    :param full: XXXX Not sure what this does.
52
 
    :param to_file: The file to output the annotation to; if None stdout is
53
 
        used.
54
64
    :param show_ids: Show revision ids in the annotation output.
 
65
    :param branch: Branch to use for revision revno lookups
55
66
    """
 
67
    if branch is None:
 
68
        branch = tree.branch
56
69
    if to_file is None:
57
70
        to_file = sys.stdout
58
71
 
59
72
    # Handle the show_ids case
60
 
    last_rev_id = None
 
73
    annotations = list(tree.annotate_iter(file_id))
61
74
    if show_ids:
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
72
 
 
73
 
    # Calculate the lengths of the various columns
74
 
    annotation = list(_annotate_file(branch, rev_id, file_id))
 
75
        return _show_id_annotations(annotations, to_file, full)
 
76
 
 
77
    if not getattr(tree, "get_revision_id", False):
 
78
        # Create a virtual revision to represent the current tree state.
 
79
        # Should get some more pending commit attributes, like pending tags,
 
80
        # bugfixes etc.
 
81
        current_rev = Revision(CURRENT_REVISION)
 
82
        current_rev.parent_ids = tree.get_parent_ids()
 
83
        try:
 
84
            current_rev.committer = branch.get_config_stack().get('email')
 
85
        except errors.NoWhoami:
 
86
            current_rev.committer = 'local user'
 
87
        current_rev.message = "?"
 
88
        current_rev.timestamp = round(time.time(), 3)
 
89
        current_rev.timezone = osutils.local_time_offset()
 
90
    else:
 
91
        current_rev = None
 
92
    annotation = list(_expand_annotations(annotations, branch,
 
93
        current_rev))
 
94
    _print_annotations(annotation, verbose, to_file, full)
 
95
 
 
96
 
 
97
def _print_annotations(annotation, verbose, to_file, full):
 
98
    """Print annotations to to_file.
 
99
 
 
100
    :param to_file: The file to output the annotation to.
 
101
    :param verbose: Show all details rather than truncating to ensure
 
102
        reasonable text width.
 
103
    :param full: XXXX Not sure what this does.
 
104
    """
75
105
    if len(annotation) == 0:
76
106
        max_origin_len = max_revno_len = max_revid_len = 0
77
107
    else:
110
140
        prevanno = anno
111
141
 
112
142
 
113
 
def _annotations(repo, file_id, rev_id):
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 w.annotate(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.
 
143
def _show_id_annotations(annotations, to_file, full):
 
144
    if not annotations:
 
145
        return
 
146
    last_rev_id = None
 
147
    max_origin_len = max(len(origin) for origin, text in annotations)
 
148
    for origin, text in annotations:
 
149
        if full or last_rev_id != origin:
 
150
            this = origin
 
151
        else:
 
152
            this = ''
 
153
        to_file.write('%*s | %s' % (max_origin_len, this, text))
 
154
        last_rev_id = origin
 
155
    return
 
156
 
 
157
 
 
158
def _expand_annotations(annotations, branch, current_rev=None):
 
159
    """Expand a file's annotations into command line UI ready tuples.
 
160
 
 
161
    Each tuple includes detailed information, such as the author name, and date
 
162
    string for the commit, rather than just the revision id.
 
163
 
 
164
    :param annotations: The annotations to expand.
 
165
    :param revision_id_to_revno: A map from id to revision numbers.
 
166
    :param branch: A locked branch to query for revision details.
124
167
    """
125
 
    revision_id_to_revno = branch.get_revision_id_to_revno_map()
126
 
    annotations = _annotations(branch.repository, file_id, rev_id)
 
168
    repository = branch.repository
 
169
    if current_rev is not None:
 
170
        # This can probably become a function on MutableTree, get_revno_map
 
171
        # there, or something.
 
172
        last_revision = current_rev.revision_id
 
173
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
 
174
        # XXX: The main difficulty is that we need to inject a single new node
 
175
        #      (current_rev) into the graph before it gets numbered, etc.
 
176
        #      Once KnownGraph gets an 'add_node()' function, we can use
 
177
        #      VF.get_known_graph_ancestry().
 
178
        graph = repository.get_graph()
 
179
        revision_graph = dict(((key, value) for key, value in
 
180
            graph.iter_ancestry(current_rev.parent_ids) if value is not None))
 
181
        revision_graph = _strip_NULL_ghosts(revision_graph)
 
182
        revision_graph[last_revision] = current_rev.parent_ids
 
183
        merge_sorted_revisions = tsort.merge_sort(
 
184
            revision_graph,
 
185
            last_revision,
 
186
            None,
 
187
            generate_revno=True)
 
188
        revision_id_to_revno = dict((rev_id, revno)
 
189
            for seq_num, rev_id, depth, revno, end_of_merge in
 
190
                merge_sorted_revisions)
 
191
    else:
 
192
        revision_id_to_revno = branch.get_revision_id_to_revno_map()
127
193
    last_origin = None
128
194
    revision_ids = set(o for o, t in annotations)
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))
 
195
    revisions = {}
 
196
    if CURRENT_REVISION in revision_ids:
 
197
        revision_id_to_revno[CURRENT_REVISION] = (
 
198
            "%d?" % (branch.revno() + 1),)
 
199
        revisions[CURRENT_REVISION] = current_rev
 
200
    revision_ids = [o for o in revision_ids if
 
201
                    repository.has_revision(o)]
 
202
    revisions.update((r.revision_id, r) for r in
 
203
                     repository.get_revisions(revision_ids))
133
204
    for origin, text in annotations:
134
205
        text = text.rstrip('\r\n')
135
206
        if origin == last_origin:
147
218
                                     time.gmtime(rev.timestamp + tz))
148
219
            # a lazy way to get something like the email address
149
220
            # TODO: Get real email address
150
 
            author = rev.get_apparent_author()
 
221
            author = rev.get_apparent_authors()[0]
151
222
            try:
152
223
                author = extract_email_address(author)
153
224
            except errors.NoEmailInUsername:
159
230
               _left_matching_blocks=None,
160
231
               heads_provider=None):
161
232
    """Create a new annotated version from new lines and parent annotations.
162
 
    
 
233
 
163
234
    :param parents_lines: List of annotated lines for all parents
164
235
    :param new_lines: The un-annotated new lines
165
236
    :param new_revision_id: The revision-id to associate with new lines
168
239
        between the text and its left-hand-parent.  The format is
169
240
        the SequenceMatcher.get_matching_blocks format
170
241
        (start_left, start_right, length_of_match).
171
 
    :param heads_provider: An object which provids a .heads() call to resolve
 
242
    :param heads_provider: An object which provides a .heads() call to resolve
172
243
        if any revision ids are children of others.
173
244
        If None, then any ancestry disputes will be resolved with
174
245
        new_revision_id
224
295
 
225
296
 
226
297
def _get_matching_blocks(old, new):
227
 
    matcher = patiencediff.PatienceSequenceMatcher(None,
228
 
        old, new)
 
298
    matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
229
299
    return matcher.get_matching_blocks()
230
300
 
231
301
 
 
302
_break_annotation_tie = None
 
303
 
 
304
def _old_break_annotation_tie(annotated_lines):
 
305
    """Chose an attribution between several possible ones.
 
306
 
 
307
    :param annotated_lines: A list of tuples ((file_id, rev_id), line) where
 
308
        the lines are identical but the revids different while no parent
 
309
        relation exist between them
 
310
 
 
311
     :return : The "winning" line. This must be one with a revid that
 
312
         guarantees that further criss-cross merges will converge. Failing to
 
313
         do so have performance implications.
 
314
    """
 
315
    # sort lexicographically so that we always get a stable result.
 
316
 
 
317
    # TODO: while 'sort' is the easiest (and nearly the only possible solution)
 
318
    # with the current implementation, chosing the oldest revision is known to
 
319
    # provide better results (as in matching user expectations). The most
 
320
    # common use case being manual cherry-pick from an already existing
 
321
    # revision.
 
322
    return sorted(annotated_lines)[0]
 
323
 
 
324
 
232
325
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
233
326
                                     child_lines, start_child, end_child,
234
327
                                     right_lines, start_right, end_right,
239
332
    :param plain_child_lines: The unannotated new lines for the child text
240
333
    :param child_lines: Lines for the child text which have been annotated
241
334
        for the left parent
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
 
335
 
 
336
    :param start_child: Position in plain_child_lines and child_lines to start
 
337
        the match searching
 
338
    :param end_child: Last position in plain_child_lines and child_lines to
 
339
        search for a match
246
340
    :param right_lines: The annotated lines for the whole text for the right
247
341
        parent
248
342
    :param start_right: Position in right_lines to start the match
284
378
                    if len(heads) == 1:
285
379
                        output_append((iter(heads).next(), left[1]))
286
380
                    else:
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,))
 
381
                        # Both claim different origins, get a stable result.
 
382
                        # If the result is not stable, there is a risk a
 
383
                        # performance degradation as criss-cross merges will
 
384
                        # flip-flop the attribution.
 
385
                        if _break_annotation_tie is None:
 
386
                            output_append(
 
387
                                _old_break_annotation_tie([left, right]))
 
388
                        else:
 
389
                            output_append(_break_annotation_tie([left, right]))
297
390
        last_child_idx = child_idx + match_len
298
391
 
299
392
 
323
416
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
324
417
                                                   annotated_lines)
325
418
    for right_idx, left_idx, match_len in matching_left_and_right:
326
 
        # annotated lines from last_left_idx to left_idx did not match the lines from
327
 
        # last_right_idx
328
 
        # to right_idx, the raw lines should be compared to determine what annotations
329
 
        # need to be updated
 
419
        # annotated lines from last_left_idx to left_idx did not match the
 
420
        # lines from last_right_idx to right_idx, the raw lines should be
 
421
        # compared to determine what annotations need to be updated
330
422
        if last_right_idx == right_idx or last_left_idx == left_idx:
331
423
            # One of the sides is empty, so this is a pure insertion
332
424
            lines_extend(annotated_lines[last_left_idx:left_idx])
344
436
        # If left and right agree on a range, just push that into the output
345
437
        lines_extend(annotated_lines[left_idx:left_idx + match_len])
346
438
    return lines
 
439
 
 
440
 
 
441
try:
 
442
    from bzrlib._annotator_pyx import Annotator
 
443
except ImportError, e:
 
444
    osutils.failed_to_load_extension(e)
 
445
    from bzrlib._annotator_py import Annotator