1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
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
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
17
17
"""File annotate based on weave storage"""
19
19
# TODO: Choice of more or less verbose formats:
21
21
# interposed: show more details between blocks of modified lines
23
23
# TODO: Show which revision caused a line to merge into the parent
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.
31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
33
31
from bzrlib import (
42
37
from bzrlib.config import extract_email_address
43
38
from bzrlib.repository import _strip_NULL_ghosts
44
from bzrlib.revision import (
48
from bzrlib.symbol_versioning import (
54
@deprecated_function(deprecated_in((2, 4, 0)))
39
from bzrlib.revision import CURRENT_REVISION, Revision
55
42
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
56
43
to_file=None, show_ids=False):
57
44
"""Annotate file_id at revision rev_id in branch.
69
56
:param show_ids: Show revision ids in the annotation output.
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)
61
# Handle the show_ids case
62
annotations = _annotations(branch.repository, file_id, rev_id)
64
return _show_id_annotations(annotations, to_file, full)
66
# Calculate the lengths of the various columns
67
annotation = list(_expand_annotations(annotations, branch))
68
_print_annotations(annotation, verbose, to_file, full)
76
71
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
77
show_ids=False, branch=None):
78
73
"""Annotate file_id in a tree.
80
75
The tree should already be read_locked() when annotate_file_tree is called.
86
81
reasonable text width.
87
82
:param full: XXXX Not sure what this does.
88
83
:param show_ids: Show revision ids in the annotation output.
89
:param branch: Branch to use for revision revno lookups
85
rev_id = tree.last_revision()
96
88
# Handle the show_ids case
97
89
annotations = list(tree.annotate_iter(file_id))
99
91
return _show_id_annotations(annotations, to_file, full)
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,
105
current_rev = Revision(CURRENT_REVISION)
106
current_rev.parent_ids = tree.get_parent_ids()
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()
116
annotation = list(_expand_annotations(annotations, branch,
93
# Create a virtual revision to represent the current tree state.
94
# Should get some more pending commit attributes, like pending tags,
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,
118
104
_print_annotations(annotation, verbose, to_file, full)
167
153
def _show_id_annotations(annotations, to_file, full):
170
154
last_rev_id = None
171
155
max_origin_len = max(len(origin) for origin, text in annotations)
172
156
for origin, text in annotations:
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))
170
return [(key[-1], line) for (key, line) in annotations]
182
173
def _expand_annotations(annotations, branch, current_rev=None):
183
"""Expand a file's annotations into command line UI ready tuples.
174
"""Expand a a files annotations into command line UI ready tuples.
185
176
Each tuple includes detailed information, such as the author name, and date
186
177
string for the commit, rather than just the revision id.
192
183
repository = branch.repository
193
184
if current_rev is not None:
194
# This can probably become a function on MutableTree, get_revno_map
195
# there, or something.
185
# This can probably become a function on MutableTree, get_revno_map there,
196
187
last_revision = current_rev.revision_id
197
188
# 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().
202
189
graph = repository.get_graph()
203
190
revision_graph = dict(((key, value) for key, value in
204
191
graph.iter_ancestry(current_rev.parent_ids) if value is not None))
221
208
revision_id_to_revno[CURRENT_REVISION] = (
222
209
"%d?" % (branch.revno() + 1),)
223
210
revisions[CURRENT_REVISION] = current_rev
224
revision_ids = [o for o in revision_ids if
211
revision_ids = [o for o in revision_ids if
225
212
repository.has_revision(o)]
226
revisions.update((r.revision_id, r) for r in
213
revisions.update((r.revision_id, r) for r in
227
214
repository.get_revisions(revision_ids))
228
215
for origin, text in annotations:
229
216
text = text.rstrip('\r\n')
242
229
time.gmtime(rev.timestamp + tz))
243
230
# a lazy way to get something like the email address
244
231
# TODO: Get real email address
245
author = rev.get_apparent_authors()[0]
232
author = rev.get_apparent_author()
247
234
author = extract_email_address(author)
248
235
except errors.NoEmailInUsername:
254
241
_left_matching_blocks=None,
255
242
heads_provider=None):
256
243
"""Create a new annotated version from new lines and parent annotations.
258
245
:param parents_lines: List of annotated lines for all parents
259
246
:param new_lines: The un-annotated new lines
260
247
:param new_revision_id: The revision-id to associate with new lines
263
250
between the text and its left-hand-parent. The format is
264
251
the SequenceMatcher.get_matching_blocks format
265
252
(start_left, start_right, length_of_match).
266
:param heads_provider: An object which provides a .heads() call to resolve
253
:param heads_provider: An object which provids a .heads() call to resolve
267
254
if any revision ids are children of others.
268
255
If None, then any ancestry disputes will be resolved with
321
308
def _get_matching_blocks(old, new):
322
matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
309
matcher = patiencediff.PatienceSequenceMatcher(None,
323
311
return matcher.get_matching_blocks()
326
_break_annotation_tie = None
328
def _old_break_annotation_tie(annotated_lines):
329
"""Chose an attribution between several possible ones.
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
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.
339
# sort lexicographically so that we always get a stable result.
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
346
return sorted(annotated_lines)[0]
349
314
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
350
315
child_lines, start_child, end_child,
351
316
right_lines, start_right, end_right,
356
321
:param plain_child_lines: The unannotated new lines for the child text
357
322
:param child_lines: Lines for the child text which have been annotated
358
323
for the left parent
360
:param start_child: Position in plain_child_lines and child_lines to start
362
:param end_child: Last position in plain_child_lines and child_lines to
324
:param start_child: Position in plain_child_lines and child_lines to start the
326
:param end_child: Last position in plain_child_lines and child_lines to search
364
328
:param right_lines: The annotated lines for the whole text for the right
366
330
:param start_right: Position in right_lines to start the match
402
366
if len(heads) == 1:
403
367
output_append((iter(heads).next(), left[1]))
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:
411
_old_break_annotation_tie([left, right]))
413
output_append(_break_annotation_tie([left, right]))
369
# Both claim different origins, sort lexicographically
370
# so that we always get a stable result.
371
output_append(sorted([left, right])[0])
414
372
last_child_idx = child_idx + match_len
440
398
matching_left_and_right = _get_matching_blocks(right_parent_lines,
442
400
for right_idx, left_idx, match_len in matching_left_and_right:
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
401
# annotated lines from last_left_idx to left_idx did not match the lines from
403
# to right_idx, the raw lines should be compared to determine what annotations
446
405
if last_right_idx == right_idx or last_left_idx == left_idx:
447
406
# One of the sides is empty, so this is a pure insertion
448
407
lines_extend(annotated_lines[last_left_idx:left_idx])
460
419
# If left and right agree on a range, just push that into the output
461
420
lines_extend(annotated_lines[left_idx:left_idx + match_len])
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
added
removed
bzrlib/annotate.py
