50
53
trees or versioned trees.
56
def changes_from(self, other, want_unchanged=False, specific_files=None,
57
extra_trees=None, require_versioned=False, include_root=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,
84
include_root=include_root
88
"""Get a list of the conflicts in the tree.
90
Each conflict is an instance of bzrlib.conflicts.Conflict.
94
def get_parent_ids(self):
95
"""Get the parent ids for this tree.
97
:return: a list of parent ids. [] is returned to indicate
98
a tree with no parents.
99
:raises: BzrError if the parents are not known.
101
raise NotImplementedError(self.get_parent_ids)
53
103
def has_filename(self, filename):
54
104
"""True if the tree has given filename."""
55
105
raise NotImplementedError()
60
110
__contains__ = has_id
112
def has_or_had_id(self, file_id):
113
if file_id == self.inventory.root.file_id:
115
return self.inventory.has_id(file_id)
62
117
def __iter__(self):
63
118
return iter(self.inventory)
65
120
def id2path(self, file_id):
66
121
return self.inventory.id2path(file_id)
123
def is_control_filename(self, filename):
124
"""True if filename is the name of a control file in this tree.
126
:param filename: A filename within the tree. This is a relative path
127
from the root of this tree.
129
This is true IF and ONLY IF the filename is part of the meta data
130
that bzr controls in this tree. I.E. a random .bzr directory placed
131
on disk will not be a control file for this tree.
133
return self.bzrdir.is_control_filename(filename)
135
def iter_entries_by_dir(self):
136
"""Walk the tree in 'by_dir' order.
138
This will yield each entry in the tree as a (path, entry) tuple. The
139
order that they are yielded is: the contents of a directory are
140
preceeded by the parent of a directory, and all the contents of a
141
directory are grouped together.
143
return self.inventory.iter_entries_by_dir()
145
def kind(self, file_id):
146
raise NotImplementedError("subclasses must implement kind")
68
148
def _get_inventory(self):
69
149
return self._inventory
151
def get_file(self, file_id):
152
"""Return a file object for the file file_id in the tree."""
153
raise NotImplementedError(self.get_file)
71
155
def get_file_by_path(self, path):
72
156
return self.get_file(self._inventory.path2id(path))
91
177
"file is actually %s" % fp['sha1'],
92
178
"store is probably damaged/corrupt"])
180
def path2id(self, path):
181
"""Return the id for path in this tree."""
182
return self._inventory.path2id(path)
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
184
def print_file(self, file_id):
185
"""Print file with id `file_id` to stdout."""
98
pumpfile(self.get_file(fileid), sys.stdout)
101
def export(self, dest, format='dir', root=None):
102
"""Export this tree."""
104
exporter = exporters[format]
106
from bzrlib.errors import BzrCommandError
107
raise BzrCommandError("export format %r not supported" % format)
108
exporter(self, dest, root)
112
class RevisionTree(Tree):
113
"""Tree viewing a previous revision.
115
File text can be retrieved from the text store.
117
TODO: Some kind of `__repr__` method, but a good one
118
probably means knowing the branch and revision number,
119
or at least passing a description to the constructor.
122
def __init__(self, store, inv):
124
self._inventory = inv
126
def get_file(self, file_id):
127
ie = self._inventory[file_id]
128
f = self._store[ie.text_id]
129
mutter(" get fileid{%s} from %r" % (file_id, self))
130
self._check_retrieved(ie, f)
133
def get_file_size(self, file_id):
134
return self._inventory[file_id].text_size
136
def get_file_sha1(self, file_id):
137
ie = self._inventory[file_id]
140
def has_filename(self, filename):
141
return bool(self.inventory.path2id(filename))
143
def list_files(self):
144
# The only files returned by this are those from the version
145
for path, entry in self.inventory.iter_entries():
146
yield path, 'V', entry.kind, entry.file_id
187
sys.stdout.write(self.get_file_text(file_id))
193
"""What files are present in this tree and unknown.
195
:return: an iterator over the unknown files.
202
def filter_unversioned_files(self, paths):
203
"""Filter out paths that are not versioned.
205
:return: set of paths.
207
# NB: we specifically *don't* call self.has_filename, because for
208
# WorkingTrees that can indicate files that exist on disk but that
210
pred = self.inventory.has_filename
211
return set((p for p in paths if not pred(p)))
215
from bzrlib.revisiontree import RevisionTree
149
218
class EmptyTree(Tree):
150
220
def __init__(self):
151
221
self._inventory = Inventory()
222
warn('EmptyTree is deprecated as of bzr 0.9 please use '
223
'repository.revision_tree instead.',
224
DeprecationWarning, stacklevel=2)
226
def get_parent_ids(self):
229
def get_symlink_target(self, file_id):
153
232
def has_filename(self, filename):
235
def kind(self, file_id):
236
assert self._inventory[file_id].kind == "directory"
156
239
def list_files(self):
157
if False: # just to make it a generator
242
def __contains__(self, file_id):
243
return (file_id in self._inventory)
245
def get_file_sha1(self, file_id, path=None):
162
249
######################################################################
224
311
yield (old_name, new_name)
228
######################################################################
231
def dir_exporter(tree, dest, root):
232
"""Export this tree to a new directory.
234
`dest` should not exist, and will be created holding the
235
contents of this tree.
237
TODO: To handle subdirectories we need to create the
240
:note: If the export fails, the destination directory will be
241
left in a half-assed state.
245
mutter('export version %r' % tree)
247
for dp, ie in inv.iter_entries():
249
fullpath = appendpath(dest, dp)
250
if kind == 'directory':
253
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
255
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
256
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
257
exporters['dir'] = dir_exporter
264
def get_root_name(dest):
265
"""Get just the root name for a tarball.
267
>>> get_root_name('mytar.tar')
269
>>> get_root_name('mytar.tar.bz2')
271
>>> get_root_name('tar.tar.tar.tgz')
273
>>> get_root_name('bzr-0.0.5.tar.gz')
275
>>> get_root_name('a/long/path/mytar.tgz')
277
>>> get_root_name('../parent/../dir/other.tbz2')
280
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
281
dest = os.path.basename(dest)
283
if dest.endswith(end):
284
return dest[:-len(end)]
286
def tar_exporter(tree, dest, root, compression=None):
287
"""Export this tree to a new tar file.
289
`dest` will be created holding the contents of this tree; if it
290
already exists, it will be clobbered, like with "tar -c".
292
from time import time
294
compression = str(compression or '')
296
root = get_root_name(dest)
298
ball = tarfile.open(dest, 'w:' + compression)
299
except tarfile.CompressionError, e:
300
raise BzrError(str(e))
301
mutter('export version %r' % tree)
303
for dp, ie in inv.iter_entries():
304
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
305
item = tarfile.TarInfo(os.path.join(root, dp))
306
# TODO: would be cool to actually set it to the timestamp of the
307
# revision it was last changed
309
if ie.kind == 'directory':
310
item.type = tarfile.DIRTYPE
315
elif ie.kind == 'file':
316
item.type = tarfile.REGTYPE
317
fileobj = tree.get_file(ie.file_id)
318
item.size = _find_file_size(fileobj)
321
raise BzrError("don't know how to export {%s} of kind %r" %
322
(ie.file_id, ie.kind))
324
ball.addfile(item, fileobj)
326
exporters['tar'] = tar_exporter
328
def tgz_exporter(tree, dest, root):
329
tar_exporter(tree, dest, root, compression='gz')
330
exporters['tgz'] = tgz_exporter
332
def tbz_exporter(tree, dest, root):
333
tar_exporter(tree, dest, root, compression='bz2')
334
exporters['tbz2'] = tbz_exporter
337
def _find_file_size(fileobj):
338
offset = fileobj.tell()
341
size = fileobj.tell()
343
# gzip doesn't accept second argument to seek()
347
nread = len(fileobj.read())
314
def find_ids_across_trees(filenames, trees, require_versioned=True):
315
"""Find the ids corresponding to specified filenames.
317
All matches in all trees will be used, and all children of matched
318
directories will be used.
320
:param filenames: The filenames to find file_ids for
321
:param trees: The trees to find file_ids within
322
:param require_versioned: if true, all specified filenames must occur in
324
:return: a set of file ids for the specified filenames and their children.
328
specified_ids = _find_filename_ids_across_trees(filenames, trees,
330
return _find_children_across_trees(specified_ids, trees)
333
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
334
"""Find the ids corresponding to specified filenames.
336
All matches in all trees will be used.
338
:param filenames: The filenames to find file_ids for
339
:param trees: The trees to find file_ids within
340
:param require_versioned: if true, all specified filenames must occur in
342
:return: a set of file ids for the specified filenames
345
interesting_ids = set()
346
for tree_path in filenames:
349
file_id = tree.inventory.path2id(tree_path)
350
if file_id is not None:
351
interesting_ids.add(file_id)
354
not_versioned.append(tree_path)
355
if len(not_versioned) > 0 and require_versioned:
356
raise errors.PathsNotVersionedError(not_versioned)
357
return interesting_ids
360
def _find_children_across_trees(specified_ids, trees):
361
"""Return a set including specified ids and their children
363
All matches in all trees will be used.
365
:param trees: The trees to find file_ids within
366
:return: a set containing all specified ids and their children
368
interesting_ids = set(specified_ids)
369
pending = interesting_ids
370
# now handle children of interesting ids
371
# we loop so that we handle all children of each id in both trees
372
while len(pending) > 0:
374
for file_id in pending:
376
if file_id not in tree:
378
entry = tree.inventory[file_id]
379
for child in getattr(entry, 'children', {}).itervalues():
380
if child.file_id not in interesting_ids:
381
new_pending.add(child.file_id)
382
interesting_ids.update(new_pending)
383
pending = new_pending
384
return interesting_ids
387
class InterTree(InterObject):
388
"""This class represents operations taking place between two Trees.
390
Its instances have methods like 'compare' and contain references to the
391
source and target trees these operations are to be carried out on.
393
clients of bzrlib should not need to use InterTree directly, rather they
394
should use the convenience methods on Tree such as 'Tree.compare()' which
395
will pass through to InterTree as appropriate.
401
def compare(self, want_unchanged=False, specific_files=None,
402
extra_trees=None, require_versioned=False, include_root=False):
403
"""Return the changes from source to target.
405
:return: A TreeDelta.
406
:param specific_files: An optional list of file paths to restrict the
407
comparison to. When mapping filenames to ids, all matches in all
408
trees (including optional extra_trees) are used, and all children of
409
matched directories are included.
410
:param want_unchanged: An optional boolean requesting the inclusion of
411
unchanged entries in the result.
412
:param extra_trees: An optional list of additional trees to use when
413
mapping the contents of specific_files (paths) to file_ids.
414
:param require_versioned: An optional boolean (defaults to False). When
415
supplied and True all the 'specific_files' must be versioned, or
416
a PathsNotVersionedError will be thrown.
418
# NB: show_status depends on being able to pass in non-versioned files and
419
# report them as unknown
420
trees = (self.source, self.target)
421
if extra_trees is not None:
422
trees = trees + tuple(extra_trees)
423
specific_file_ids = find_ids_across_trees(specific_files,
424
trees, require_versioned=require_versioned)
425
if specific_files and not specific_file_ids:
426
# All files are unversioned, so just return an empty delta
427
# _compare_trees would think we want a complete delta
428
return delta.TreeDelta()
429
return delta._compare_trees(self.source, self.target, want_unchanged,
430
specific_file_ids, include_root)
added
removed
bzrlib/tree.py
