53
56
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
59
def has_filename(self, filename):
103
60
"""True if the tree has given filename."""
104
61
raise NotImplementedError()
109
66
__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
68
def __iter__(self):
117
69
return iter(self.inventory)
119
71
def id2path(self, file_id):
120
72
return self.inventory.id2path(file_id)
122
def iter_entries_by_dir(self):
123
"""Walk the tree in 'by_dir' order.
125
This will yield each entry in the tree as a (path, entry) tuple. The
126
order that they are yielded is: the contents of a directory are
127
preceeded by the parent of a directory, and all the contents of a
128
directory are grouped together.
130
return self.inventory.iter_entries_by_dir()
132
def kind(self, file_id):
133
raise NotImplementedError("subclasses must implement kind")
135
74
def _get_inventory(self):
136
75
return self._inventory
138
def get_file_by_path(self, path):
139
return self.get_file(self._inventory.path2id(path))
141
77
inventory = property(_get_inventory,
142
78
doc="Inventory of this Tree")
144
80
def _check_retrieved(self, ie, f):
147
81
fp = fingerprint_file(f)
150
if ie.text_size is not None:
84
if ie.text_size != None:
151
85
if ie.text_size != fp['size']:
152
86
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
153
87
["inventory expects %d bytes" % ie.text_size,
161
95
"store is probably damaged/corrupt"])
164
def print_file(self, file_id):
165
"""Print file with id `file_id` to stdout."""
98
def print_file(self, fileid):
99
"""Print file with id `fileid` to stdout."""
167
sys.stdout.write(self.get_file_text(file_id))
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
101
pumpfile(self.get_file(fileid), sys.stdout)
104
def export(self, dest, format='dir'):
105
"""Export this tree."""
107
exporter = exporters[format]
109
raise BzrCommandError("export format %r not supported" % format)
114
class RevisionTree(Tree):
115
"""Tree viewing a previous revision.
117
File text can be retrieved from the text store.
119
TODO: Some kind of `__repr__` method, but a good one
120
probably means knowing the branch and revision number,
121
or at least passing a description to the constructor.
124
def __init__(self, store, inv):
126
self._inventory = inv
128
def get_file(self, file_id):
129
ie = self._inventory[file_id]
130
f = self._store[ie.text_id]
131
mutter(" get fileid{%s} from %r" % (file_id, self))
132
self._check_retrieved(ie, f)
135
def get_file_size(self, file_id):
136
return self._inventory[file_id].text_size
138
def get_file_sha1(self, file_id):
139
ie = self._inventory[file_id]
142
def has_filename(self, filename):
143
return bool(self.inventory.path2id(filename))
145
def list_files(self):
146
# The only files returned by this are those from the version
147
for path, entry in self.inventory.iter_entries():
148
yield path, 'V', entry.kind, entry.file_id
198
151
class EmptyTree(Tree):
200
152
def __init__(self):
201
153
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):
209
def get_symlink_target(self, file_id):
212
155
def has_filename(self, filename):
215
def kind(self, file_id):
216
assert self._inventory[file_id].kind == "directory"
219
158
def list_files(self):
159
if False: # just to make it a generator
222
def __contains__(self, file_id):
223
return (file_id in self._inventory)
225
def get_file_sha1(self, file_id, path=None):
229
164
######################################################################
291
226
yield (old_name, new_name)
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.
230
######################################################################
233
def dir_exporter(tree, dest):
234
"""Export this tree to a new directory.
236
`dest` should not exist, and will be created holding the
237
contents of this tree.
239
TODO: To handle subdirectories we need to create the
242
:note: If the export fails, the destination directory will be
243
left in a half-assed state.
246
mutter('export version %r' % tree)
248
for dp, ie in inv.iter_entries():
250
fullpath = appendpath(dest, dp)
251
if kind == 'directory':
254
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
256
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
257
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
258
exporters['dir'] = dir_exporter
265
def tar_exporter(tree, dest, compression=None):
266
"""Export this tree to a new tar file.
268
`dest` will be created holding the contents of this tree; if it
269
already exists, it will be clobbered, like with "tar -c".
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,
272
compression = str(compression or '')
274
ball = tarfile.open(dest, 'w:' + compression)
275
except tarfile.CompressionError, e:
276
raise BzrError(str(e))
277
mutter('export version %r' % tree)
279
for dp, ie in inv.iter_entries():
280
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
281
item = tarfile.TarInfo(dp)
282
# TODO: would be cool to actually set it to the timestamp of the
283
# revision it was last changed
285
if ie.kind == 'directory':
286
item.type = tarfile.DIRTYPE
291
elif ie.kind == 'file':
292
item.type = tarfile.REGTYPE
293
fileobj = tree.get_file(ie.file_id)
294
item.size = _find_file_size(fileobj)
297
raise BzrError("don't know how to export {%s} of kind %r" %
298
(ie.file_id, ie.kind))
300
ball.addfile(item, fileobj)
302
exporters['tar'] = tar_exporter
304
def tgz_exporter(tree, dest):
305
tar_exporter(tree, dest, compression='gz')
306
exporters['tgz'] = tgz_exporter
308
def tbz_exporter(tree, dest):
309
tar_exporter(tree, dest, compression='bz2')
310
exporters['tbz2'] = tbz_exporter
313
def _find_file_size(fileobj):
314
offset = fileobj.tell()
317
size = fileobj.tell()
319
# gzip doesn't accept second argument to seek()
323
nread = len(fileobj.read())
added
removed
bzrlib/tree.py
