50
51
trees or versioned trees.
54
def changes_from(self, other, want_unchanged=False, specific_files=None,
55
extra_trees=None, require_versioned=False):
56
"""Return a TreeDelta of the changes from other to this tree.
58
:param other: A tree to compare with.
59
:param specific_files: An optional list of file paths to restrict the
60
comparison to. When mapping filenames to ids, all matches in all
61
trees (including optional extra_trees) are used, and all children of
62
matched directories are included.
63
:param want_unchanged: An optional boolean requesting the inclusion of
64
unchanged entries in the result.
65
:param extra_trees: An optional list of additional trees to use when
66
mapping the contents of specific_files (paths) to file_ids.
67
:param require_versioned: An optional boolean (defaults to False). When
68
supplied and True all the 'specific_files' must be versioned, or
69
a PathsNotVersionedError will be thrown.
71
The comparison will be performed by an InterTree object looked up on
74
# Martin observes that Tree.changes_from returns a TreeDelta and this
75
# may confuse people, because the class name of the returned object is
76
# a synonym of the object referenced in the method name.
77
return InterTree.get(other, self).compare(
78
want_unchanged=want_unchanged,
79
specific_files=specific_files,
80
extra_trees=extra_trees,
81
require_versioned=require_versioned,
85
"""Get a list of the conflicts in the tree.
87
Each conflict is an instance of bzrlib.conflicts.Conflict.
91
def get_parent_ids(self):
92
"""Get the parent ids for this tree.
94
:return: a list of parent ids. [] is returned to indicate
95
a tree with no parents.
96
:raises: BzrError if the parents are not known.
98
raise NotImplementedError(self.get_parent_ids)
53
100
def has_filename(self, filename):
54
101
"""True if the tree has given filename."""
55
102
raise NotImplementedError()
92
159
"store is probably damaged/corrupt"])
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
162
def print_file(self, file_id):
163
"""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
165
sys.stdout.write(self.get_file_text(file_id))
171
"""What files are present in this tree and unknown.
173
:return: an iterator over the unknown files.
180
def filter_unversioned_files(self, paths):
181
"""Filter out paths that are not versioned.
183
:return: set of paths.
185
# NB: we specifically *don't* call self.has_filename, because for
186
# WorkingTrees that can indicate files that exist on disk but that
188
pred = self.inventory.has_filename
189
return set((p for p in paths if not pred(p)))
193
from bzrlib.revisiontree import RevisionTree
149
196
class EmptyTree(Tree):
150
198
def __init__(self):
151
199
self._inventory = Inventory()
200
warn('EmptyTree is deprecated as of bzr 0.9 please use '
201
'repository.revision_tree instead.',
202
DeprecationWarning, stacklevel=2)
204
def get_parent_ids(self):
207
def get_symlink_target(self, file_id):
153
210
def has_filename(self, filename):
213
def kind(self, file_id):
214
assert self._inventory[file_id].kind == "root_directory"
215
return "root_directory"
156
217
def list_files(self):
157
if False: # just to make it a generator
220
def __contains__(self, file_id):
221
return file_id in self._inventory
223
def get_file_sha1(self, file_id, path=None):
224
assert self._inventory[file_id].kind == "root_directory"
162
228
######################################################################
224
290
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())
293
def find_ids_across_trees(filenames, trees, require_versioned=True):
294
"""Find the ids corresponding to specified filenames.
296
All matches in all trees will be used, and all children of matched
297
directories will be used.
299
:param filenames: The filenames to find file_ids for
300
:param trees: The trees to find file_ids within
301
:param require_versioned: if true, all specified filenames must occur in
303
:return: a set of file ids for the specified filenames and their children.
307
specified_ids = _find_filename_ids_across_trees(filenames, trees,
309
return _find_children_across_trees(specified_ids, trees)
312
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
313
"""Find the ids corresponding to specified filenames.
315
All matches in all trees will be used.
317
:param filenames: The filenames to find file_ids for
318
:param trees: The trees to find file_ids within
319
:param require_versioned: if true, all specified filenames must occur in
321
:return: a set of file ids for the specified filenames
324
interesting_ids = set()
325
for tree_path in filenames:
328
file_id = tree.inventory.path2id(tree_path)
329
if file_id is not None:
330
interesting_ids.add(file_id)
333
not_versioned.append(tree_path)
334
if len(not_versioned) > 0 and require_versioned:
335
raise errors.PathsNotVersionedError(not_versioned)
336
return interesting_ids
339
def _find_children_across_trees(specified_ids, trees):
340
"""Return a set including specified ids and their children
342
All matches in all trees will be used.
344
:param trees: The trees to find file_ids within
345
:return: a set containing all specified ids and their children
347
interesting_ids = set(specified_ids)
348
pending = interesting_ids
349
# now handle children of interesting ids
350
# we loop so that we handle all children of each id in both trees
351
while len(pending) > 0:
353
for file_id in pending:
355
if file_id not in tree:
357
entry = tree.inventory[file_id]
358
for child in getattr(entry, 'children', {}).itervalues():
359
if child.file_id not in interesting_ids:
360
new_pending.add(child.file_id)
361
interesting_ids.update(new_pending)
362
pending = new_pending
363
return interesting_ids
366
class InterTree(InterObject):
367
"""This class represents operations taking place between two Trees.
369
Its instances have methods like 'compare' and contain references to the
370
source and target trees these operations are to be carried out on.
372
clients of bzrlib should not need to use InterTree directly, rather they
373
should use the convenience methods on Tree such as 'Tree.compare()' which
374
will pass through to InterTree as appropriate.
379
def compare(self, want_unchanged=False, specific_files=None,
380
extra_trees=None, require_versioned=False):
381
"""Return the changes from source to target.
383
:return: A TreeDelta.
384
:param specific_files: An optional list of file paths to restrict the
385
comparison to. When mapping filenames to ids, all matches in all
386
trees (including optional extra_trees) are used, and all children of
387
matched directories are included.
388
:param want_unchanged: An optional boolean requesting the inclusion of
389
unchanged entries in the result.
390
:param extra_trees: An optional list of additional trees to use when
391
mapping the contents of specific_files (paths) to file_ids.
392
:param require_versioned: An optional boolean (defaults to False). When
393
supplied and True all the 'specific_files' must be versioned, or
394
a PathsNotVersionedError will be thrown.
396
# imported later to avoid circular imports
397
from bzrlib.delta import compare_trees
398
return compare_trees(
401
want_unchanged=want_unchanged,
402
specific_files=specific_files,
403
extra_trees=extra_trees,
404
require_versioned=require_versioned,
added
removed
bzrlib/tree.py
