173
127
preceeded by the parent of a directory, and all the contents of a
174
128
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
130
return self.inventory.iter_entries_by_dir()
184
132
def kind(self, file_id):
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)
133
raise NotImplementedError("subclasses must implement kind")
221
135
def _get_inventory(self):
222
136
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)
241
138
def get_file_by_path(self, 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 annotate_iter(self, file_id):
281
"""Return an iterator of revision_id, line tuples.
283
For working trees (and mutable trees in general), the special
284
revision_id 'current:' will be used for lines that are new in this
285
tree, e.g. uncommitted changes.
286
:param file_id: The file to produce an annotated version from
288
raise NotImplementedError(self.annotate_iter)
290
def plan_file_merge(self, file_id, other):
291
"""Generate a merge plan based on annotations.
293
If the file contains uncommitted changes in this tree, they will be
294
attributed to the 'current:' pseudo-revision. If the file contains
295
uncommitted changes in the other tree, they will be assigned to the
296
'other:' pseudo-revision.
298
from bzrlib import merge
299
annotated_a = list(self.annotate_iter(file_id,
300
_mod_revision.CURRENT_REVISION))
301
annotated_b = list(other.annotate_iter(file_id, 'other:'))
302
ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
303
ancestors_b = other._get_ancestors('other:')
304
return merge._plan_annotate_merge(annotated_a, annotated_b,
305
ancestors_a, ancestors_b)
139
return self.get_file(self._inventory.path2id(path))
307
141
inventory = property(_get_inventory,
308
142
doc="Inventory of this Tree")
394
190
pred = self.inventory.has_filename
395
191
return set((p for p in paths if not pred(p)))
397
def walkdirs(self, prefix=""):
398
"""Walk the contents of this tree from path down.
400
This yields all the data about the contents of a directory at a time.
401
After each directory has been yielded, if the caller has mutated the
402
list to exclude some directories, they are then not descended into.
404
The data yielded is of the form:
405
((directory-relpath, directory-path-from-root, directory-fileid),
406
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
407
versioned_kind), ...]),
408
- directory-relpath is the containing dirs relpath from prefix
409
- directory-path-from-root is the containing dirs path from /
410
- directory-fileid is the id of the directory if it is versioned.
411
- relpath is the relative path within the subtree being walked.
412
- basename is the basename
413
- kind is the kind of the file now. If unknonwn then the file is not
414
present within the tree - but it may be recorded as versioned. See
416
- lstat is the stat data *if* the file was statted.
417
- path_from_tree_root is the path from the root of the tree.
418
- file_id is the file_id if the entry is versioned.
419
- versioned_kind is the kind of the file as last recorded in the
420
versioning system. If 'unknown' the file is not versioned.
421
One of 'kind' and 'versioned_kind' must not be 'unknown'.
423
:param prefix: Start walking from prefix within the tree rather than
424
at the root. This allows one to walk a subtree but get paths that are
425
relative to a tree rooted higher up.
426
:return: an iterator over the directory data.
428
raise NotImplementedError(self.walkdirs)
195
from bzrlib.revisiontree import RevisionTree
431
198
class EmptyTree(Tree):
433
200
def __init__(self):
434
self._inventory = Inventory(root_id=None)
435
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
436
' use repository.revision_tree instead.',
437
DeprecationWarning, stacklevel=2)
201
self._inventory = Inventory()
202
warn('EmptyTree is deprecated as of bzr 0.9 please use '
203
'repository.revision_tree instead.',
204
DeprecationWarning, stacklevel=2)
439
206
def get_parent_ids(self):
629
394
:param require_versioned: An optional boolean (defaults to False). When
630
395
supplied and True all the 'specific_files' must be versioned, or
631
396
a PathsNotVersionedError will be thrown.
632
:param want_unversioned: Scan for unversioned paths.
634
# NB: show_status depends on being able to pass in non-versioned files
635
# and report them as unknown
636
trees = (self.source,)
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)
637
401
if extra_trees is not None:
638
402
trees = trees + tuple(extra_trees)
639
# target is usually the newer tree:
640
specific_file_ids = self.target.paths2ids(specific_files, trees,
641
require_versioned=require_versioned)
403
specific_file_ids = find_ids_across_trees(specific_files,
404
trees, require_versioned=require_versioned)
642
405
if specific_files and not specific_file_ids:
643
406
# All files are unversioned, so just return an empty delta
644
407
# _compare_trees would think we want a complete delta
645
result = delta.TreeDelta()
646
fake_entry = InventoryFile('unused', 'unused', 'unused')
647
result.unversioned = [(path, None,
648
self.target._comparison_data(fake_entry, path)[0]) for path in
408
return delta.TreeDelta()
651
409
return delta._compare_trees(self.source, self.target, want_unchanged,
652
specific_files, include_root, extra_trees=extra_trees,
653
require_versioned=require_versioned,
654
want_unversioned=want_unversioned)
656
def _iter_changes(self, include_unchanged=False,
657
specific_files=None, pb=None, extra_trees=[],
658
require_versioned=True, want_unversioned=False):
659
"""Generate an iterator of changes between trees.
662
(file_id, (path_in_source, path_in_target),
663
changed_content, versioned, parent, name, kind,
666
Changed_content is True if the file's content has changed. This
667
includes changes to its kind, and to a symlink's target.
669
versioned, parent, name, kind, executable are tuples of (from, to).
670
If a file is missing in a tree, its kind is None.
672
Iteration is done in parent-to-child order, relative to the target
675
There is no guarantee that all paths are in sorted order: the
676
requirement to expand the search due to renames may result in children
677
that should be found early being found late in the search, after
678
lexically later results have been returned.
679
:param require_versioned: Raise errors.PathsNotVersionedError if a
680
path in the specific_files list is not versioned in one of
681
source, target or extra_trees.
682
:param want_unversioned: Should unversioned files be returned in the
683
output. An unversioned file is defined as one with (False, False)
684
for the versioned pair.
687
lookup_trees = [self.source]
689
lookup_trees.extend(extra_trees)
690
if specific_files == []:
691
specific_file_ids = []
693
specific_file_ids = self.target.paths2ids(specific_files,
694
lookup_trees, require_versioned=require_versioned)
696
all_unversioned = sorted([(p.split('/'), p) for p in
698
if specific_files is None or
699
osutils.is_inside_any(specific_files, p)])
700
all_unversioned = deque(all_unversioned)
702
all_unversioned = deque()
704
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
705
specific_file_ids=specific_file_ids))
706
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
707
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
708
specific_file_ids=specific_file_ids))
709
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
711
# the unversioned path lookup only occurs on real trees - where there
712
# can be extras. So the fake_entry is solely used to look up
713
# executable it values when execute is not supported.
714
fake_entry = InventoryFile('unused', 'unused', 'unused')
715
for to_path, to_entry in to_entries_by_dir:
716
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
717
unversioned_path = all_unversioned.popleft()
718
to_kind, to_executable, to_stat = \
719
self.target._comparison_data(fake_entry, unversioned_path[1])
720
yield (None, (None, unversioned_path[1]), True, (False, False),
722
(None, unversioned_path[0][-1]),
724
(None, to_executable))
725
file_id = to_entry.file_id
726
to_paths[file_id] = to_path
728
changed_content = False
729
from_path, from_entry = from_data.get(file_id, (None, None))
730
from_versioned = (from_entry is not None)
731
if from_entry is not None:
732
from_versioned = True
733
from_name = from_entry.name
734
from_parent = from_entry.parent_id
735
from_kind, from_executable, from_stat = \
736
self.source._comparison_data(from_entry, from_path)
739
from_versioned = False
743
from_executable = None
744
versioned = (from_versioned, True)
745
to_kind, to_executable, to_stat = \
746
self.target._comparison_data(to_entry, to_path)
747
kind = (from_kind, to_kind)
748
if kind[0] != kind[1]:
749
changed_content = True
750
elif from_kind == 'file':
751
from_size = self.source._file_size(from_entry, from_stat)
752
to_size = self.target._file_size(to_entry, to_stat)
753
if from_size != to_size:
754
changed_content = True
755
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
756
self.target.get_file_sha1(file_id, to_path, to_stat)):
757
changed_content = True
758
elif from_kind == 'symlink':
759
if (self.source.get_symlink_target(file_id) !=
760
self.target.get_symlink_target(file_id)):
761
changed_content = True
762
elif from_kind == 'tree-reference':
763
if (self.source.get_reference_revision(file_id, from_path)
764
!= self.target.get_reference_revision(file_id, to_path)):
765
changed_content = True
766
parent = (from_parent, to_entry.parent_id)
767
name = (from_name, to_entry.name)
768
executable = (from_executable, to_executable)
770
pb.update('comparing files', entry_count, num_entries)
771
if (changed_content is not False or versioned[0] != versioned[1]
772
or parent[0] != parent[1] or name[0] != name[1] or
773
executable[0] != executable[1] or include_unchanged):
774
yield (file_id, (from_path, to_path), changed_content,
775
versioned, parent, name, kind, executable)
777
while all_unversioned:
778
# yield any trailing unversioned paths
779
unversioned_path = all_unversioned.popleft()
780
to_kind, to_executable, to_stat = \
781
self.target._comparison_data(fake_entry, unversioned_path[1])
782
yield (None, (None, unversioned_path[1]), True, (False, False),
784
(None, unversioned_path[0][-1]),
786
(None, to_executable))
788
def get_to_path(to_entry):
789
if to_entry.parent_id is None:
790
to_path = '' # the root
792
if to_entry.parent_id not in to_paths:
794
return get_to_path(self.target.inventory[to_entry.parent_id])
795
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
797
to_paths[to_entry.file_id] = to_path
800
for path, from_entry in from_entries_by_dir:
801
file_id = from_entry.file_id
802
if file_id in to_paths:
805
if not file_id in self.target.inventory:
806
# common case - paths we have not emitted are not present in
810
to_path = get_to_path(self.target.inventory[file_id])
813
pb.update('comparing files', entry_count, num_entries)
814
versioned = (True, False)
815
parent = (from_entry.parent_id, None)
816
name = (from_entry.name, None)
817
from_kind, from_executable, stat_value = \
818
self.source._comparison_data(from_entry, path)
819
kind = (from_kind, None)
820
executable = (from_executable, None)
821
changed_content = True
822
# the parent's path is necessarily known at this point.
823
yield(file_id, (path, to_path), changed_content, versioned, parent,
824
name, kind, executable)
827
# This was deprecated before 0.12, but did not have an official warning
828
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
829
def RevisionTree(*args, **kwargs):
830
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
832
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
835
from bzrlib.revisiontree import RevisionTree as _RevisionTree
836
return _RevisionTree(*args, **kwargs)
added
removed
bzrlib/tree.py
