48
58
trees or versioned trees.
61
def changes_from(self, other, want_unchanged=False, specific_files=None,
62
extra_trees=None, require_versioned=False, include_root=False,
63
want_unversioned=False):
64
"""Return a TreeDelta of the changes from other to this tree.
66
:param other: A tree to compare with.
67
:param specific_files: An optional list of file paths to restrict the
68
comparison to. When mapping filenames to ids, all matches in all
69
trees (including optional extra_trees) are used, and all children of
70
matched directories are included.
71
:param want_unchanged: An optional boolean requesting the inclusion of
72
unchanged entries in the result.
73
:param extra_trees: An optional list of additional trees to use when
74
mapping the contents of specific_files (paths) to file_ids.
75
:param require_versioned: An optional boolean (defaults to False). When
76
supplied and True all the 'specific_files' must be versioned, or
77
a PathsNotVersionedError will be thrown.
78
:param want_unversioned: Scan for unversioned paths.
80
The comparison will be performed by an InterTree object looked up on
83
# Martin observes that Tree.changes_from returns a TreeDelta and this
84
# may confuse people, because the class name of the returned object is
85
# a synonym of the object referenced in the method name.
86
return InterTree.get(other, self).compare(
87
want_unchanged=want_unchanged,
88
specific_files=specific_files,
89
extra_trees=extra_trees,
90
require_versioned=require_versioned,
91
include_root=include_root,
92
want_unversioned=want_unversioned,
95
def _iter_changes(self, from_tree, include_unchanged=False,
96
specific_files=None, pb=None, extra_trees=None,
97
require_versioned=True, want_unversioned=False):
98
intertree = InterTree.get(from_tree, self)
99
return intertree._iter_changes(include_unchanged, specific_files, pb,
100
extra_trees, require_versioned, want_unversioned=want_unversioned)
103
"""Get a list of the conflicts in the tree.
105
Each conflict is an instance of bzrlib.conflicts.Conflict.
110
"""For trees that can have unversioned files, return all such paths."""
113
def get_parent_ids(self):
114
"""Get the parent ids for this tree.
116
:return: a list of parent ids. [] is returned to indicate
117
a tree with no parents.
118
:raises: BzrError if the parents are not known.
120
raise NotImplementedError(self.get_parent_ids)
51
122
def has_filename(self, filename):
52
123
"""True if the tree has given filename."""
53
124
raise NotImplementedError()
55
126
def has_id(self, file_id):
127
file_id = osutils.safe_file_id(file_id)
56
128
return self.inventory.has_id(file_id)
130
__contains__ = has_id
58
132
def has_or_had_id(self, file_id):
133
file_id = osutils.safe_file_id(file_id)
59
134
if file_id == self.inventory.root.file_id:
61
136
return self.inventory.has_id(file_id)
138
def is_ignored(self, filename):
139
"""Check whether the filename is ignored by this tree.
141
:param filename: The relative filename within the tree.
142
:return: True if the filename is ignored.
65
146
def __iter__(self):
66
147
return iter(self.inventory)
68
149
def id2path(self, file_id):
150
"""Return the path for a file id.
154
file_id = osutils.safe_file_id(file_id)
69
155
return self.inventory.id2path(file_id)
157
def is_control_filename(self, filename):
158
"""True if filename is the name of a control file in this tree.
160
:param filename: A filename within the tree. This is a relative path
161
from the root of this tree.
163
This is true IF and ONLY IF the filename is part of the meta data
164
that bzr controls in this tree. I.E. a random .bzr directory placed
165
on disk will not be a control file for this tree.
167
return self.bzrdir.is_control_filename(filename)
170
def iter_entries_by_dir(self, specific_file_ids=None):
171
"""Walk the tree in 'by_dir' order.
173
This will yield each entry in the tree as a (path, entry) tuple. The
174
order that they are yielded is: the contents of a directory are
175
preceeded by the parent of a directory, and all the contents of a
176
directory are grouped together.
178
return self.inventory.iter_entries_by_dir(
179
specific_file_ids=specific_file_ids)
181
def iter_references(self):
182
for path, entry in self.iter_entries_by_dir():
183
if entry.kind == 'tree-reference':
184
yield path, entry.file_id
71
186
def kind(self, file_id):
72
raise NotImplementedError("subclasses must implement kind")
187
raise NotImplementedError("Tree subclass %s must implement kind"
188
% self.__class__.__name__)
190
def get_reference_revision(self, file_id, path=None):
191
raise NotImplementedError("Tree subclass %s must implement "
192
"get_reference_revision"
193
% self.__class__.__name__)
195
def _comparison_data(self, entry, path):
196
"""Return a tuple of kind, executable, stat_value for a file.
198
entry may be None if there is no inventory entry for the file, but
199
path must always be supplied.
201
kind is None if there is no file present (even if an inventory id is
202
present). executable is False for non-file entries.
204
raise NotImplementedError(self._comparison_data)
206
def _file_size(self, entry, stat_value):
207
raise NotImplementedError(self._file_size)
74
209
def _get_inventory(self):
75
210
return self._inventory
212
def get_file(self, file_id):
213
"""Return a file object for the file file_id in the tree."""
214
raise NotImplementedError(self.get_file)
216
def get_file_mtime(self, file_id, path=None):
217
"""Return the modification time for a file.
219
:param file_id: The handle for this file.
220
:param path: The path that this file can be found at.
221
These must point to the same object.
223
raise NotImplementedError(self.get_file_mtime)
77
225
def get_file_by_path(self, path):
78
226
return self.get_file(self._inventory.path2id(path))
228
def get_symlink_target(self, file_id):
229
"""Get the target for a given file_id.
231
It is assumed that the caller already knows that file_id is referencing
233
:param file_id: Handle for the symlink entry.
234
:return: The path the symlink points to.
236
raise NotImplementedError(self.get_symlink_target)
238
def annotate_iter(self, file_id):
239
"""Return an iterator of revision_id, line tuples
241
For working trees (and mutable trees in general), the special
242
revision_id 'current:' will be used for lines that are new in this
243
tree, e.g. uncommitted changes.
244
:param file_id: The file to produce an annotated version from
246
raise NotImplementedError(self.annotate_iter)
248
def plan_file_merge(self, file_id, other):
249
"""Generate a merge plan based on annotations
251
If the file contains uncommitted changes in this tree, they will be
252
attributed to the 'current:' pseudo-revision. If the file contains
253
uncommitted changes in the other tree, they will be assigned to the
254
'other:' pseudo-revision.
256
from bzrlib import merge
257
annotated_a = list(self.annotate_iter(file_id,
258
_mod_revision.CURRENT_REVISION))
259
annotated_b = list(other.annotate_iter(file_id, 'other:'))
260
ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
261
ancestors_b = other._get_ancestors('other:')
262
return merge._plan_annotate_merge(annotated_a, annotated_b,
263
ancestors_a, ancestors_b)
80
265
inventory = property(_get_inventory,
81
266
doc="Inventory of this Tree")
99
284
"file is actually %s" % fp['sha1'],
100
285
"store is probably damaged/corrupt"])
288
def path2id(self, path):
289
"""Return the id for path in this tree."""
290
return self._inventory.path2id(path)
292
def paths2ids(self, paths, trees=[], require_versioned=True):
293
"""Return all the ids that can be reached by walking from paths.
295
Each path is looked up in each this tree and any extras provided in
296
trees, and this is repeated recursively: the children in an extra tree
297
of a directory that has been renamed under a provided path in this tree
298
are all returned, even if none exist until a provided path in this
299
tree, and vice versa.
301
:param paths: An iterable of paths to start converting to ids from.
302
Alternatively, if paths is None, no ids should be calculated and None
303
will be returned. This is offered to make calling the api unconditional
304
for code that *might* take a list of files.
305
:param trees: Additional trees to consider.
306
:param require_versioned: If False, do not raise NotVersionedError if
307
an element of paths is not versioned in this tree and all of trees.
309
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
103
311
def print_file(self, file_id):
104
312
"""Print file with id `file_id` to stdout."""
313
file_id = osutils.safe_file_id(file_id)
106
315
sys.stdout.write(self.get_file_text(file_id))
109
class RevisionTree(Tree):
110
"""Tree viewing a previous revision.
112
File text can be retrieved from the text store.
114
TODO: Some kind of `__repr__` method, but a good one
115
probably means knowing the branch and revision number,
116
or at least passing a description to the constructor.
119
def __init__(self, branch, inv, revision_id):
120
self._branch = branch
121
self._weave_store = branch.weave_store
122
self._inventory = inv
123
self._revision_id = revision_id
125
def get_weave(self, file_id):
126
import bzrlib.transactions as transactions
127
return self._weave_store.get_weave(file_id,
128
self._branch.get_transaction())
130
def get_weave_prelude(self, file_id):
131
import bzrlib.transactions as transactions
132
return self._weave_store.get_weave_prelude(file_id,
133
self._branch.get_transaction())
135
def get_file_lines(self, file_id):
136
ie = self._inventory[file_id]
137
weave = self.get_weave(file_id)
138
return weave.get(ie.revision)
140
def get_file_text(self, file_id):
141
return ''.join(self.get_file_lines(file_id))
143
def get_file(self, file_id):
144
return StringIO(self.get_file_text(file_id))
146
def get_file_size(self, file_id):
147
return self._inventory[file_id].text_size
149
def get_file_sha1(self, file_id):
150
ie = self._inventory[file_id]
151
if ie.kind == "file":
154
def is_executable(self, file_id):
155
ie = self._inventory[file_id]
156
if ie.kind != "file":
158
return self._inventory[file_id].executable
160
def has_filename(self, filename):
161
return bool(self.inventory.path2id(filename))
163
def list_files(self):
164
# The only files returned by this are those from the version
165
for path, entry in self.inventory.iter_entries():
166
yield path, 'V', entry.kind, entry.file_id, entry
168
def get_symlink_target(self, file_id):
169
ie = self._inventory[file_id]
170
return ie.symlink_target;
172
def kind(self, file_id):
173
return self._inventory[file_id].kind
320
def revision_tree(self, revision_id):
321
"""Obtain a revision tree for the revision revision_id.
323
The intention of this method is to allow access to possibly cached
324
tree data. Implementors of this method should raise NoSuchRevision if
325
the tree is not locally available, even if they could obtain the
326
tree via a repository or some other means. Callers are responsible
327
for finding the ultimate source for a revision tree.
329
:param revision_id: The revision_id of the requested tree.
331
:raises: NoSuchRevision if the tree cannot be obtained.
333
raise errors.NoSuchRevisionInTree(self, revision_id)
336
"""What files are present in this tree and unknown.
338
:return: an iterator over the unknown files.
345
def filter_unversioned_files(self, paths):
346
"""Filter out paths that are versioned.
348
:return: set of paths.
350
# NB: we specifically *don't* call self.has_filename, because for
351
# WorkingTrees that can indicate files that exist on disk but that
353
pred = self.inventory.has_filename
354
return set((p for p in paths if not pred(p)))
356
def walkdirs(self, prefix=""):
357
"""Walk the contents of this tree from path down.
359
This yields all the data about the contents of a directory at a time.
360
After each directory has been yielded, if the caller has mutated the
361
list to exclude some directories, they are then not descended into.
363
The data yielded is of the form:
364
((directory-relpath, directory-path-from-root, directory-fileid),
365
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
366
versioned_kind), ...]),
367
- directory-relpath is the containing dirs relpath from prefix
368
- directory-path-from-root is the containing dirs path from /
369
- directory-fileid is the id of the directory if it is versioned.
370
- relpath is the relative path within the subtree being walked.
371
- basename is the basename
372
- kind is the kind of the file now. If unknonwn then the file is not
373
present within the tree - but it may be recorded as versioned. See
375
- lstat is the stat data *if* the file was statted.
376
- path_from_tree_root is the path from the root of the tree.
377
- file_id is the file_id is the entry is versioned.
378
- versioned_kind is the kind of the file as last recorded in the
379
versioning system. If 'unknown' the file is not versioned.
380
One of 'kind' and 'versioned_kind' must not be 'unknown'.
382
:param prefix: Start walking from prefix within the tree rather than
383
at the root. This allows one to walk a subtree but get paths that are
384
relative to a tree rooted higher up.
385
:return: an iterator over the directory data.
387
raise NotImplementedError(self.walkdirs)
176
390
class EmptyTree(Tree):
177
392
def __init__(self):
178
self._inventory = Inventory()
393
self._inventory = Inventory(root_id=None)
394
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
395
' use repository.revision_tree instead.',
396
DeprecationWarning, stacklevel=2)
398
def get_parent_ids(self):
180
401
def get_symlink_target(self, file_id):
263
485
yield (old_name, new_name)
488
def find_ids_across_trees(filenames, trees, require_versioned=True):
489
"""Find the ids corresponding to specified filenames.
491
All matches in all trees will be used, and all children of matched
492
directories will be used.
494
:param filenames: The filenames to find file_ids for (if None, returns
496
:param trees: The trees to find file_ids within
497
:param require_versioned: if true, all specified filenames must occur in
499
:return: a set of file ids for the specified filenames and their children.
503
specified_path_ids = _find_ids_across_trees(filenames, trees,
505
return _find_children_across_trees(specified_path_ids, trees)
508
def _find_ids_across_trees(filenames, trees, require_versioned):
509
"""Find the ids corresponding to specified filenames.
511
All matches in all trees will be used, but subdirectories are not scanned.
513
:param filenames: The filenames to find file_ids for
514
:param trees: The trees to find file_ids within
515
:param require_versioned: if true, all specified filenames must occur in
517
:return: a set of (path, file ids) for the specified filenames
520
interesting_ids = set()
521
for tree_path in filenames:
524
file_id = tree.path2id(tree_path)
525
if file_id is not None:
526
interesting_ids.add(file_id)
529
not_versioned.append(tree_path)
530
if len(not_versioned) > 0 and require_versioned:
531
raise errors.PathsNotVersionedError(not_versioned)
532
return interesting_ids
535
def _find_children_across_trees(specified_ids, trees):
536
"""Return a set including specified ids and their children
538
All matches in all trees will be used.
540
:param trees: The trees to find file_ids within
541
:return: a set containing all specified ids and their children
543
interesting_ids = set(specified_ids)
544
pending = interesting_ids
545
# now handle children of interesting ids
546
# we loop so that we handle all children of each id in both trees
547
while len(pending) > 0:
549
for file_id in pending:
551
if not tree.has_id(file_id):
553
entry = tree.inventory[file_id]
554
for child in getattr(entry, 'children', {}).itervalues():
555
if child.file_id not in interesting_ids:
556
new_pending.add(child.file_id)
557
interesting_ids.update(new_pending)
558
pending = new_pending
559
return interesting_ids
562
class InterTree(InterObject):
563
"""This class represents operations taking place between two Trees.
565
Its instances have methods like 'compare' and contain references to the
566
source and target trees these operations are to be carried out on.
568
clients of bzrlib should not need to use InterTree directly, rather they
569
should use the convenience methods on Tree such as 'Tree.compare()' which
570
will pass through to InterTree as appropriate.
576
def compare(self, want_unchanged=False, specific_files=None,
577
extra_trees=None, require_versioned=False, include_root=False,
578
want_unversioned=False):
579
"""Return the changes from source to target.
581
:return: A TreeDelta.
582
:param specific_files: An optional list of file paths to restrict the
583
comparison to. When mapping filenames to ids, all matches in all
584
trees (including optional extra_trees) are used, and all children of
585
matched directories are included.
586
:param want_unchanged: An optional boolean requesting the inclusion of
587
unchanged entries in the result.
588
:param extra_trees: An optional list of additional trees to use when
589
mapping the contents of specific_files (paths) to file_ids.
590
:param require_versioned: An optional boolean (defaults to False). When
591
supplied and True all the 'specific_files' must be versioned, or
592
a PathsNotVersionedError will be thrown.
593
:param want_unversioned: Scan for unversioned paths.
595
# NB: show_status depends on being able to pass in non-versioned files
596
# and report them as unknown
597
trees = (self.source,)
598
if extra_trees is not None:
599
trees = trees + tuple(extra_trees)
600
# target is usually the newer tree:
601
specific_file_ids = self.target.paths2ids(specific_files, trees,
602
require_versioned=require_versioned)
603
if specific_files and not specific_file_ids:
604
# All files are unversioned, so just return an empty delta
605
# _compare_trees would think we want a complete delta
606
result = delta.TreeDelta()
607
fake_entry = InventoryFile('unused', 'unused', 'unused')
608
result.unversioned = [(path, None,
609
self.target._comparison_data(fake_entry, path)[0]) for path in
612
return delta._compare_trees(self.source, self.target, want_unchanged,
613
specific_files, include_root, extra_trees=extra_trees,
614
require_versioned=require_versioned,
615
want_unversioned=want_unversioned)
617
def _iter_changes(self, include_unchanged=False,
618
specific_files=None, pb=None, extra_trees=[],
619
require_versioned=True, want_unversioned=False):
620
"""Generate an iterator of changes between trees.
623
(file_id, (path_in_source, path_in_target),
624
changed_content, versioned, parent, name, kind,
627
Changed_content is True if the file's content has changed. This
628
includes changes to its kind, and to a symlink's target.
630
versioned, parent, name, kind, executable are tuples of (from, to).
631
If a file is missing in a tree, its kind is None.
633
Iteration is done in parent-to-child order, relative to the target
636
There is no guarantee that all paths are in sorted order: the
637
requirement to expand the search due to renames may result in children
638
that should be found early being found late in the search, after
639
lexically later results have been returned.
640
:param require_versioned: Raise errors.PathsNotVersionedError if a
641
path in the specific_files list is not versioned in one of
642
source, target or extra_trees.
643
:param want_unversioned: Should unversioned files be returned in the
644
output. An unversioned file is defined as one with (False, False)
645
for the versioned pair.
648
lookup_trees = [self.source]
650
lookup_trees.extend(extra_trees)
651
specific_file_ids = self.target.paths2ids(specific_files,
652
lookup_trees, require_versioned=require_versioned)
654
all_unversioned = sorted([(p.split('/'), p) for p in self.target.extras()
655
if not specific_files or
656
osutils.is_inside_any(specific_files, p)])
657
all_unversioned = deque(all_unversioned)
659
all_unversioned = deque()
661
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
662
specific_file_ids=specific_file_ids))
663
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
664
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
665
specific_file_ids=specific_file_ids))
666
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
668
# the unversioned path lookup only occurs on real trees - where there
669
# can be extras. So the fake_entry is solely used to look up
670
# executable it values when execute is not supported.
671
fake_entry = InventoryFile('unused', 'unused', 'unused')
672
for to_path, to_entry in to_entries_by_dir:
673
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
674
unversioned_path = all_unversioned.popleft()
675
to_kind, to_executable, to_stat = \
676
self.target._comparison_data(fake_entry, unversioned_path[1])
677
yield (None, (None, unversioned_path[1]), True, (False, False),
679
(None, unversioned_path[0][-1]),
681
(None, to_executable))
682
file_id = to_entry.file_id
683
to_paths[file_id] = to_path
685
changed_content = False
686
from_path, from_entry = from_data.get(file_id, (None, None))
687
from_versioned = (from_entry is not None)
688
if from_entry is not None:
689
from_versioned = True
690
from_name = from_entry.name
691
from_parent = from_entry.parent_id
692
from_kind, from_executable, from_stat = \
693
self.source._comparison_data(from_entry, from_path)
696
from_versioned = False
700
from_executable = None
701
versioned = (from_versioned, True)
702
to_kind, to_executable, to_stat = \
703
self.target._comparison_data(to_entry, to_path)
704
kind = (from_kind, to_kind)
705
if kind[0] != kind[1]:
706
changed_content = True
707
elif from_kind == 'file':
708
from_size = self.source._file_size(from_entry, from_stat)
709
to_size = self.target._file_size(to_entry, to_stat)
710
if from_size != to_size:
711
changed_content = True
712
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
713
self.target.get_file_sha1(file_id, to_path, to_stat)):
714
changed_content = True
715
elif from_kind == 'symlink':
716
if (self.source.get_symlink_target(file_id) !=
717
self.target.get_symlink_target(file_id)):
718
changed_content = True
719
elif from_kind == 'tree-reference':
720
if (self.source.get_reference_revision(file_id, from_path)
721
!= self.target.get_reference_revision(file_id, to_path)):
722
changed_content = True
723
parent = (from_parent, to_entry.parent_id)
724
name = (from_name, to_entry.name)
725
executable = (from_executable, to_executable)
727
pb.update('comparing files', entry_count, num_entries)
728
if (changed_content is not False or versioned[0] != versioned[1]
729
or parent[0] != parent[1] or name[0] != name[1] or
730
executable[0] != executable[1] or include_unchanged):
731
yield (file_id, (from_path, to_path), changed_content,
732
versioned, parent, name, kind, executable)
734
while all_unversioned:
735
# yield any trailing unversioned paths
736
unversioned_path = all_unversioned.popleft()
737
to_kind, to_executable, to_stat = \
738
self.target._comparison_data(fake_entry, unversioned_path[1])
739
yield (None, (None, unversioned_path[1]), True, (False, False),
741
(None, unversioned_path[0][-1]),
743
(None, to_executable))
745
def get_to_path(to_entry):
746
if to_entry.parent_id is None:
747
to_path = '' # the root
749
if to_entry.parent_id not in to_paths:
751
return get_to_path(self.target.inventory[to_entry.parent_id])
752
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
754
to_paths[to_entry.file_id] = to_path
757
for path, from_entry in from_entries_by_dir:
758
file_id = from_entry.file_id
759
if file_id in to_paths:
762
if not file_id in self.target.inventory:
763
# common case - paths we have not emitted are not present in
767
to_path = get_to_path(self.target.inventory[file_id])
770
pb.update('comparing files', entry_count, num_entries)
771
versioned = (True, False)
772
parent = (from_entry.parent_id, None)
773
name = (from_entry.name, None)
774
from_kind, from_executable, stat_value = \
775
self.source._comparison_data(from_entry, path)
776
kind = (from_kind, None)
777
executable = (from_executable, None)
778
changed_content = True
779
# the parent's path is necessarily known at this point.
780
yield(file_id, (path, to_path), changed_content, versioned, parent,
781
name, kind, executable)
784
# This was deprecated before 0.12, but did not have an official warning
785
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
786
def RevisionTree(*args, **kwargs):
787
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
789
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
792
from bzrlib.revisiontree import RevisionTree as _RevisionTree
793
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
