55
50
trees or versioned trees.
58
def changes_from(self, other, want_unchanged=False, specific_files=None,
59
extra_trees=None, require_versioned=False, include_root=False):
60
"""Return a TreeDelta of the changes from other to this tree.
62
:param other: A tree to compare with.
63
:param specific_files: An optional list of file paths to restrict the
64
comparison to. When mapping filenames to ids, all matches in all
65
trees (including optional extra_trees) are used, and all children of
66
matched directories are included.
67
:param want_unchanged: An optional boolean requesting the inclusion of
68
unchanged entries in the result.
69
:param extra_trees: An optional list of additional trees to use when
70
mapping the contents of specific_files (paths) to file_ids.
71
:param require_versioned: An optional boolean (defaults to False). When
72
supplied and True all the 'specific_files' must be versioned, or
73
a PathsNotVersionedError will be thrown.
75
The comparison will be performed by an InterTree object looked up on
78
# Martin observes that Tree.changes_from returns a TreeDelta and this
79
# may confuse people, because the class name of the returned object is
80
# a synonym of the object referenced in the method name.
81
return InterTree.get(other, self).compare(
82
want_unchanged=want_unchanged,
83
specific_files=specific_files,
84
extra_trees=extra_trees,
85
require_versioned=require_versioned,
86
include_root=include_root
90
"""Get a list of the conflicts in the tree.
92
Each conflict is an instance of bzrlib.conflicts.Conflict.
96
def get_parent_ids(self):
97
"""Get the parent ids for this tree.
99
:return: a list of parent ids. [] is returned to indicate
100
a tree with no parents.
101
:raises: BzrError if the parents are not known.
103
raise NotImplementedError(self.get_parent_ids)
105
53
def has_filename(self, filename):
106
54
"""True if the tree has given filename."""
107
55
raise NotImplementedError()
112
60
__contains__ = has_id
114
def has_or_had_id(self, file_id):
115
if file_id == self.inventory.root.file_id:
117
return self.inventory.has_id(file_id)
119
62
def __iter__(self):
120
63
return iter(self.inventory)
122
65
def id2path(self, file_id):
123
66
return self.inventory.id2path(file_id)
125
def is_control_filename(self, filename):
126
"""True if filename is the name of a control file in this tree.
128
:param filename: A filename within the tree. This is a relative path
129
from the root of this tree.
131
This is true IF and ONLY IF the filename is part of the meta data
132
that bzr controls in this tree. I.E. a random .bzr directory placed
133
on disk will not be a control file for this tree.
135
return self.bzrdir.is_control_filename(filename)
137
def iter_entries_by_dir(self):
138
"""Walk the tree in 'by_dir' order.
140
This will yield each entry in the tree as a (path, entry) tuple. The
141
order that they are yielded is: the contents of a directory are
142
preceeded by the parent of a directory, and all the contents of a
143
directory are grouped together.
145
return self.inventory.iter_entries_by_dir()
147
def kind(self, file_id):
148
raise NotImplementedError("subclasses must implement kind")
150
68
def _get_inventory(self):
151
69
return self._inventory
153
def get_file(self, file_id):
154
"""Return a file object for the file file_id in the tree."""
155
raise NotImplementedError(self.get_file)
157
71
def get_file_by_path(self, path):
158
72
return self.get_file(self._inventory.path2id(path))
179
91
"file is actually %s" % fp['sha1'],
180
92
"store is probably damaged/corrupt"])
182
def path2id(self, path):
183
"""Return the id for path in this tree."""
184
return self._inventory.path2id(path)
186
def print_file(self, file_id):
187
"""Print file with id `file_id` to stdout."""
95
def print_file(self, fileid):
96
"""Print file with id `fileid` to stdout."""
189
sys.stdout.write(self.get_file_text(file_id))
195
"""What files are present in this tree and unknown.
197
:return: an iterator over the unknown files.
204
def filter_unversioned_files(self, paths):
205
"""Filter out paths that are not versioned.
207
:return: set of paths.
209
# NB: we specifically *don't* call self.has_filename, because for
210
# WorkingTrees that can indicate files that exist on disk but that
212
pred = self.inventory.has_filename
213
return set((p for p in paths if not pred(p)))
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
216
150
class EmptyTree(Tree):
218
151
def __init__(self):
219
self._inventory = Inventory(root_id=None)
220
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
221
' use repository.revision_tree instead.',
222
DeprecationWarning, stacklevel=2)
224
def get_parent_ids(self):
227
def get_symlink_target(self, file_id):
152
self._inventory = Inventory()
230
154
def has_filename(self, filename):
233
def kind(self, file_id):
234
assert self._inventory[file_id].kind == "directory"
237
def list_files(self, include_root=False):
157
def list_files(self):
158
if False: # just to make it a generator
240
161
def __contains__(self, file_id):
241
return (file_id in self._inventory)
162
return file_id in self._inventory
243
def get_file_sha1(self, file_id, path=None):
164
def get_file_sha1(self, file_id):
165
assert self._inventory[file_id].kind == "root_directory"
247
171
######################################################################
309
233
yield (old_name, new_name)
312
def find_ids_across_trees(filenames, trees, require_versioned=True):
313
"""Find the ids corresponding to specified filenames.
315
All matches in all trees will be used, and all children of matched
316
directories 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 and their children.
326
specified_ids = _find_filename_ids_across_trees(filenames, trees,
328
return _find_children_across_trees(specified_ids, trees)
331
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
332
"""Find the ids corresponding to specified filenames.
334
All matches in all trees will be used.
336
:param filenames: The filenames to find file_ids for
337
:param trees: The trees to find file_ids within
338
:param require_versioned: if true, all specified filenames must occur in
340
:return: a set of file ids for the specified filenames
343
interesting_ids = set()
344
for tree_path in filenames:
347
file_id = tree.inventory.path2id(tree_path)
348
if file_id is not None:
349
interesting_ids.add(file_id)
352
not_versioned.append(tree_path)
353
if len(not_versioned) > 0 and require_versioned:
354
raise errors.PathsNotVersionedError(not_versioned)
355
return interesting_ids
358
def _find_children_across_trees(specified_ids, trees):
359
"""Return a set including specified ids and their children
361
All matches in all trees will be used.
363
:param trees: The trees to find file_ids within
364
:return: a set containing all specified ids and their children
366
interesting_ids = set(specified_ids)
367
pending = interesting_ids
368
# now handle children of interesting ids
369
# we loop so that we handle all children of each id in both trees
370
while len(pending) > 0:
372
for file_id in pending:
374
if file_id not in tree:
376
entry = tree.inventory[file_id]
377
for child in getattr(entry, 'children', {}).itervalues():
378
if child.file_id not in interesting_ids:
379
new_pending.add(child.file_id)
380
interesting_ids.update(new_pending)
381
pending = new_pending
382
return interesting_ids
385
class InterTree(InterObject):
386
"""This class represents operations taking place between two Trees.
388
Its instances have methods like 'compare' and contain references to the
389
source and target trees these operations are to be carried out on.
391
clients of bzrlib should not need to use InterTree directly, rather they
392
should use the convenience methods on Tree such as 'Tree.compare()' which
393
will pass through to InterTree as appropriate.
399
def compare(self, want_unchanged=False, specific_files=None,
400
extra_trees=None, require_versioned=False, include_root=False):
401
"""Return the changes from source to target.
403
:return: A TreeDelta.
404
:param specific_files: An optional list of file paths to restrict the
405
comparison to. When mapping filenames to ids, all matches in all
406
trees (including optional extra_trees) are used, and all children of
407
matched directories are included.
408
:param want_unchanged: An optional boolean requesting the inclusion of
409
unchanged entries in the result.
410
:param extra_trees: An optional list of additional trees to use when
411
mapping the contents of specific_files (paths) to file_ids.
412
:param require_versioned: An optional boolean (defaults to False). When
413
supplied and True all the 'specific_files' must be versioned, or
414
a PathsNotVersionedError will be thrown.
416
# NB: show_status depends on being able to pass in non-versioned files and
417
# report them as unknown
418
trees = (self.source, self.target)
419
if extra_trees is not None:
420
trees = trees + tuple(extra_trees)
421
specific_file_ids = find_ids_across_trees(specific_files,
422
trees, require_versioned=require_versioned)
423
if specific_files and not specific_file_ids:
424
# All files are unversioned, so just return an empty delta
425
# _compare_trees would think we want a complete delta
426
return delta.TreeDelta()
427
return delta._compare_trees(self.source, self.target, want_unchanged,
428
specific_file_ids, include_root)
431
# This was deprecated before 0.12, but did not have an official warning
432
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
433
def RevisionTree(*args, **kwargs):
434
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
436
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
439
from bzrlib.revisiontree import RevisionTree as _RevisionTree
440
return _RevisionTree(*args, **kwargs)
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())
added
removed
bzrlib/tree.py
