84
89
specific_files=specific_files,
85
90
extra_trees=extra_trees,
86
91
require_versioned=require_versioned,
87
include_root=include_root
92
include_root=include_root,
93
want_unversioned=want_unversioned,
90
def _iter_changes(self, from_tree, include_unchanged=False,
91
specific_file_ids=None, pb=None):
96
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
97
def _iter_changes(self, *args, **kwargs):
98
return self.iter_changes(*args, **kwargs)
100
def iter_changes(self, from_tree, include_unchanged=False,
101
specific_files=None, pb=None, extra_trees=None,
102
require_versioned=True, want_unversioned=False):
92
103
intertree = InterTree.get(from_tree, self)
93
return intertree._iter_changes(from_tree, self, include_unchanged,
94
specific_file_ids, pb)
104
return intertree.iter_changes(include_unchanged, specific_files, pb,
105
extra_trees, require_versioned, want_unversioned=want_unversioned)
96
107
def conflicts(self):
97
108
"""Get a list of the conflicts in the tree.
99
110
Each conflict is an instance of bzrlib.conflicts.Conflict.
112
return _mod_conflicts.ConflictList()
115
"""For trees that can have unversioned files, return all such paths."""
103
118
def get_parent_ids(self):
153
184
return self.inventory.iter_entries_by_dir(
154
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
156
192
def kind(self, file_id):
157
raise NotImplementedError("subclasses must implement kind")
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__)
159
223
def _comparison_data(self, entry, path):
160
224
"""Return a tuple of kind, executable, stat_value for a file.
173
237
def _get_inventory(self):
174
238
return self._inventory
176
def get_file(self, file_id):
177
"""Return a file object for the file file_id in the tree."""
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.
178
246
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
def get_file_size(self, file_id):
258
"""Return the size of a file in bytes.
260
This applies only to regular files. If invoked on directories or
261
symlinks, it will return None.
262
:param file_id: The file-id of the file
264
raise NotImplementedError(self.get_file_size)
180
266
def get_file_by_path(self, path):
181
return self.get_file(self._inventory.path2id(path))
183
def annotate_iter(self, file_id):
184
"""Return an iterator of revision_id, line tuples
267
return self.get_file(self._inventory.path2id(path), path)
269
def iter_files_bytes(self, desired_files):
270
"""Iterate through file contents.
272
Files will not necessarily be returned in the order they occur in
273
desired_files. No specific order is guaranteed.
275
Yields pairs of identifier, bytes_iterator. identifier is an opaque
276
value supplied by the caller as part of desired_files. It should
277
uniquely identify the file version in the caller's context. (Examples:
278
an index number or a TreeTransform trans_id.)
280
bytes_iterator is an iterable of bytestrings for the file. The
281
kind of iterable and length of the bytestrings are unspecified, but for
282
this implementation, it is a tuple containing a single bytestring with
283
the complete text of the file.
285
:param desired_files: a list of (file_id, identifier) pairs
287
for file_id, identifier in desired_files:
288
# We wrap the string in a tuple so that we can return an iterable
289
# of bytestrings. (Technically, a bytestring is also an iterable
290
# of bytestrings, but iterating through each character is not
292
cur_file = (self.get_file_text(file_id),)
293
yield identifier, cur_file
295
def get_symlink_target(self, file_id):
296
"""Get the target for a given file_id.
298
It is assumed that the caller already knows that file_id is referencing
300
:param file_id: Handle for the symlink entry.
301
:return: The path the symlink points to.
303
raise NotImplementedError(self.get_symlink_target)
305
def get_root_id(self):
306
"""Return the file_id for the root of this tree."""
307
raise NotImplementedError(self.get_root_id)
309
def annotate_iter(self, file_id,
310
default_revision=_mod_revision.CURRENT_REVISION):
311
"""Return an iterator of revision_id, line tuples.
186
313
For working trees (and mutable trees in general), the special
187
314
revision_id 'current:' will be used for lines that are new in this
188
315
tree, e.g. uncommitted changes.
189
316
:param file_id: The file to produce an annotated version from
317
:param default_revision: For lines that don't match a basis, mark them
318
with this revision id. Not all implementations will make use of
191
321
raise NotImplementedError(self.annotate_iter)
323
def _get_plan_merge_data(self, file_id, other, base):
324
from bzrlib import merge, versionedfile
325
vf = versionedfile._PlanMergeVersionedFile(file_id)
326
last_revision_a = self._get_file_revision(file_id, vf, 'this:')
327
last_revision_b = other._get_file_revision(file_id, vf, 'other:')
329
last_revision_base = None
331
last_revision_base = base._get_file_revision(file_id, vf, 'base:')
332
return vf, last_revision_a, last_revision_b, last_revision_base
334
def plan_file_merge(self, file_id, other, base=None):
335
"""Generate a merge plan based on annotations.
337
If the file contains uncommitted changes in this tree, they will be
338
attributed to the 'current:' pseudo-revision. If the file contains
339
uncommitted changes in the other tree, they will be assigned to the
340
'other:' pseudo-revision.
342
data = self._get_plan_merge_data(file_id, other, base)
343
vf, last_revision_a, last_revision_b, last_revision_base = data
344
return vf.plan_merge(last_revision_a, last_revision_b,
347
def plan_file_lca_merge(self, file_id, other, base=None):
348
"""Generate a merge plan based lca-newness.
350
If the file contains uncommitted changes in this tree, they will be
351
attributed to the 'current:' pseudo-revision. If the file contains
352
uncommitted changes in the other tree, they will be assigned to the
353
'other:' pseudo-revision.
355
data = self._get_plan_merge_data(file_id, other, base)
356
vf, last_revision_a, last_revision_b, last_revision_base = data
357
return vf.plan_lca_merge(last_revision_a, last_revision_b,
360
def _get_file_revision(self, file_id, vf, tree_revision):
361
def file_revision(revision_tree):
362
revision_tree.lock_read()
364
return revision_tree.inventory[file_id].revision
366
revision_tree.unlock()
368
def iter_parent_trees():
369
for revision_id in self.get_parent_ids():
371
yield self.revision_tree(revision_id)
373
yield self.repository.revision_tree(revision_id)
375
if getattr(self, '_get_weave', None) is None:
376
last_revision = tree_revision
377
parent_revisions = [file_revision(t) for t in iter_parent_trees()]
378
vf.add_lines(last_revision, parent_revisions,
379
self.get_file(file_id).readlines())
380
repo = self.branch.repository
381
transaction = repo.get_transaction()
382
base_vf = repo.weave_store.get_weave(file_id, transaction)
384
last_revision = file_revision(self)
385
base_vf = self._get_weave(file_id)
386
vf.fallback_versionedfiles.append(base_vf)
193
389
inventory = property(_get_inventory,
194
390
doc="Inventory of this Tree")
212
408
"file is actually %s" % fp['sha1'],
213
409
"store is probably damaged/corrupt"])
215
412
def path2id(self, path):
216
413
"""Return the id for path in this tree."""
217
414
return self._inventory.path2id(path)
416
def paths2ids(self, paths, trees=[], require_versioned=True):
417
"""Return all the ids that can be reached by walking from paths.
419
Each path is looked up in this tree and any extras provided in
420
trees, and this is repeated recursively: the children in an extra tree
421
of a directory that has been renamed under a provided path in this tree
422
are all returned, even if none exist under a provided path in this
423
tree, and vice versa.
425
:param paths: An iterable of paths to start converting to ids from.
426
Alternatively, if paths is None, no ids should be calculated and None
427
will be returned. This is offered to make calling the api unconditional
428
for code that *might* take a list of files.
429
:param trees: Additional trees to consider.
430
:param require_versioned: If False, do not raise NotVersionedError if
431
an element of paths is not versioned in this tree and all of trees.
433
return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
219
435
def print_file(self, file_id):
220
436
"""Print file with id `file_id` to stdout."""
408
624
specified_path_ids = _find_ids_across_trees(filenames, trees,
409
625
require_versioned)
410
626
return _find_children_across_trees(specified_path_ids, trees)
411
# specified_ids = [id for path, id in _find_path_ids_across_trees(filenames, trees, require_versioned)]
412
# return _find_children_across_trees(specified_ids, trees)
414
def find_path_ids_across_trees(filenames, trees, require_versioned=True):
415
"""Find the paths and ids corresponding to specified filenames.
417
All matches in all trees will be used, and all children of matched
418
directories will be included
420
:param filenames: The filenames to find file_ids for
421
:param trees: The trees to find file_ids within
422
:param require_versioned: if true, all specified filenames must occur in
424
:return: a set of (path, file ids) for the specified filenames and their
425
children. The returned path is the path of the id in the first tree
426
that contains it. This matters when files have been moved
430
# This function needs to know the ids for filenames in all trees, then
431
# search for those same files and children in all the other trees.
432
# it is complicated by the same path in two trees being able to have
433
# different ids, which might both be present in both trees.
434
# consider two trees, which have had 'mv foo bar' and 'mv baz foo' done
435
# in this case, a diff of 'foo' should should changes to both the current
436
# 'bar' and the current 'foo' which was baz. Its arguable that if
437
# the situation is 'mv parent/foo bar' and 'mv baz parent/foo', that
438
# we should return the current bar and the current parent/foo' - at the
439
# moment we do, but we loop around all ids and all trees: I*T checks.
441
# Updating this algorithm to be fast in the common case:
442
# nothing has moved, all files have the same id in parent, child and there
443
# are only two trees (or one is working tree and the others are parents).
444
# walk the dirstate. as we find each path, gather the paths of that
445
# id in all trees. add a mapping from the id to the path in those trees.
446
# now lookup children by id, again in all trees; for these trees that
447
# nothing has moved in, the id->path mapping will allow us to find the
448
# parent trivially. To answer 'has anything been moved' in one of the
449
# dirstate parent trees though, we will need to stare harder at it.
451
# Now, given a path index, that is trivial for any one tree, and given
452
# that we can ask for additional data from a dirstate tree, its a single
453
# pass, though it will require scanning the entire tree to find paths
454
# that were at the current location.
455
# ideal results?: There are three things: tree, path, id. Pathologically
456
# we can have completely disjoint ids for each tree; but we cannot have
457
# disjoin paths for each tree, except if we scan each tree for the
458
# different ids from other trees.
460
specified_path_ids = _find_ids_across_trees(filenames, trees,
462
return _find_path_id_children_across_trees(specified_path_ids, trees)
465
629
def _find_ids_across_trees(filenames, trees, require_versioned):
546
711
:param require_versioned: An optional boolean (defaults to False). When
547
712
supplied and True all the 'specific_files' must be versioned, or
548
713
a PathsNotVersionedError will be thrown.
714
:param want_unversioned: Scan for unversioned paths.
550
716
# NB: show_status depends on being able to pass in non-versioned files
551
717
# and report them as unknown
552
trees = (self.source, self.target)
718
trees = (self.source,)
553
719
if extra_trees is not None:
554
720
trees = trees + tuple(extra_trees)
555
specific_file_ids = find_ids_across_trees(specific_files,
556
trees, require_versioned=require_versioned)
721
# target is usually the newer tree:
722
specific_file_ids = self.target.paths2ids(specific_files, trees,
723
require_versioned=require_versioned)
557
724
if specific_files and not specific_file_ids:
558
725
# All files are unversioned, so just return an empty delta
559
726
# _compare_trees would think we want a complete delta
560
return delta.TreeDelta()
727
result = delta.TreeDelta()
728
fake_entry = InventoryFile('unused', 'unused', 'unused')
729
result.unversioned = [(path, None,
730
self.target._comparison_data(fake_entry, path)[0]) for path in
561
733
return delta._compare_trees(self.source, self.target, want_unchanged,
562
specific_file_ids, include_root)
734
specific_files, include_root, extra_trees=extra_trees,
735
require_versioned=require_versioned,
736
want_unversioned=want_unversioned)
564
def _iter_changes(self, from_tree, to_tree, include_unchanged,
565
specific_file_ids, pb):
738
def iter_changes(self, include_unchanged=False,
739
specific_files=None, pb=None, extra_trees=[],
740
require_versioned=True, want_unversioned=False):
566
741
"""Generate an iterator of changes between trees.
568
743
A tuple is returned:
569
(file_id, path, changed_content, versioned, parent, name, kind,
744
(file_id, (path_in_source, path_in_target),
745
changed_content, versioned, parent, name, kind,
572
Path is relative to the to_tree. changed_content is True if the file's
573
content has changed. This includes changes to its kind, and to
748
Changed_content is True if the file's content has changed. This
749
includes changes to its kind, and to a symlink's target.
576
751
versioned, parent, name, kind, executable are tuples of (from, to).
577
752
If a file is missing in a tree, its kind is None.
579
Iteration is done in parent-to-child order, relative to the to_tree.
754
Iteration is done in parent-to-child order, relative to the target
757
There is no guarantee that all paths are in sorted order: the
758
requirement to expand the search due to renames may result in children
759
that should be found early being found late in the search, after
760
lexically later results have been returned.
761
:param require_versioned: Raise errors.PathsNotVersionedError if a
762
path in the specific_files list is not versioned in one of
763
source, target or extra_trees.
764
:param want_unversioned: Should unversioned files be returned in the
765
output. An unversioned file is defined as one with (False, False)
766
for the versioned pair.
769
lookup_trees = [self.source]
771
lookup_trees.extend(extra_trees)
772
if specific_files == []:
773
specific_file_ids = []
775
specific_file_ids = self.target.paths2ids(specific_files,
776
lookup_trees, require_versioned=require_versioned)
778
all_unversioned = sorted([(p.split('/'), p) for p in
780
if specific_files is None or
781
osutils.is_inside_any(specific_files, p)])
782
all_unversioned = deque(all_unversioned)
784
all_unversioned = deque()
582
from_entries_by_dir = list(from_tree.inventory.iter_entries_by_dir(
786
from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
583
787
specific_file_ids=specific_file_ids))
584
788
from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
585
to_entries_by_dir = list(to_tree.inventory.iter_entries_by_dir(
789
to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
586
790
specific_file_ids=specific_file_ids))
587
791
num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
793
# the unversioned path lookup only occurs on real trees - where there
794
# can be extras. So the fake_entry is solely used to look up
795
# executable it values when execute is not supported.
796
fake_entry = InventoryFile('unused', 'unused', 'unused')
589
797
for to_path, to_entry in to_entries_by_dir:
798
while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
799
unversioned_path = all_unversioned.popleft()
800
to_kind, to_executable, to_stat = \
801
self.target._comparison_data(fake_entry, unversioned_path[1])
802
yield (None, (None, unversioned_path[1]), True, (False, False),
804
(None, unversioned_path[0][-1]),
806
(None, to_executable))
590
807
file_id = to_entry.file_id
591
808
to_paths[file_id] = to_path
608
825
from_executable = None
609
826
versioned = (from_versioned, True)
610
827
to_kind, to_executable, to_stat = \
611
to_tree._comparison_data(to_entry, to_path)
828
self.target._comparison_data(to_entry, to_path)
612
829
kind = (from_kind, to_kind)
613
830
if kind[0] != kind[1]:
614
831
changed_content = True
615
832
elif from_kind == 'file':
616
from_size = from_tree._file_size(from_entry, from_stat)
617
to_size = to_tree._file_size(to_entry, to_stat)
833
from_size = self.source._file_size(from_entry, from_stat)
834
to_size = self.target._file_size(to_entry, to_stat)
618
835
if from_size != to_size:
619
836
changed_content = True
620
elif (from_tree.get_file_sha1(file_id, from_path, from_stat) !=
621
to_tree.get_file_sha1(file_id, to_path, to_stat)):
837
elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
838
self.target.get_file_sha1(file_id, to_path, to_stat)):
622
839
changed_content = True
623
840
elif from_kind == 'symlink':
624
if (from_tree.get_symlink_target(file_id) !=
625
to_tree.get_symlink_target(file_id)):
841
if (self.source.get_symlink_target(file_id) !=
842
self.target.get_symlink_target(file_id)):
626
843
changed_content = True
844
elif from_kind == 'tree-reference':
845
if (self.source.get_reference_revision(file_id, from_path)
846
!= self.target.get_reference_revision(file_id, to_path)):
847
changed_content = True
627
848
parent = (from_parent, to_entry.parent_id)
628
849
name = (from_name, to_entry.name)
629
850
executable = (from_executable, to_executable)
630
851
if pb is not None:
631
852
pb.update('comparing files', entry_count, num_entries)
632
if (changed_content is not False or versioned[0] != versioned[1]
853
if (changed_content is not False or versioned[0] != versioned[1]
633
854
or parent[0] != parent[1] or name[0] != name[1] or
634
855
executable[0] != executable[1] or include_unchanged):
635
yield (file_id, to_path, changed_content, versioned, parent,
636
name, kind, executable)
638
def get_to_path(from_entry):
639
if from_entry.parent_id is None:
856
yield (file_id, (from_path, to_path), changed_content,
857
versioned, parent, name, kind, executable)
859
while all_unversioned:
860
# yield any trailing unversioned paths
861
unversioned_path = all_unversioned.popleft()
862
to_kind, to_executable, to_stat = \
863
self.target._comparison_data(fake_entry, unversioned_path[1])
864
yield (None, (None, unversioned_path[1]), True, (False, False),
866
(None, unversioned_path[0][-1]),
868
(None, to_executable))
870
def get_to_path(to_entry):
871
if to_entry.parent_id is None:
872
to_path = '' # the root
642
if from_entry.parent_id not in to_paths:
643
get_to_path(from_tree.inventory[from_entry.parent_id])
644
to_path = osutils.pathjoin(to_paths[from_entry.parent_id],
646
to_paths[from_entry.file_id] = to_path
874
if to_entry.parent_id not in to_paths:
876
return get_to_path(self.target.inventory[to_entry.parent_id])
877
to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
879
to_paths[to_entry.file_id] = to_path
649
882
for path, from_entry in from_entries_by_dir:
650
883
file_id = from_entry.file_id
651
884
if file_id in to_paths:
653
to_path = get_to_path(from_entry)
887
if not file_id in self.target.inventory:
888
# common case - paths we have not emitted are not present in
892
to_path = get_to_path(self.target.inventory[file_id])
655
894
if pb is not None:
656
895
pb.update('comparing files', entry_count, num_entries)
added
removed
bzrlib/tree.py
