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):
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)
53
102
def has_filename(self, filename):
54
103
"""True if the tree has given filename."""
55
104
raise NotImplementedError()
60
109
__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)
62
116
def __iter__(self):
63
117
return iter(self.inventory)
65
119
def id2path(self, file_id):
66
120
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")
68
147
def _get_inventory(self):
69
148
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)
71
154
def get_file_by_path(self, path):
72
155
return self.get_file(self._inventory.path2id(path))
91
176
"file is actually %s" % fp['sha1'],
92
177
"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)
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
183
def print_file(self, file_id):
184
"""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]
138
if ie.kind == "file":
141
def has_filename(self, filename):
142
return bool(self.inventory.path2id(filename))
144
def list_files(self):
145
# The only files returned by this are those from the version
146
for path, entry in self.inventory.iter_entries():
147
yield path, 'V', entry.kind, entry.file_id
186
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
150
217
class EmptyTree(Tree):
151
219
def __init__(self):
152
220
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
def get_symlink_target(self, file_id):
154
231
def has_filename(self, filename):
234
def kind(self, file_id):
235
assert self._inventory[file_id].kind == "directory"
157
238
def list_files(self):
158
if False: # just to make it a generator
161
241
def __contains__(self, file_id):
162
return file_id in self._inventory
242
return (file_id in self._inventory)
164
def get_file_sha1(self, file_id):
165
assert self._inventory[file_id].kind == "root_directory"
244
def get_file_sha1(self, file_id, path=None):
171
248
######################################################################
233
310
yield (old_name, new_name)
237
######################################################################
240
def dir_exporter(tree, dest, root):
241
"""Export this tree to a new directory.
243
`dest` should not exist, and will be created holding the
244
contents of this tree.
246
TODO: To handle subdirectories we need to create the
249
:note: If the export fails, the destination directory will be
250
left in a half-assed state.
254
mutter('export version %r' % tree)
256
for dp, ie in inv.iter_entries():
258
fullpath = appendpath(dest, dp)
259
if kind == 'directory':
262
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
264
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
265
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
266
exporters['dir'] = dir_exporter
273
def get_root_name(dest):
274
"""Get just the root name for a tarball.
276
>>> get_root_name('mytar.tar')
278
>>> get_root_name('mytar.tar.bz2')
280
>>> get_root_name('tar.tar.tar.tgz')
282
>>> get_root_name('bzr-0.0.5.tar.gz')
284
>>> get_root_name('a/long/path/mytar.tgz')
286
>>> get_root_name('../parent/../dir/other.tbz2')
289
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
290
dest = os.path.basename(dest)
292
if dest.endswith(end):
293
return dest[:-len(end)]
295
def tar_exporter(tree, dest, root, compression=None):
296
"""Export this tree to a new tar file.
298
`dest` will be created holding the contents of this tree; if it
299
already exists, it will be clobbered, like with "tar -c".
301
from time import time
303
compression = str(compression or '')
305
root = get_root_name(dest)
307
ball = tarfile.open(dest, 'w:' + compression)
308
except tarfile.CompressionError, e:
309
raise BzrError(str(e))
310
mutter('export version %r' % tree)
312
for dp, ie in inv.iter_entries():
313
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
314
item = tarfile.TarInfo(os.path.join(root, dp))
315
# TODO: would be cool to actually set it to the timestamp of the
316
# revision it was last changed
318
if ie.kind == 'directory':
319
item.type = tarfile.DIRTYPE
324
elif ie.kind == 'file':
325
item.type = tarfile.REGTYPE
326
fileobj = tree.get_file(ie.file_id)
327
item.size = _find_file_size(fileobj)
330
raise BzrError("don't know how to export {%s} of kind %r" %
331
(ie.file_id, ie.kind))
333
ball.addfile(item, fileobj)
335
exporters['tar'] = tar_exporter
337
def tgz_exporter(tree, dest, root):
338
tar_exporter(tree, dest, root, compression='gz')
339
exporters['tgz'] = tgz_exporter
341
def tbz_exporter(tree, dest, root):
342
tar_exporter(tree, dest, root, compression='bz2')
343
exporters['tbz2'] = tbz_exporter
346
def _find_file_size(fileobj):
347
offset = fileobj.tell()
350
size = fileobj.tell()
352
# gzip doesn't accept second argument to seek()
356
nread = len(fileobj.read())
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,
added
removed
bzrlib/tree.py
