181
140
preceeded by the parent of a directory, and all the contents of a
182
141
directory are grouped together.
184
return self.inventory.iter_entries_by_dir(
185
specific_file_ids=specific_file_ids)
187
def iter_references(self):
188
for path, entry in self.iter_entries_by_dir():
189
if entry.kind == 'tree-reference':
190
yield path, entry.file_id
143
return self.inventory.iter_entries_by_dir()
192
145
def kind(self, file_id):
193
raise NotImplementedError("Tree subclass %s must implement kind"
194
% self.__class__.__name__)
196
def stored_kind(self, file_id):
197
"""File kind stored for this file_id.
199
May not match kind on disk for working trees. Always available
200
for versioned files, even when the file itself is missing.
202
return self.kind(file_id)
204
def path_content_summary(self, path):
205
"""Get a summary of the information about path.
207
:param path: A relative path within the tree.
208
:return: A tuple containing kind, size, exec, sha1-or-link.
209
Kind is always present (see tree.kind()).
210
size is present if kind is file, None otherwise.
211
exec is None unless kind is file and the platform supports the 'x'
213
sha1-or-link is the link target if kind is symlink, or the sha1 if
214
it can be obtained without reading the file.
216
raise NotImplementedError(self.path_content_summary)
218
def get_reference_revision(self, file_id, path=None):
219
raise NotImplementedError("Tree subclass %s must implement "
220
"get_reference_revision"
221
% self.__class__.__name__)
223
def _comparison_data(self, entry, path):
224
"""Return a tuple of kind, executable, stat_value for a file.
226
entry may be None if there is no inventory entry for the file, but
227
path must always be supplied.
229
kind is None if there is no file present (even if an inventory id is
230
present). executable is False for non-file entries.
232
raise NotImplementedError(self._comparison_data)
234
def _file_size(self, entry, stat_value):
235
raise NotImplementedError(self._file_size)
146
raise NotImplementedError("subclasses must implement kind")
237
148
def _get_inventory(self):
238
149
return self._inventory
240
def get_file(self, file_id, path=None):
241
"""Return a file object for the file file_id in the tree.
243
If both file_id and path are defined, it is implementation defined as
244
to which one is used.
151
def get_file(self, file_id):
152
"""Return a file object for the file file_id in the tree."""
246
153
raise NotImplementedError(self.get_file)
248
def get_file_mtime(self, file_id, path=None):
249
"""Return the modification time for a file.
251
:param file_id: The handle for this file.
252
:param path: The path that this file can be found at.
253
These must point to the same object.
255
raise NotImplementedError(self.get_file_mtime)
257
155
def get_file_by_path(self, path):
258
return self.get_file(self._inventory.path2id(path), path)
260
def iter_files_bytes(self, desired_files):
261
"""Iterate through file contents.
263
Files will not necessarily be returned in the order they occur in
264
desired_files. No specific order is guaranteed.
266
Yields pairs of identifier, bytes_iterator. identifier is an opaque
267
value supplied by the caller as part of desired_files. It should
268
uniquely identify the file version in the caller's context. (Examples:
269
an index number or a TreeTransform trans_id.)
271
bytes_iterator is an iterable of bytestrings for the file. The
272
kind of iterable and length of the bytestrings are unspecified, but for
273
this implementation, it is a tuple containing a single bytestring with
274
the complete text of the file.
276
:param desired_files: a list of (file_id, identifier) pairs
278
for file_id, identifier in desired_files:
279
# We wrap the string in a tuple so that we can return an iterable
280
# of bytestrings. (Technically, a bytestring is also an iterable
281
# of bytestrings, but iterating through each character is not
283
cur_file = (self.get_file_text(file_id),)
284
yield identifier, cur_file
286
def get_symlink_target(self, file_id):
287
"""Get the target for a given file_id.
289
It is assumed that the caller already knows that file_id is referencing
291
:param file_id: Handle for the symlink entry.
292
:return: The path the symlink points to.
294
raise NotImplementedError(self.get_symlink_target)
296
def get_root_id(self):
297
"""Return the file_id for the root of this tree."""
298
raise NotImplementedError(self.get_root_id)
300
def annotate_iter(self, file_id,
301
default_revision=_mod_revision.CURRENT_REVISION):
302
"""Return an iterator of revision_id, line tuples.
304
For working trees (and mutable trees in general), the special
305
revision_id 'current:' will be used for lines that are new in this
306
tree, e.g. uncommitted changes.
307
:param file_id: The file to produce an annotated version from
308
:param default_revision: For lines that don't match a basis, mark them
309
with this revision id. Not all implementations will make use of
312
raise NotImplementedError(self.annotate_iter)
314
def _get_plan_merge_data(self, file_id, other, base):
315
from bzrlib import merge, versionedfile
316
vf = versionedfile._PlanMergeVersionedFile(file_id)
317
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
318
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
320
last_revision_base = None
322
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
323
return vf, last_revision_a, last_revision_b, last_revision_base
325
def plan_file_merge(self, file_id, other, base=None):
326
"""Generate a merge plan based on annotations.
328
If the file contains uncommitted changes in this tree, they will be
329
attributed to the 'current:' pseudo-revision. If the file contains
330
uncommitted changes in the other tree, they will be assigned to the
331
'other:' pseudo-revision.
333
data = self._get_plan_merge_data(file_id, other, base)
334
vf, last_revision_a, last_revision_b, last_revision_base = data
335
return vf.plan_merge(last_revision_a, last_revision_b,
338
def plan_file_lca_merge(self, file_id, other, base=None):
339
"""Generate a merge plan based lca-newness.
341
If the file contains uncommitted changes in this tree, they will be
342
attributed to the 'current:' pseudo-revision. If the file contains
343
uncommitted changes in the other tree, they will be assigned to the
344
'other:' pseudo-revision.
346
data = self._get_plan_merge_data(file_id, other, base)
347
vf, last_revision_a, last_revision_b, last_revision_base = data
348
return vf.plan_lca_merge(last_revision_a, last_revision_b,
351
def _get_file_revision(self, file_id, vf, tree_revision):
352
def file_revision(revision_tree):
353
revision_tree.lock_read()
355
return revision_tree.inventory[file_id].revision
357
revision_tree.unlock()
359
def iter_parent_trees():
360
for revision_id in self.get_parent_ids():
362
yield self.revision_tree(revision_id)
364
yield self.repository.revision_tree(revision_id)
366
if getattr(self, '_get_weave', None) is None:
367
last_revision = tree_revision
368
parent_revisions = [file_revision(t) for t in iter_parent_trees()]
369
vf.add_lines(last_revision, parent_revisions,
370
self.get_file(file_id).readlines())
371
repo = self.branch.repository
372
transaction = repo.get_transaction()
373
base_vf = repo.weave_store.get_weave(file_id, transaction)
375
last_revision = file_revision(self)
376
base_vf = self._get_weave(file_id)
377
vf.fallback_versionedfiles.append(base_vf)
156
return self.get_file(self._inventory.path2id(path))
380
158
inventory = property(_get_inventory,
381
159
doc="Inventory of this Tree")
467
210
pred = self.inventory.has_filename
468
211
return set((p for p in paths if not pred(p)))
470
def walkdirs(self, prefix=""):
471
"""Walk the contents of this tree from path down.
473
This yields all the data about the contents of a directory at a time.
474
After each directory has been yielded, if the caller has mutated the
475
list to exclude some directories, they are then not descended into.
477
The data yielded is of the form:
478
((directory-relpath, directory-path-from-root, directory-fileid),
479
[(relpath, basename, kind, lstat, path_from_tree_root, file_id,
480
versioned_kind), ...]),
481
- directory-relpath is the containing dirs relpath from prefix
482
- directory-path-from-root is the containing dirs path from /
483
- directory-fileid is the id of the directory if it is versioned.
484
- relpath is the relative path within the subtree being walked.
485
- basename is the basename
486
- kind is the kind of the file now. If unknonwn then the file is not
487
present within the tree - but it may be recorded as versioned. See
489
- lstat is the stat data *if* the file was statted.
490
- path_from_tree_root is the path from the root of the tree.
491
- file_id is the file_id if the entry is versioned.
492
- versioned_kind is the kind of the file as last recorded in the
493
versioning system. If 'unknown' the file is not versioned.
494
One of 'kind' and 'versioned_kind' must not be 'unknown'.
496
:param prefix: Start walking from prefix within the tree rather than
497
at the root. This allows one to walk a subtree but get paths that are
498
relative to a tree rooted higher up.
499
:return: an iterator over the directory data.
501
raise NotImplementedError(self.walkdirs)
215
from bzrlib.revisiontree import RevisionTree
504
218
class EmptyTree(Tree):
506
220
def __init__(self):
507
self._inventory = Inventory(root_id=None)
508
symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
509
' use repository.revision_tree instead.',
510
DeprecationWarning, stacklevel=2)
221
self._inventory = Inventory()
222
warn('EmptyTree is deprecated as of bzr 0.9 please use '
223
'repository.revision_tree instead.',
224
DeprecationWarning, stacklevel=2)
512
226
def get_parent_ids(self):
702
414
:param require_versioned: An optional boolean (defaults to False). When
703
415
supplied and True all the 'specific_files' must be versioned, or
704
416
a PathsNotVersionedError will be thrown.
705
:param want_unversioned: Scan for unversioned paths.
707
# NB: show_status depends on being able to pass in non-versioned files
708
# and report them as unknown
709
trees = (self.source,)
418
# NB: show_status depends on being able to pass in non-versioned files and
419
# report them as unknown
420
trees = (self.source, self.target)
710
421
if extra_trees is not None:
711
422
trees = trees + tuple(extra_trees)
712
# target is usually the newer tree:
713
specific_file_ids = self.target.paths2ids(specific_files, trees,
714
require_versioned=require_versioned)
423
specific_file_ids = find_ids_across_trees(specific_files,
424
trees, require_versioned=require_versioned)
715
425
if specific_files and not specific_file_ids:
716
426
# All files are unversioned, so just return an empty delta
717
427
# _compare_trees would think we want a complete delta
718
result = delta.TreeDelta()
719
fake_entry = InventoryFile('unused', 'unused', 'unused')
720
result.unversioned = [(path, None,
721
self.target._comparison_data(fake_entry, path)[0]) for path in
428
return delta.TreeDelta()
724
429
return delta._compare_trees(self.source, self.target, want_unchanged,
725
specific_files, include_root, extra_trees=extra_trees,
726
require_versioned=require_versioned,
727
want_unversioned=want_unversioned)
729
def iter_changes(self, include_unchanged=False,
730
specific_files=None, pb=None, extra_trees=[],
731
require_versioned=True, want_unversioned=False):
732
"""Generate an iterator of changes between trees.
735
(file_id, (path_in_source, path_in_target),
736
changed_content, versioned, parent, name, kind,
739
Changed_content is True if the file's content has changed. This
740
includes changes to its kind, and to a symlink's target.
742
versioned, parent, name, kind, executable are tuples of (from, to).
743
If a file is missing in a tree, its kind is None.
745
Iteration is done in parent-to-child order, relative to the target
748
There is no guarantee that all paths are in sorted order: the
749
requirement to expand the search due to renames may result in children
750
that should be found early being found late in the search, after
751
lexically later results have been returned.
752
:param require_versioned: Raise errors.PathsNotVersionedError if a
753
path in the specific_files list is not versioned in one of
754
source, target or extra_trees.
755
:param want_unversioned: Should unversioned files be returned in the
756
output. An unversioned file is defined as one with (False, False)
757
for the versioned pair.
760
lookup_trees = [self.source]
762
lookup_trees.extend(extra_trees)
763
if specific_files == []:
764
specific_file_ids = []
766
specific_file_ids = self.target.paths2ids(specific_files,
767
lookup_trees, require_versioned=require_versioned)
769
all_unversioned = sorted([(p.split('/'), p) for p in
771
if specific_files is None or
772
osutils.is_inside_any(specific_files, p)])
773
all_unversioned = deque(all_unversioned)
775
all_unversioned = deque()
777
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
778
specific_file_ids=specific_file_ids))
779
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
780
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
781
specific_file_ids=specific_file_ids))
782
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
784
# the unversioned path lookup only occurs on real trees - where there
785
# can be extras. So the fake_entry is solely used to look up
786
# executable it values when execute is not supported.
787
fake_entry = InventoryFile('unused', 'unused', 'unused')
788
for to_path, to_entry in to_entries_by_dir:
789
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
790
unversioned_path = all_unversioned.popleft()
791
to_kind, to_executable, to_stat = \
792
self.target._comparison_data(fake_entry, unversioned_path[1])
793
yield (None, (None, unversioned_path[1]), True, (False, False),
795
(None, unversioned_path[0][-1]),
797
(None, to_executable))
798
file_id = to_entry.file_id
799
to_paths[file_id] = to_path
801
changed_content = False
802
from_path, from_entry = from_data.get(file_id, (None, None))
803
from_versioned = (from_entry is not None)
804
if from_entry is not None:
805
from_versioned = True
806
from_name = from_entry.name
807
from_parent = from_entry.parent_id
808
from_kind, from_executable, from_stat = \
809
self.source._comparison_data(from_entry, from_path)
812
from_versioned = False
816
from_executable = None
817
versioned = (from_versioned, True)
818
to_kind, to_executable, to_stat = \
819
self.target._comparison_data(to_entry, to_path)
820
kind = (from_kind, to_kind)
821
if kind[0] != kind[1]:
822
changed_content = True
823
elif from_kind == 'file':
824
from_size = self.source._file_size(from_entry, from_stat)
825
to_size = self.target._file_size(to_entry, to_stat)
826
if from_size != to_size:
827
changed_content = True
828
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
829
self.target.get_file_sha1(file_id, to_path, to_stat)):
830
changed_content = True
831
elif from_kind == 'symlink':
832
if (self.source.get_symlink_target(file_id) !=
833
self.target.get_symlink_target(file_id)):
834
changed_content = True
835
elif from_kind == 'tree-reference':
836
if (self.source.get_reference_revision(file_id, from_path)
837
!= self.target.get_reference_revision(file_id, to_path)):
838
changed_content = True
839
parent = (from_parent, to_entry.parent_id)
840
name = (from_name, to_entry.name)
841
executable = (from_executable, to_executable)
843
pb.update('comparing files', entry_count, num_entries)
844
if (changed_content is not False or versioned[0] != versioned[1]
845
or parent[0] != parent[1] or name[0] != name[1] or
846
executable[0] != executable[1] or include_unchanged):
847
yield (file_id, (from_path, to_path), changed_content,
848
versioned, parent, name, kind, executable)
850
while all_unversioned:
851
# yield any trailing unversioned paths
852
unversioned_path = all_unversioned.popleft()
853
to_kind, to_executable, to_stat = \
854
self.target._comparison_data(fake_entry, unversioned_path[1])
855
yield (None, (None, unversioned_path[1]), True, (False, False),
857
(None, unversioned_path[0][-1]),
859
(None, to_executable))
861
def get_to_path(to_entry):
862
if to_entry.parent_id is None:
863
to_path = '' # the root
865
if to_entry.parent_id not in to_paths:
867
return get_to_path(self.target.inventory[to_entry.parent_id])
868
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
870
to_paths[to_entry.file_id] = to_path
873
for path, from_entry in from_entries_by_dir:
874
file_id = from_entry.file_id
875
if file_id in to_paths:
878
if not file_id in self.target.inventory:
879
# common case - paths we have not emitted are not present in
883
to_path = get_to_path(self.target.inventory[file_id])
886
pb.update('comparing files', entry_count, num_entries)
887
versioned = (True, False)
888
parent = (from_entry.parent_id, None)
889
name = (from_entry.name, None)
890
from_kind, from_executable, stat_value = \
891
self.source._comparison_data(from_entry, path)
892
kind = (from_kind, None)
893
executable = (from_executable, None)
894
changed_content = True
895
# the parent's path is necessarily known at this point.
896
yield(file_id, (path, to_path), changed_content, versioned, parent,
897
name, kind, executable)
900
# This was deprecated before 0.12, but did not have an official warning
901
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
902
def RevisionTree(*args, **kwargs):
903
"""RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
905
Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
908
from bzrlib.revisiontree import RevisionTree as _RevisionTree
909
return _RevisionTree(*args, **kwargs)
430
specific_file_ids, include_root)
added
removed
bzrlib/tree.py
