53
51
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)
102
54
def has_filename(self, filename):
103
55
"""True if the tree has given filename."""
104
56
raise NotImplementedError()
109
61
__contains__ = has_id
111
def has_or_had_id(self, file_id):
112
if file_id == self.inventory.root.file_id:
114
return self.inventory.has_id(file_id)
116
63
def __iter__(self):
117
64
return iter(self.inventory)
119
66
def id2path(self, file_id):
120
67
return self.inventory.id2path(file_id)
122
def is_control_filename(self, filename):
123
"""True if filename is the name of a control file in this tree.
125
:param filename: A filename within the tree. This is a relative path
126
from the root of this tree.
128
This is true IF and ONLY IF the filename is part of the meta data
129
that bzr controls in this tree. I.E. a random .bzr directory placed
130
on disk will not be a control file for this tree.
132
return self.bzrdir.is_control_filename(filename)
134
def iter_entries_by_dir(self):
135
"""Walk the tree in 'by_dir' order.
137
This will yield each entry in the tree as a (path, entry) tuple. The
138
order that they are yielded is: the contents of a directory are
139
preceeded by the parent of a directory, and all the contents of a
140
directory are grouped together.
142
return self.inventory.iter_entries_by_dir()
144
def kind(self, file_id):
145
raise NotImplementedError("subclasses must implement kind")
147
69
def _get_inventory(self):
148
70
return self._inventory
150
def get_file(self, file_id):
151
"""Return a file object for the file file_id in the tree."""
152
raise NotImplementedError(self.get_file)
154
72
def get_file_by_path(self, path):
155
73
return self.get_file(self._inventory.path2id(path))
176
94
"file is actually %s" % fp['sha1'],
177
95
"store is probably damaged/corrupt"])
179
def path2id(self, path):
180
"""Return the id for path in this tree."""
181
return self._inventory.path2id(path)
183
98
def print_file(self, file_id):
184
99
"""Print file with id `file_id` to stdout."""
186
101
sys.stdout.write(self.get_file_text(file_id))
192
"""What files are present in this tree and unknown.
194
:return: an iterator over the unknown files.
201
def filter_unversioned_files(self, paths):
202
"""Filter out paths that are not versioned.
204
:return: set of paths.
206
# NB: we specifically *don't* call self.has_filename, because for
207
# WorkingTrees that can indicate files that exist on disk but that
209
pred = self.inventory.has_filename
210
return set((p for p in paths if not pred(p)))
214
from bzrlib.revisiontree import RevisionTree
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
# FIXME: RevisionTree should be given a branch
132
# not a store, or the store should know the branch.
133
import bzrlib.transactions as transactions
134
return self._weave_store.get_weave(file_id,
135
transactions.PassThroughTransaction())
138
def get_file_lines(self, file_id):
139
ie = self._inventory[file_id]
140
weave = self.get_weave(file_id)
141
return weave.get(ie.revision)
144
def get_file_text(self, file_id):
145
return ''.join(self.get_file_lines(file_id))
148
def get_file(self, file_id):
149
return StringIO(self.get_file_text(file_id))
151
def get_file_size(self, file_id):
152
return self._inventory[file_id].text_size
154
def get_file_sha1(self, file_id):
155
ie = self._inventory[file_id]
156
if ie.kind == "file":
159
def is_executable(self, file_id):
160
ie = self._inventory[file_id]
161
if ie.kind != "file":
163
return self._inventory[file_id].executable
165
def has_filename(self, filename):
166
return bool(self.inventory.path2id(filename))
168
def list_files(self):
169
# The only files returned by this are those from the version
170
for path, entry in self.inventory.iter_entries():
171
yield path, 'V', entry.kind, entry.file_id, entry
173
def get_symlink_target(self, file_id):
174
ie = self._inventory[file_id]
175
return ie.symlink_target;
177
def kind(self, file_id):
178
return self._inventory[file_id].kind
217
180
class EmptyTree(Tree):
219
181
def __init__(self):
220
182
self._inventory = Inventory()
221
warn('EmptyTree is deprecated as of bzr 0.9 please use '
222
'repository.revision_tree instead.',
223
DeprecationWarning, stacklevel=2)
225
def get_parent_ids(self):
228
184
def get_symlink_target(self, file_id):
310
263
yield (old_name, new_name)
313
def find_ids_across_trees(filenames, trees, require_versioned=True):
314
"""Find the ids corresponding to specified filenames.
316
All matches in all trees will be used, and all children of matched
317
directories will be used.
319
:param filenames: The filenames to find file_ids for
320
:param trees: The trees to find file_ids within
321
:param require_versioned: if true, all specified filenames must occur in
323
:return: a set of file ids for the specified filenames and their children.
327
specified_ids = _find_filename_ids_across_trees(filenames, trees,
329
return _find_children_across_trees(specified_ids, trees)
332
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
333
"""Find the ids corresponding to specified filenames.
335
All matches in all trees will be used.
337
:param filenames: The filenames to find file_ids for
338
:param trees: The trees to find file_ids within
339
:param require_versioned: if true, all specified filenames must occur in
341
:return: a set of file ids for the specified filenames
344
interesting_ids = set()
345
for tree_path in filenames:
348
file_id = tree.inventory.path2id(tree_path)
349
if file_id is not None:
350
interesting_ids.add(file_id)
353
not_versioned.append(tree_path)
354
if len(not_versioned) > 0 and require_versioned:
355
raise errors.PathsNotVersionedError(not_versioned)
356
return interesting_ids
359
def _find_children_across_trees(specified_ids, trees):
360
"""Return a set including specified ids and their children
362
All matches in all trees will be used.
364
:param trees: The trees to find file_ids within
365
:return: a set containing all specified ids and their children
367
interesting_ids = set(specified_ids)
368
pending = interesting_ids
369
# now handle children of interesting ids
370
# we loop so that we handle all children of each id in both trees
371
while len(pending) > 0:
373
for file_id in pending:
375
if file_id not in tree:
377
entry = tree.inventory[file_id]
378
for child in getattr(entry, 'children', {}).itervalues():
379
if child.file_id not in interesting_ids:
380
new_pending.add(child.file_id)
381
interesting_ids.update(new_pending)
382
pending = new_pending
383
return interesting_ids
386
class InterTree(InterObject):
387
"""This class represents operations taking place between two Trees.
389
Its instances have methods like 'compare' and contain references to the
390
source and target trees these operations are to be carried out on.
392
clients of bzrlib should not need to use InterTree directly, rather they
393
should use the convenience methods on Tree such as 'Tree.compare()' which
394
will pass through to InterTree as appropriate.
400
def compare(self, want_unchanged=False, specific_files=None,
401
extra_trees=None, require_versioned=False):
402
"""Return the changes from source to target.
404
:return: A TreeDelta.
405
:param specific_files: An optional list of file paths to restrict the
406
comparison to. When mapping filenames to ids, all matches in all
407
trees (including optional extra_trees) are used, and all children of
408
matched directories are included.
409
:param want_unchanged: An optional boolean requesting the inclusion of
410
unchanged entries in the result.
411
:param extra_trees: An optional list of additional trees to use when
412
mapping the contents of specific_files (paths) to file_ids.
413
:param require_versioned: An optional boolean (defaults to False). When
414
supplied and True all the 'specific_files' must be versioned, or
415
a PathsNotVersionedError will be thrown.
417
# NB: show_status depends on being able to pass in non-versioned files and
418
# report them as unknown
419
trees = (self.source, self.target)
420
if extra_trees is not None:
421
trees = trees + tuple(extra_trees)
422
specific_file_ids = find_ids_across_trees(specific_files,
423
trees, require_versioned=require_versioned)
424
if specific_files and not specific_file_ids:
425
# All files are unversioned, so just return an empty delta
426
# _compare_trees would think we want a complete delta
427
return delta.TreeDelta()
428
return delta._compare_trees(self.source, self.target, want_unchanged,
267
######################################################################
270
def dir_exporter(tree, dest, root):
271
"""Export this tree to a new directory.
273
`dest` should not exist, and will be created holding the
274
contents of this tree.
276
TODO: To handle subdirectories we need to create the
279
:note: If the export fails, the destination directory will be
280
left in a half-assed state.
284
mutter('export version %r' % tree)
286
for dp, ie in inv.iter_entries():
287
ie.put_on_disk(dest, dp, tree)
289
exporters['dir'] = dir_exporter
296
def get_root_name(dest):
297
"""Get just the root name for a tarball.
299
>>> get_root_name('mytar.tar')
301
>>> get_root_name('mytar.tar.bz2')
303
>>> get_root_name('tar.tar.tar.tgz')
305
>>> get_root_name('bzr-0.0.5.tar.gz')
307
>>> get_root_name('a/long/path/mytar.tgz')
309
>>> get_root_name('../parent/../dir/other.tbz2')
312
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
313
dest = os.path.basename(dest)
315
if dest.endswith(end):
316
return dest[:-len(end)]
318
def tar_exporter(tree, dest, root, compression=None):
319
"""Export this tree to a new tar file.
321
`dest` will be created holding the contents of this tree; if it
322
already exists, it will be clobbered, like with "tar -c".
324
from time import time
326
compression = str(compression or '')
328
root = get_root_name(dest)
330
ball = tarfile.open(dest, 'w:' + compression)
331
except tarfile.CompressionError, e:
332
raise BzrError(str(e))
333
mutter('export version %r' % tree)
335
for dp, ie in inv.iter_entries():
336
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
337
item, fileobj = ie.get_tar_item(root, dp, now, tree)
338
ball.addfile(item, fileobj)
341
exporters['tar'] = tar_exporter
343
def tgz_exporter(tree, dest, root):
344
tar_exporter(tree, dest, root, compression='gz')
345
exporters['tgz'] = tgz_exporter
347
def tbz_exporter(tree, dest, root):
348
tar_exporter(tree, dest, root, compression='bz2')
349
exporters['tbz2'] = tbz_exporter
added
removed
bzrlib/tree.py
