48
59
trees or versioned trees.
62
def changes_from(self, other, want_unchanged=False, specific_files=None,
63
extra_trees=None, require_versioned=False, include_root=False,
64
want_unversioned=False):
65
"""Return a TreeDelta of the changes from other to this tree.
67
:param other: A tree to compare with.
68
:param specific_files: An optional list of file paths to restrict the
69
comparison to. When mapping filenames to ids, all matches in all
70
trees (including optional extra_trees) are used, and all children of
71
matched directories are included.
72
:param want_unchanged: An optional boolean requesting the inclusion of
73
unchanged entries in the result.
74
:param extra_trees: An optional list of additional trees to use when
75
mapping the contents of specific_files (paths) to file_ids.
76
:param require_versioned: An optional boolean (defaults to False). When
77
supplied and True all the 'specific_files' must be versioned, or
78
a PathsNotVersionedError will be thrown.
79
:param want_unversioned: Scan for unversioned paths.
81
The comparison will be performed by an InterTree object looked up on
84
# Martin observes that Tree.changes_from returns a TreeDelta and this
85
# may confuse people, because the class name of the returned object is
86
# a synonym of the object referenced in the method name.
87
return InterTree.get(other, self).compare(
88
want_unchanged=want_unchanged,
89
specific_files=specific_files,
90
extra_trees=extra_trees,
91
require_versioned=require_versioned,
92
include_root=include_root,
93
want_unversioned=want_unversioned,
96
def _iter_changes(self, from_tree, include_unchanged=False,
97
specific_files=None, pb=None, extra_trees=None,
98
require_versioned=True, want_unversioned=False):
99
intertree = InterTree.get(from_tree, self)
100
return intertree._iter_changes(include_unchanged, specific_files, pb,
101
extra_trees, require_versioned, want_unversioned=want_unversioned)
104
"""Get a list of the conflicts in the tree.
106
Each conflict is an instance of bzrlib.conflicts.Conflict.
108
return _mod_conflicts.ConflictList()
111
"""For trees that can have unversioned files, return all such paths."""
114
def get_parent_ids(self):
115
"""Get the parent ids for this tree.
117
:return: a list of parent ids. [] is returned to indicate
118
a tree with no parents.
119
:raises: BzrError if the parents are not known.
121
raise NotImplementedError(self.get_parent_ids)
51
123
def has_filename(self, filename):
52
124
"""True if the tree has given filename."""
53
raise NotImplementedError()
125
raise NotImplementedError(self.has_filename)
55
127
def has_id(self, 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):
59
133
if file_id == self.inventory.root.file_id:
61
135
return self.inventory.has_id(file_id)
137
def is_ignored(self, filename):
138
"""Check whether the filename is ignored by this tree.
140
:param filename: The relative filename within the tree.
141
:return: True if the filename is ignored.
65
145
def __iter__(self):
66
146
return iter(self.inventory)
68
148
def id2path(self, file_id):
149
"""Return the path for a file id.
69
153
return self.inventory.id2path(file_id)
155
def is_control_filename(self, filename):
156
"""True if filename is the name of a control file in this tree.
158
:param filename: A filename within the tree. This is a relative path
159
from the root of this tree.
161
This is true IF and ONLY IF the filename is part of the meta data
162
that bzr controls in this tree. I.E. a random .bzr directory placed
163
on disk will not be a control file for this tree.
165
return self.bzrdir.is_control_filename(filename)
168
def iter_entries_by_dir(self, specific_file_ids=None):
169
"""Walk the tree in 'by_dir' order.
171
This will yield each entry in the tree as a (path, entry) tuple. The
172
order that they are yielded is: the contents of a directory are
173
preceeded by the parent of a directory, and all the contents of a
174
directory are grouped together.
176
return self.inventory.iter_entries_by_dir(
177
specific_file_ids=specific_file_ids)
179
def iter_references(self):
180
for path, entry in self.iter_entries_by_dir():
181
if entry.kind == 'tree-reference':
182
yield path, entry.file_id
71
184
def kind(self, file_id):
72
raise NotImplementedError("subclasses must implement kind")
185
raise NotImplementedError("Tree subclass %s must implement kind"
186
% self.__class__.__name__)
188
def path_content_summary(self, path):
189
"""Get a summary of the information about path.
191
:param path: A relative path within the tree.
192
:return: A tuple containing kind, size, exec, sha1-or-link.
193
Kind is always present (see tree.kind()).
194
size is present if kind is file, None otherwise.
195
exec is None unless kind is file and the platform supports the 'x'
197
sha1-or-link is the link target if kind is symlink, or the sha1 if
198
it can be obtained without reading the file.
200
raise NotImplementedError(self.path_content_summary)
202
def get_reference_revision(self, file_id, path=None):
203
raise NotImplementedError("Tree subclass %s must implement "
204
"get_reference_revision"
205
% self.__class__.__name__)
207
def _comparison_data(self, entry, path):
208
"""Return a tuple of kind, executable, stat_value for a file.
210
entry may be None if there is no inventory entry for the file, but
211
path must always be supplied.
213
kind is None if there is no file present (even if an inventory id is
214
present). executable is False for non-file entries.
216
raise NotImplementedError(self._comparison_data)
218
def _file_size(self, entry, stat_value):
219
raise NotImplementedError(self._file_size)
74
221
def _get_inventory(self):
75
222
return self._inventory
224
def get_file(self, file_id, path=None):
225
"""Return a file object for the file file_id in the tree.
227
If both file_id and path are defined, it is implementation defined as
228
to which one is used.
230
raise NotImplementedError(self.get_file)
232
def get_file_mtime(self, file_id, path=None):
233
"""Return the modification time for a file.
235
:param file_id: The handle for this file.
236
:param path: The path that this file can be found at.
237
These must point to the same object.
239
raise NotImplementedError(self.get_file_mtime)
77
241
def get_file_by_path(self, path):
78
return self.get_file(self._inventory.path2id(path))
242
return self.get_file(self._inventory.path2id(path), path)
244
def iter_files_bytes(self, desired_files):
245
"""Iterate through file contents.
247
Files will not necessarily be returned in the order they occur in
248
desired_files. No specific order is guaranteed.
250
Yields pairs of identifier, bytes_iterator. identifier is an opaque
251
value supplied by the caller as part of desired_files. It should
252
uniquely identify the file version in the caller's context. (Examples:
253
an index number or a TreeTransform trans_id.)
255
bytes_iterator is an iterable of bytestrings for the file. The
256
kind of iterable and length of the bytestrings are unspecified, but for
257
this implementation, it is a tuple containing a single bytestring with
258
the complete text of the file.
260
:param desired_files: a list of (file_id, identifier) pairs
262
for file_id, identifier in desired_files:
263
# We wrap the string in a tuple so that we can return an iterable
264
# of bytestrings. (Technically, a bytestring is also an iterable
265
# of bytestrings, but iterating through each character is not
267
cur_file = (self.get_file_text(file_id),)
268
yield identifier, cur_file
270
def get_symlink_target(self, file_id):
271
"""Get the target for a given file_id.
273
It is assumed that the caller already knows that file_id is referencing
275
:param file_id: Handle for the symlink entry.
276
:return: The path the symlink points to.
278
raise NotImplementedError(self.get_symlink_target)
280
def get_root_id(self):
281
"""Return the file_id for the root of this tree."""
282
raise NotImplementedError(self.get_root_id)
284
def annotate_iter(self, file_id):
285
"""Return an iterator of revision_id, line tuples.
287
For working trees (and mutable trees in general), the special
288
revision_id 'current:' will be used for lines that are new in this
289
tree, e.g. uncommitted changes.
290
:param file_id: The file to produce an annotated version from
292
raise NotImplementedError(self.annotate_iter)
294
def _get_plan_merge_data(self, file_id, other, base):
295
from bzrlib import merge, versionedfile
296
vf = versionedfile._PlanMergeVersionedFile(file_id)
297
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
298
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
300
last_revision_base = None
302
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
303
return vf, last_revision_a, last_revision_b, last_revision_base
305
def plan_file_merge(self, file_id, other, base=None):
306
"""Generate a merge plan based on annotations.
308
If the file contains uncommitted changes in this tree, they will be
309
attributed to the 'current:' pseudo-revision. If the file contains
310
uncommitted changes in the other tree, they will be assigned to the
311
'other:' pseudo-revision.
313
data = self._get_plan_merge_data(file_id, other, base)
314
vf, last_revision_a, last_revision_b, last_revision_base = data
315
return vf.plan_merge(last_revision_a, last_revision_b,
318
def plan_file_lca_merge(self, file_id, other, base=None):
319
"""Generate a merge plan based lca-newness.
321
If the file contains uncommitted changes in this tree, they will be
322
attributed to the 'current:' pseudo-revision. If the file contains
323
uncommitted changes in the other tree, they will be assigned to the
324
'other:' pseudo-revision.
326
data = self._get_plan_merge_data(file_id, other, base)
327
vf, last_revision_a, last_revision_b, last_revision_base = data
328
return vf.plan_lca_merge(last_revision_a, last_revision_b,
331
def _get_file_revision(self, file_id, vf, tree_revision):
332
def file_revision(revision_tree):
333
revision_tree.lock_read()
335
return revision_tree.inventory[file_id].revision
337
revision_tree.unlock()
339
def iter_parent_trees():
340
for revision_id in self.get_parent_ids():
342
yield self.revision_tree(revision_id)
344
yield self.repository.revision_tree(revision_id)
346
if getattr(self, '_get_weave', None) is None:
347
last_revision = tree_revision
348
parent_revisions = [file_revision(t) for t in iter_parent_trees()]
349
vf.add_lines(last_revision, parent_revisions,
350
self.get_file(file_id).readlines())
351
repo = self.branch.repository
352
transaction = repo.get_transaction()
353
base_vf = repo.weave_store.get_weave(file_id, transaction)
355
last_revision = file_revision(self)
356
base_vf = self._get_weave(file_id)
357
vf.fallback_versionedfiles.append(base_vf)
80
360
inventory = property(_get_inventory,
81
361
doc="Inventory of this Tree")
121
446
# are not versioned.
122
447
pred = self.inventory.has_filename
123
448
return set((p for p in paths if not pred(p)))
126
class RevisionTree(Tree):
127
"""Tree viewing a previous revision.
129
File text can be retrieved from the text store.
131
TODO: Some kind of `__repr__` method, but a good one
132
probably means knowing the branch and revision number,
133
or at least passing a description to the constructor.
136
def __init__(self, branch, inv, revision_id):
137
self._branch = branch
138
self._weave_store = branch.weave_store
139
self._inventory = inv
140
self._revision_id = revision_id
142
def get_weave(self, file_id):
143
return self._weave_store.get_weave(file_id,
144
self._branch.get_transaction())
146
def get_file_lines(self, file_id):
147
ie = self._inventory[file_id]
148
weave = self.get_weave(file_id)
149
return weave.get_lines(ie.revision)
151
def get_file_text(self, file_id):
152
return ''.join(self.get_file_lines(file_id))
154
def get_file(self, file_id):
155
return StringIO(self.get_file_text(file_id))
157
def get_file_size(self, file_id):
158
return self._inventory[file_id].text_size
160
def get_file_sha1(self, file_id):
161
ie = self._inventory[file_id]
162
if ie.kind == "file":
165
def is_executable(self, file_id):
166
ie = self._inventory[file_id]
167
if ie.kind != "file":
169
return self._inventory[file_id].executable
171
def has_filename(self, filename):
172
return bool(self.inventory.path2id(filename))
174
def list_files(self):
175
# The only files returned by this are those from the version
176
for path, entry in self.inventory.iter_entries():
177
yield path, 'V', entry.kind, entry.file_id, entry
179
def get_symlink_target(self, file_id):
180
ie = self._inventory[file_id]
181
return ie.symlink_target;
183
def kind(self, file_id):
184
return self._inventory[file_id].kind
187
self._branch.lock_read()
190
self._branch.unlock()
450
def walkdirs(self, prefix=""):
451
"""Walk the contents of this tree from path down.
453
This yields all the data about the contents of a directory at a time.
454
After each directory has been yielded, if the caller has mutated the
455
list to exclude some directories, they are then not descended into.
457
The data yielded is of the form:
458
((directory-relpath, directory-path-from-root, directory-fileid),
459
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
460
versioned_kind), ...]),
461
- directory-relpath is the containing dirs relpath from prefix
462
- directory-path-from-root is the containing dirs path from /
463
- directory-fileid is the id of the directory if it is versioned.
464
- relpath is the relative path within the subtree being walked.
465
- basename is the basename
466
- kind is the kind of the file now. If unknonwn then the file is not
467
present within the tree - but it may be recorded as versioned. See
469
- lstat is the stat data *if* the file was statted.
470
- path_from_tree_root is the path from the root of the tree.
471
- file_id is the file_id if the entry is versioned.
472
- versioned_kind is the kind of the file as last recorded in the
473
versioning system. If 'unknown' the file is not versioned.
474
One of 'kind' and 'versioned_kind' must not be 'unknown'.
476
:param prefix: Start walking from prefix within the tree rather than
477
at the root. This allows one to walk a subtree but get paths that are
478
relative to a tree rooted higher up.
479
:return: an iterator over the directory data.
481
raise NotImplementedError(self.walkdirs)
193
484
class EmptyTree(Tree):
194
486
def __init__(self):
195
self._inventory = Inventory()
487
self._inventory = Inventory(root_id=None)
488
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
489
' use repository.revision_tree instead.',
490
DeprecationWarning, stacklevel=2)
492
def get_parent_ids(self):
197
495
def get_symlink_target(self, file_id):
280
577
yield (old_name, new_name)
580
def find_ids_across_trees(filenames, trees, require_versioned=True):
581
"""Find the ids corresponding to specified filenames.
583
All matches in all trees will be used, and all children of matched
584
directories will be used.
586
:param filenames: The filenames to find file_ids for (if None, returns
588
:param trees: The trees to find file_ids within
589
:param require_versioned: if true, all specified filenames must occur in
591
:return: a set of file ids for the specified filenames and their children.
595
specified_path_ids = _find_ids_across_trees(filenames, trees,
597
return _find_children_across_trees(specified_path_ids, trees)
600
def _find_ids_across_trees(filenames, trees, require_versioned):
601
"""Find the ids corresponding to specified filenames.
603
All matches in all trees will be used, but subdirectories are not scanned.
605
:param filenames: The filenames to find file_ids for
606
:param trees: The trees to find file_ids within
607
:param require_versioned: if true, all specified filenames must occur in
609
:return: a set of file ids for the specified filenames
612
interesting_ids = set()
613
for tree_path in filenames:
616
file_id = tree.path2id(tree_path)
617
if file_id is not None:
618
interesting_ids.add(file_id)
621
not_versioned.append(tree_path)
622
if len(not_versioned) > 0 and require_versioned:
623
raise errors.PathsNotVersionedError(not_versioned)
624
return interesting_ids
627
def _find_children_across_trees(specified_ids, trees):
628
"""Return a set including specified ids and their children.
630
All matches in all trees will be used.
632
:param trees: The trees to find file_ids within
633
:return: a set containing all specified ids and their children
635
interesting_ids = set(specified_ids)
636
pending = interesting_ids
637
# now handle children of interesting ids
638
# we loop so that we handle all children of each id in both trees
639
while len(pending) > 0:
641
for file_id in pending:
643
if not tree.has_id(file_id):
645
entry = tree.inventory[file_id]
646
for child in getattr(entry, 'children', {}).itervalues():
647
if child.file_id not in interesting_ids:
648
new_pending.add(child.file_id)
649
interesting_ids.update(new_pending)
650
pending = new_pending
651
return interesting_ids
654
class InterTree(InterObject):
655
"""This class represents operations taking place between two Trees.
657
Its instances have methods like 'compare' and contain references to the
658
source and target trees these operations are to be carried out on.
660
Clients of bzrlib should not need to use InterTree directly, rather they
661
should use the convenience methods on Tree such as 'Tree.compare()' which
662
will pass through to InterTree as appropriate.
668
def compare(self, want_unchanged=False, specific_files=None,
669
extra_trees=None, require_versioned=False, include_root=False,
670
want_unversioned=False):
671
"""Return the changes from source to target.
673
:return: A TreeDelta.
674
:param specific_files: An optional list of file paths to restrict the
675
comparison to. When mapping filenames to ids, all matches in all
676
trees (including optional extra_trees) are used, and all children of
677
matched directories are included.
678
:param want_unchanged: An optional boolean requesting the inclusion of
679
unchanged entries in the result.
680
:param extra_trees: An optional list of additional trees to use when
681
mapping the contents of specific_files (paths) to file_ids.
682
:param require_versioned: An optional boolean (defaults to False). When
683
supplied and True all the 'specific_files' must be versioned, or
684
a PathsNotVersionedError will be thrown.
685
:param want_unversioned: Scan for unversioned paths.
687
# NB: show_status depends on being able to pass in non-versioned files
688
# and report them as unknown
689
trees = (self.source,)
690
if extra_trees is not None:
691
trees = trees + tuple(extra_trees)
692
# target is usually the newer tree:
693
specific_file_ids = self.target.paths2ids(specific_files, trees,
694
require_versioned=require_versioned)
695
if specific_files and not specific_file_ids:
696
# All files are unversioned, so just return an empty delta
697
# _compare_trees would think we want a complete delta
698
result = delta.TreeDelta()
699
fake_entry = InventoryFile('unused', 'unused', 'unused')
700
result.unversioned = [(path, None,
701
self.target._comparison_data(fake_entry, path)[0]) for path in
704
return delta._compare_trees(self.source, self.target, want_unchanged,
705
specific_files, include_root, extra_trees=extra_trees,
706
require_versioned=require_versioned,
707
want_unversioned=want_unversioned)
709
def _iter_changes(self, include_unchanged=False,
710
specific_files=None, pb=None, extra_trees=[],
711
require_versioned=True, want_unversioned=False):
712
"""Generate an iterator of changes between trees.
715
(file_id, (path_in_source, path_in_target),
716
changed_content, versioned, parent, name, kind,
719
Changed_content is True if the file's content has changed. This
720
includes changes to its kind, and to a symlink's target.
722
versioned, parent, name, kind, executable are tuples of (from, to).
723
If a file is missing in a tree, its kind is None.
725
Iteration is done in parent-to-child order, relative to the target
728
There is no guarantee that all paths are in sorted order: the
729
requirement to expand the search due to renames may result in children
730
that should be found early being found late in the search, after
731
lexically later results have been returned.
732
:param require_versioned: Raise errors.PathsNotVersionedError if a
733
path in the specific_files list is not versioned in one of
734
source, target or extra_trees.
735
:param want_unversioned: Should unversioned files be returned in the
736
output. An unversioned file is defined as one with (False, False)
737
for the versioned pair.
740
lookup_trees = [self.source]
742
lookup_trees.extend(extra_trees)
743
if specific_files == []:
744
specific_file_ids = []
746
specific_file_ids = self.target.paths2ids(specific_files,
747
lookup_trees, require_versioned=require_versioned)
749
all_unversioned = sorted([(p.split('/'), p) for p in
751
if specific_files is None or
752
osutils.is_inside_any(specific_files, p)])
753
all_unversioned = deque(all_unversioned)
755
all_unversioned = deque()
757
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
758
specific_file_ids=specific_file_ids))
759
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
760
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
761
specific_file_ids=specific_file_ids))
762
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
764
# the unversioned path lookup only occurs on real trees - where there
765
# can be extras. So the fake_entry is solely used to look up
766
# executable it values when execute is not supported.
767
fake_entry = InventoryFile('unused', 'unused', 'unused')
768
for to_path, to_entry in to_entries_by_dir:
769
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
770
unversioned_path = all_unversioned.popleft()
771
to_kind, to_executable, to_stat = \
772
self.target._comparison_data(fake_entry, unversioned_path[1])
773
yield (None, (None, unversioned_path[1]), True, (False, False),
775
(None, unversioned_path[0][-1]),
777
(None, to_executable))
778
file_id = to_entry.file_id
779
to_paths[file_id] = to_path
781
changed_content = False
782
from_path, from_entry = from_data.get(file_id, (None, None))
783
from_versioned = (from_entry is not None)
784
if from_entry is not None:
785
from_versioned = True
786
from_name = from_entry.name
787
from_parent = from_entry.parent_id
788
from_kind, from_executable, from_stat = \
789
self.source._comparison_data(from_entry, from_path)
792
from_versioned = False
796
from_executable = None
797
versioned = (from_versioned, True)
798
to_kind, to_executable, to_stat = \
799
self.target._comparison_data(to_entry, to_path)
800
kind = (from_kind, to_kind)
801
if kind[0] != kind[1]:
802
changed_content = True
803
elif from_kind == 'file':
804
from_size = self.source._file_size(from_entry, from_stat)
805
to_size = self.target._file_size(to_entry, to_stat)
806
if from_size != to_size:
807
changed_content = True
808
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
809
self.target.get_file_sha1(file_id, to_path, to_stat)):
810
changed_content = True
811
elif from_kind == 'symlink':
812
if (self.source.get_symlink_target(file_id) !=
813
self.target.get_symlink_target(file_id)):
814
changed_content = True
815
elif from_kind == 'tree-reference':
816
if (self.source.get_reference_revision(file_id, from_path)
817
!= self.target.get_reference_revision(file_id, to_path)):
818
changed_content = True
819
parent = (from_parent, to_entry.parent_id)
820
name = (from_name, to_entry.name)
821
executable = (from_executable, to_executable)
823
pb.update('comparing files', entry_count, num_entries)
824
if (changed_content is not False or versioned[0] != versioned[1]
825
or parent[0] != parent[1] or name[0] != name[1] or
826
executable[0] != executable[1] or include_unchanged):
827
yield (file_id, (from_path, to_path), changed_content,
828
versioned, parent, name, kind, executable)
830
while all_unversioned:
831
# yield any trailing unversioned paths
832
unversioned_path = all_unversioned.popleft()
833
to_kind, to_executable, to_stat = \
834
self.target._comparison_data(fake_entry, unversioned_path[1])
835
yield (None, (None, unversioned_path[1]), True, (False, False),
837
(None, unversioned_path[0][-1]),
839
(None, to_executable))
841
def get_to_path(to_entry):
842
if to_entry.parent_id is None:
843
to_path = '' # the root
845
if to_entry.parent_id not in to_paths:
847
return get_to_path(self.target.inventory[to_entry.parent_id])
848
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
850
to_paths[to_entry.file_id] = to_path
853
for path, from_entry in from_entries_by_dir:
854
file_id = from_entry.file_id
855
if file_id in to_paths:
858
if not file_id in self.target.inventory:
859
# common case - paths we have not emitted are not present in
863
to_path = get_to_path(self.target.inventory[file_id])
866
pb.update('comparing files', entry_count, num_entries)
867
versioned = (True, False)
868
parent = (from_entry.parent_id, None)
869
name = (from_entry.name, None)
870
from_kind, from_executable, stat_value = \
871
self.source._comparison_data(from_entry, path)
872
kind = (from_kind, None)
873
executable = (from_executable, None)
874
changed_content = True
875
# the parent's path is necessarily known at this point.
876
yield(file_id, (path, to_path), changed_content, versioned, parent,
877
name, kind, executable)
880
# This was deprecated before 0.12, but did not have an official warning
881
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
882
def RevisionTree(*args, **kwargs):
883
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
885
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
888
from bzrlib.revisiontree import RevisionTree as _RevisionTree
889
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
