51
56
trees or versioned trees.
59
def changes_from(self, other, want_unchanged=False, specific_files=None,
60
extra_trees=None, require_versioned=False, include_root=False):
61
"""Return a TreeDelta of the changes from other to this tree.
63
:param other: A tree to compare with.
64
:param specific_files: An optional list of file paths to restrict the
65
comparison to. When mapping filenames to ids, all matches in all
66
trees (including optional extra_trees) are used, and all children of
67
matched directories are included.
68
:param want_unchanged: An optional boolean requesting the inclusion of
69
unchanged entries in the result.
70
:param extra_trees: An optional list of additional trees to use when
71
mapping the contents of specific_files (paths) to file_ids.
72
:param require_versioned: An optional boolean (defaults to False). When
73
supplied and True all the 'specific_files' must be versioned, or
74
a PathsNotVersionedError will be thrown.
76
The comparison will be performed by an InterTree object looked up on
79
# Martin observes that Tree.changes_from returns a TreeDelta and this
80
# may confuse people, because the class name of the returned object is
81
# a synonym of the object referenced in the method name.
82
return InterTree.get(other, self).compare(
83
want_unchanged=want_unchanged,
84
specific_files=specific_files,
85
extra_trees=extra_trees,
86
require_versioned=require_versioned,
87
include_root=include_root
90
def _iter_changes(self, from_tree, include_unchanged=False,
91
specific_file_ids=None, pb=None):
92
intertree = InterTree.get(from_tree, self)
93
return intertree._iter_changes(from_tree, self, include_unchanged,
94
specific_file_ids, pb)
97
"""Get a list of the conflicts in the tree.
99
Each conflict is an instance of bzrlib.conflicts.Conflict.
103
def get_parent_ids(self):
104
"""Get the parent ids for this tree.
106
:return: a list of parent ids. [] is returned to indicate
107
a tree with no parents.
108
:raises: BzrError if the parents are not known.
110
raise NotImplementedError(self.get_parent_ids)
54
112
def has_filename(self, filename):
55
113
"""True if the tree has given filename."""
56
114
raise NotImplementedError()
58
116
def has_id(self, file_id):
117
file_id = osutils.safe_file_id(file_id)
59
118
return self.inventory.has_id(file_id)
61
120
__contains__ = has_id
122
def has_or_had_id(self, file_id):
123
file_id = osutils.safe_file_id(file_id)
124
if file_id == self.inventory.root.file_id:
126
return self.inventory.has_id(file_id)
63
128
def __iter__(self):
64
129
return iter(self.inventory)
66
131
def id2path(self, file_id):
132
file_id = osutils.safe_file_id(file_id)
67
133
return self.inventory.id2path(file_id)
135
def is_control_filename(self, filename):
136
"""True if filename is the name of a control file in this tree.
138
:param filename: A filename within the tree. This is a relative path
139
from the root of this tree.
141
This is true IF and ONLY IF the filename is part of the meta data
142
that bzr controls in this tree. I.E. a random .bzr directory placed
143
on disk will not be a control file for this tree.
145
return self.bzrdir.is_control_filename(filename)
147
def iter_entries_by_dir(self, specific_file_ids=None):
148
"""Walk the tree in 'by_dir' order.
150
This will yield each entry in the tree as a (path, entry) tuple. The
151
order that they are yielded is: the contents of a directory are
152
preceeded by the parent of a directory, and all the contents of a
153
directory are grouped together.
155
return self.inventory.iter_entries_by_dir(
156
specific_file_ids=specific_file_ids)
158
def kind(self, file_id):
159
raise NotImplementedError("subclasses must implement kind")
161
def _comparison_data(self, entry, path):
162
"""Return a tuple of kind, executable, stat_value for a file.
164
entry may be None if there is no inventory entry for the file, but
165
path must always be supplied.
167
kind is None if there is no file present (even if an inventory id is
168
present). executable is False for non-file entries.
170
raise NotImplementedError(self._comparison_data)
172
def _file_size(entry, stat_value):
173
raise NotImplementedError(self._file_size)
69
175
def _get_inventory(self):
70
176
return self._inventory
178
def get_file(self, file_id):
179
"""Return a file object for the file file_id in the tree."""
180
raise NotImplementedError(self.get_file)
72
182
def get_file_by_path(self, path):
73
183
return self.get_file(self._inventory.path2id(path))
185
def annotate_iter(self, file_id):
186
"""Return an iterator of revision_id, line tuples
188
For working trees (and mutable trees in general), the special
189
revision_id 'current:' will be used for lines that are new in this
190
tree, e.g. uncommitted changes.
191
:param file_id: The file to produce an annotated version from
193
raise NotImplementedError(self.annotate_iter)
75
195
inventory = property(_get_inventory,
76
196
doc="Inventory of this Tree")
78
198
def _check_retrieved(self, ie, f):
79
201
fp = fingerprint_file(f)
82
if ie.text_size != None:
204
if ie.text_size is not None:
83
205
if ie.text_size != fp['size']:
84
206
raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
85
207
["inventory expects %d bytes" % ie.text_size,
92
214
"file is actually %s" % fp['sha1'],
93
215
"store is probably damaged/corrupt"])
217
def path2id(self, path):
218
"""Return the id for path in this tree."""
219
return self._inventory.path2id(path)
96
221
def print_file(self, file_id):
97
222
"""Print file with id `file_id` to stdout."""
223
file_id = osutils.safe_file_id(file_id)
99
225
sys.stdout.write(self.get_file_text(file_id))
102
def export(self, dest, format='dir', root=None):
103
"""Export this tree."""
105
exporter = exporters[format]
107
from bzrlib.errors import BzrCommandError
108
raise BzrCommandError("export format %r not supported" % format)
109
exporter(self, dest, root)
113
class RevisionTree(Tree):
114
"""Tree viewing a previous revision.
116
File text can be retrieved from the text store.
118
TODO: Some kind of `__repr__` method, but a good one
119
probably means knowing the branch and revision number,
120
or at least passing a description to the constructor.
123
def __init__(self, weave_store, inv, revision_id):
124
self._weave_store = weave_store
125
self._inventory = inv
126
self._revision_id = revision_id
128
def get_weave(self, file_id):
129
return self._weave_store.get_weave(file_id)
132
def get_file_text(self, file_id):
133
ie = self._inventory[file_id]
134
weave = self.get_weave(file_id)
135
idx = weave.lookup(ie.text_version)
136
content = weave.get_text(idx)
137
if len(content) != ie.text_size:
138
raise BzrCheckError('mismatched size on revision %s of file %s: '
140
% (self._revision_id, file_id, len(content),
144
def get_file(self, file_id):
145
return StringIO(self.get_file_text(file_id))
147
def get_file_size(self, file_id):
148
return self._inventory[file_id].text_size
150
def get_file_sha1(self, file_id):
151
ie = self._inventory[file_id]
152
if ie.kind == "file":
155
def has_filename(self, filename):
156
return bool(self.inventory.path2id(filename))
158
def list_files(self):
159
# The only files returned by this are those from the version
160
for path, entry in self.inventory.iter_entries():
161
yield path, 'V', entry.kind, entry.file_id
231
"""What files are present in this tree and unknown.
233
:return: an iterator over the unknown files.
240
def filter_unversioned_files(self, paths):
241
"""Filter out paths that are not versioned.
243
:return: set of paths.
245
# NB: we specifically *don't* call self.has_filename, because for
246
# WorkingTrees that can indicate files that exist on disk but that
248
pred = self.inventory.has_filename
249
return set((p for p in paths if not pred(p)))
164
252
class EmptyTree(Tree):
165
254
def __init__(self):
166
self._inventory = Inventory()
255
self._inventory = Inventory(root_id=None)
256
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
257
' use repository.revision_tree instead.',
258
DeprecationWarning, stacklevel=2)
260
def get_parent_ids(self):
263
def get_symlink_target(self, file_id):
168
266
def has_filename(self, filename):
171
def list_files(self):
172
if False: # just to make it a generator
269
def kind(self, file_id):
270
file_id = osutils.safe_file_id(file_id)
271
assert self._inventory[file_id].kind == "directory"
274
def list_files(self, include_root=False):
175
277
def __contains__(self, file_id):
176
return file_id in self._inventory
278
file_id = osutils.safe_file_id(file_id)
279
return (file_id in self._inventory)
178
def get_file_sha1(self, file_id):
179
assert self._inventory[file_id].kind == "root_directory"
281
def get_file_sha1(self, file_id, path=None, stat_value=None):
185
285
######################################################################
247
347
yield (old_name, new_name)
251
######################################################################
254
def dir_exporter(tree, dest, root):
255
"""Export this tree to a new directory.
257
`dest` should not exist, and will be created holding the
258
contents of this tree.
260
TODO: To handle subdirectories we need to create the
263
:note: If the export fails, the destination directory will be
264
left in a half-assed state.
268
mutter('export version %r' % tree)
270
for dp, ie in inv.iter_entries():
272
fullpath = appendpath(dest, dp)
273
if kind == 'directory':
276
pumpfile(tree.get_file(ie.file_id), file(fullpath, 'wb'))
278
raise BzrError("don't know how to export {%s} of kind %r" % (ie.file_id, kind))
279
mutter(" export {%s} kind %s to %s" % (ie.file_id, kind, fullpath))
280
exporters['dir'] = dir_exporter
287
def get_root_name(dest):
288
"""Get just the root name for a tarball.
290
>>> get_root_name('mytar.tar')
292
>>> get_root_name('mytar.tar.bz2')
294
>>> get_root_name('tar.tar.tar.tgz')
296
>>> get_root_name('bzr-0.0.5.tar.gz')
298
>>> get_root_name('a/long/path/mytar.tgz')
300
>>> get_root_name('../parent/../dir/other.tbz2')
303
endings = ['.tar', '.tar.gz', '.tgz', '.tar.bz2', '.tbz2']
304
dest = os.path.basename(dest)
306
if dest.endswith(end):
307
return dest[:-len(end)]
309
def tar_exporter(tree, dest, root, compression=None):
310
"""Export this tree to a new tar file.
312
`dest` will be created holding the contents of this tree; if it
313
already exists, it will be clobbered, like with "tar -c".
315
from time import time
317
compression = str(compression or '')
319
root = get_root_name(dest)
321
ball = tarfile.open(dest, 'w:' + compression)
322
except tarfile.CompressionError, e:
323
raise BzrError(str(e))
324
mutter('export version %r' % tree)
326
for dp, ie in inv.iter_entries():
327
mutter(" export {%s} kind %s to %s" % (ie.file_id, ie.kind, dest))
328
item = tarfile.TarInfo(os.path.join(root, dp))
329
# TODO: would be cool to actually set it to the timestamp of the
330
# revision it was last changed
332
if ie.kind == 'directory':
333
item.type = tarfile.DIRTYPE
338
elif ie.kind == 'file':
339
item.type = tarfile.REGTYPE
340
fileobj = tree.get_file(ie.file_id)
341
item.size = _find_file_size(fileobj)
344
raise BzrError("don't know how to export {%s} of kind %r" %
345
(ie.file_id, ie.kind))
347
ball.addfile(item, fileobj)
349
exporters['tar'] = tar_exporter
351
def tgz_exporter(tree, dest, root):
352
tar_exporter(tree, dest, root, compression='gz')
353
exporters['tgz'] = tgz_exporter
355
def tbz_exporter(tree, dest, root):
356
tar_exporter(tree, dest, root, compression='bz2')
357
exporters['tbz2'] = tbz_exporter
360
def _find_file_size(fileobj):
361
offset = fileobj.tell()
364
size = fileobj.tell()
366
# gzip doesn't accept second argument to seek()
370
nread = len(fileobj.read())
350
def find_ids_across_trees(filenames, trees, require_versioned=True):
351
"""Find the ids corresponding to specified filenames.
353
All matches in all trees will be used, and all children of matched
354
directories will be used.
356
:param filenames: The filenames to find file_ids for (if None, returns
358
:param trees: The trees to find file_ids within
359
:param require_versioned: if true, all specified filenames must occur in
361
:return: a set of file ids for the specified filenames and their children.
365
specified_ids = _find_filename_ids_across_trees(filenames, trees,
367
return _find_children_across_trees(specified_ids, trees)
370
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
371
"""Find the ids corresponding to specified filenames.
373
All matches in all trees will be used.
375
:param filenames: The filenames to find file_ids for
376
:param trees: The trees to find file_ids within
377
:param require_versioned: if true, all specified filenames must occur in
379
:return: a set of file ids for the specified filenames
382
interesting_ids = set()
383
for tree_path in filenames:
386
file_id = tree.inventory.path2id(tree_path)
387
if file_id is not None:
388
interesting_ids.add(file_id)
391
not_versioned.append(tree_path)
392
if len(not_versioned) > 0 and require_versioned:
393
raise errors.PathsNotVersionedError(not_versioned)
394
return interesting_ids
397
def _find_children_across_trees(specified_ids, trees):
398
"""Return a set including specified ids and their children
400
All matches in all trees will be used.
402
:param trees: The trees to find file_ids within
403
:return: a set containing all specified ids and their children
405
interesting_ids = set(specified_ids)
406
pending = interesting_ids
407
# now handle children of interesting ids
408
# we loop so that we handle all children of each id in both trees
409
while len(pending) > 0:
411
for file_id in pending:
413
if file_id not in tree:
415
entry = tree.inventory[file_id]
416
for child in getattr(entry, 'children', {}).itervalues():
417
if child.file_id not in interesting_ids:
418
new_pending.add(child.file_id)
419
interesting_ids.update(new_pending)
420
pending = new_pending
421
return interesting_ids
424
class InterTree(InterObject):
425
"""This class represents operations taking place between two Trees.
427
Its instances have methods like 'compare' and contain references to the
428
source and target trees these operations are to be carried out on.
430
clients of bzrlib should not need to use InterTree directly, rather they
431
should use the convenience methods on Tree such as 'Tree.compare()' which
432
will pass through to InterTree as appropriate.
438
def compare(self, want_unchanged=False, specific_files=None,
439
extra_trees=None, require_versioned=False, include_root=False):
440
"""Return the changes from source to target.
442
:return: A TreeDelta.
443
:param specific_files: An optional list of file paths to restrict the
444
comparison to. When mapping filenames to ids, all matches in all
445
trees (including optional extra_trees) are used, and all children of
446
matched directories are included.
447
:param want_unchanged: An optional boolean requesting the inclusion of
448
unchanged entries in the result.
449
:param extra_trees: An optional list of additional trees to use when
450
mapping the contents of specific_files (paths) to file_ids.
451
:param require_versioned: An optional boolean (defaults to False). When
452
supplied and True all the 'specific_files' must be versioned, or
453
a PathsNotVersionedError will be thrown.
455
# NB: show_status depends on being able to pass in non-versioned files and
456
# report them as unknown
457
trees = (self.source, self.target)
458
if extra_trees is not None:
459
trees = trees + tuple(extra_trees)
460
specific_file_ids = find_ids_across_trees(specific_files,
461
trees, require_versioned=require_versioned)
462
if specific_files and not specific_file_ids:
463
# All files are unversioned, so just return an empty delta
464
# _compare_trees would think we want a complete delta
465
return delta.TreeDelta()
466
return delta._compare_trees(self.source, self.target, want_unchanged,
467
specific_file_ids, include_root)
469
def _iter_changes(self, from_tree, to_tree, include_unchanged,
470
specific_file_ids, pb):
471
"""Generate an iterator of changes between trees.
474
(file_id, path, changed_content, versioned, parent, name, kind,
477
Path is relative to the to_tree. changed_content is True if the file's
478
content has changed. This includes changes to its kind, and to
481
versioned, parent, name, kind, executable are tuples of (from, to).
482
If a file is missing in a tree, its kind is None.
484
Iteration is done in parent-to-child order, relative to the to_tree.
487
from_entries_by_dir = list(from_tree.inventory.iter_entries_by_dir(
488
specific_file_ids=specific_file_ids))
489
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
490
to_entries_by_dir = list(to_tree.inventory.iter_entries_by_dir(
491
specific_file_ids=specific_file_ids))
492
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
494
for to_path, to_entry in to_entries_by_dir:
495
file_id = to_entry.file_id
496
to_paths[file_id] = to_path
498
changed_content = False
499
from_path, from_entry = from_data.get(file_id, (None, None))
500
from_versioned = (from_entry is not None)
501
if from_entry is not None:
502
from_versioned = True
503
from_name = from_entry.name
504
from_parent = from_entry.parent_id
505
from_kind, from_executable, from_stat = \
506
from_tree._comparison_data(from_entry, from_path)
509
from_versioned = False
513
from_executable = None
514
versioned = (from_versioned, True)
515
to_kind, to_executable, to_stat = \
516
to_tree._comparison_data(to_entry, to_path)
517
kind = (from_kind, to_kind)
518
if kind[0] != kind[1]:
519
changed_content = True
520
elif from_kind == 'file':
521
from_size = from_tree._file_size(from_entry, from_stat)
522
to_size = to_tree._file_size(to_entry, to_stat)
523
if from_size != to_size:
524
changed_content = True
525
elif (from_tree.get_file_sha1(file_id, from_path, from_stat) !=
526
to_tree.get_file_sha1(file_id, to_path, to_stat)):
527
changed_content = True
528
elif from_kind == 'symlink':
529
if (from_tree.get_symlink_target(file_id) !=
530
to_tree.get_symlink_target(file_id)):
531
changed_content = True
532
parent = (from_parent, to_entry.parent_id)
533
name = (from_name, to_entry.name)
534
executable = (from_executable, to_executable)
536
pb.update('comparing files', entry_count, num_entries)
537
if (changed_content is not False or versioned[0] != versioned[1]
538
or parent[0] != parent[1] or name[0] != name[1] or
539
executable[0] != executable[1] or include_unchanged):
540
yield (file_id, to_path, changed_content, versioned, parent,
541
name, kind, executable)
543
def get_to_path(from_entry):
544
if from_entry.parent_id is None:
547
if from_entry.parent_id not in to_paths:
548
get_to_path(from_tree.inventory[from_entry.parent_id])
549
to_path = osutils.pathjoin(to_paths[from_entry.parent_id],
551
to_paths[from_entry.file_id] = to_path
554
for path, from_entry in from_entries_by_dir:
555
file_id = from_entry.file_id
556
if file_id in to_paths:
558
to_path = get_to_path(from_entry)
561
pb.update('comparing files', entry_count, num_entries)
562
versioned = (True, False)
563
parent = (from_entry.parent_id, None)
564
name = (from_entry.name, None)
565
from_kind, from_executable, stat_value = \
566
from_tree._comparison_data(from_entry, path)
567
kind = (from_kind, None)
568
executable = (from_executable, None)
569
changed_content = True
570
# the parent's path is necessarily known at this point.
571
yield(file_id, to_path, changed_content, versioned, parent,
572
name, kind, executable)
575
# This was deprecated before 0.12, but did not have an official warning
576
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
577
def RevisionTree(*args, **kwargs):
578
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
580
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
583
from bzrlib.revisiontree import RevisionTree as _RevisionTree
584
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
