1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
# Copyright (C) 2009 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Functionality for doing annotations in the 'optimal' way"""
from bzrlib.lazy_import import lazy_import
lazy_import(globals(), """
from bzrlib import (
annotate, # Must be lazy to avoid circular importing
graph as _mod_graph,
patiencediff,
)
""")
from bzrlib import (
errors,
osutils,
ui,
)
class Annotator(object):
"""Class that drives performing annotations."""
def __init__(self, vf):
"""Create a new Annotator from a VersionedFile."""
self._vf = vf
self._parent_map = {}
self._text_cache = {}
# Map from key => number of nexts that will be built from this key
self._num_needed_children = {}
self._annotations_cache = {}
self._heads_provider = None
self._ann_tuple_cache = {}
def _update_needed_children(self, key, parent_keys):
for parent_key in parent_keys:
if parent_key in self._num_needed_children:
self._num_needed_children[parent_key] += 1
else:
self._num_needed_children[parent_key] = 1
def _get_needed_keys(self, key):
"""Determine the texts we need to get from the backing vf.
:return: (vf_keys_needed, ann_keys_needed)
vf_keys_needed These are keys that we need to get from the vf
ann_keys_needed Texts which we have in self._text_cache but we
don't have annotations for. We need to yield these
in the proper order so that we can get proper
annotations.
"""
parent_map = self._parent_map
# We need 1 extra copy of the node we will be looking at when we are
# done
self._num_needed_children[key] = 1
vf_keys_needed = set()
ann_keys_needed = set()
needed_keys = set([key])
while needed_keys:
parent_lookup = []
next_parent_map = {}
for key in needed_keys:
if key in self._parent_map:
# We don't need to lookup this key in the vf
if key not in self._text_cache:
# Extract this text from the vf
vf_keys_needed.add(key)
elif key not in self._annotations_cache:
# We do need to annotate
ann_keys_needed.add(key)
next_parent_map[key] = self._parent_map[key]
else:
parent_lookup.append(key)
vf_keys_needed.add(key)
needed_keys = set()
next_parent_map.update(self._vf.get_parent_map(parent_lookup))
for key, parent_keys in next_parent_map.iteritems():
if parent_keys is None: # No graph versionedfile
parent_keys = ()
next_parent_map[key] = ()
self._update_needed_children(key, parent_keys)
needed_keys.update([key for key in parent_keys
if key not in parent_map])
parent_map.update(next_parent_map)
# _heads_provider does some graph caching, so it is only valid while
# self._parent_map hasn't changed
self._heads_provider = None
return vf_keys_needed, ann_keys_needed
def _get_needed_texts(self, key, pb=None):
"""Get the texts we need to properly annotate key.
:param key: A Key that is present in self._vf
:return: Yield (this_key, text, num_lines)
'text' is an opaque object that just has to work with whatever
matcher object we are using. Currently it is always 'lines' but
future improvements may change this to a simple text string.
"""
keys, ann_keys = self._get_needed_keys(key)
if pb is not None:
pb.update('getting stream', 0, len(keys))
stream = self._vf.get_record_stream(keys, 'topological', True)
for idx, record in enumerate(stream):
if pb is not None:
pb.update('extracting', 0, len(keys))
if record.storage_kind == 'absent':
raise errors.RevisionNotPresent(record.key, self._vf)
this_key = record.key
lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
num_lines = len(lines)
self._text_cache[this_key] = lines
yield this_key, lines, num_lines
for key in ann_keys:
lines = self._text_cache[key]
num_lines = len(lines)
yield key, lines, num_lines
def _get_parent_annotations_and_matches(self, key, text, parent_key):
"""Get the list of annotations for the parent, and the matching lines.
:param text: The opaque value given by _get_needed_texts
:param parent_key: The key for the parent text
:return: (parent_annotations, matching_blocks)
parent_annotations is a list as long as the number of lines in
parent
matching_blocks is a list of (parent_idx, text_idx, len) tuples
indicating which lines match between the two texts
"""
parent_lines = self._text_cache[parent_key]
parent_annotations = self._annotations_cache[parent_key]
# PatienceSequenceMatcher should probably be part of Policy
matcher = patiencediff.PatienceSequenceMatcher(None,
parent_lines, text)
matching_blocks = matcher.get_matching_blocks()
return parent_annotations, matching_blocks
def _update_from_first_parent(self, key, annotations, lines, parent_key):
"""Reannotate this text relative to its first parent."""
(parent_annotations,
matching_blocks) = self._get_parent_annotations_and_matches(
key, lines, parent_key)
for parent_idx, lines_idx, match_len in matching_blocks:
# For all matching regions we copy across the parent annotations
annotations[lines_idx:lines_idx + match_len] = \
parent_annotations[parent_idx:parent_idx + match_len]
def _update_from_other_parents(self, key, annotations, lines,
this_annotation, parent_key):
"""Reannotate this text relative to a second (or more) parent."""
(parent_annotations,
matching_blocks) = self._get_parent_annotations_and_matches(
key, lines, parent_key)
last_ann = None
last_parent = None
last_res = None
# TODO: consider making all annotations unique and then using 'is'
# everywhere. Current results claim that isn't any faster,
# because of the time spent deduping
# deduping also saves a bit of memory. For NEWS it saves ~1MB,
# but that is out of 200-300MB for extracting everything, so a
# fairly trivial amount
for parent_idx, lines_idx, match_len in matching_blocks:
# For lines which match this parent, we will now resolve whether
# this parent wins over the current annotation
ann_sub = annotations[lines_idx:lines_idx + match_len]
par_sub = parent_annotations[parent_idx:parent_idx + match_len]
if ann_sub == par_sub:
continue
for idx in xrange(match_len):
ann = ann_sub[idx]
par_ann = par_sub[idx]
ann_idx = lines_idx + idx
if ann == par_ann:
# Nothing to change
continue
if ann == this_annotation:
# Originally claimed 'this', but it was really in this
# parent
annotations[ann_idx] = par_ann
continue
# Resolve the fact that both sides have a different value for
# last modified
if ann == last_ann and par_ann == last_parent:
annotations[ann_idx] = last_res
else:
new_ann = set(ann)
new_ann.update(par_ann)
new_ann = tuple(sorted(new_ann))
annotations[ann_idx] = new_ann
last_ann = ann
last_parent = par_ann
last_res = new_ann
def _record_annotation(self, key, parent_keys, annotations):
self._annotations_cache[key] = annotations
for parent_key in parent_keys:
num = self._num_needed_children[parent_key]
num -= 1
if num == 0:
del self._text_cache[parent_key]
del self._annotations_cache[parent_key]
# Do we want to clean up _num_needed_children at this point as
# well?
self._num_needed_children[parent_key] = num
def _annotate_one(self, key, text, num_lines):
this_annotation = (key,)
# Note: annotations will be mutated by calls to _update_from*
annotations = [this_annotation] * num_lines
parent_keys = self._parent_map[key]
if parent_keys:
self._update_from_first_parent(key, annotations, text,
parent_keys[0])
for parent in parent_keys[1:]:
self._update_from_other_parents(key, annotations, text,
this_annotation, parent)
self._record_annotation(key, parent_keys, annotations)
def add_special_text(self, key, parent_keys, text):
"""Add a specific text to the graph.
This is used to add a text which is not otherwise present in the
versioned file. (eg. a WorkingTree injecting 'current:' into the
graph to annotate the edited content.)
:param key: The key to use to request this text be annotated
:param parent_keys: The parents of this text
:param text: A string containing the content of the text
"""
self._parent_map[key] = parent_keys
self._text_cache[key] = osutils.split_lines(text)
self._heads_provider = None
def annotate(self, key):
"""Return annotated fulltext for the given key.
:param key: A tuple defining the text to annotate
:return: ([annotations], [lines])
annotations is a list of tuples of keys, one for each line in lines
each key is a possible source for the given line.
lines the text of "key" as a list of lines
"""
pb = ui.ui_factory.nested_progress_bar()
try:
for text_key, text, num_lines in self._get_needed_texts(key, pb=pb):
self._annotate_one(text_key, text, num_lines)
finally:
pb.finished()
try:
annotations = self._annotations_cache[key]
except KeyError:
raise errors.RevisionNotPresent(key, self._vf)
return annotations, self._text_cache[key]
def _get_heads_provider(self):
if self._heads_provider is None:
self._heads_provider = _mod_graph.KnownGraph(self._parent_map)
return self._heads_provider
def _resolve_annotation_tie(self, the_heads, line, tiebreaker):
if tiebreaker is None:
head = sorted(the_heads)[0]
else:
# Backwards compatibility, break up the heads into pairs and
# resolve the result
next_head = iter(the_heads)
head = next_head.next()
for possible_head in next_head:
annotated_lines = ((head, line), (possible_head, line))
head = tiebreaker(annotated_lines)[0]
return head
def annotate_flat(self, key):
"""Determine the single-best-revision to source for each line.
This is meant as a compatibility thunk to how annotate() used to work.
:return: [(ann_key, line)]
A list of tuples with a single annotation key for each line.
"""
custom_tiebreaker = annotate._break_annotation_tie
annotations, lines = self.annotate(key)
out = []
heads = self._get_heads_provider().heads
append = out.append
for annotation, line in zip(annotations, lines):
if len(annotation) == 1:
head = annotation[0]
else:
the_heads = heads(annotation)
if len(the_heads) == 1:
for head in the_heads: break # get the item out of the set
else:
head = self._resolve_annotation_tie(the_heads, line,
custom_tiebreaker)
append((head, line))
return out
|