/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/annotate.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/annotate.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""File annotate based on weave storage"""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
19
# TODO: Choice of more or less verbose formats:
22
 
#
 
20
# 
23
21
# interposed: show more details between blocks of modified lines
24
22
 
25
23
# TODO: Show which revision caused a line to merge into the parent
26
24
 
27
25
# TODO: perhaps abbreviate timescales depending on how recent they are
28
 
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.
 
26
# e.g. "3:12 Tue", "13 Oct", "Oct 2005", etc.  
29
27
 
30
28
import sys
31
29
import time
32
30
 
33
 
from .lazy_import import lazy_import
34
 
lazy_import(globals(), """
35
 
from breezy import (
 
31
from bzrlib import (
 
32
    errors,
 
33
    osutils,
36
34
    patiencediff,
37
35
    tsort,
38
36
    )
39
 
""")
40
 
from . import (
41
 
    errors,
42
 
    osutils,
43
 
    )
44
 
from .config import (
45
 
    NoEmailInUsername,
46
 
    NoWhoami,
47
 
    extract_email_address,
48
 
    )
49
 
from .repository import _strip_NULL_ghosts
50
 
from .revision import (
51
 
    CURRENT_REVISION,
52
 
    Revision,
53
 
    )
54
 
 
55
 
 
56
 
def annotate_file_tree(tree, path, to_file, verbose=False, full=False,
57
 
    show_ids=False, branch=None, file_id=None):
58
 
    """Annotate file_id in a tree.
59
 
 
60
 
    The tree should already be read_locked() when annotate_file_tree is called.
61
 
 
62
 
    :param tree: The tree to look for revision numbers and history from.
63
 
    :param path: The path to annotate
64
 
    :param to_file: The file to output the annotation to.
 
37
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.
 
48
    :param file_id: The file_id to annotate.
65
49
    :param verbose: Show all details rather than truncating to ensure
66
50
        reasonable text width.
67
51
    :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.
68
54
    :param show_ids: Show revision ids in the annotation output.
69
 
    :param file_id: The file_id to annotate (must match file path)
70
 
    :param branch: Branch to use for revision revno lookups
71
55
    """
72
 
    if branch is None:
73
 
        branch = tree.branch
74
56
    if to_file is None:
75
57
        to_file = sys.stdout
76
58
 
77
59
    # Handle the show_ids case
78
 
    annotations = list(tree.annotate_iter(path, file_id))
 
60
    last_rev_id = None
79
61
    if show_ids:
80
 
        return _show_id_annotations(annotations, to_file, full)
81
 
 
82
 
    if not getattr(tree, "get_revision_id", False):
83
 
        # Create a virtual revision to represent the current tree state.
84
 
        # Should get some more pending commit attributes, like pending tags,
85
 
        # bugfixes etc.
86
 
        current_rev = Revision(CURRENT_REVISION)
87
 
        current_rev.parent_ids = tree.get_parent_ids()
88
 
        try:
89
 
            current_rev.committer = branch.get_config_stack().get('email')
90
 
        except NoWhoami:
91
 
            current_rev.committer = 'local user'
92
 
        current_rev.message = "?"
93
 
        current_rev.timestamp = round(time.time(), 3)
94
 
        current_rev.timezone = osutils.local_time_offset()
95
 
    else:
96
 
        current_rev = None
97
 
    annotation = list(_expand_annotations(annotations, branch,
98
 
        current_rev))
99
 
    _print_annotations(annotation, verbose, to_file, full)
100
 
 
101
 
 
102
 
def _print_annotations(annotation, verbose, to_file, full):
103
 
    """Print annotations to to_file.
104
 
 
105
 
    :param to_file: The file to output the annotation to.
106
 
    :param verbose: Show all details rather than truncating to ensure
107
 
        reasonable text width.
108
 
    :param full: XXXX Not sure what this does.
109
 
    """
 
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))
110
75
    if len(annotation) == 0:
111
76
        max_origin_len = max_revno_len = max_revid_len = 0
112
77
    else:
119
84
 
120
85
    # Output the annotations
121
86
    prevanno = ''
 
87
    encoding = getattr(to_file, 'encoding', None) or \
 
88
            osutils.get_terminal_encoding()
122
89
    for (revno_str, author, date_str, line_rev_id, text) in annotation:
123
90
        if verbose:
124
91
            anno = '%-*s %-*s %8s ' % (max_revno_len, revno_str,
129
96
            anno = "%-*s %-7s " % (max_revno_len, revno_str, author[:7])
130
97
        if anno.lstrip() == "" and full:
131
98
            anno = prevanno
132
 
        # GZ 2017-05-21: Writing both unicode annotation and bytes from file
133
 
        # which the given to_file must cope with.
134
 
        to_file.write(anno)
 
99
        try:
 
100
            to_file.write(anno)
 
101
        except UnicodeEncodeError:
 
102
            # cmd_annotate should be passing in an 'exact' object, which means
 
103
            # we have a direct handle to sys.stdout or equivalent. It may not
 
104
            # be able to handle the exact Unicode characters, but 'annotate' is
 
105
            # a user function (non-scripting), so shouldn't die because of
 
106
            # unrepresentable annotation characters. So encode using 'replace',
 
107
            # and write them again.
 
108
            to_file.write(anno.encode(encoding, 'replace'))
135
109
        to_file.write('| %s\n' % (text,))
136
110
        prevanno = anno
137
111
 
138
112
 
139
 
def _show_id_annotations(annotations, to_file, full):
140
 
    if not annotations:
141
 
        return
142
 
    last_rev_id = None
143
 
    max_origin_len = max(len(origin) for origin, text in annotations)
144
 
    for origin, text in annotations:
145
 
        if full or last_rev_id != origin:
146
 
            this = origin
147
 
        else:
148
 
            this = ''
149
 
        to_file.write('%*s | %s' % (max_origin_len, this, text))
150
 
        last_rev_id = origin
151
 
    return
152
 
 
153
 
 
154
 
def _expand_annotations(annotations, branch, current_rev=None):
155
 
    """Expand a file's annotations into command line UI ready tuples.
156
 
 
157
 
    Each tuple includes detailed information, such as the author name, and date
158
 
    string for the commit, rather than just the revision id.
159
 
 
160
 
    :param annotations: The annotations to expand.
161
 
    :param revision_id_to_revno: A map from id to revision numbers.
162
 
    :param branch: A locked branch to query for revision details.
 
113
def _annotations(repo, file_id, rev_id):
 
114
    """Return the list of (origin_revision_id, line_text) for a revision of a file in a repository."""
 
115
    annotations = repo.texts.annotate((file_id, rev_id))
 
116
    # 
 
117
    return [(key[-1], line) for (key, line) in annotations]
 
118
 
 
119
 
 
120
def _annotate_file(branch, rev_id, file_id):
 
121
    """Yield the origins for each line of a file.
 
122
 
 
123
    This includes detailed information, such as the author name, and
 
124
    date string for the commit, rather than just the revision id.
163
125
    """
164
 
    repository = branch.repository
 
126
    revision_id_to_revno = branch.get_revision_id_to_revno_map()
 
127
    annotations = _annotations(branch.repository, file_id, rev_id)
 
128
    last_origin = None
165
129
    revision_ids = set(o for o, t in annotations)
166
 
    if current_rev is not None:
167
 
        # This can probably become a function on MutableTree, get_revno_map
168
 
        # there, or something.
169
 
        last_revision = current_rev.revision_id
170
 
        # XXX: Partially Cloned from branch, uses the old_get_graph, eep.
171
 
        # XXX: The main difficulty is that we need to inject a single new node
172
 
        #      (current_rev) into the graph before it gets numbered, etc.
173
 
        #      Once KnownGraph gets an 'add_node()' function, we can use
174
 
        #      VF.get_known_graph_ancestry().
175
 
        graph = repository.get_graph()
176
 
        revision_graph = dict(((key, value) for key, value in
177
 
            graph.iter_ancestry(current_rev.parent_ids) if value is not None))
178
 
        revision_graph = _strip_NULL_ghosts(revision_graph)
179
 
        revision_graph[last_revision] = current_rev.parent_ids
180
 
        merge_sorted_revisions = tsort.merge_sort(
181
 
            revision_graph,
182
 
            last_revision,
183
 
            None,
184
 
            generate_revno=True)
185
 
        revision_id_to_revno = dict((rev_id, revno)
186
 
            for seq_num, rev_id, depth, revno, end_of_merge in
187
 
                merge_sorted_revisions)
188
 
    else:
189
 
        # TODO(jelmer): Only look up the revision ids that we need (i.e. those
190
 
        # in revision_ids). Possibly add a HPSS call that can look those up
191
 
        # in bulk over HPSS.
192
 
        revision_id_to_revno = branch.get_revision_id_to_revno_map()
193
 
    last_origin = None
194
 
    revisions = {}
195
 
    if CURRENT_REVISION in revision_ids:
196
 
        revision_id_to_revno[CURRENT_REVISION] = (
197
 
            "%d?" % (branch.revno() + 1),)
198
 
        revisions[CURRENT_REVISION] = current_rev
199
 
    revisions.update(
200
 
            entry for entry in
201
 
            repository.iter_revisions(revision_ids)
202
 
            if entry[1] is not None)
 
130
    revision_ids = [o for o in revision_ids if 
 
131
                    branch.repository.has_revision(o)]
 
132
    revisions = dict((r.revision_id, r) for r in 
 
133
                     branch.repository.get_revisions(revision_ids))
203
134
    for origin, text in annotations:
204
 
        text = text.rstrip(b'\r\n')
 
135
        text = text.rstrip('\r\n')
205
136
        if origin == last_origin:
206
 
            (revno_str, author, date_str) = ('', '', '')
 
137
            (revno_str, author, date_str) = ('','','')
207
138
        else:
208
139
            last_origin = origin
209
140
            if origin not in revisions:
210
 
                (revno_str, author, date_str) = ('?', '?', '?')
 
141
                (revno_str, author, date_str) = ('?','?','?')
211
142
            else:
212
143
                revno_str = '.'.join(str(i) for i in
213
144
                                            revision_id_to_revno[origin])
217
148
                                     time.gmtime(rev.timestamp + tz))
218
149
            # a lazy way to get something like the email address
219
150
            # TODO: Get real email address
220
 
            author = rev.get_apparent_authors()[0]
 
151
            author = rev.get_apparent_author()
221
152
            try:
222
153
                author = extract_email_address(author)
223
 
            except NoEmailInUsername:
 
154
            except errors.NoEmailInUsername:
224
155
                pass        # use the whole name
225
156
        yield (revno_str, author, date_str, origin, text)
226
157
 
229
160
               _left_matching_blocks=None,
230
161
               heads_provider=None):
231
162
    """Create a new annotated version from new lines and parent annotations.
232
 
 
 
163
    
233
164
    :param parents_lines: List of annotated lines for all parents
234
165
    :param new_lines: The un-annotated new lines
235
166
    :param new_revision_id: The revision-id to associate with new lines
238
169
        between the text and its left-hand-parent.  The format is
239
170
        the SequenceMatcher.get_matching_blocks format
240
171
        (start_left, start_right, length_of_match).
241
 
    :param heads_provider: An object which provides a .heads() call to resolve
 
172
    :param heads_provider: An object which provids a .heads() call to resolve
242
173
        if any revision ids are children of others.
243
174
        If None, then any ancestry disputes will be resolved with
244
175
        new_revision_id
294
225
 
295
226
 
296
227
def _get_matching_blocks(old, new):
297
 
    matcher = patiencediff.PatienceSequenceMatcher(None, old, new)
 
228
    matcher = patiencediff.PatienceSequenceMatcher(None,
 
229
        old, new)
298
230
    return matcher.get_matching_blocks()
299
231
 
300
232
 
301
 
_break_annotation_tie = None
302
 
 
303
 
def _old_break_annotation_tie(annotated_lines):
304
 
    """Chose an attribution between several possible ones.
305
 
 
306
 
    :param annotated_lines: A list of tuples ((file_id, rev_id), line) where
307
 
        the lines are identical but the revids different while no parent
308
 
        relation exist between them
309
 
 
310
 
     :return : The "winning" line. This must be one with a revid that
311
 
         guarantees that further criss-cross merges will converge. Failing to
312
 
         do so have performance implications.
313
 
    """
314
 
    # sort lexicographically so that we always get a stable result.
315
 
 
316
 
    # TODO: while 'sort' is the easiest (and nearly the only possible solution)
317
 
    # with the current implementation, chosing the oldest revision is known to
318
 
    # provide better results (as in matching user expectations). The most
319
 
    # common use case being manual cherry-pick from an already existing
320
 
    # revision.
321
 
    return sorted(annotated_lines)[0]
322
 
 
323
 
 
324
233
def _find_matching_unannotated_lines(output_lines, plain_child_lines,
325
234
                                     child_lines, start_child, end_child,
326
235
                                     right_lines, start_right, end_right,
331
240
    :param plain_child_lines: The unannotated new lines for the child text
332
241
    :param child_lines: Lines for the child text which have been annotated
333
242
        for the left parent
334
 
 
335
 
    :param start_child: Position in plain_child_lines and child_lines to start
336
 
        the match searching
337
 
    :param end_child: Last position in plain_child_lines and child_lines to
338
 
        search for a match
 
243
    :param start_child: Position in plain_child_lines and child_lines to start the
 
244
        match searching
 
245
    :param end_child: Last position in plain_child_lines and child_lines to search
 
246
        for a match
339
247
    :param right_lines: The annotated lines for the whole text for the right
340
248
        parent
341
249
    :param start_right: Position in right_lines to start the match
347
255
    output_extend = output_lines.extend
348
256
    output_append = output_lines.append
349
257
    # We need to see if any of the unannotated lines match
350
 
    plain_right_subset = [l for a, l in right_lines[start_right:end_right]]
 
258
    plain_right_subset = [l for a,l in right_lines[start_right:end_right]]
351
259
    plain_child_subset = plain_child_lines[start_child:end_child]
352
260
    match_blocks = _get_matching_blocks(plain_right_subset, plain_child_subset)
353
261
 
358
266
        if child_idx > last_child_idx:
359
267
            output_extend(child_lines[start_child + last_child_idx
360
268
                                      :start_child + child_idx])
361
 
        for offset in range(match_len):
 
269
        for offset in xrange(match_len):
362
270
            left = child_lines[start_child+child_idx+offset]
363
271
            right = right_lines[start_right+right_idx+offset]
364
272
            if left[0] == right[0]:
375
283
                else:
376
284
                    heads = heads_provider.heads((left[0], right[0]))
377
285
                    if len(heads) == 1:
378
 
                        output_append((next(iter(heads)), left[1]))
 
286
                        output_append((iter(heads).next(), left[1]))
379
287
                    else:
380
 
                        # Both claim different origins, get a stable result.
381
 
                        # If the result is not stable, there is a risk a
382
 
                        # performance degradation as criss-cross merges will
383
 
                        # flip-flop the attribution.
384
 
                        if _break_annotation_tie is None:
385
 
                            output_append(
386
 
                                _old_break_annotation_tie([left, right]))
387
 
                        else:
388
 
                            output_append(_break_annotation_tie([left, right]))
 
288
                        # Both claim different origins, sort lexicographically
 
289
                        # so that we always get a stable result.
 
290
                        output_append(sorted([left, right])[0])
389
291
        last_child_idx = child_idx + match_len
390
292
 
391
293
 
415
317
    matching_left_and_right = _get_matching_blocks(right_parent_lines,
416
318
                                                   annotated_lines)
417
319
    for right_idx, left_idx, match_len in matching_left_and_right:
418
 
        # annotated lines from last_left_idx to left_idx did not match the
419
 
        # lines from last_right_idx to right_idx, the raw lines should be
420
 
        # compared to determine what annotations need to be updated
 
320
        # annotated lines from last_left_idx to left_idx did not match the lines from
 
321
        # last_right_idx
 
322
        # to right_idx, the raw lines should be compared to determine what annotations
 
323
        # need to be updated
421
324
        if last_right_idx == right_idx or last_left_idx == left_idx:
422
325
            # One of the sides is empty, so this is a pure insertion
423
326
            lines_extend(annotated_lines[last_left_idx:left_idx])
435
338
        # If left and right agree on a range, just push that into the output
436
339
        lines_extend(annotated_lines[left_idx:left_idx + match_len])
437
340
    return lines
438
 
 
439
 
 
440
 
try:
441
 
    from breezy._annotator_pyx import Annotator
442
 
except ImportError as e:
443
 
    osutils.failed_to_load_extension(e)
444
 
    from breezy._annotator_py import Annotator