1
1
# Copyright (C) 2005 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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
49
53
trees or versioned trees.
56
def changes_from(self, other, want_unchanged=False, specific_files=None,
57
extra_trees=None, require_versioned=False):
58
"""Return a TreeDelta of the changes from other to this tree.
60
:param other: A tree to compare with.
61
:param specific_files: An optional list of file paths to restrict the
62
comparison to. When mapping filenames to ids, all matches in all
63
trees (including optional extra_trees) are used, and all children of
64
matched directories are included.
65
:param want_unchanged: An optional boolean requesting the inclusion of
66
unchanged entries in the result.
67
:param extra_trees: An optional list of additional trees to use when
68
mapping the contents of specific_files (paths) to file_ids.
69
:param require_versioned: An optional boolean (defaults to False). When
70
supplied and True all the 'specific_files' must be versioned, or
71
a PathsNotVersionedError will be thrown.
73
The comparison will be performed by an InterTree object looked up on
76
# Martin observes that Tree.changes_from returns a TreeDelta and this
77
# may confuse people, because the class name of the returned object is
78
# a synonym of the object referenced in the method name.
79
return InterTree.get(other, self).compare(
80
want_unchanged=want_unchanged,
81
specific_files=specific_files,
82
extra_trees=extra_trees,
83
require_versioned=require_versioned,
52
86
def conflicts(self):
53
87
"""Get a list of the conflicts in the tree.
72
106
def has_id(self, file_id):
73
107
return self.inventory.has_id(file_id)
109
__contains__ = has_id
75
111
def has_or_had_id(self, file_id):
76
112
if file_id == self.inventory.root.file_id:
78
114
return self.inventory.has_id(file_id)
82
116
def __iter__(self):
83
117
return iter(self.inventory)
85
119
def id2path(self, file_id):
86
120
return self.inventory.id2path(file_id)
122
def iter_entries_by_dir(self):
123
"""Walk the tree in 'by_dir' order.
125
This will yield each entry in the tree as a (path, entry) tuple. The
126
order that they are yielded is: the contents of a directory are
127
preceeded by the parent of a directory, and all the contents of a
128
directory are grouped together.
130
return self.inventory.iter_entries_by_dir()
88
132
def kind(self, file_id):
89
133
raise NotImplementedError("subclasses must implement kind")
145
189
# are not versioned.
146
190
pred = self.inventory.has_filename
147
191
return set((p for p in paths if not pred(p)))
150
class RevisionTree(Tree):
151
"""Tree viewing a previous revision.
153
File text can be retrieved from the text store.
155
TODO: Some kind of `__repr__` method, but a good one
156
probably means knowing the branch and revision number,
157
or at least passing a description to the constructor.
160
def __init__(self, branch, inv, revision_id):
161
# for compatability the 'branch' parameter has not been renamed to
162
# repository at this point. However, we should change RevisionTree's
163
# construction to always be via Repository and not via direct
164
# construction - this will mean that we can change the constructor
165
# with much less chance of breaking client code.
166
self._repository = branch
167
self._weave_store = branch.weave_store
168
self._inventory = inv
169
self._revision_id = revision_id
171
def get_parent_ids(self):
172
"""See Tree.get_parent_ids.
174
A RevisionTree's parents match the revision graph.
176
parent_ids = self._repository.get_revision(self._revision_id).parent_ids
179
def get_revision_id(self):
180
"""Return the revision id associated with this tree."""
181
return self._revision_id
183
def get_weave(self, file_id):
184
return self._weave_store.get_weave(file_id,
185
self._repository.get_transaction())
187
def get_file_lines(self, file_id):
188
ie = self._inventory[file_id]
189
weave = self.get_weave(file_id)
190
return weave.get_lines(ie.revision)
192
def get_file_text(self, file_id):
193
return ''.join(self.get_file_lines(file_id))
195
def get_file(self, file_id):
196
return StringIO(self.get_file_text(file_id))
198
def get_file_size(self, file_id):
199
return self._inventory[file_id].text_size
201
def get_file_sha1(self, file_id, path=None):
202
ie = self._inventory[file_id]
203
if ie.kind == "file":
207
def get_file_mtime(self, file_id, path=None):
208
ie = self._inventory[file_id]
209
revision = self._repository.get_revision(ie.revision)
210
return revision.timestamp
212
def is_executable(self, file_id, path=None):
213
ie = self._inventory[file_id]
214
if ie.kind != "file":
216
return self._inventory[file_id].executable
218
def has_filename(self, filename):
219
return bool(self.inventory.path2id(filename))
221
def list_files(self):
222
# The only files returned by this are those from the version
223
for path, entry in self.inventory.iter_entries():
224
yield path, 'V', entry.kind, entry.file_id, entry
226
def get_symlink_target(self, file_id):
227
ie = self._inventory[file_id]
228
return ie.symlink_target;
230
def kind(self, file_id):
231
return self._inventory[file_id].kind
234
self._repository.lock_read()
237
self._repository.unlock()
195
from bzrlib.revisiontree import RevisionTree
240
198
class EmptyTree(Tree):
242
200
def __init__(self):
243
201
self._inventory = Inventory()
202
warn('EmptyTree is deprecated as of bzr 0.9 please use '
203
'repository.revision_tree instead.',
204
DeprecationWarning, stacklevel=2)
245
206
def get_parent_ids(self):
246
"""See Tree.get_parent_ids.
248
An EmptyTree always has NULL_REVISION as the only parent.
252
209
def get_symlink_target(self, file_id):
335
291
yield (old_name, new_name)
294
def find_ids_across_trees(filenames, trees, require_versioned=True):
295
"""Find the ids corresponding to specified filenames.
297
All matches in all trees will be used, and all children of matched
298
directories will be used.
300
:param filenames: The filenames to find file_ids for
301
:param trees: The trees to find file_ids within
302
:param require_versioned: if true, all specified filenames must occur in
304
:return: a set of file ids for the specified filenames and their children.
308
specified_ids = _find_filename_ids_across_trees(filenames, trees,
310
return _find_children_across_trees(specified_ids, trees)
313
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
314
"""Find the ids corresponding to specified filenames.
316
All matches in all trees will be used.
318
:param filenames: The filenames to find file_ids for
319
:param trees: The trees to find file_ids within
320
:param require_versioned: if true, all specified filenames must occur in
322
:return: a set of file ids for the specified filenames
325
interesting_ids = set()
326
for tree_path in filenames:
329
file_id = tree.inventory.path2id(tree_path)
330
if file_id is not None:
331
interesting_ids.add(file_id)
334
not_versioned.append(tree_path)
335
if len(not_versioned) > 0 and require_versioned:
336
raise errors.PathsNotVersionedError(not_versioned)
337
return interesting_ids
340
def _find_children_across_trees(specified_ids, trees):
341
"""Return a set including specified ids and their children
343
All matches in all trees will be used.
345
:param trees: The trees to find file_ids within
346
:return: a set containing all specified ids and their children
348
interesting_ids = set(specified_ids)
349
pending = interesting_ids
350
# now handle children of interesting ids
351
# we loop so that we handle all children of each id in both trees
352
while len(pending) > 0:
354
for file_id in pending:
356
if file_id not in tree:
358
entry = tree.inventory[file_id]
359
for child in getattr(entry, 'children', {}).itervalues():
360
if child.file_id not in interesting_ids:
361
new_pending.add(child.file_id)
362
interesting_ids.update(new_pending)
363
pending = new_pending
364
return interesting_ids
367
class InterTree(InterObject):
368
"""This class represents operations taking place between two Trees.
370
Its instances have methods like 'compare' and contain references to the
371
source and target trees these operations are to be carried out on.
373
clients of bzrlib should not need to use InterTree directly, rather they
374
should use the convenience methods on Tree such as 'Tree.compare()' which
375
will pass through to InterTree as appropriate.
381
def compare(self, want_unchanged=False, specific_files=None,
382
extra_trees=None, require_versioned=False):
383
"""Return the changes from source to target.
385
:return: A TreeDelta.
386
:param specific_files: An optional list of file paths to restrict the
387
comparison to. When mapping filenames to ids, all matches in all
388
trees (including optional extra_trees) are used, and all children of
389
matched directories are included.
390
:param want_unchanged: An optional boolean requesting the inclusion of
391
unchanged entries in the result.
392
:param extra_trees: An optional list of additional trees to use when
393
mapping the contents of specific_files (paths) to file_ids.
394
:param require_versioned: An optional boolean (defaults to False). When
395
supplied and True all the 'specific_files' must be versioned, or
396
a PathsNotVersionedError will be thrown.
398
# NB: show_status depends on being able to pass in non-versioned files and
399
# report them as unknown
400
trees = (self.source, self.target)
401
if extra_trees is not None:
402
trees = trees + tuple(extra_trees)
403
specific_file_ids = find_ids_across_trees(specific_files,
404
trees, require_versioned=require_versioned)
405
if specific_files and not specific_file_ids:
406
# All files are unversioned, so just return an empty delta
407
# _compare_trees would think we want a complete delta
408
return delta.TreeDelta()
409
return delta._compare_trees(self.source, self.target, want_unchanged,
added
removed
bzrlib/tree.py
