← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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
45
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)
 
46
from bzrlib.revision import (
 
47
    CURRENT_REVISION,
 
48
    Revision,
 
49
    )
69
50
 
70
51
 
71
52
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
72
 
    show_ids=False):
 
53
    show_ids=False, branch=None):
73
54
    """Annotate file_id in a tree.
74
55
 
75
56
    The tree should already be read_locked() when annotate_file_tree is called.
81
62
        reasonable text width.
82
63
    :param full: XXXX Not sure what this does.
83
64
    :param show_ids: Show revision ids in the annotation output.
 
65
    :param branch: Branch to use for revision revno lookups
84
66
    """
85
 
    rev_id = tree.last_revision()
86
 
    branch = tree.branch
 
67
    if branch is None:
 
68
        branch = tree.branch
 
69
    if to_file is None:
 
70
        to_file = sys.stdout
87
71
 
88
72
    # Handle the show_ids case
89
73
    annotations = list(tree.annotate_iter(file_id))
90
74
    if show_ids:
91
75
        return _show_id_annotations(annotations, to_file, full)
92
76
 
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,
 
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,
103
93
        current_rev))
104
94
    _print_annotations(annotation, verbose, to_file, full)
105
95
 
151
141
 
152
142
 
153
143
def _show_id_annotations(annotations, to_file, full):
 
144
    if not annotations:
 
145
        return
154
146
    last_rev_id = None
155
147
    max_origin_len = max(len(origin) for origin, text in annotations)
156
148
    for origin, text in annotations:
163
155
    return
164
156
 
165
157
 
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
158
def _expand_annotations(annotations, branch, current_rev=None):
174
 
    """Expand a a files annotations into command line UI ready tuples.
 
159
    """Expand a file's annotations into command line UI ready tuples.
175
160
 
176
161
    Each tuple includes detailed information, such as the author name, and date
177
162
    string for the commit, rather than just the revision id.
182
167
    """
183
168
    repository = branch.repository
184
169
    if current_rev is not None:
185
 
        # This can probably become a function on MutableTree, get_revno_map there,
186
 
        # or something.
 
170
        # This can probably become a function on MutableTree, get_revno_map
 
171
        # there, or something.
187
172
        last_revision = current_rev.revision_id
188
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().
189
178
        graph = repository.get_graph()
190
179
        revision_graph = dict(((key, value) for key, value in
191
180
            graph.iter_ancestry(current_rev.parent_ids) if value is not None))
208
197
        revision_id_to_revno[CURRENT_REVISION] = (
209
198
            "%d?" % (branch.revno() + 1),)
210
199
        revisions[CURRENT_REVISION] = current_rev
211
 
    revision_ids = [o for o in revision_ids if 
 
200
    revision_ids = [o for o in revision_ids if
212
201
                    repository.has_revision(o)]
213
 
    revisions.update((r.revision_id, r) for r in 
 
202
    revisions.update((r.revision_id, r) for r in
214
203
                     repository.get_revisions(revision_ids))
215
204
    for origin, text in annotations:
216
205
        text = text.rstrip('\r\n')
229
218
                                     time.gmtime(rev.timestamp + tz))
230
219
            # a lazy way to get something like the email address
231
220
            # TODO: Get real email address
232
 
            author = rev.get_apparent_author()
 
221
            author = rev.get_apparent_authors()[0]
233
222
            try:
234
223
                author = extract_email_address(author)
235
224
            except errors.NoEmailInUsername:
241
230
               _left_matching_blocks=None,
242
231
               heads_provider=None):
243
232
    """Create a new annotated version from new lines and parent annotations.
244
 
    
 
233
 
245
234
    :param parents_lines: List of annotated lines for all parents
246
235
    :param new_lines: The un-annotated new lines
247
236
    :param new_revision_id: The revision-id to associate with new lines
250
239
        between the text and its left-hand-parent.  The format is
251
240
        the SequenceMatcher.get_matching_blocks format
252
241
        (start_left, start_right, length_of_match).
253
 
    :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
254
243
        if any revision ids are children of others.
255
244
        If None, then any ancestry disputes will be resolved with
256
245
        new_revision_id
306
295
 
307
296
 
308
297
def _get_matching_blocks(old, new):
309
 
    matcher = patiencediff.PatienceSequenceMatcher(None,
310
 
        old, new)
 
298
    matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
311
299
    return matcher.get_matching_blocks()
312
300
 
313
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
 
314
325
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
315
326
                                     child_lines, start_child, end_child,
316
327
                                     right_lines, start_right, end_right,
321
332
    :param plain_child_lines: The unannotated new lines for the child text
322
333
    :param child_lines: Lines for the child text which have been annotated
323
334
        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
 
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
328
340
    :param right_lines: The annotated lines for the whole text for the right
329
341
        parent
330
342
    :param start_right: Position in right_lines to start the match
366
378
                    if len(heads) == 1:
367
379
                        output_append((iter(heads).next(), left[1]))
368
380
                    else:
369
 
                        # Both claim different origins, sort lexicographically
370
 
                        # so that we always get a stable result.
371
 
                        output_append(sorted([left, right])[0])
 
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]))
372
390
        last_child_idx = child_idx + match_len
373
391
 
374
392
 
398
416
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
399
417
                                                   annotated_lines)
400
418
    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
 
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
405
422
        if last_right_idx == right_idx or last_left_idx == left_idx:
406
423
            # One of the sides is empty, so this is a pure insertion
407
424
            lines_extend(annotated_lines[last_left_idx:left_idx])
419
436
        # If left and right agree on a range, just push that into the output
420
437
        lines_extend(annotated_lines[left_idx:left_idx + match_len])
421
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