1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""File annotate based on weave storage"""
19
# TODO: Choice of more or less verbose formats:
21
# interposed: show more details between blocks of modified lines
23
# TODO: Show which revision caused a line to merge into the parent
25
# TODO: perhaps abbreviate timescales depending on how recent they are
26
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.
31
from bzrlib.lazy_import import lazy_import
32
lazy_import(globals(), """
42
from bzrlib.config import extract_email_address
43
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)))
55
def annotate_file(branch, rev_id, file_id, verbose=False, full=False,
56
to_file=None, show_ids=False):
57
"""Annotate file_id at revision rev_id in branch.
59
The branch should already be read_locked() when annotate_file is called.
61
:param branch: The branch to look for revision numbers and history from.
62
:param rev_id: The revision id to annotate.
63
:param file_id: The file_id to annotate.
64
:param verbose: Show all details rather than truncating to ensure
65
reasonable text width.
66
:param full: XXXX Not sure what this does.
67
:param to_file: The file to output the annotation to; if None stdout is
69
: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)
76
def annotate_file_tree(tree, file_id, to_file, verbose=False, full=False,
77
show_ids=False, branch=None):
78
"""Annotate file_id in a tree.
80
The tree should already be read_locked() when annotate_file_tree is called.
82
:param tree: The tree to look for revision numbers and history from.
83
:param file_id: The file_id to annotate.
84
:param to_file: The file to output the annotation to.
85
:param verbose: Show all details rather than truncating to ensure
86
reasonable text width.
87
:param full: XXXX Not sure what this does.
88
:param show_ids: Show revision ids in the annotation output.
89
:param branch: Branch to use for revision revno lookups
96
# Handle the show_ids case
97
annotations = list(tree.annotate_iter(file_id))
99
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()
107
current_rev.committer = branch.get_config().username()
108
current_rev.message = "?"
109
current_rev.timestamp = round(time.time(), 3)
110
current_rev.timezone = osutils.local_time_offset()
113
annotation = list(_expand_annotations(annotations, branch,
115
_print_annotations(annotation, verbose, to_file, full)
118
def _print_annotations(annotation, verbose, to_file, full):
119
"""Print annotations to to_file.
121
:param to_file: The file to output the annotation to.
122
:param verbose: Show all details rather than truncating to ensure
123
reasonable text width.
124
:param full: XXXX Not sure what this does.
126
if len(annotation) == 0:
127
max_origin_len = max_revno_len = max_revid_len = 0
129
max_origin_len = max(len(x[1]) for x in annotation)
130
max_revno_len = max(len(x[0]) for x in annotation)
131
max_revid_len = max(len(x[3]) for x in annotation)
133
max_revno_len = min(max_revno_len, 12)
134
max_revno_len = max(max_revno_len, 3)
136
# Output the annotations
138
encoding = getattr(to_file, 'encoding', None) or \
139
osutils.get_terminal_encoding()
140
for (revno_str, author, date_str, line_rev_id, text) in annotation:
142
anno = '%-*s %-*s %8s ' % (max_revno_len, revno_str,
143
max_origin_len, author, date_str)
145
if len(revno_str) > max_revno_len:
146
revno_str = revno_str[:max_revno_len-1] + '>'
147
anno = "%-*s %-7s " % (max_revno_len, revno_str, author[:7])
148
if anno.lstrip() == "" and full:
152
except UnicodeEncodeError:
153
# cmd_annotate should be passing in an 'exact' object, which means
154
# we have a direct handle to sys.stdout or equivalent. It may not
155
# be able to handle the exact Unicode characters, but 'annotate' is
156
# a user function (non-scripting), so shouldn't die because of
157
# unrepresentable annotation characters. So encode using 'replace',
158
# and write them again.
159
to_file.write(anno.encode(encoding, 'replace'))
160
to_file.write('| %s\n' % (text,))
164
def _show_id_annotations(annotations, to_file, full):
168
max_origin_len = max(len(origin) for origin, text in annotations)
169
for origin, text in annotations:
170
if full or last_rev_id != origin:
174
to_file.write('%*s | %s' % (max_origin_len, this, text))
179
def _expand_annotations(annotations, branch, current_rev=None):
180
"""Expand a file's annotations into command line UI ready tuples.
182
Each tuple includes detailed information, such as the author name, and date
183
string for the commit, rather than just the revision id.
185
:param annotations: The annotations to expand.
186
:param revision_id_to_revno: A map from id to revision numbers.
187
:param branch: A locked branch to query for revision details.
189
repository = branch.repository
190
if current_rev is not None:
191
# This can probably become a function on MutableTree, get_revno_map
192
# there, or something.
193
last_revision = current_rev.revision_id
194
# XXX: Partially Cloned from branch, uses the old_get_graph, eep.
195
# XXX: The main difficulty is that we need to inject a single new node
196
# (current_rev) into the graph before it gets numbered, etc.
197
# Once KnownGraph gets an 'add_node()' function, we can use
198
# VF.get_known_graph_ancestry().
199
graph = repository.get_graph()
200
revision_graph = dict(((key, value) for key, value in
201
graph.iter_ancestry(current_rev.parent_ids) if value is not None))
202
revision_graph = _strip_NULL_ghosts(revision_graph)
203
revision_graph[last_revision] = current_rev.parent_ids
204
merge_sorted_revisions = tsort.merge_sort(
209
revision_id_to_revno = dict((rev_id, revno)
210
for seq_num, rev_id, depth, revno, end_of_merge in
211
merge_sorted_revisions)
213
revision_id_to_revno = branch.get_revision_id_to_revno_map()
215
revision_ids = set(o for o, t in annotations)
217
if CURRENT_REVISION in revision_ids:
218
revision_id_to_revno[CURRENT_REVISION] = (
219
"%d?" % (branch.revno() + 1),)
220
revisions[CURRENT_REVISION] = current_rev
221
revision_ids = [o for o in revision_ids if
222
repository.has_revision(o)]
223
revisions.update((r.revision_id, r) for r in
224
repository.get_revisions(revision_ids))
225
for origin, text in annotations:
226
text = text.rstrip('\r\n')
227
if origin == last_origin:
228
(revno_str, author, date_str) = ('','','')
231
if origin not in revisions:
232
(revno_str, author, date_str) = ('?','?','?')
234
revno_str = '.'.join(str(i) for i in
235
revision_id_to_revno[origin])
236
rev = revisions[origin]
237
tz = rev.timezone or 0
238
date_str = time.strftime('%Y%m%d',
239
time.gmtime(rev.timestamp + tz))
240
# a lazy way to get something like the email address
241
# TODO: Get real email address
242
author = rev.get_apparent_authors()[0]
244
author = extract_email_address(author)
245
except errors.NoEmailInUsername:
246
pass # use the whole name
247
yield (revno_str, author, date_str, origin, text)
250
def reannotate(parents_lines, new_lines, new_revision_id,
251
_left_matching_blocks=None,
252
heads_provider=None):
253
"""Create a new annotated version from new lines and parent annotations.
255
:param parents_lines: List of annotated lines for all parents
256
:param new_lines: The un-annotated new lines
257
:param new_revision_id: The revision-id to associate with new lines
258
(will often be CURRENT_REVISION)
259
:param left_matching_blocks: a hint about which areas are common
260
between the text and its left-hand-parent. The format is
261
the SequenceMatcher.get_matching_blocks format
262
(start_left, start_right, length_of_match).
263
:param heads_provider: An object which provides a .heads() call to resolve
264
if any revision ids are children of others.
265
If None, then any ancestry disputes will be resolved with
268
if len(parents_lines) == 0:
269
lines = [(new_revision_id, line) for line in new_lines]
270
elif len(parents_lines) == 1:
271
lines = _reannotate(parents_lines[0], new_lines, new_revision_id,
272
_left_matching_blocks)
273
elif len(parents_lines) == 2:
274
left = _reannotate(parents_lines[0], new_lines, new_revision_id,
275
_left_matching_blocks)
276
lines = _reannotate_annotated(parents_lines[1], new_lines,
277
new_revision_id, left,
280
reannotations = [_reannotate(parents_lines[0], new_lines,
281
new_revision_id, _left_matching_blocks)]
282
reannotations.extend(_reannotate(p, new_lines, new_revision_id)
283
for p in parents_lines[1:])
285
for annos in zip(*reannotations):
286
origins = set(a for a, l in annos)
287
if len(origins) == 1:
288
# All the parents agree, so just return the first one
289
lines.append(annos[0])
292
if len(origins) == 2 and new_revision_id in origins:
293
origins.remove(new_revision_id)
294
if len(origins) == 1:
295
lines.append((origins.pop(), line))
297
lines.append((new_revision_id, line))
301
def _reannotate(parent_lines, new_lines, new_revision_id,
302
matching_blocks=None):
304
if matching_blocks is None:
305
plain_parent_lines = [l for r, l in parent_lines]
306
matcher = patiencediff.PatienceSequenceMatcher(None,
307
plain_parent_lines, new_lines)
308
matching_blocks = matcher.get_matching_blocks()
310
for i, j, n in matching_blocks:
311
for line in new_lines[new_cur:j]:
312
lines.append((new_revision_id, line))
313
lines.extend(parent_lines[i:i+n])
318
def _get_matching_blocks(old, new):
319
matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
320
return matcher.get_matching_blocks()
323
_break_annotation_tie = None
325
def _old_break_annotation_tie(annotated_lines):
326
"""Chose an attribution between several possible ones.
328
:param annotated_lines: A list of tuples ((file_id, rev_id), line) where
329
the lines are identical but the revids different while no parent
330
relation exist between them
332
:return : The "winning" line. This must be one with a revid that
333
guarantees that further criss-cross merges will converge. Failing to
334
do so have performance implications.
336
# sort lexicographically so that we always get a stable result.
338
# TODO: while 'sort' is the easiest (and nearly the only possible solution)
339
# with the current implementation, chosing the oldest revision is known to
340
# provide better results (as in matching user expectations). The most
341
# common use case being manual cherry-pick from an already existing
343
return sorted(annotated_lines)[0]
346
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
347
child_lines, start_child, end_child,
348
right_lines, start_right, end_right,
349
heads_provider, revision_id):
350
"""Find lines in plain_right_lines that match the existing lines.
352
:param output_lines: Append final annotated lines to this list
353
:param plain_child_lines: The unannotated new lines for the child text
354
:param child_lines: Lines for the child text which have been annotated
357
:param start_child: Position in plain_child_lines and child_lines to start
359
:param end_child: Last position in plain_child_lines and child_lines to
361
:param right_lines: The annotated lines for the whole text for the right
363
:param start_right: Position in right_lines to start the match
364
:param end_right: Last position in right_lines to search for a match
365
:param heads_provider: When parents disagree on the lineage of a line, we
366
need to check if one side supersedes the other
367
:param revision_id: The label to give if a line should be labeled 'tip'
369
output_extend = output_lines.extend
370
output_append = output_lines.append
371
# We need to see if any of the unannotated lines match
372
plain_right_subset = [l for a,l in right_lines[start_right:end_right]]
373
plain_child_subset = plain_child_lines[start_child:end_child]
374
match_blocks = _get_matching_blocks(plain_right_subset, plain_child_subset)
378
for right_idx, child_idx, match_len in match_blocks:
379
# All the lines that don't match are just passed along
380
if child_idx > last_child_idx:
381
output_extend(child_lines[start_child + last_child_idx
382
:start_child + child_idx])
383
for offset in xrange(match_len):
384
left = child_lines[start_child+child_idx+offset]
385
right = right_lines[start_right+right_idx+offset]
386
if left[0] == right[0]:
387
# The annotations match, just return the left one
389
elif left[0] == revision_id:
390
# The left parent marked this as unmatched, so let the
391
# right parent claim it
394
# Left and Right both claim this line
395
if heads_provider is None:
396
output_append((revision_id, left[1]))
398
heads = heads_provider.heads((left[0], right[0]))
400
output_append((iter(heads).next(), left[1]))
402
# Both claim different origins, get a stable result.
403
# If the result is not stable, there is a risk a
404
# performance degradation as criss-cross merges will
405
# flip-flop the attribution.
406
if _break_annotation_tie is None:
408
_old_break_annotation_tie([left, right]))
410
output_append(_break_annotation_tie([left, right]))
411
last_child_idx = child_idx + match_len
414
def _reannotate_annotated(right_parent_lines, new_lines, new_revision_id,
415
annotated_lines, heads_provider):
416
"""Update the annotations for a node based on another parent.
418
:param right_parent_lines: A list of annotated lines for the right-hand
420
:param new_lines: The unannotated new lines.
421
:param new_revision_id: The revision_id to attribute to lines which are not
422
present in either parent.
423
:param annotated_lines: A list of annotated lines. This should be the
424
annotation of new_lines based on parents seen so far.
425
:param heads_provider: When parents disagree on the lineage of a line, we
426
need to check if one side supersedes the other.
428
if len(new_lines) != len(annotated_lines):
429
raise AssertionError("mismatched new_lines and annotated_lines")
430
# First compare the newly annotated lines with the right annotated lines.
431
# Lines which were not changed in left or right should match. This tends to
432
# be the bulk of the lines, and they will need no further processing.
434
lines_extend = lines.extend
435
last_right_idx = 0 # The line just after the last match from the right side
437
matching_left_and_right = _get_matching_blocks(right_parent_lines,
439
for right_idx, left_idx, match_len in matching_left_and_right:
440
# annotated lines from last_left_idx to left_idx did not match the
441
# lines from last_right_idx to right_idx, the raw lines should be
442
# compared to determine what annotations need to be updated
443
if last_right_idx == right_idx or last_left_idx == left_idx:
444
# One of the sides is empty, so this is a pure insertion
445
lines_extend(annotated_lines[last_left_idx:left_idx])
447
# We need to see if any of the unannotated lines match
448
_find_matching_unannotated_lines(lines,
449
new_lines, annotated_lines,
450
last_left_idx, left_idx,
452
last_right_idx, right_idx,
455
last_right_idx = right_idx + match_len
456
last_left_idx = left_idx + match_len
457
# If left and right agree on a range, just push that into the output
458
lines_extend(annotated_lines[left_idx:left_idx + match_len])
463
from bzrlib._annotator_pyx import Annotator
464
except ImportError, e:
465
osutils.failed_to_load_extension(e)
466
from bzrlib._annotator_py import Annotator
added
removed
bzrlib/annotate.py
