51
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,
87
"""Get a list of the conflicts in the tree.
89
Each conflict is an instance of bzrlib.conflicts.Conflict.
93
def get_parent_ids(self):
94
"""Get the parent ids for this tree.
96
:return: a list of parent ids. [] is returned to indicate
97
a tree with no parents.
98
:raises: BzrError if the parents are not known.
100
raise NotImplementedError(self.get_parent_ids)
54
102
def has_filename(self, filename):
55
103
"""True if the tree has given filename."""
56
104
raise NotImplementedError()
99
165
"""Print file with id `file_id` to stdout."""
101
167
sys.stdout.write(self.get_file_text(file_id))
104
def export(self, dest, format='dir', root=None):
105
"""Export this tree."""
107
exporter = exporters[format]
109
from bzrlib.errors import BzrCommandError
110
raise BzrCommandError("export format %r not supported" % format)
111
exporter(self, dest, root)
115
class RevisionTree(Tree):
116
"""Tree viewing a previous revision.
118
File text can be retrieved from the text store.
120
TODO: Some kind of `__repr__` method, but a good one
121
probably means knowing the branch and revision number,
122
or at least passing a description to the constructor.
125
def __init__(self, weave_store, inv, revision_id):
126
self._weave_store = weave_store
127
self._inventory = inv
128
self._revision_id = revision_id
130
def get_weave(self, file_id):
131
return self._weave_store.get_weave(file_id)
134
def get_file_lines(self, file_id):
135
ie = self._inventory[file_id]
136
weave = self.get_weave(file_id)
137
return weave.get(ie.revision)
140
def get_file_text(self, file_id):
141
return ''.join(self.get_file_lines(file_id))
144
def get_file(self, file_id):
145
return StringIO(self.get_file_text(file_id))
147
def get_file_size(self, file_id):
148
return self._inventory[file_id].text_size
150
def get_file_sha1(self, file_id):
151
ie = self._inventory[file_id]
152
if ie.kind == "file":
155
def is_executable(self, file_id):
156
return self._inventory[file_id].executable
158
def has_filename(self, filename):
159
return bool(self.inventory.path2id(filename))
161
def list_files(self):
162
# The only files returned by this are those from the version
163
for path, entry in self.inventory.iter_entries():
164
yield path, 'V', entry.kind, entry.file_id, entry
166
def get_symlink_target(self, file_id):
167
ie = self._inventory[file_id]
168
return ie.symlink_target;
173
"""What files are present in this tree and unknown.
175
:return: an iterator over the unknown files.
182
def filter_unversioned_files(self, paths):
183
"""Filter out paths that are not versioned.
185
:return: set of paths.
187
# NB: we specifically *don't* call self.has_filename, because for
188
# WorkingTrees that can indicate files that exist on disk but that
190
pred = self.inventory.has_filename
191
return set((p for p in paths if not pred(p)))
195
from bzrlib.revisiontree import RevisionTree
171
198
class EmptyTree(Tree):
172
200
def __init__(self):
173
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)
206
def get_parent_ids(self):
175
209
def get_symlink_target(self, file_id):
254
291
yield (old_name, new_name)
258
######################################################################
261
def dir_exporter(tree, dest, root):
262
"""Export this tree to a new directory.
264
`dest` should not exist, and will be created holding the
265
contents of this tree.
267
TODO: To handle subdirectories we need to create the
270
:note: If the export fails, the destination directory will be
271
left in a half-assed state.
275
mutter('export version %r' % tree)
277
for dp, ie in inv.iter_entries():
278
ie.put_on_disk(dest, dp, tree)
280
exporters['dir'] = dir_exporter
287
def get_root_name(dest):
288
"""Get just the root name for a tarball.
290
>>> get_root_name('mytar.tar')
292
>>> get_root_name('mytar.tar.bz2')
294
>>> get_root_name('tar.tar.tar.tgz')
296
>>> get_root_name('bzr-0.0.5.tar.gz')
298
>>> get_root_name('a/long/path/mytar.tgz')
300
>>> get_root_name('../parent/../dir/other.tbz2')
303
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
304
dest = os.path.basename(dest)
306
if dest.endswith(end):
307
return dest[:-len(end)]
309
def tar_exporter(tree, dest, root, compression=None):
310
"""Export this tree to a new tar file.
312
`dest` will be created holding the contents of this tree; if it
313
already exists, it will be clobbered, like with "tar -c".
315
from time import time
317
compression = str(compression or '')
319
root = get_root_name(dest)
321
ball = tarfile.open(dest, 'w:' + compression)
322
except tarfile.CompressionError, e:
323
raise BzrError(str(e))
324
mutter('export version %r' % tree)
326
for dp, ie in inv.iter_entries():
327
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
328
item, fileobj = ie.get_tar_item(root, dp, now, tree)
329
ball.addfile(item, fileobj)
332
exporters['tar'] = tar_exporter
334
def tgz_exporter(tree, dest, root):
335
tar_exporter(tree, dest, root, compression='gz')
336
exporters['tgz'] = tgz_exporter
338
def tbz_exporter(tree, dest, root):
339
tar_exporter(tree, dest, root, compression='bz2')
340
exporters['tbz2'] = tbz_exporter
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
