← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/_annotator_py.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-17 19:38:58 UTC
  • mto: This revision was merged to the branch mainline in revision 4522.
  • Revision ID: john@arbash-meinel.com-20090617193858-y7qy0zhsxeoewoyd
Initial api for Annotator.

Currently just a thunk around the other annotation code.
But it defines the api as returning multiple possible sources
for each line. And separates the annotations into a separate
list from the actual lines.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/_annotator_py.py
 
1
# Copyright (C) 2009 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
"""Functionality for doing annotations in the 'optimal' way"""
 
18
 
 
19
from bzrlib import (
 
20
    annotate,
 
21
    errors,
 
22
    graph as _mod_graph,
 
23
    osutils,
 
24
    )
 
25
 
 
26
 
 
27
class AnnotatorPolicy(object):
 
28
    """Variables that define annotations."""
 
29
 
 
30
 
 
31
class Annotator(object):
 
32
    """Class that drives performing annotations."""
 
33
 
 
34
    def __init__(self, vf):
 
35
        """Create a new Annotator from a VersionedFile."""
 
36
        self._vf = vf
 
37
 
 
38
    def annotate(self, key):
 
39
        """Return annotated fulltext for the given key."""
 
40
        graph = _mod_graph.Graph(self._vf)
 
41
        parent_map = dict((k, v) for k, v in graph.iter_ancestry([key])
 
42
                          if v is not None)
 
43
        if not parent_map:
 
44
            raise errors.RevisionNotPresent(key, self)
 
45
        keys = parent_map.keys()
 
46
        heads_provider = _mod_graph.KnownGraph(parent_map)
 
47
        parent_cache = {}
 
48
        reannotate = annotate.reannotate
 
49
        for record in self._vf.get_record_stream(keys, 'topological', True):
 
50
            key = record.key
 
51
            fulltext = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
52
            parents = parent_map[key]
 
53
            if parents is not None:
 
54
                parent_lines = [parent_cache[parent] for parent in parent_map[key]]
 
55
            else:
 
56
                parent_lines = []
 
57
            parent_cache[key] = list(
 
58
                reannotate(parent_lines, fulltext, key, None, heads_provider))
 
59
        try:
 
60
            annotated = parent_cache[key]
 
61
        except KeyError, e:
 
62
            raise errors.RevisionNotPresent(key, self._vf)
 
63
        annotations = [(a,) for a,l in annotated]
 
64
        lines = [l for a,l in annotated]
 
65
        return annotations, lines